@aws-sdk/client-pinpoint 3.325.0 → 3.326.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CreateAppCommand.d.ts +14 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/CreateEmailTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateExportJobCommand.d.ts +27 -0
- package/dist-types/commands/CreateImportJobCommand.d.ts +31 -0
- package/dist-types/commands/CreateInAppTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/CreatePushTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/CreateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/CreateSmsTemplateCommand.d.ts +10 -0
- package/dist-types/commands/CreateVoiceTemplateCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/DeleteAppCommand.d.ts +14 -0
- package/dist-types/commands/DeleteBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +385 -0
- package/dist-types/commands/DeleteEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/DeleteEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteEndpointCommand.d.ts +51 -0
- package/dist-types/commands/DeleteEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/DeleteGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/DeleteInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteJourneyCommand.d.ts +383 -0
- package/dist-types/commands/DeletePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSegmentCommand.d.ts +158 -0
- package/dist-types/commands/DeleteSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/DeleteSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/DeleteUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/DeleteVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/DeleteVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/GetAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/GetAppCommand.d.ts +14 -0
- package/dist-types/commands/GetApplicationDateRangeKpiCommand.d.ts +32 -0
- package/dist-types/commands/GetApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/GetAppsCommand.d.ts +19 -0
- package/dist-types/commands/GetBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetCampaignActivitiesCommand.d.ts +28 -0
- package/dist-types/commands/GetCampaignCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetCampaignVersionCommand.d.ts +385 -0
- package/dist-types/commands/GetCampaignVersionsCommand.d.ts +390 -0
- package/dist-types/commands/GetCampaignsCommand.d.ts +390 -0
- package/dist-types/commands/GetChannelsCommand.d.ts +20 -0
- package/dist-types/commands/GetEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/GetEmailTemplateCommand.d.ts +22 -0
- package/dist-types/commands/GetEndpointCommand.d.ts +51 -0
- package/dist-types/commands/GetEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/GetExportJobCommand.d.ts +27 -0
- package/dist-types/commands/GetExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +31 -0
- package/dist-types/commands/GetImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetInAppMessagesCommand.d.ts +112 -0
- package/dist-types/commands/GetInAppTemplateCommand.d.ts +78 -0
- package/dist-types/commands/GetJourneyCommand.d.ts +383 -0
- package/dist-types/commands/GetJourneyDateRangeKpiCommand.d.ts +33 -0
- package/dist-types/commands/GetJourneyExecutionActivityMetricsCommand.d.ts +15 -0
- package/dist-types/commands/GetJourneyExecutionMetricsCommand.d.ts +13 -0
- package/dist-types/commands/GetJourneyRunExecutionActivityMetricsCommand.d.ts +16 -0
- package/dist-types/commands/GetJourneyRunExecutionMetricsCommand.d.ts +14 -0
- package/dist-types/commands/GetJourneyRunsCommand.d.ts +16 -0
- package/dist-types/commands/GetPushTemplateCommand.d.ts +68 -0
- package/dist-types/commands/GetRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/GetRecommenderConfigurationsCommand.d.ts +26 -0
- package/dist-types/commands/GetSegmentCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentExportJobsCommand.d.ts +32 -0
- package/dist-types/commands/GetSegmentImportJobsCommand.d.ts +36 -0
- package/dist-types/commands/GetSegmentVersionCommand.d.ts +158 -0
- package/dist-types/commands/GetSegmentVersionsCommand.d.ts +163 -0
- package/dist-types/commands/GetSegmentsCommand.d.ts +163 -0
- package/dist-types/commands/GetSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/GetSmsTemplateCommand.d.ts +20 -0
- package/dist-types/commands/GetUserEndpointsCommand.d.ts +55 -0
- package/dist-types/commands/GetVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/GetVoiceTemplateCommand.d.ts +21 -0
- package/dist-types/commands/ListJourneysCommand.d.ts +388 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +10 -0
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +21 -0
- package/dist-types/commands/ListTemplatesCommand.d.ts +23 -0
- package/dist-types/commands/PhoneNumberValidateCommand.d.ts +21 -0
- package/dist-types/commands/PutEventStreamCommand.d.ts +13 -0
- package/dist-types/commands/PutEventsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveAttributesCommand.d.ts +12 -0
- package/dist-types/commands/SendMessagesCommand.d.ts +28 -0
- package/dist-types/commands/SendOTPMessageCommand.d.ts +28 -0
- package/dist-types/commands/SendUsersMessagesCommand.d.ts +21 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAdmChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateApnsChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApnsVoipSandboxChannelCommand.d.ts +19 -0
- package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +25 -0
- package/dist-types/commands/UpdateBaiduChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateCampaignCommand.d.ts +385 -0
- package/dist-types/commands/UpdateEmailChannelCommand.d.ts +22 -0
- package/dist-types/commands/UpdateEmailTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointCommand.d.ts +9 -0
- package/dist-types/commands/UpdateEndpointsBatchCommand.d.ts +9 -0
- package/dist-types/commands/UpdateGcmChannelCommand.d.ts +18 -0
- package/dist-types/commands/UpdateInAppTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateJourneyCommand.d.ts +383 -0
- package/dist-types/commands/UpdateJourneyStateCommand.d.ts +383 -0
- package/dist-types/commands/UpdatePushTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateRecommenderConfigurationCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSegmentCommand.d.ts +158 -0
- package/dist-types/commands/UpdateSmsChannelCommand.d.ts +21 -0
- package/dist-types/commands/UpdateSmsTemplateCommand.d.ts +9 -0
- package/dist-types/commands/UpdateTemplateActiveVersionCommand.d.ts +9 -0
- package/dist-types/commands/UpdateVoiceChannelCommand.d.ts +17 -0
- package/dist-types/commands/UpdateVoiceTemplateCommand.d.ts +9 -0
- package/dist-types/commands/VerifyOTPMessageCommand.d.ts +8 -0
- package/package.json +3 -3
|
@@ -396,6 +396,389 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
396
396
|
* };
|
|
397
397
|
* const command = new UpdateCampaignCommand(input);
|
|
398
398
|
* const response = await client.send(command);
|
|
399
|
+
* // { // UpdateCampaignResponse
|
|
400
|
+
* // CampaignResponse: { // CampaignResponse
|
|
401
|
+
* // AdditionalTreatments: [ // ListOfTreatmentResource
|
|
402
|
+
* // { // TreatmentResource
|
|
403
|
+
* // CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
|
|
404
|
+
* // DeliveryUri: "STRING_VALUE", // required
|
|
405
|
+
* // EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
406
|
+
* // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
407
|
+
* // ],
|
|
408
|
+
* // },
|
|
409
|
+
* // Id: "STRING_VALUE", // required
|
|
410
|
+
* // MessageConfiguration: { // MessageConfiguration
|
|
411
|
+
* // ADMMessage: { // Message
|
|
412
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
413
|
+
* // Body: "STRING_VALUE",
|
|
414
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
415
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
416
|
+
* // ImageUrl: "STRING_VALUE",
|
|
417
|
+
* // JsonBody: "STRING_VALUE",
|
|
418
|
+
* // MediaUrl: "STRING_VALUE",
|
|
419
|
+
* // RawContent: "STRING_VALUE",
|
|
420
|
+
* // SilentPush: true || false,
|
|
421
|
+
* // TimeToLive: Number("int"),
|
|
422
|
+
* // Title: "STRING_VALUE",
|
|
423
|
+
* // Url: "STRING_VALUE",
|
|
424
|
+
* // },
|
|
425
|
+
* // APNSMessage: {
|
|
426
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
427
|
+
* // Body: "STRING_VALUE",
|
|
428
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
429
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
430
|
+
* // ImageUrl: "STRING_VALUE",
|
|
431
|
+
* // JsonBody: "STRING_VALUE",
|
|
432
|
+
* // MediaUrl: "STRING_VALUE",
|
|
433
|
+
* // RawContent: "STRING_VALUE",
|
|
434
|
+
* // SilentPush: true || false,
|
|
435
|
+
* // TimeToLive: Number("int"),
|
|
436
|
+
* // Title: "STRING_VALUE",
|
|
437
|
+
* // Url: "STRING_VALUE",
|
|
438
|
+
* // },
|
|
439
|
+
* // BaiduMessage: {
|
|
440
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
441
|
+
* // Body: "STRING_VALUE",
|
|
442
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
443
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
444
|
+
* // ImageUrl: "STRING_VALUE",
|
|
445
|
+
* // JsonBody: "STRING_VALUE",
|
|
446
|
+
* // MediaUrl: "STRING_VALUE",
|
|
447
|
+
* // RawContent: "STRING_VALUE",
|
|
448
|
+
* // SilentPush: true || false,
|
|
449
|
+
* // TimeToLive: Number("int"),
|
|
450
|
+
* // Title: "STRING_VALUE",
|
|
451
|
+
* // Url: "STRING_VALUE",
|
|
452
|
+
* // },
|
|
453
|
+
* // CustomMessage: { // CampaignCustomMessage
|
|
454
|
+
* // Data: "STRING_VALUE",
|
|
455
|
+
* // },
|
|
456
|
+
* // DefaultMessage: {
|
|
457
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
458
|
+
* // Body: "STRING_VALUE",
|
|
459
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
460
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
461
|
+
* // ImageUrl: "STRING_VALUE",
|
|
462
|
+
* // JsonBody: "STRING_VALUE",
|
|
463
|
+
* // MediaUrl: "STRING_VALUE",
|
|
464
|
+
* // RawContent: "STRING_VALUE",
|
|
465
|
+
* // SilentPush: true || false,
|
|
466
|
+
* // TimeToLive: Number("int"),
|
|
467
|
+
* // Title: "STRING_VALUE",
|
|
468
|
+
* // Url: "STRING_VALUE",
|
|
469
|
+
* // },
|
|
470
|
+
* // EmailMessage: { // CampaignEmailMessage
|
|
471
|
+
* // Body: "STRING_VALUE",
|
|
472
|
+
* // FromAddress: "STRING_VALUE",
|
|
473
|
+
* // HtmlBody: "STRING_VALUE",
|
|
474
|
+
* // Title: "STRING_VALUE",
|
|
475
|
+
* // },
|
|
476
|
+
* // GCMMessage: {
|
|
477
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
478
|
+
* // Body: "STRING_VALUE",
|
|
479
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
480
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
481
|
+
* // ImageUrl: "STRING_VALUE",
|
|
482
|
+
* // JsonBody: "STRING_VALUE",
|
|
483
|
+
* // MediaUrl: "STRING_VALUE",
|
|
484
|
+
* // RawContent: "STRING_VALUE",
|
|
485
|
+
* // SilentPush: true || false,
|
|
486
|
+
* // TimeToLive: Number("int"),
|
|
487
|
+
* // Title: "STRING_VALUE",
|
|
488
|
+
* // Url: "STRING_VALUE",
|
|
489
|
+
* // },
|
|
490
|
+
* // SMSMessage: { // CampaignSmsMessage
|
|
491
|
+
* // Body: "STRING_VALUE",
|
|
492
|
+
* // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
493
|
+
* // OriginationNumber: "STRING_VALUE",
|
|
494
|
+
* // SenderId: "STRING_VALUE",
|
|
495
|
+
* // EntityId: "STRING_VALUE",
|
|
496
|
+
* // TemplateId: "STRING_VALUE",
|
|
497
|
+
* // },
|
|
498
|
+
* // InAppMessage: { // CampaignInAppMessage
|
|
499
|
+
* // Body: "STRING_VALUE",
|
|
500
|
+
* // Content: [ // ListOfInAppMessageContent
|
|
501
|
+
* // { // InAppMessageContent
|
|
502
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
503
|
+
* // BodyConfig: { // InAppMessageBodyConfig
|
|
504
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
505
|
+
* // Body: "STRING_VALUE", // required
|
|
506
|
+
* // TextColor: "STRING_VALUE", // required
|
|
507
|
+
* // },
|
|
508
|
+
* // HeaderConfig: { // InAppMessageHeaderConfig
|
|
509
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
510
|
+
* // Header: "STRING_VALUE", // required
|
|
511
|
+
* // TextColor: "STRING_VALUE", // required
|
|
512
|
+
* // },
|
|
513
|
+
* // ImageUrl: "STRING_VALUE",
|
|
514
|
+
* // PrimaryBtn: { // InAppMessageButton
|
|
515
|
+
* // Android: { // OverrideButtonConfiguration
|
|
516
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
517
|
+
* // Link: "STRING_VALUE",
|
|
518
|
+
* // },
|
|
519
|
+
* // DefaultConfig: { // DefaultButtonConfiguration
|
|
520
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
521
|
+
* // BorderRadius: Number("int"),
|
|
522
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
523
|
+
* // Link: "STRING_VALUE",
|
|
524
|
+
* // Text: "STRING_VALUE", // required
|
|
525
|
+
* // TextColor: "STRING_VALUE",
|
|
526
|
+
* // },
|
|
527
|
+
* // IOS: {
|
|
528
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
529
|
+
* // Link: "STRING_VALUE",
|
|
530
|
+
* // },
|
|
531
|
+
* // Web: {
|
|
532
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
533
|
+
* // Link: "STRING_VALUE",
|
|
534
|
+
* // },
|
|
535
|
+
* // },
|
|
536
|
+
* // SecondaryBtn: {
|
|
537
|
+
* // Android: {
|
|
538
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
539
|
+
* // Link: "STRING_VALUE",
|
|
540
|
+
* // },
|
|
541
|
+
* // DefaultConfig: {
|
|
542
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
543
|
+
* // BorderRadius: Number("int"),
|
|
544
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
545
|
+
* // Link: "STRING_VALUE",
|
|
546
|
+
* // Text: "STRING_VALUE", // required
|
|
547
|
+
* // TextColor: "STRING_VALUE",
|
|
548
|
+
* // },
|
|
549
|
+
* // IOS: {
|
|
550
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
551
|
+
* // Link: "STRING_VALUE",
|
|
552
|
+
* // },
|
|
553
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
554
|
+
* // },
|
|
555
|
+
* // },
|
|
556
|
+
* // ],
|
|
557
|
+
* // CustomConfig: { // MapOf__string
|
|
558
|
+
* // "<keys>": "STRING_VALUE",
|
|
559
|
+
* // },
|
|
560
|
+
* // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
561
|
+
* // },
|
|
562
|
+
* // },
|
|
563
|
+
* // Schedule: { // Schedule
|
|
564
|
+
* // EndTime: "STRING_VALUE",
|
|
565
|
+
* // EventFilter: { // CampaignEventFilter
|
|
566
|
+
* // Dimensions: { // EventDimensions
|
|
567
|
+
* // Attributes: { // MapOfAttributeDimension
|
|
568
|
+
* // "<keys>": { // AttributeDimension
|
|
569
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
570
|
+
* // Values: [ // ListOf__string // required
|
|
571
|
+
* // "STRING_VALUE",
|
|
572
|
+
* // ],
|
|
573
|
+
* // },
|
|
574
|
+
* // },
|
|
575
|
+
* // EventType: { // SetDimension
|
|
576
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
577
|
+
* // Values: [ // required
|
|
578
|
+
* // "STRING_VALUE",
|
|
579
|
+
* // ],
|
|
580
|
+
* // },
|
|
581
|
+
* // Metrics: { // MapOfMetricDimension
|
|
582
|
+
* // "<keys>": { // MetricDimension
|
|
583
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
584
|
+
* // Value: Number("double"), // required
|
|
585
|
+
* // },
|
|
586
|
+
* // },
|
|
587
|
+
* // },
|
|
588
|
+
* // FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
589
|
+
* // },
|
|
590
|
+
* // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
591
|
+
* // IsLocalTime: true || false,
|
|
592
|
+
* // QuietTime: { // QuietTime
|
|
593
|
+
* // End: "STRING_VALUE",
|
|
594
|
+
* // Start: "STRING_VALUE",
|
|
595
|
+
* // },
|
|
596
|
+
* // StartTime: "STRING_VALUE", // required
|
|
597
|
+
* // Timezone: "STRING_VALUE",
|
|
598
|
+
* // },
|
|
599
|
+
* // SizePercent: Number("int"), // required
|
|
600
|
+
* // State: { // CampaignState
|
|
601
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
602
|
+
* // },
|
|
603
|
+
* // TemplateConfiguration: { // TemplateConfiguration
|
|
604
|
+
* // EmailTemplate: { // Template
|
|
605
|
+
* // Name: "STRING_VALUE",
|
|
606
|
+
* // Version: "STRING_VALUE",
|
|
607
|
+
* // },
|
|
608
|
+
* // PushTemplate: {
|
|
609
|
+
* // Name: "STRING_VALUE",
|
|
610
|
+
* // Version: "STRING_VALUE",
|
|
611
|
+
* // },
|
|
612
|
+
* // SMSTemplate: {
|
|
613
|
+
* // Name: "STRING_VALUE",
|
|
614
|
+
* // Version: "STRING_VALUE",
|
|
615
|
+
* // },
|
|
616
|
+
* // VoiceTemplate: {
|
|
617
|
+
* // Name: "STRING_VALUE",
|
|
618
|
+
* // Version: "STRING_VALUE",
|
|
619
|
+
* // },
|
|
620
|
+
* // },
|
|
621
|
+
* // TreatmentDescription: "STRING_VALUE",
|
|
622
|
+
* // TreatmentName: "STRING_VALUE",
|
|
623
|
+
* // },
|
|
624
|
+
* // ],
|
|
625
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
626
|
+
* // Arn: "STRING_VALUE", // required
|
|
627
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
628
|
+
* // CustomDeliveryConfiguration: {
|
|
629
|
+
* // DeliveryUri: "STRING_VALUE", // required
|
|
630
|
+
* // EndpointTypes: [
|
|
631
|
+
* // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
632
|
+
* // ],
|
|
633
|
+
* // },
|
|
634
|
+
* // DefaultState: {
|
|
635
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
636
|
+
* // },
|
|
637
|
+
* // Description: "STRING_VALUE",
|
|
638
|
+
* // HoldoutPercent: Number("int"),
|
|
639
|
+
* // Hook: { // CampaignHook
|
|
640
|
+
* // LambdaFunctionName: "STRING_VALUE",
|
|
641
|
+
* // Mode: "DELIVERY" || "FILTER",
|
|
642
|
+
* // WebUrl: "STRING_VALUE",
|
|
643
|
+
* // },
|
|
644
|
+
* // Id: "STRING_VALUE", // required
|
|
645
|
+
* // IsPaused: true || false,
|
|
646
|
+
* // LastModifiedDate: "STRING_VALUE", // required
|
|
647
|
+
* // Limits: { // CampaignLimits
|
|
648
|
+
* // Daily: Number("int"),
|
|
649
|
+
* // MaximumDuration: Number("int"),
|
|
650
|
+
* // MessagesPerSecond: Number("int"),
|
|
651
|
+
* // Total: Number("int"),
|
|
652
|
+
* // Session: Number("int"),
|
|
653
|
+
* // },
|
|
654
|
+
* // MessageConfiguration: {
|
|
655
|
+
* // ADMMessage: "<Message>",
|
|
656
|
+
* // APNSMessage: "<Message>",
|
|
657
|
+
* // BaiduMessage: "<Message>",
|
|
658
|
+
* // CustomMessage: {
|
|
659
|
+
* // Data: "STRING_VALUE",
|
|
660
|
+
* // },
|
|
661
|
+
* // DefaultMessage: "<Message>",
|
|
662
|
+
* // EmailMessage: {
|
|
663
|
+
* // Body: "STRING_VALUE",
|
|
664
|
+
* // FromAddress: "STRING_VALUE",
|
|
665
|
+
* // HtmlBody: "STRING_VALUE",
|
|
666
|
+
* // Title: "STRING_VALUE",
|
|
667
|
+
* // },
|
|
668
|
+
* // GCMMessage: "<Message>",
|
|
669
|
+
* // SMSMessage: {
|
|
670
|
+
* // Body: "STRING_VALUE",
|
|
671
|
+
* // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
672
|
+
* // OriginationNumber: "STRING_VALUE",
|
|
673
|
+
* // SenderId: "STRING_VALUE",
|
|
674
|
+
* // EntityId: "STRING_VALUE",
|
|
675
|
+
* // TemplateId: "STRING_VALUE",
|
|
676
|
+
* // },
|
|
677
|
+
* // InAppMessage: {
|
|
678
|
+
* // Body: "STRING_VALUE",
|
|
679
|
+
* // Content: [
|
|
680
|
+
* // {
|
|
681
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
682
|
+
* // BodyConfig: {
|
|
683
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
684
|
+
* // Body: "STRING_VALUE", // required
|
|
685
|
+
* // TextColor: "STRING_VALUE", // required
|
|
686
|
+
* // },
|
|
687
|
+
* // HeaderConfig: {
|
|
688
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
689
|
+
* // Header: "STRING_VALUE", // required
|
|
690
|
+
* // TextColor: "STRING_VALUE", // required
|
|
691
|
+
* // },
|
|
692
|
+
* // ImageUrl: "STRING_VALUE",
|
|
693
|
+
* // PrimaryBtn: {
|
|
694
|
+
* // Android: "<OverrideButtonConfiguration>",
|
|
695
|
+
* // DefaultConfig: {
|
|
696
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
697
|
+
* // BorderRadius: Number("int"),
|
|
698
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
699
|
+
* // Link: "STRING_VALUE",
|
|
700
|
+
* // Text: "STRING_VALUE", // required
|
|
701
|
+
* // TextColor: "STRING_VALUE",
|
|
702
|
+
* // },
|
|
703
|
+
* // IOS: "<OverrideButtonConfiguration>",
|
|
704
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
705
|
+
* // },
|
|
706
|
+
* // SecondaryBtn: {
|
|
707
|
+
* // Android: "<OverrideButtonConfiguration>",
|
|
708
|
+
* // DefaultConfig: {
|
|
709
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
710
|
+
* // BorderRadius: Number("int"),
|
|
711
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
712
|
+
* // Link: "STRING_VALUE",
|
|
713
|
+
* // Text: "STRING_VALUE", // required
|
|
714
|
+
* // TextColor: "STRING_VALUE",
|
|
715
|
+
* // },
|
|
716
|
+
* // IOS: "<OverrideButtonConfiguration>",
|
|
717
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
718
|
+
* // },
|
|
719
|
+
* // },
|
|
720
|
+
* // ],
|
|
721
|
+
* // CustomConfig: {
|
|
722
|
+
* // "<keys>": "STRING_VALUE",
|
|
723
|
+
* // },
|
|
724
|
+
* // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
725
|
+
* // },
|
|
726
|
+
* // },
|
|
727
|
+
* // Name: "STRING_VALUE",
|
|
728
|
+
* // Schedule: {
|
|
729
|
+
* // EndTime: "STRING_VALUE",
|
|
730
|
+
* // EventFilter: {
|
|
731
|
+
* // Dimensions: {
|
|
732
|
+
* // Attributes: {
|
|
733
|
+
* // "<keys>": {
|
|
734
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
735
|
+
* // Values: "<ListOf__string>", // required
|
|
736
|
+
* // },
|
|
737
|
+
* // },
|
|
738
|
+
* // EventType: {
|
|
739
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
740
|
+
* // Values: "<ListOf__string>", // required
|
|
741
|
+
* // },
|
|
742
|
+
* // Metrics: {
|
|
743
|
+
* // "<keys>": {
|
|
744
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
745
|
+
* // Value: Number("double"), // required
|
|
746
|
+
* // },
|
|
747
|
+
* // },
|
|
748
|
+
* // },
|
|
749
|
+
* // FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
750
|
+
* // },
|
|
751
|
+
* // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
752
|
+
* // IsLocalTime: true || false,
|
|
753
|
+
* // QuietTime: {
|
|
754
|
+
* // End: "STRING_VALUE",
|
|
755
|
+
* // Start: "STRING_VALUE",
|
|
756
|
+
* // },
|
|
757
|
+
* // StartTime: "STRING_VALUE", // required
|
|
758
|
+
* // Timezone: "STRING_VALUE",
|
|
759
|
+
* // },
|
|
760
|
+
* // SegmentId: "STRING_VALUE", // required
|
|
761
|
+
* // SegmentVersion: Number("int"), // required
|
|
762
|
+
* // State: {
|
|
763
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
764
|
+
* // },
|
|
765
|
+
* // tags: "<MapOf__string>",
|
|
766
|
+
* // TemplateConfiguration: {
|
|
767
|
+
* // EmailTemplate: {
|
|
768
|
+
* // Name: "STRING_VALUE",
|
|
769
|
+
* // Version: "STRING_VALUE",
|
|
770
|
+
* // },
|
|
771
|
+
* // PushTemplate: "<Template>",
|
|
772
|
+
* // SMSTemplate: "<Template>",
|
|
773
|
+
* // VoiceTemplate: "<Template>",
|
|
774
|
+
* // },
|
|
775
|
+
* // TreatmentDescription: "STRING_VALUE",
|
|
776
|
+
* // TreatmentName: "STRING_VALUE",
|
|
777
|
+
* // Version: Number("int"),
|
|
778
|
+
* // Priority: Number("int"),
|
|
779
|
+
* // },
|
|
780
|
+
* // };
|
|
781
|
+
*
|
|
399
782
|
* ```
|
|
400
783
|
*
|
|
401
784
|
* @param UpdateCampaignCommandInput - {@link UpdateCampaignCommandInput}
|
|
@@ -425,6 +808,8 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M
|
|
|
425
808
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
426
809
|
* <p>Provides information about an API request or response.</p>
|
|
427
810
|
*
|
|
811
|
+
* @throws {@link PinpointServiceException}
|
|
812
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
428
813
|
*
|
|
429
814
|
*/
|
|
430
815
|
export declare class UpdateCampaignCommand extends $Command<UpdateCampaignCommandInput, UpdateCampaignCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -38,6 +38,26 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new UpdateEmailChannelCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // UpdateEmailChannelResponse
|
|
42
|
+
* // EmailChannelResponse: { // EmailChannelResponse
|
|
43
|
+
* // ApplicationId: "STRING_VALUE",
|
|
44
|
+
* // ConfigurationSet: "STRING_VALUE",
|
|
45
|
+
* // CreationDate: "STRING_VALUE",
|
|
46
|
+
* // Enabled: true || false,
|
|
47
|
+
* // FromAddress: "STRING_VALUE",
|
|
48
|
+
* // HasCredential: true || false,
|
|
49
|
+
* // Id: "STRING_VALUE",
|
|
50
|
+
* // Identity: "STRING_VALUE",
|
|
51
|
+
* // IsArchived: true || false,
|
|
52
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
53
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
54
|
+
* // MessagesPerSecond: Number("int"),
|
|
55
|
+
* // Platform: "STRING_VALUE", // required
|
|
56
|
+
* // RoleArn: "STRING_VALUE",
|
|
57
|
+
* // Version: Number("int"),
|
|
58
|
+
* // },
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
41
61
|
* ```
|
|
42
62
|
*
|
|
43
63
|
* @param UpdateEmailChannelCommandInput - {@link UpdateEmailChannelCommandInput}
|
|
@@ -67,6 +87,8 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo
|
|
|
67
87
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
68
88
|
* <p>Provides information about an API request or response.</p>
|
|
69
89
|
*
|
|
90
|
+
* @throws {@link PinpointServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
70
92
|
*
|
|
71
93
|
*/
|
|
72
94
|
export declare class UpdateEmailChannelCommand extends $Command<UpdateEmailChannelCommandInput, UpdateEmailChannelCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -44,6 +44,13 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new UpdateEmailTemplateCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // UpdateEmailTemplateResponse
|
|
48
|
+
* // MessageBody: { // MessageBody
|
|
49
|
+
* // Message: "STRING_VALUE",
|
|
50
|
+
* // RequestID: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
47
54
|
* ```
|
|
48
55
|
*
|
|
49
56
|
* @param UpdateEmailTemplateCommandInput - {@link UpdateEmailTemplateCommandInput}
|
|
@@ -73,6 +80,8 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes
|
|
|
73
80
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
74
81
|
* <p>Provides information about an API request or response.</p>
|
|
75
82
|
*
|
|
83
|
+
* @throws {@link PinpointServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
76
85
|
*
|
|
77
86
|
*/
|
|
78
87
|
export declare class UpdateEmailTemplateCommand extends $Command<UpdateEmailTemplateCommandInput, UpdateEmailTemplateCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -74,6 +74,13 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
|
|
|
74
74
|
* };
|
|
75
75
|
* const command = new UpdateEndpointCommand(input);
|
|
76
76
|
* const response = await client.send(command);
|
|
77
|
+
* // { // UpdateEndpointResponse
|
|
78
|
+
* // MessageBody: { // MessageBody
|
|
79
|
+
* // Message: "STRING_VALUE",
|
|
80
|
+
* // RequestID: "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
77
84
|
* ```
|
|
78
85
|
*
|
|
79
86
|
* @param UpdateEndpointCommandInput - {@link UpdateEndpointCommandInput}
|
|
@@ -103,6 +110,8 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
|
|
|
103
110
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
104
111
|
* <p>Provides information about an API request or response.</p>
|
|
105
112
|
*
|
|
113
|
+
* @throws {@link PinpointServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
106
115
|
*
|
|
107
116
|
*/
|
|
108
117
|
export declare class UpdateEndpointCommand extends $Command<UpdateEndpointCommandInput, UpdateEndpointCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -78,6 +78,13 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
|
|
|
78
78
|
* };
|
|
79
79
|
* const command = new UpdateEndpointsBatchCommand(input);
|
|
80
80
|
* const response = await client.send(command);
|
|
81
|
+
* // { // UpdateEndpointsBatchResponse
|
|
82
|
+
* // MessageBody: { // MessageBody
|
|
83
|
+
* // Message: "STRING_VALUE",
|
|
84
|
+
* // RequestID: "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
81
88
|
* ```
|
|
82
89
|
*
|
|
83
90
|
* @param UpdateEndpointsBatchCommandInput - {@link UpdateEndpointsBatchCommandInput}
|
|
@@ -107,6 +114,8 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR
|
|
|
107
114
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
108
115
|
* <p>Provides information about an API request or response.</p>
|
|
109
116
|
*
|
|
117
|
+
* @throws {@link PinpointServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
110
119
|
*
|
|
111
120
|
*/
|
|
112
121
|
export declare class UpdateEndpointsBatchCommand extends $Command<UpdateEndpointsBatchCommandInput, UpdateEndpointsBatchCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -35,6 +35,22 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse,
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new UpdateGcmChannelCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // UpdateGcmChannelResponse
|
|
39
|
+
* // GCMChannelResponse: { // GCMChannelResponse
|
|
40
|
+
* // ApplicationId: "STRING_VALUE",
|
|
41
|
+
* // CreationDate: "STRING_VALUE",
|
|
42
|
+
* // Credential: "STRING_VALUE", // required
|
|
43
|
+
* // Enabled: true || false,
|
|
44
|
+
* // HasCredential: true || false,
|
|
45
|
+
* // Id: "STRING_VALUE",
|
|
46
|
+
* // IsArchived: true || false,
|
|
47
|
+
* // LastModifiedBy: "STRING_VALUE",
|
|
48
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
49
|
+
* // Platform: "STRING_VALUE", // required
|
|
50
|
+
* // Version: Number("int"),
|
|
51
|
+
* // },
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
38
54
|
* ```
|
|
39
55
|
*
|
|
40
56
|
* @param UpdateGcmChannelCommandInput - {@link UpdateGcmChannelCommandInput}
|
|
@@ -64,6 +80,8 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse,
|
|
|
64
80
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
65
81
|
* <p>Provides information about an API request or response.</p>
|
|
66
82
|
*
|
|
83
|
+
* @throws {@link PinpointServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
67
85
|
*
|
|
68
86
|
*/
|
|
69
87
|
export declare class UpdateGcmChannelCommand extends $Command<UpdateGcmChannelCommandInput, UpdateGcmChannelCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -100,6 +100,13 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
|
|
|
100
100
|
* };
|
|
101
101
|
* const command = new UpdateInAppTemplateCommand(input);
|
|
102
102
|
* const response = await client.send(command);
|
|
103
|
+
* // { // UpdateInAppTemplateResponse
|
|
104
|
+
* // MessageBody: { // MessageBody
|
|
105
|
+
* // Message: "STRING_VALUE",
|
|
106
|
+
* // RequestID: "STRING_VALUE",
|
|
107
|
+
* // },
|
|
108
|
+
* // };
|
|
109
|
+
*
|
|
103
110
|
* ```
|
|
104
111
|
*
|
|
105
112
|
* @param UpdateInAppTemplateCommandInput - {@link UpdateInAppTemplateCommandInput}
|
|
@@ -129,6 +136,8 @@ export interface UpdateInAppTemplateCommandOutput extends UpdateInAppTemplateRes
|
|
|
129
136
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
130
137
|
* <p>Provides information about an API request or response.</p>
|
|
131
138
|
*
|
|
139
|
+
* @throws {@link PinpointServiceException}
|
|
140
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
132
141
|
*
|
|
133
142
|
*/
|
|
134
143
|
export declare class UpdateInAppTemplateCommand extends $Command<UpdateInAppTemplateCommandInput, UpdateInAppTemplateCommandOutput, PinpointClientResolvedConfig> {
|