« blib/lib/Paws/Pinpoint/WriteEventStream.pm
↑ Summary
blib/lib/Paws/Pinpoint/WriteSegmentRequest.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::WriteJourneyRequest; | ||
| 3 | use Moose; | ||
| 4 | has Activities => (is => 'ro', isa => 'Paws::Pinpoint::MapOfActivity'); | ||
| 5 | has CreationDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastModifiedDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has Limits => (is => 'ro', isa => 'Paws::Pinpoint::JourneyLimits'); | ||
| 8 | has LocalTime => (is => 'ro', isa => 'Bool'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has QuietTime => (is => 'ro', isa => 'Paws::Pinpoint::QuietTime'); | ||
| 11 | has RefreshFrequency => (is => 'ro', isa => 'Str'); | ||
| 12 | has RefreshOnSegmentUpdate => (is => 'ro', isa => 'Bool'); | ||
| 13 | has Schedule => (is => 'ro', isa => 'Paws::Pinpoint::JourneySchedule'); | ||
| 14 | has StartActivity => (is => 'ro', isa => 'Str'); | ||
| 15 | has StartCondition => (is => 'ro', isa => 'Paws::Pinpoint::StartCondition'); | ||
| 16 | has State => (is => 'ro', isa => 'Str'); | ||
| 17 | has WaitForQuietTime => (is => 'ro', isa => 'Bool'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Pinpoint::WriteJourneyRequest | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::Pinpoint::WriteJourneyRequest object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { Activities => $value, ..., WaitForQuietTime => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteJourneyRequest object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->Activities | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Specifies the configuration and other settings for a journey. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Activities => L<Paws::Pinpoint::MapOfActivity> | ||
| 55 | |||
| 56 | A map that contains a set of Activity objects, one object for each | ||
| 57 | activity in the journey. For each Activity object, the key is the | ||
| 58 | unique identifier (string) for an activity and the value is the | ||
| 59 | settings for the activity. An activity identifier can contain a maximum | ||
| 60 | of 100 characters. The characters must be alphanumeric characters. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 CreationDate => Str | ||
| 64 | |||
| 65 | The date, in ISO 8601 format, when the journey was created. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 LastModifiedDate => Str | ||
| 69 | |||
| 70 | The date, in ISO 8601 format, when the journey was last modified. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Limits => L<Paws::Pinpoint::JourneyLimits> | ||
| 74 | |||
| 75 | The messaging and entry limits for the journey. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 LocalTime => Bool | ||
| 79 | |||
| 80 | Specifies whether the journey's scheduled start and end times use each | ||
| 81 | participant's local time. To base the schedule on each participant's | ||
| 82 | local time, set this value to true. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> Name => Str | ||
| 86 | |||
| 87 | The name of the journey. A journey name can contain a maximum of 150 | ||
| 88 | characters. The characters can be alphanumeric characters or symbols, | ||
| 89 | such as underscores (_) or hyphens (-). A journey name can't contain | ||
| 90 | any spaces. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 QuietTime => L<Paws::Pinpoint::QuietTime> | ||
| 94 | |||
| 95 | The quiet time settings for the journey. Quiet time is a specific time | ||
| 96 | range when a journey doesn't send messages to participants, if all the | ||
| 97 | following conditions are met: | ||
| 98 | |||
| 99 | =over | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | The EndpointDemographic.Timezone property of the endpoint for the | ||
| 104 | participant is set to a valid value. | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | The current time in the participant's time zone is later than or equal | ||
| 109 | to the time specified by the QuietTime.Start property for the journey. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | The current time in the participant's time zone is earlier than or | ||
| 114 | equal to the time specified by the QuietTime.End property for the | ||
| 115 | journey. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | If any of the preceding conditions isn't met, the participant will | ||
| 120 | receive messages from the journey, even if quiet time is enabled. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 RefreshFrequency => Str | ||
| 124 | |||
| 125 | The frequency with which Amazon Pinpoint evaluates segment and event | ||
| 126 | data for the journey, as a duration in ISO 8601 format. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 RefreshOnSegmentUpdate => Bool | ||
| 130 | |||
| 131 | Specifies whether a journey should be refreshed on segment update. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 Schedule => L<Paws::Pinpoint::JourneySchedule> | ||
| 135 | |||
| 136 | The schedule settings for the journey. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 StartActivity => Str | ||
| 140 | |||
| 141 | The unique identifier for the first activity in the journey. The | ||
| 142 | identifier for this activity can contain a maximum of 128 characters. | ||
| 143 | The characters must be alphanumeric characters. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 StartCondition => L<Paws::Pinpoint::StartCondition> | ||
| 147 | |||
| 148 | The segment that defines which users are participants in the journey. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 State => Str | ||
| 152 | |||
| 153 | The status of the journey. Valid values are: | ||
| 154 | |||
| 155 | =over | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | DRAFT - Saves the journey and doesn't publish it. | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | ACTIVE - Saves and publishes the journey. Depending on the journey's | ||
| 164 | schedule, the journey starts running immediately or at the scheduled | ||
| 165 | start time. If a journey's status is ACTIVE, you can't add, change, or | ||
| 166 | remove activities from it. | ||
| 167 | |||
| 168 | =back | ||
| 169 | |||
| 170 | PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in | ||
| 171 | requests to create or update a journey. To cancel, pause, or resume a | ||
| 172 | journey, use the | ||
| 173 | |||
| 174 | Journey State resource. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 WaitForQuietTime => Bool | ||
| 178 | |||
| 179 | Specifies whether endpoints in quiet hours should enter a wait till the | ||
| 180 | end of their quiet hours. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head1 SEE ALSO | ||
| 185 | |||
| 186 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 187 | |||
| 188 | =head1 BUGS and CONTRIBUTIONS | ||
| 189 | |||
| 190 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 191 | |||
| 192 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 193 | |||
| 194 | =cut | ||
| 195 |