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