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