« blib/lib/Paws/Pinpoint/CreateImportJobResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/CreateJourneyResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::CreateJourney; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has WriteJourneyRequest => (is => 'ro', isa => 'Paws::Pinpoint::WriteJourneyRequest', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | class_has _stream_param => (is => 'ro', default => 'WriteJourneyRequest'); | ||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateJourney'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/journeys'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::CreateJourneyResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Pinpoint::CreateJourney - Arguments for method CreateJourney on L<Paws::Pinpoint> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateJourney on the | ||
| 24 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateJourney. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJourney. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 32 | my $CreateJourneyResponse = $pinpoint->CreateJourney( | ||
| 33 | ApplicationId => 'My__string', | ||
| 34 | WriteJourneyRequest => { | ||
| 35 | Name => 'My__string', | ||
| 36 | Activities => { | ||
| 37 | 'My__string' => { | ||
| 38 | CUSTOM => { | ||
| 39 | DeliveryUri => 'My__string', | ||
| 40 | EndpointTypes => [ | ||
| 41 | 'PUSH', | ||
| 42 | ... # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM | ||
| 43 | ], # OPTIONAL | ||
| 44 | MessageConfig => { Data => 'My__string', }, # OPTIONAL | ||
| 45 | NextActivity => 'My__string', | ||
| 46 | TemplateName => 'My__string', | ||
| 47 | TemplateVersion => 'My__string', | ||
| 48 | }, # OPTIONAL | ||
| 49 | ConditionalSplit => { | ||
| 50 | Condition => { | ||
| 51 | Conditions => [ | ||
| 52 | { | ||
| 53 | EventCondition => { | ||
| 54 | Dimensions => { | ||
| 55 | Attributes => { | ||
| 56 | 'My__string' => { | ||
| 57 | Values => [ 'My__string', ... ], | ||
| 58 | AttributeType => 'INCLUSIVE' | ||
| 59 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 60 | }, | ||
| 61 | }, # OPTIONAL | ||
| 62 | EventType => { | ||
| 63 | Values => [ 'My__string', ... ], | ||
| 64 | DimensionType => 'INCLUSIVE' | ||
| 65 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | Metrics => { | ||
| 68 | 'My__string' => { | ||
| 69 | ComparisonOperator => 'My__string', | ||
| 70 | Value => 1, | ||
| 71 | |||
| 72 | }, | ||
| 73 | }, # OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | MessageActivity => 'My__string', | ||
| 76 | }, # OPTIONAL | ||
| 77 | SegmentCondition => { | ||
| 78 | SegmentId => 'My__string', | ||
| 79 | |||
| 80 | }, # OPTIONAL | ||
| 81 | SegmentDimensions => { | ||
| 82 | Attributes => { | ||
| 83 | 'My__string' => { | ||
| 84 | Values => [ 'My__string', ... ], | ||
| 85 | AttributeType => 'INCLUSIVE' | ||
| 86 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 87 | }, | ||
| 88 | }, # OPTIONAL | ||
| 89 | Behavior => { | ||
| 90 | Recency => { | ||
| 91 | Duration => | ||
| 92 | 'HR_24', # values: HR_24, DAY_7, DAY_14, DAY_30 | ||
| 93 | RecencyType => 'ACTIVE', # values: ACTIVE, INACTIVE | ||
| 94 | |||
| 95 | }, # OPTIONAL | ||
| 96 | }, # OPTIONAL | ||
| 97 | Demographic => { | ||
| 98 | AppVersion => { | ||
| 99 | Values => [ 'My__string', ... ], | ||
| 100 | DimensionType => 'INCLUSIVE' | ||
| 101 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 102 | }, # OPTIONAL | ||
| 103 | Channel => { | ||
| 104 | Values => [ 'My__string', ... ], | ||
| 105 | DimensionType => 'INCLUSIVE' | ||
| 106 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 107 | }, # OPTIONAL | ||
| 108 | DeviceType => { | ||
| 109 | Values => [ 'My__string', ... ], | ||
| 110 | DimensionType => 'INCLUSIVE' | ||
| 111 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 112 | }, # OPTIONAL | ||
| 113 | Make => { | ||
| 114 | Values => [ 'My__string', ... ], | ||
| 115 | DimensionType => 'INCLUSIVE' | ||
| 116 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 117 | }, # OPTIONAL | ||
| 118 | Model => { | ||
| 119 | Values => [ 'My__string', ... ], | ||
| 120 | DimensionType => 'INCLUSIVE' | ||
| 121 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 122 | }, # OPTIONAL | ||
| 123 | Platform => { | ||
| 124 | Values => [ 'My__string', ... ], | ||
| 125 | DimensionType => 'INCLUSIVE' | ||
| 126 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 127 | }, # OPTIONAL | ||
| 128 | }, # OPTIONAL | ||
| 129 | Location => { | ||
| 130 | Country => { | ||
| 131 | Values => [ 'My__string', ... ], | ||
| 132 | DimensionType => 'INCLUSIVE' | ||
| 133 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 134 | }, # OPTIONAL | ||
| 135 | GPSPoint => { | ||
| 136 | Coordinates => { | ||
| 137 | Latitude => 1, | ||
| 138 | Longitude => 1, | ||
| 139 | |||
| 140 | }, | ||
| 141 | RangeInKilometers => 1, | ||
| 142 | }, # OPTIONAL | ||
| 143 | }, # OPTIONAL | ||
| 144 | Metrics => { | ||
| 145 | 'My__string' => { | ||
| 146 | ComparisonOperator => 'My__string', | ||
| 147 | Value => 1, | ||
| 148 | |||
| 149 | }, | ||
| 150 | }, # OPTIONAL | ||
| 151 | UserAttributes => { | ||
| 152 | 'My__string' => { | ||
| 153 | Values => [ 'My__string', ... ], | ||
| 154 | AttributeType => 'INCLUSIVE' | ||
| 155 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 156 | }, | ||
| 157 | }, # OPTIONAL | ||
| 158 | }, # OPTIONAL | ||
| 159 | }, | ||
| 160 | ... | ||
| 161 | ], # OPTIONAL | ||
| 162 | Operator => 'ALL', # values: ALL, ANY; OPTIONAL | ||
| 163 | }, # OPTIONAL | ||
| 164 | EvaluationWaitTime => { | ||
| 165 | WaitFor => 'My__string', | ||
| 166 | WaitUntil => 'My__string', | ||
| 167 | }, # OPTIONAL | ||
| 168 | FalseActivity => 'My__string', | ||
| 169 | TrueActivity => 'My__string', | ||
| 170 | }, # OPTIONAL | ||
| 171 | Description => 'My__string', | ||
| 172 | EMAIL => { | ||
| 173 | MessageConfig => { FromAddress => 'My__string', }, # OPTIONAL | ||
| 174 | NextActivity => 'My__string', | ||
| 175 | TemplateName => 'My__string', | ||
| 176 | TemplateVersion => 'My__string', | ||
| 177 | }, # OPTIONAL | ||
| 178 | Holdout => { | ||
| 179 | Percentage => 1, | ||
| 180 | NextActivity => 'My__string', | ||
| 181 | }, # OPTIONAL | ||
| 182 | MultiCondition => { | ||
| 183 | Branches => [ | ||
| 184 | { | ||
| 185 | Condition => { | ||
| 186 | EventCondition => { | ||
| 187 | Dimensions => { | ||
| 188 | Attributes => { | ||
| 189 | 'My__string' => { | ||
| 190 | Values => [ 'My__string', ... ], | ||
| 191 | AttributeType => 'INCLUSIVE' | ||
| 192 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 193 | }, | ||
| 194 | }, # OPTIONAL | ||
| 195 | EventType => { | ||
| 196 | Values => [ 'My__string', ... ], | ||
| 197 | DimensionType => 'INCLUSIVE' | ||
| 198 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 199 | }, # OPTIONAL | ||
| 200 | Metrics => { | ||
| 201 | 'My__string' => { | ||
| 202 | ComparisonOperator => 'My__string', | ||
| 203 | Value => 1, | ||
| 204 | |||
| 205 | }, | ||
| 206 | }, # OPTIONAL | ||
| 207 | }, # OPTIONAL | ||
| 208 | MessageActivity => 'My__string', | ||
| 209 | }, # OPTIONAL | ||
| 210 | SegmentCondition => { | ||
| 211 | SegmentId => 'My__string', | ||
| 212 | |||
| 213 | }, # OPTIONAL | ||
| 214 | SegmentDimensions => { | ||
| 215 | Attributes => { | ||
| 216 | 'My__string' => { | ||
| 217 | Values => [ 'My__string', ... ], | ||
| 218 | AttributeType => 'INCLUSIVE' | ||
| 219 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 220 | }, | ||
| 221 | }, # OPTIONAL | ||
| 222 | Behavior => { | ||
| 223 | Recency => { | ||
| 224 | Duration => | ||
| 225 | 'HR_24', # values: HR_24, DAY_7, DAY_14, DAY_30 | ||
| 226 | RecencyType => 'ACTIVE', # values: ACTIVE, INACTIVE | ||
| 227 | |||
| 228 | }, # OPTIONAL | ||
| 229 | }, # OPTIONAL | ||
| 230 | Demographic => { | ||
| 231 | AppVersion => { | ||
| 232 | Values => [ 'My__string', ... ], | ||
| 233 | DimensionType => 'INCLUSIVE' | ||
| 234 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 235 | }, # OPTIONAL | ||
| 236 | Channel => { | ||
| 237 | Values => [ 'My__string', ... ], | ||
| 238 | DimensionType => 'INCLUSIVE' | ||
| 239 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 240 | }, # OPTIONAL | ||
| 241 | DeviceType => { | ||
| 242 | Values => [ 'My__string', ... ], | ||
| 243 | DimensionType => 'INCLUSIVE' | ||
| 244 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 245 | }, # OPTIONAL | ||
| 246 | Make => { | ||
| 247 | Values => [ 'My__string', ... ], | ||
| 248 | DimensionType => 'INCLUSIVE' | ||
| 249 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 250 | }, # OPTIONAL | ||
| 251 | Model => { | ||
| 252 | Values => [ 'My__string', ... ], | ||
| 253 | DimensionType => 'INCLUSIVE' | ||
| 254 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 255 | }, # OPTIONAL | ||
| 256 | Platform => { | ||
| 257 | Values => [ 'My__string', ... ], | ||
| 258 | DimensionType => 'INCLUSIVE' | ||
| 259 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 260 | }, # OPTIONAL | ||
| 261 | }, # OPTIONAL | ||
| 262 | Location => { | ||
| 263 | Country => { | ||
| 264 | Values => [ 'My__string', ... ], | ||
| 265 | DimensionType => 'INCLUSIVE' | ||
| 266 | , # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 267 | }, # OPTIONAL | ||
| 268 | GPSPoint => { | ||
| 269 | Coordinates => { | ||
| 270 | Latitude => 1, | ||
| 271 | Longitude => 1, | ||
| 272 | |||
| 273 | }, | ||
| 274 | RangeInKilometers => 1, | ||
| 275 | }, # OPTIONAL | ||
| 276 | }, # OPTIONAL | ||
| 277 | Metrics => { | ||
| 278 | 'My__string' => { | ||
| 279 | ComparisonOperator => 'My__string', | ||
| 280 | Value => 1, | ||
| 281 | |||
| 282 | }, | ||
| 283 | }, # OPTIONAL | ||
| 284 | UserAttributes => { | ||
| 285 | 'My__string' => { | ||
| 286 | Values => [ 'My__string', ... ], | ||
| 287 | AttributeType => 'INCLUSIVE' | ||
| 288 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 289 | }, | ||
| 290 | }, # OPTIONAL | ||
| 291 | }, # OPTIONAL | ||
| 292 | }, | ||
| 293 | NextActivity => 'My__string', | ||
| 294 | }, | ||
| 295 | ... | ||
| 296 | ], # OPTIONAL | ||
| 297 | DefaultActivity => 'My__string', | ||
| 298 | EvaluationWaitTime => { | ||
| 299 | WaitFor => 'My__string', | ||
| 300 | WaitUntil => 'My__string', | ||
| 301 | }, # OPTIONAL | ||
| 302 | }, # OPTIONAL | ||
| 303 | PUSH => { | ||
| 304 | MessageConfig => { TimeToLive => 'My__string', }, # OPTIONAL | ||
| 305 | NextActivity => 'My__string', | ||
| 306 | TemplateName => 'My__string', | ||
| 307 | TemplateVersion => 'My__string', | ||
| 308 | }, # OPTIONAL | ||
| 309 | RandomSplit => { | ||
| 310 | Branches => [ | ||
| 311 | { | ||
| 312 | NextActivity => 'My__string', | ||
| 313 | Percentage => 1, | ||
| 314 | }, | ||
| 315 | ... | ||
| 316 | ], # OPTIONAL | ||
| 317 | }, # OPTIONAL | ||
| 318 | SMS => { | ||
| 319 | MessageConfig => { | ||
| 320 | EntityId => 'My__string', | ||
| 321 | MessageType => 'TRANSACTIONAL' | ||
| 322 | , # values: TRANSACTIONAL, PROMOTIONAL; OPTIONAL | ||
| 323 | OriginationNumber => 'My__string', | ||
| 324 | SenderId => 'My__string', | ||
| 325 | TemplateId => 'My__string', | ||
| 326 | }, # OPTIONAL | ||
| 327 | NextActivity => 'My__string', | ||
| 328 | TemplateName => 'My__string', | ||
| 329 | TemplateVersion => 'My__string', | ||
| 330 | }, # OPTIONAL | ||
| 331 | Wait => { | ||
| 332 | NextActivity => 'My__string', | ||
| 333 | WaitTime => { | ||
| 334 | WaitFor => 'My__string', | ||
| 335 | WaitUntil => 'My__string', | ||
| 336 | }, # OPTIONAL | ||
| 337 | }, # OPTIONAL | ||
| 338 | }, | ||
| 339 | }, # OPTIONAL | ||
| 340 | CreationDate => 'My__string', | ||
| 341 | LastModifiedDate => 'My__string', | ||
| 342 | Limits => { | ||
| 343 | DailyCap => 1, | ||
| 344 | EndpointReentryCap => 1, | ||
| 345 | EndpointReentryInterval => 'My__string', | ||
| 346 | MessagesPerSecond => 1, | ||
| 347 | }, # OPTIONAL | ||
| 348 | LocalTime => 1, # OPTIONAL | ||
| 349 | QuietTime => { | ||
| 350 | End => 'My__string', | ||
| 351 | Start => 'My__string', | ||
| 352 | }, # OPTIONAL | ||
| 353 | RefreshFrequency => 'My__string', | ||
| 354 | RefreshOnSegmentUpdate => 1, # OPTIONAL | ||
| 355 | Schedule => { | ||
| 356 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 357 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 358 | Timezone => 'My__string', | ||
| 359 | }, # OPTIONAL | ||
| 360 | StartActivity => 'My__string', | ||
| 361 | StartCondition => { | ||
| 362 | Description => 'My__string', | ||
| 363 | EventStartCondition => { | ||
| 364 | EventFilter => { | ||
| 365 | Dimensions => { | ||
| 366 | Attributes => { | ||
| 367 | 'My__string' => { | ||
| 368 | Values => [ 'My__string', ... ], | ||
| 369 | AttributeType => 'INCLUSIVE' | ||
| 370 | , # values: INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, ON, BETWEEN; OPTIONAL | ||
| 371 | }, | ||
| 372 | }, # OPTIONAL | ||
| 373 | EventType => { | ||
| 374 | Values => [ 'My__string', ... ], | ||
| 375 | DimensionType => | ||
| 376 | 'INCLUSIVE', # values: INCLUSIVE, EXCLUSIVE; OPTIONAL | ||
| 377 | }, # OPTIONAL | ||
| 378 | Metrics => { | ||
| 379 | 'My__string' => { | ||
| 380 | ComparisonOperator => 'My__string', | ||
| 381 | Value => 1, | ||
| 382 | |||
| 383 | }, | ||
| 384 | }, # OPTIONAL | ||
| 385 | }, # OPTIONAL | ||
| 386 | FilterType => 'SYSTEM', # values: SYSTEM, ENDPOINT | ||
| 387 | |||
| 388 | }, # OPTIONAL | ||
| 389 | SegmentId => 'My__string', | ||
| 390 | }, # OPTIONAL | ||
| 391 | SegmentStartCondition => { | ||
| 392 | SegmentId => 'My__string', | ||
| 393 | |||
| 394 | }, # OPTIONAL | ||
| 395 | }, # OPTIONAL | ||
| 396 | State => 'DRAFT' | ||
| 397 | , # values: DRAFT, ACTIVE, COMPLETED, CANCELLED, CLOSED, PAUSED; OPTIONAL | ||
| 398 | WaitForQuietTime => 1, # OPTIONAL | ||
| 399 | }, | ||
| 400 | |||
| 401 | ); | ||
| 402 | |||
| 403 | # Results: | ||
| 404 | my $JourneyResponse = $CreateJourneyResponse->JourneyResponse; | ||
| 405 | |||
| 406 | # Returns a L<Paws::Pinpoint::CreateJourneyResponse> object. | ||
| 407 | |||
| 408 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 409 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/CreateJourney> | ||
| 410 | |||
| 411 | =head1 ATTRIBUTES | ||
| 412 | |||
| 413 | |||
| 414 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 415 | |||
| 416 | The unique identifier for the application. This identifier is displayed | ||
| 417 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 418 | |||
| 419 | |||
| 420 | |||
| 421 | =head2 B<REQUIRED> WriteJourneyRequest => L<Paws::Pinpoint::WriteJourneyRequest> | ||
| 422 | |||
| 423 | |||
| 424 | |||
| 425 | |||
| 426 | |||
| 427 | |||
| 428 | =head1 SEE ALSO | ||
| 429 | |||
| 430 | This class forms part of L<Paws>, documenting arguments for method CreateJourney in L<Paws::Pinpoint> | ||
| 431 | |||
| 432 | =head1 BUGS and CONTRIBUTIONS | ||
| 433 | |||
| 434 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 435 | |||
| 436 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 437 | |||
| 438 | =cut | ||
| 439 |