@aws-sdk/client-pinpoint 3.321.1 → 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 +16 -16
|
@@ -36,6 +36,18 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new CreateAppCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // CreateAppResponse
|
|
40
|
+
* // ApplicationResponse: { // ApplicationResponse
|
|
41
|
+
* // Arn: "STRING_VALUE", // required
|
|
42
|
+
* // Id: "STRING_VALUE", // required
|
|
43
|
+
* // Name: "STRING_VALUE", // required
|
|
44
|
+
* // tags: { // MapOf__string
|
|
45
|
+
* // "<keys>": "STRING_VALUE",
|
|
46
|
+
* // },
|
|
47
|
+
* // CreationDate: "STRING_VALUE",
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
39
51
|
* ```
|
|
40
52
|
*
|
|
41
53
|
* @param CreateAppCommandInput - {@link CreateAppCommandInput}
|
|
@@ -65,6 +77,8 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea
|
|
|
65
77
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
78
|
* <p>Provides information about an API request or response.</p>
|
|
67
79
|
*
|
|
80
|
+
* @throws {@link PinpointServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
68
82
|
*
|
|
69
83
|
*/
|
|
70
84
|
export declare class CreateAppCommand extends $Command<CreateAppCommandInput, CreateAppCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -395,6 +395,389 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
395
395
|
* };
|
|
396
396
|
* const command = new CreateCampaignCommand(input);
|
|
397
397
|
* const response = await client.send(command);
|
|
398
|
+
* // { // CreateCampaignResponse
|
|
399
|
+
* // CampaignResponse: { // CampaignResponse
|
|
400
|
+
* // AdditionalTreatments: [ // ListOfTreatmentResource
|
|
401
|
+
* // { // TreatmentResource
|
|
402
|
+
* // CustomDeliveryConfiguration: { // CustomDeliveryConfiguration
|
|
403
|
+
* // DeliveryUri: "STRING_VALUE", // required
|
|
404
|
+
* // EndpointTypes: [ // ListOf__EndpointTypesElement
|
|
405
|
+
* // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
406
|
+
* // ],
|
|
407
|
+
* // },
|
|
408
|
+
* // Id: "STRING_VALUE", // required
|
|
409
|
+
* // MessageConfiguration: { // MessageConfiguration
|
|
410
|
+
* // ADMMessage: { // Message
|
|
411
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
412
|
+
* // Body: "STRING_VALUE",
|
|
413
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
414
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
415
|
+
* // ImageUrl: "STRING_VALUE",
|
|
416
|
+
* // JsonBody: "STRING_VALUE",
|
|
417
|
+
* // MediaUrl: "STRING_VALUE",
|
|
418
|
+
* // RawContent: "STRING_VALUE",
|
|
419
|
+
* // SilentPush: true || false,
|
|
420
|
+
* // TimeToLive: Number("int"),
|
|
421
|
+
* // Title: "STRING_VALUE",
|
|
422
|
+
* // Url: "STRING_VALUE",
|
|
423
|
+
* // },
|
|
424
|
+
* // APNSMessage: {
|
|
425
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
426
|
+
* // Body: "STRING_VALUE",
|
|
427
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
428
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
429
|
+
* // ImageUrl: "STRING_VALUE",
|
|
430
|
+
* // JsonBody: "STRING_VALUE",
|
|
431
|
+
* // MediaUrl: "STRING_VALUE",
|
|
432
|
+
* // RawContent: "STRING_VALUE",
|
|
433
|
+
* // SilentPush: true || false,
|
|
434
|
+
* // TimeToLive: Number("int"),
|
|
435
|
+
* // Title: "STRING_VALUE",
|
|
436
|
+
* // Url: "STRING_VALUE",
|
|
437
|
+
* // },
|
|
438
|
+
* // BaiduMessage: {
|
|
439
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
440
|
+
* // Body: "STRING_VALUE",
|
|
441
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
442
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
443
|
+
* // ImageUrl: "STRING_VALUE",
|
|
444
|
+
* // JsonBody: "STRING_VALUE",
|
|
445
|
+
* // MediaUrl: "STRING_VALUE",
|
|
446
|
+
* // RawContent: "STRING_VALUE",
|
|
447
|
+
* // SilentPush: true || false,
|
|
448
|
+
* // TimeToLive: Number("int"),
|
|
449
|
+
* // Title: "STRING_VALUE",
|
|
450
|
+
* // Url: "STRING_VALUE",
|
|
451
|
+
* // },
|
|
452
|
+
* // CustomMessage: { // CampaignCustomMessage
|
|
453
|
+
* // Data: "STRING_VALUE",
|
|
454
|
+
* // },
|
|
455
|
+
* // DefaultMessage: {
|
|
456
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
457
|
+
* // Body: "STRING_VALUE",
|
|
458
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
459
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
460
|
+
* // ImageUrl: "STRING_VALUE",
|
|
461
|
+
* // JsonBody: "STRING_VALUE",
|
|
462
|
+
* // MediaUrl: "STRING_VALUE",
|
|
463
|
+
* // RawContent: "STRING_VALUE",
|
|
464
|
+
* // SilentPush: true || false,
|
|
465
|
+
* // TimeToLive: Number("int"),
|
|
466
|
+
* // Title: "STRING_VALUE",
|
|
467
|
+
* // Url: "STRING_VALUE",
|
|
468
|
+
* // },
|
|
469
|
+
* // EmailMessage: { // CampaignEmailMessage
|
|
470
|
+
* // Body: "STRING_VALUE",
|
|
471
|
+
* // FromAddress: "STRING_VALUE",
|
|
472
|
+
* // HtmlBody: "STRING_VALUE",
|
|
473
|
+
* // Title: "STRING_VALUE",
|
|
474
|
+
* // },
|
|
475
|
+
* // GCMMessage: {
|
|
476
|
+
* // Action: "OPEN_APP" || "DEEP_LINK" || "URL",
|
|
477
|
+
* // Body: "STRING_VALUE",
|
|
478
|
+
* // ImageIconUrl: "STRING_VALUE",
|
|
479
|
+
* // ImageSmallIconUrl: "STRING_VALUE",
|
|
480
|
+
* // ImageUrl: "STRING_VALUE",
|
|
481
|
+
* // JsonBody: "STRING_VALUE",
|
|
482
|
+
* // MediaUrl: "STRING_VALUE",
|
|
483
|
+
* // RawContent: "STRING_VALUE",
|
|
484
|
+
* // SilentPush: true || false,
|
|
485
|
+
* // TimeToLive: Number("int"),
|
|
486
|
+
* // Title: "STRING_VALUE",
|
|
487
|
+
* // Url: "STRING_VALUE",
|
|
488
|
+
* // },
|
|
489
|
+
* // SMSMessage: { // CampaignSmsMessage
|
|
490
|
+
* // Body: "STRING_VALUE",
|
|
491
|
+
* // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
492
|
+
* // OriginationNumber: "STRING_VALUE",
|
|
493
|
+
* // SenderId: "STRING_VALUE",
|
|
494
|
+
* // EntityId: "STRING_VALUE",
|
|
495
|
+
* // TemplateId: "STRING_VALUE",
|
|
496
|
+
* // },
|
|
497
|
+
* // InAppMessage: { // CampaignInAppMessage
|
|
498
|
+
* // Body: "STRING_VALUE",
|
|
499
|
+
* // Content: [ // ListOfInAppMessageContent
|
|
500
|
+
* // { // InAppMessageContent
|
|
501
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
502
|
+
* // BodyConfig: { // InAppMessageBodyConfig
|
|
503
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
504
|
+
* // Body: "STRING_VALUE", // required
|
|
505
|
+
* // TextColor: "STRING_VALUE", // required
|
|
506
|
+
* // },
|
|
507
|
+
* // HeaderConfig: { // InAppMessageHeaderConfig
|
|
508
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
509
|
+
* // Header: "STRING_VALUE", // required
|
|
510
|
+
* // TextColor: "STRING_VALUE", // required
|
|
511
|
+
* // },
|
|
512
|
+
* // ImageUrl: "STRING_VALUE",
|
|
513
|
+
* // PrimaryBtn: { // InAppMessageButton
|
|
514
|
+
* // Android: { // OverrideButtonConfiguration
|
|
515
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
516
|
+
* // Link: "STRING_VALUE",
|
|
517
|
+
* // },
|
|
518
|
+
* // DefaultConfig: { // DefaultButtonConfiguration
|
|
519
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
520
|
+
* // BorderRadius: Number("int"),
|
|
521
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
522
|
+
* // Link: "STRING_VALUE",
|
|
523
|
+
* // Text: "STRING_VALUE", // required
|
|
524
|
+
* // TextColor: "STRING_VALUE",
|
|
525
|
+
* // },
|
|
526
|
+
* // IOS: {
|
|
527
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
528
|
+
* // Link: "STRING_VALUE",
|
|
529
|
+
* // },
|
|
530
|
+
* // Web: {
|
|
531
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
532
|
+
* // Link: "STRING_VALUE",
|
|
533
|
+
* // },
|
|
534
|
+
* // },
|
|
535
|
+
* // SecondaryBtn: {
|
|
536
|
+
* // Android: {
|
|
537
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
538
|
+
* // Link: "STRING_VALUE",
|
|
539
|
+
* // },
|
|
540
|
+
* // DefaultConfig: {
|
|
541
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
542
|
+
* // BorderRadius: Number("int"),
|
|
543
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
544
|
+
* // Link: "STRING_VALUE",
|
|
545
|
+
* // Text: "STRING_VALUE", // required
|
|
546
|
+
* // TextColor: "STRING_VALUE",
|
|
547
|
+
* // },
|
|
548
|
+
* // IOS: {
|
|
549
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
550
|
+
* // Link: "STRING_VALUE",
|
|
551
|
+
* // },
|
|
552
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
553
|
+
* // },
|
|
554
|
+
* // },
|
|
555
|
+
* // ],
|
|
556
|
+
* // CustomConfig: { // MapOf__string
|
|
557
|
+
* // "<keys>": "STRING_VALUE",
|
|
558
|
+
* // },
|
|
559
|
+
* // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
560
|
+
* // },
|
|
561
|
+
* // },
|
|
562
|
+
* // Schedule: { // Schedule
|
|
563
|
+
* // EndTime: "STRING_VALUE",
|
|
564
|
+
* // EventFilter: { // CampaignEventFilter
|
|
565
|
+
* // Dimensions: { // EventDimensions
|
|
566
|
+
* // Attributes: { // MapOfAttributeDimension
|
|
567
|
+
* // "<keys>": { // AttributeDimension
|
|
568
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
569
|
+
* // Values: [ // ListOf__string // required
|
|
570
|
+
* // "STRING_VALUE",
|
|
571
|
+
* // ],
|
|
572
|
+
* // },
|
|
573
|
+
* // },
|
|
574
|
+
* // EventType: { // SetDimension
|
|
575
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
576
|
+
* // Values: [ // required
|
|
577
|
+
* // "STRING_VALUE",
|
|
578
|
+
* // ],
|
|
579
|
+
* // },
|
|
580
|
+
* // Metrics: { // MapOfMetricDimension
|
|
581
|
+
* // "<keys>": { // MetricDimension
|
|
582
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
583
|
+
* // Value: Number("double"), // required
|
|
584
|
+
* // },
|
|
585
|
+
* // },
|
|
586
|
+
* // },
|
|
587
|
+
* // FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
588
|
+
* // },
|
|
589
|
+
* // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
590
|
+
* // IsLocalTime: true || false,
|
|
591
|
+
* // QuietTime: { // QuietTime
|
|
592
|
+
* // End: "STRING_VALUE",
|
|
593
|
+
* // Start: "STRING_VALUE",
|
|
594
|
+
* // },
|
|
595
|
+
* // StartTime: "STRING_VALUE", // required
|
|
596
|
+
* // Timezone: "STRING_VALUE",
|
|
597
|
+
* // },
|
|
598
|
+
* // SizePercent: Number("int"), // required
|
|
599
|
+
* // State: { // CampaignState
|
|
600
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
601
|
+
* // },
|
|
602
|
+
* // TemplateConfiguration: { // TemplateConfiguration
|
|
603
|
+
* // EmailTemplate: { // Template
|
|
604
|
+
* // Name: "STRING_VALUE",
|
|
605
|
+
* // Version: "STRING_VALUE",
|
|
606
|
+
* // },
|
|
607
|
+
* // PushTemplate: {
|
|
608
|
+
* // Name: "STRING_VALUE",
|
|
609
|
+
* // Version: "STRING_VALUE",
|
|
610
|
+
* // },
|
|
611
|
+
* // SMSTemplate: {
|
|
612
|
+
* // Name: "STRING_VALUE",
|
|
613
|
+
* // Version: "STRING_VALUE",
|
|
614
|
+
* // },
|
|
615
|
+
* // VoiceTemplate: {
|
|
616
|
+
* // Name: "STRING_VALUE",
|
|
617
|
+
* // Version: "STRING_VALUE",
|
|
618
|
+
* // },
|
|
619
|
+
* // },
|
|
620
|
+
* // TreatmentDescription: "STRING_VALUE",
|
|
621
|
+
* // TreatmentName: "STRING_VALUE",
|
|
622
|
+
* // },
|
|
623
|
+
* // ],
|
|
624
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
625
|
+
* // Arn: "STRING_VALUE", // required
|
|
626
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
627
|
+
* // CustomDeliveryConfiguration: {
|
|
628
|
+
* // DeliveryUri: "STRING_VALUE", // required
|
|
629
|
+
* // EndpointTypes: [
|
|
630
|
+
* // "PUSH" || "GCM" || "APNS" || "APNS_SANDBOX" || "APNS_VOIP" || "APNS_VOIP_SANDBOX" || "ADM" || "SMS" || "VOICE" || "EMAIL" || "BAIDU" || "CUSTOM" || "IN_APP",
|
|
631
|
+
* // ],
|
|
632
|
+
* // },
|
|
633
|
+
* // DefaultState: {
|
|
634
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
635
|
+
* // },
|
|
636
|
+
* // Description: "STRING_VALUE",
|
|
637
|
+
* // HoldoutPercent: Number("int"),
|
|
638
|
+
* // Hook: { // CampaignHook
|
|
639
|
+
* // LambdaFunctionName: "STRING_VALUE",
|
|
640
|
+
* // Mode: "DELIVERY" || "FILTER",
|
|
641
|
+
* // WebUrl: "STRING_VALUE",
|
|
642
|
+
* // },
|
|
643
|
+
* // Id: "STRING_VALUE", // required
|
|
644
|
+
* // IsPaused: true || false,
|
|
645
|
+
* // LastModifiedDate: "STRING_VALUE", // required
|
|
646
|
+
* // Limits: { // CampaignLimits
|
|
647
|
+
* // Daily: Number("int"),
|
|
648
|
+
* // MaximumDuration: Number("int"),
|
|
649
|
+
* // MessagesPerSecond: Number("int"),
|
|
650
|
+
* // Total: Number("int"),
|
|
651
|
+
* // Session: Number("int"),
|
|
652
|
+
* // },
|
|
653
|
+
* // MessageConfiguration: {
|
|
654
|
+
* // ADMMessage: "<Message>",
|
|
655
|
+
* // APNSMessage: "<Message>",
|
|
656
|
+
* // BaiduMessage: "<Message>",
|
|
657
|
+
* // CustomMessage: {
|
|
658
|
+
* // Data: "STRING_VALUE",
|
|
659
|
+
* // },
|
|
660
|
+
* // DefaultMessage: "<Message>",
|
|
661
|
+
* // EmailMessage: {
|
|
662
|
+
* // Body: "STRING_VALUE",
|
|
663
|
+
* // FromAddress: "STRING_VALUE",
|
|
664
|
+
* // HtmlBody: "STRING_VALUE",
|
|
665
|
+
* // Title: "STRING_VALUE",
|
|
666
|
+
* // },
|
|
667
|
+
* // GCMMessage: "<Message>",
|
|
668
|
+
* // SMSMessage: {
|
|
669
|
+
* // Body: "STRING_VALUE",
|
|
670
|
+
* // MessageType: "TRANSACTIONAL" || "PROMOTIONAL",
|
|
671
|
+
* // OriginationNumber: "STRING_VALUE",
|
|
672
|
+
* // SenderId: "STRING_VALUE",
|
|
673
|
+
* // EntityId: "STRING_VALUE",
|
|
674
|
+
* // TemplateId: "STRING_VALUE",
|
|
675
|
+
* // },
|
|
676
|
+
* // InAppMessage: {
|
|
677
|
+
* // Body: "STRING_VALUE",
|
|
678
|
+
* // Content: [
|
|
679
|
+
* // {
|
|
680
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
681
|
+
* // BodyConfig: {
|
|
682
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
683
|
+
* // Body: "STRING_VALUE", // required
|
|
684
|
+
* // TextColor: "STRING_VALUE", // required
|
|
685
|
+
* // },
|
|
686
|
+
* // HeaderConfig: {
|
|
687
|
+
* // Alignment: "LEFT" || "CENTER" || "RIGHT", // required
|
|
688
|
+
* // Header: "STRING_VALUE", // required
|
|
689
|
+
* // TextColor: "STRING_VALUE", // required
|
|
690
|
+
* // },
|
|
691
|
+
* // ImageUrl: "STRING_VALUE",
|
|
692
|
+
* // PrimaryBtn: {
|
|
693
|
+
* // Android: "<OverrideButtonConfiguration>",
|
|
694
|
+
* // DefaultConfig: {
|
|
695
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
696
|
+
* // BorderRadius: Number("int"),
|
|
697
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
698
|
+
* // Link: "STRING_VALUE",
|
|
699
|
+
* // Text: "STRING_VALUE", // required
|
|
700
|
+
* // TextColor: "STRING_VALUE",
|
|
701
|
+
* // },
|
|
702
|
+
* // IOS: "<OverrideButtonConfiguration>",
|
|
703
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
704
|
+
* // },
|
|
705
|
+
* // SecondaryBtn: {
|
|
706
|
+
* // Android: "<OverrideButtonConfiguration>",
|
|
707
|
+
* // DefaultConfig: {
|
|
708
|
+
* // BackgroundColor: "STRING_VALUE",
|
|
709
|
+
* // BorderRadius: Number("int"),
|
|
710
|
+
* // ButtonAction: "LINK" || "DEEP_LINK" || "CLOSE", // required
|
|
711
|
+
* // Link: "STRING_VALUE",
|
|
712
|
+
* // Text: "STRING_VALUE", // required
|
|
713
|
+
* // TextColor: "STRING_VALUE",
|
|
714
|
+
* // },
|
|
715
|
+
* // IOS: "<OverrideButtonConfiguration>",
|
|
716
|
+
* // Web: "<OverrideButtonConfiguration>",
|
|
717
|
+
* // },
|
|
718
|
+
* // },
|
|
719
|
+
* // ],
|
|
720
|
+
* // CustomConfig: {
|
|
721
|
+
* // "<keys>": "STRING_VALUE",
|
|
722
|
+
* // },
|
|
723
|
+
* // Layout: "BOTTOM_BANNER" || "TOP_BANNER" || "OVERLAYS" || "MOBILE_FEED" || "MIDDLE_BANNER" || "CAROUSEL",
|
|
724
|
+
* // },
|
|
725
|
+
* // },
|
|
726
|
+
* // Name: "STRING_VALUE",
|
|
727
|
+
* // Schedule: {
|
|
728
|
+
* // EndTime: "STRING_VALUE",
|
|
729
|
+
* // EventFilter: {
|
|
730
|
+
* // Dimensions: {
|
|
731
|
+
* // Attributes: {
|
|
732
|
+
* // "<keys>": {
|
|
733
|
+
* // AttributeType: "INCLUSIVE" || "EXCLUSIVE" || "CONTAINS" || "BEFORE" || "AFTER" || "ON" || "BETWEEN",
|
|
734
|
+
* // Values: "<ListOf__string>", // required
|
|
735
|
+
* // },
|
|
736
|
+
* // },
|
|
737
|
+
* // EventType: {
|
|
738
|
+
* // DimensionType: "INCLUSIVE" || "EXCLUSIVE",
|
|
739
|
+
* // Values: "<ListOf__string>", // required
|
|
740
|
+
* // },
|
|
741
|
+
* // Metrics: {
|
|
742
|
+
* // "<keys>": {
|
|
743
|
+
* // ComparisonOperator: "STRING_VALUE", // required
|
|
744
|
+
* // Value: Number("double"), // required
|
|
745
|
+
* // },
|
|
746
|
+
* // },
|
|
747
|
+
* // },
|
|
748
|
+
* // FilterType: "SYSTEM" || "ENDPOINT", // required
|
|
749
|
+
* // },
|
|
750
|
+
* // Frequency: "ONCE" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "EVENT" || "IN_APP_EVENT",
|
|
751
|
+
* // IsLocalTime: true || false,
|
|
752
|
+
* // QuietTime: {
|
|
753
|
+
* // End: "STRING_VALUE",
|
|
754
|
+
* // Start: "STRING_VALUE",
|
|
755
|
+
* // },
|
|
756
|
+
* // StartTime: "STRING_VALUE", // required
|
|
757
|
+
* // Timezone: "STRING_VALUE",
|
|
758
|
+
* // },
|
|
759
|
+
* // SegmentId: "STRING_VALUE", // required
|
|
760
|
+
* // SegmentVersion: Number("int"), // required
|
|
761
|
+
* // State: {
|
|
762
|
+
* // CampaignStatus: "SCHEDULED" || "EXECUTING" || "PENDING_NEXT_RUN" || "COMPLETED" || "PAUSED" || "DELETED" || "INVALID",
|
|
763
|
+
* // },
|
|
764
|
+
* // tags: "<MapOf__string>",
|
|
765
|
+
* // TemplateConfiguration: {
|
|
766
|
+
* // EmailTemplate: {
|
|
767
|
+
* // Name: "STRING_VALUE",
|
|
768
|
+
* // Version: "STRING_VALUE",
|
|
769
|
+
* // },
|
|
770
|
+
* // PushTemplate: "<Template>",
|
|
771
|
+
* // SMSTemplate: "<Template>",
|
|
772
|
+
* // VoiceTemplate: "<Template>",
|
|
773
|
+
* // },
|
|
774
|
+
* // TreatmentDescription: "STRING_VALUE",
|
|
775
|
+
* // TreatmentName: "STRING_VALUE",
|
|
776
|
+
* // Version: Number("int"),
|
|
777
|
+
* // Priority: Number("int"),
|
|
778
|
+
* // },
|
|
779
|
+
* // };
|
|
780
|
+
*
|
|
398
781
|
* ```
|
|
399
782
|
*
|
|
400
783
|
* @param CreateCampaignCommandInput - {@link CreateCampaignCommandInput}
|
|
@@ -424,6 +807,8 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M
|
|
|
424
807
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
425
808
|
* <p>Provides information about an API request or response.</p>
|
|
426
809
|
*
|
|
810
|
+
* @throws {@link PinpointServiceException}
|
|
811
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
427
812
|
*
|
|
428
813
|
*/
|
|
429
814
|
export declare class CreateCampaignCommand extends $Command<CreateCampaignCommandInput, CreateCampaignCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -42,6 +42,14 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new CreateEmailTemplateCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // CreateEmailTemplateResponse
|
|
46
|
+
* // CreateTemplateMessageBody: { // CreateTemplateMessageBody
|
|
47
|
+
* // Arn: "STRING_VALUE",
|
|
48
|
+
* // Message: "STRING_VALUE",
|
|
49
|
+
* // RequestID: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
45
53
|
* ```
|
|
46
54
|
*
|
|
47
55
|
* @param CreateEmailTemplateCommandInput - {@link CreateEmailTemplateCommandInput}
|
|
@@ -65,6 +73,8 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes
|
|
|
65
73
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
66
74
|
* <p>Provides information about an API request or response.</p>
|
|
67
75
|
*
|
|
76
|
+
* @throws {@link PinpointServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
68
78
|
*
|
|
69
79
|
*/
|
|
70
80
|
export declare class CreateEmailTemplateCommand extends $Command<CreateEmailTemplateCommandInput, CreateEmailTemplateCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -37,6 +37,31 @@ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, _
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new CreateExportJobCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // CreateExportJobResponse
|
|
41
|
+
* // ExportJobResponse: { // ExportJobResponse
|
|
42
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
43
|
+
* // CompletedPieces: Number("int"),
|
|
44
|
+
* // CompletionDate: "STRING_VALUE",
|
|
45
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
46
|
+
* // Definition: { // ExportJobResource
|
|
47
|
+
* // RoleArn: "STRING_VALUE", // required
|
|
48
|
+
* // S3UrlPrefix: "STRING_VALUE", // required
|
|
49
|
+
* // SegmentId: "STRING_VALUE",
|
|
50
|
+
* // SegmentVersion: Number("int"),
|
|
51
|
+
* // },
|
|
52
|
+
* // FailedPieces: Number("int"),
|
|
53
|
+
* // Failures: [ // ListOf__string
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // Id: "STRING_VALUE", // required
|
|
57
|
+
* // JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
|
|
58
|
+
* // TotalFailures: Number("int"),
|
|
59
|
+
* // TotalPieces: Number("int"),
|
|
60
|
+
* // TotalProcessed: Number("int"),
|
|
61
|
+
* // Type: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
40
65
|
* ```
|
|
41
66
|
*
|
|
42
67
|
* @param CreateExportJobCommandInput - {@link CreateExportJobCommandInput}
|
|
@@ -66,6 +91,8 @@ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, _
|
|
|
66
91
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
67
92
|
* <p>Provides information about an API request or response.</p>
|
|
68
93
|
*
|
|
94
|
+
* @throws {@link PinpointServiceException}
|
|
95
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
69
96
|
*
|
|
70
97
|
*/
|
|
71
98
|
export declare class CreateExportJobCommand extends $Command<CreateExportJobCommandInput, CreateExportJobCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -41,6 +41,35 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new CreateImportJobCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // CreateImportJobResponse
|
|
45
|
+
* // ImportJobResponse: { // ImportJobResponse
|
|
46
|
+
* // ApplicationId: "STRING_VALUE", // required
|
|
47
|
+
* // CompletedPieces: Number("int"),
|
|
48
|
+
* // CompletionDate: "STRING_VALUE",
|
|
49
|
+
* // CreationDate: "STRING_VALUE", // required
|
|
50
|
+
* // Definition: { // ImportJobResource
|
|
51
|
+
* // DefineSegment: true || false,
|
|
52
|
+
* // ExternalId: "STRING_VALUE",
|
|
53
|
+
* // Format: "CSV" || "JSON", // required
|
|
54
|
+
* // RegisterEndpoints: true || false,
|
|
55
|
+
* // RoleArn: "STRING_VALUE", // required
|
|
56
|
+
* // S3Url: "STRING_VALUE", // required
|
|
57
|
+
* // SegmentId: "STRING_VALUE",
|
|
58
|
+
* // SegmentName: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // FailedPieces: Number("int"),
|
|
61
|
+
* // Failures: [ // ListOf__string
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // Id: "STRING_VALUE", // required
|
|
65
|
+
* // JobStatus: "CREATED" || "PREPARING_FOR_INITIALIZATION" || "INITIALIZING" || "PROCESSING" || "PENDING_JOB" || "COMPLETING" || "COMPLETED" || "FAILING" || "FAILED", // required
|
|
66
|
+
* // TotalFailures: Number("int"),
|
|
67
|
+
* // TotalPieces: Number("int"),
|
|
68
|
+
* // TotalProcessed: Number("int"),
|
|
69
|
+
* // Type: "STRING_VALUE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
44
73
|
* ```
|
|
45
74
|
*
|
|
46
75
|
* @param CreateImportJobCommandInput - {@link CreateImportJobCommandInput}
|
|
@@ -70,6 +99,8 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _
|
|
|
70
99
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
71
100
|
* <p>Provides information about an API request or response.</p>
|
|
72
101
|
*
|
|
102
|
+
* @throws {@link PinpointServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
73
104
|
*
|
|
74
105
|
*/
|
|
75
106
|
export declare class CreateImportJobCommand extends $Command<CreateImportJobCommandInput, CreateImportJobCommandOutput, PinpointClientResolvedConfig> {
|
|
@@ -98,6 +98,14 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
|
|
|
98
98
|
* };
|
|
99
99
|
* const command = new CreateInAppTemplateCommand(input);
|
|
100
100
|
* const response = await client.send(command);
|
|
101
|
+
* // { // CreateInAppTemplateResponse
|
|
102
|
+
* // TemplateCreateMessageBody: { // TemplateCreateMessageBody
|
|
103
|
+
* // Arn: "STRING_VALUE",
|
|
104
|
+
* // Message: "STRING_VALUE",
|
|
105
|
+
* // RequestID: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // };
|
|
108
|
+
*
|
|
101
109
|
* ```
|
|
102
110
|
*
|
|
103
111
|
* @param CreateInAppTemplateCommandInput - {@link CreateInAppTemplateCommandInput}
|
|
@@ -121,6 +129,8 @@ export interface CreateInAppTemplateCommandOutput extends CreateInAppTemplateRes
|
|
|
121
129
|
* @throws {@link TooManyRequestsException} (client fault)
|
|
122
130
|
* <p>Provides information about an API request or response.</p>
|
|
123
131
|
*
|
|
132
|
+
* @throws {@link PinpointServiceException}
|
|
133
|
+
* <p>Base exception class for all service exceptions from Pinpoint service.</p>
|
|
124
134
|
*
|
|
125
135
|
*/
|
|
126
136
|
export declare class CreateInAppTemplateCommand extends $Command<CreateInAppTemplateCommandInput, CreateInAppTemplateCommandOutput, PinpointClientResolvedConfig> {
|