@aws-sdk/client-pinpoint 3.687.0 → 3.692.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.
@@ -47,12 +47,12 @@ export interface GetCampaignVersionsRequest {
47
47
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
48
48
  * @public
49
49
  */
50
- PageSize?: string;
50
+ PageSize?: string | undefined;
51
51
  /**
52
52
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
53
53
  * @public
54
54
  */
55
- Token?: string;
55
+ Token?: string | undefined;
56
56
  }
57
57
  /**
58
58
  * @public
@@ -117,7 +117,7 @@ export interface GetEmailTemplateRequest {
117
117
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
118
118
  * @public
119
119
  */
120
- Version?: string;
120
+ Version?: string | undefined;
121
121
  }
122
122
  /**
123
123
  * @public
@@ -212,12 +212,12 @@ export interface GetExportJobsRequest {
212
212
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
213
213
  * @public
214
214
  */
215
- PageSize?: string;
215
+ PageSize?: string | undefined;
216
216
  /**
217
217
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
218
218
  * @public
219
219
  */
220
- Token?: string;
220
+ Token?: string | undefined;
221
221
  }
222
222
  /**
223
223
  * @public
@@ -287,12 +287,12 @@ export interface GetImportJobsRequest {
287
287
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
288
288
  * @public
289
289
  */
290
- PageSize?: string;
290
+ PageSize?: string | undefined;
291
291
  /**
292
292
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
293
293
  * @public
294
294
  */
295
- Token?: string;
295
+ Token?: string | undefined;
296
296
  }
297
297
  /**
298
298
  * <p>Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.</p>
@@ -308,7 +308,7 @@ export interface ImportJobsResponse {
308
308
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
309
309
  * @public
310
310
  */
311
- NextToken?: string;
311
+ NextToken?: string | undefined;
312
312
  }
313
313
  /**
314
314
  * @public
@@ -344,17 +344,17 @@ export interface InAppMessage {
344
344
  * <p>In-app message content.</p>
345
345
  * @public
346
346
  */
347
- Content?: InAppMessageContent[];
347
+ Content?: InAppMessageContent[] | undefined;
348
348
  /**
349
349
  * <p>Custom config to be sent to SDK.</p>
350
350
  * @public
351
351
  */
352
- CustomConfig?: Record<string, string>;
352
+ CustomConfig?: Record<string, string> | undefined;
353
353
  /**
354
354
  * <p>The layout of the message.</p>
355
355
  * @public
356
356
  */
357
- Layout?: Layout;
357
+ Layout?: Layout | undefined;
358
358
  }
359
359
  /**
360
360
  * <p>Schedule of the campaign.</p>
@@ -365,17 +365,17 @@ export interface InAppCampaignSchedule {
365
365
  * <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
366
366
  * @public
367
367
  */
368
- EndDate?: string;
368
+ EndDate?: string | undefined;
369
369
  /**
370
370
  * <p>The event filter the SDK has to use to show the in-app message in the application.</p>
371
371
  * @public
372
372
  */
373
- EventFilter?: CampaignEventFilter;
373
+ EventFilter?: CampaignEventFilter | undefined;
374
374
  /**
375
375
  * <p>Time during which the in-app message should not be shown to the user.</p>
376
376
  * @public
377
377
  */
378
- QuietTime?: QuietTime;
378
+ QuietTime?: QuietTime | undefined;
379
379
  }
380
380
  /**
381
381
  * <p>Targeted in-app message campaign.</p>
@@ -386,42 +386,42 @@ export interface InAppMessageCampaign {
386
386
  * <p>Campaign id of the corresponding campaign.</p>
387
387
  * @public
388
388
  */
389
- CampaignId?: string;
389
+ CampaignId?: string | undefined;
390
390
  /**
391
391
  * <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
392
392
  * @public
393
393
  */
394
- DailyCap?: number;
394
+ DailyCap?: number | undefined;
395
395
  /**
396
396
  * <p>In-app message content with all fields required for rendering an in-app message.</p>
397
397
  * @public
398
398
  */
399
- InAppMessage?: InAppMessage;
399
+ InAppMessage?: InAppMessage | undefined;
400
400
  /**
401
401
  * <p>Priority of the in-app message.</p>
402
402
  * @public
403
403
  */
404
- Priority?: number;
404
+ Priority?: number | undefined;
405
405
  /**
406
406
  * <p>Schedule of the campaign.</p>
407
407
  * @public
408
408
  */
409
- Schedule?: InAppCampaignSchedule;
409
+ Schedule?: InAppCampaignSchedule | undefined;
410
410
  /**
411
411
  * <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
412
412
  * @public
413
413
  */
414
- SessionCap?: number;
414
+ SessionCap?: number | undefined;
415
415
  /**
416
416
  * <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
417
417
  * @public
418
418
  */
419
- TotalCap?: number;
419
+ TotalCap?: number | undefined;
420
420
  /**
421
421
  * <p>Treatment id of the campaign.</p>
422
422
  * @public
423
423
  */
424
- TreatmentId?: string;
424
+ TreatmentId?: string | undefined;
425
425
  }
426
426
  /**
427
427
  * <p>Get in-app messages response object.</p>
@@ -432,7 +432,7 @@ export interface InAppMessagesResponse {
432
432
  * <p>List of targeted in-app message campaigns.</p>
433
433
  * @public
434
434
  */
435
- InAppMessageCampaigns?: InAppMessageCampaign[];
435
+ InAppMessageCampaigns?: InAppMessageCampaign[] | undefined;
436
436
  }
437
437
  /**
438
438
  * @public
@@ -457,7 +457,7 @@ export interface GetInAppTemplateRequest {
457
457
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
458
458
  * @public
459
459
  */
460
- Version?: string;
460
+ Version?: string | undefined;
461
461
  }
462
462
  /**
463
463
  * <p>In-App Template Response.</p>
@@ -468,12 +468,12 @@ export interface InAppTemplateResponse {
468
468
  * <p>The resource arn of the template.</p>
469
469
  * @public
470
470
  */
471
- Arn?: string;
471
+ Arn?: string | undefined;
472
472
  /**
473
473
  * <p>The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.</p>
474
474
  * @public
475
475
  */
476
- Content?: InAppMessageContent[];
476
+ Content?: InAppMessageContent[] | undefined;
477
477
  /**
478
478
  * <p>The creation date of the template.</p>
479
479
  * @public
@@ -483,7 +483,7 @@ export interface InAppTemplateResponse {
483
483
  * <p>Custom config to be sent to client.</p>
484
484
  * @public
485
485
  */
486
- CustomConfig?: Record<string, string>;
486
+ CustomConfig?: Record<string, string> | undefined;
487
487
  /**
488
488
  * <p>The last modified date of the template.</p>
489
489
  * @public
@@ -493,17 +493,17 @@ export interface InAppTemplateResponse {
493
493
  * <p>The layout of the message.</p>
494
494
  * @public
495
495
  */
496
- Layout?: Layout;
496
+ Layout?: Layout | undefined;
497
497
  /**
498
498
  * <p>A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.</p>
499
499
  * @public
500
500
  */
501
- tags?: Record<string, string>;
501
+ tags?: Record<string, string> | undefined;
502
502
  /**
503
503
  * <p>The description of the template.</p>
504
504
  * @public
505
505
  */
506
- TemplateDescription?: string;
506
+ TemplateDescription?: string | undefined;
507
507
  /**
508
508
  * <p>The name of the template.</p>
509
509
  * @public
@@ -518,7 +518,7 @@ export interface InAppTemplateResponse {
518
518
  * <p>The version id of the template.</p>
519
519
  * @public
520
520
  */
521
- Version?: string;
521
+ Version?: string | undefined;
522
522
  }
523
523
  /**
524
524
  * @public
@@ -568,7 +568,7 @@ export interface GetJourneyDateRangeKpiRequest {
568
568
  * <p>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</p>
569
569
  * @public
570
570
  */
571
- EndTime?: Date;
571
+ EndTime?: Date | undefined;
572
572
  /**
573
573
  * <p>The unique identifier for the journey.</p>
574
574
  * @public
@@ -583,17 +583,17 @@ export interface GetJourneyDateRangeKpiRequest {
583
583
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
584
584
  * @public
585
585
  */
586
- NextToken?: string;
586
+ NextToken?: string | undefined;
587
587
  /**
588
588
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
589
589
  * @public
590
590
  */
591
- PageSize?: string;
591
+ PageSize?: string | undefined;
592
592
  /**
593
593
  * <p>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</p>
594
594
  * @public
595
595
  */
596
- StartTime?: Date;
596
+ StartTime?: Date | undefined;
597
597
  }
598
598
  /**
599
599
  * <p>Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.</p>
@@ -629,7 +629,7 @@ export interface JourneyDateRangeKpiResponse {
629
629
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.</p>
630
630
  * @public
631
631
  */
632
- NextToken?: string;
632
+ NextToken?: string | undefined;
633
633
  /**
634
634
  * <p>The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.</p>
635
635
  * @public
@@ -669,12 +669,12 @@ export interface GetJourneyExecutionActivityMetricsRequest {
669
669
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
670
670
  * @public
671
671
  */
672
- NextToken?: string;
672
+ NextToken?: string | undefined;
673
673
  /**
674
674
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
675
675
  * @public
676
676
  */
677
- PageSize?: string;
677
+ PageSize?: string | undefined;
678
678
  }
679
679
  /**
680
680
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.</p>
@@ -740,12 +740,12 @@ export interface GetJourneyExecutionMetricsRequest {
740
740
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
741
741
  * @public
742
742
  */
743
- NextToken?: string;
743
+ NextToken?: string | undefined;
744
744
  /**
745
745
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
746
746
  * @public
747
747
  */
748
- PageSize?: string;
748
+ PageSize?: string | undefined;
749
749
  }
750
750
  /**
751
751
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.</p>
@@ -806,12 +806,12 @@ export interface GetJourneyRunExecutionActivityMetricsRequest {
806
806
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
807
807
  * @public
808
808
  */
809
- NextToken?: string;
809
+ NextToken?: string | undefined;
810
810
  /**
811
811
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
812
812
  * @public
813
813
  */
814
- PageSize?: string;
814
+ PageSize?: string | undefined;
815
815
  /**
816
816
  * <p>The unique identifier for the journey run.</p>
817
817
  * @public
@@ -887,12 +887,12 @@ export interface GetJourneyRunExecutionMetricsRequest {
887
887
  * <p>The <code/> string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
888
888
  * @public
889
889
  */
890
- NextToken?: string;
890
+ NextToken?: string | undefined;
891
891
  /**
892
892
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
893
893
  * @public
894
894
  */
895
- PageSize?: string;
895
+ PageSize?: string | undefined;
896
896
  /**
897
897
  * <p>The unique identifier for the journey run.</p>
898
898
  * @public
@@ -958,12 +958,12 @@ export interface GetJourneyRunsRequest {
958
958
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
959
959
  * @public
960
960
  */
961
- PageSize?: string;
961
+ PageSize?: string | undefined;
962
962
  /**
963
963
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
964
964
  * @public
965
965
  */
966
- Token?: string;
966
+ Token?: string | undefined;
967
967
  }
968
968
  /**
969
969
  * @public
@@ -1019,7 +1019,7 @@ export interface JourneyRunsResponse {
1019
1019
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1020
1020
  * @public
1021
1021
  */
1022
- NextToken?: string;
1022
+ NextToken?: string | undefined;
1023
1023
  }
1024
1024
  /**
1025
1025
  * @public
@@ -1044,7 +1044,7 @@ export interface GetPushTemplateRequest {
1044
1044
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1045
1045
  * @public
1046
1046
  */
1047
- Version?: string;
1047
+ Version?: string | undefined;
1048
1048
  }
1049
1049
  /**
1050
1050
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
@@ -1055,22 +1055,22 @@ export interface PushNotificationTemplateResponse {
1055
1055
  * <p>The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1056
1056
  * @public
1057
1057
  */
1058
- ADM?: AndroidPushNotificationTemplate;
1058
+ ADM?: AndroidPushNotificationTemplate | undefined;
1059
1059
  /**
1060
1060
  * <p>The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1061
1061
  * @public
1062
1062
  */
1063
- APNS?: APNSPushNotificationTemplate;
1063
+ APNS?: APNSPushNotificationTemplate | undefined;
1064
1064
  /**
1065
1065
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1066
1066
  * @public
1067
1067
  */
1068
- Arn?: string;
1068
+ Arn?: string | undefined;
1069
1069
  /**
1070
1070
  * <p>The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1071
1071
  * @public
1072
1072
  */
1073
- Baidu?: AndroidPushNotificationTemplate;
1073
+ Baidu?: AndroidPushNotificationTemplate | undefined;
1074
1074
  /**
1075
1075
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1076
1076
  * @public
@@ -1080,17 +1080,17 @@ export interface PushNotificationTemplateResponse {
1080
1080
  * <p>The default message template that's used for push notification channels.</p>
1081
1081
  * @public
1082
1082
  */
1083
- Default?: DefaultPushNotificationTemplate;
1083
+ Default?: DefaultPushNotificationTemplate | undefined;
1084
1084
  /**
1085
1085
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1086
1086
  * @public
1087
1087
  */
1088
- DefaultSubstitutions?: string;
1088
+ DefaultSubstitutions?: string | undefined;
1089
1089
  /**
1090
1090
  * <p>The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>
1091
1091
  * @public
1092
1092
  */
1093
- GCM?: AndroidPushNotificationTemplate;
1093
+ GCM?: AndroidPushNotificationTemplate | undefined;
1094
1094
  /**
1095
1095
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1096
1096
  * @public
@@ -1100,17 +1100,17 @@ export interface PushNotificationTemplateResponse {
1100
1100
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
1101
1101
  * @public
1102
1102
  */
1103
- RecommenderId?: string;
1103
+ RecommenderId?: string | undefined;
1104
1104
  /**
1105
1105
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1106
1106
  * @public
1107
1107
  */
1108
- tags?: Record<string, string>;
1108
+ tags?: Record<string, string> | undefined;
1109
1109
  /**
1110
1110
  * <p>The custom description of the message template.</p>
1111
1111
  * @public
1112
1112
  */
1113
- TemplateDescription?: string;
1113
+ TemplateDescription?: string | undefined;
1114
1114
  /**
1115
1115
  * <p>The name of the message template.</p>
1116
1116
  * @public
@@ -1125,7 +1125,7 @@ export interface PushNotificationTemplateResponse {
1125
1125
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1126
1126
  * @public
1127
1127
  */
1128
- Version?: string;
1128
+ Version?: string | undefined;
1129
1129
  }
1130
1130
  /**
1131
1131
  * @public
@@ -1165,12 +1165,12 @@ export interface GetRecommenderConfigurationsRequest {
1165
1165
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1166
1166
  * @public
1167
1167
  */
1168
- PageSize?: string;
1168
+ PageSize?: string | undefined;
1169
1169
  /**
1170
1170
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1171
1171
  * @public
1172
1172
  */
1173
- Token?: string;
1173
+ Token?: string | undefined;
1174
1174
  }
1175
1175
  /**
1176
1176
  * <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
@@ -1186,7 +1186,7 @@ export interface ListRecommenderConfigurationsResponse {
1186
1186
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1187
1187
  * @public
1188
1188
  */
1189
- NextToken?: string;
1189
+ NextToken?: string | undefined;
1190
1190
  }
1191
1191
  /**
1192
1192
  * @public
@@ -1236,7 +1236,7 @@ export interface GetSegmentExportJobsRequest {
1236
1236
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1237
1237
  * @public
1238
1238
  */
1239
- PageSize?: string;
1239
+ PageSize?: string | undefined;
1240
1240
  /**
1241
1241
  * <p>The unique identifier for the segment.</p>
1242
1242
  * @public
@@ -1246,7 +1246,7 @@ export interface GetSegmentExportJobsRequest {
1246
1246
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1247
1247
  * @public
1248
1248
  */
1249
- Token?: string;
1249
+ Token?: string | undefined;
1250
1250
  }
1251
1251
  /**
1252
1252
  * @public
@@ -1271,7 +1271,7 @@ export interface GetSegmentImportJobsRequest {
1271
1271
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1272
1272
  * @public
1273
1273
  */
1274
- PageSize?: string;
1274
+ PageSize?: string | undefined;
1275
1275
  /**
1276
1276
  * <p>The unique identifier for the segment.</p>
1277
1277
  * @public
@@ -1281,7 +1281,7 @@ export interface GetSegmentImportJobsRequest {
1281
1281
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1282
1282
  * @public
1283
1283
  */
1284
- Token?: string;
1284
+ Token?: string | undefined;
1285
1285
  }
1286
1286
  /**
1287
1287
  * @public
@@ -1306,12 +1306,12 @@ export interface GetSegmentsRequest {
1306
1306
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1307
1307
  * @public
1308
1308
  */
1309
- PageSize?: string;
1309
+ PageSize?: string | undefined;
1310
1310
  /**
1311
1311
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1312
1312
  * @public
1313
1313
  */
1314
- Token?: string;
1314
+ Token?: string | undefined;
1315
1315
  }
1316
1316
  /**
1317
1317
  * <p>Provides information about all the segments that are associated with an application.</p>
@@ -1327,7 +1327,7 @@ export interface SegmentsResponse {
1327
1327
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1328
1328
  * @public
1329
1329
  */
1330
- NextToken?: string;
1330
+ NextToken?: string | undefined;
1331
1331
  }
1332
1332
  /**
1333
1333
  * @public
@@ -1382,7 +1382,7 @@ export interface GetSegmentVersionsRequest {
1382
1382
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1383
1383
  * @public
1384
1384
  */
1385
- PageSize?: string;
1385
+ PageSize?: string | undefined;
1386
1386
  /**
1387
1387
  * <p>The unique identifier for the segment.</p>
1388
1388
  * @public
@@ -1392,7 +1392,7 @@ export interface GetSegmentVersionsRequest {
1392
1392
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1393
1393
  * @public
1394
1394
  */
1395
- Token?: string;
1395
+ Token?: string | undefined;
1396
1396
  }
1397
1397
  /**
1398
1398
  * @public
@@ -1437,7 +1437,7 @@ export interface GetSmsTemplateRequest {
1437
1437
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1438
1438
  * @public
1439
1439
  */
1440
- Version?: string;
1440
+ Version?: string | undefined;
1441
1441
  }
1442
1442
  /**
1443
1443
  * <p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
@@ -1448,12 +1448,12 @@ export interface SMSTemplateResponse {
1448
1448
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1449
1449
  * @public
1450
1450
  */
1451
- Arn?: string;
1451
+ Arn?: string | undefined;
1452
1452
  /**
1453
1453
  * <p>The message body that's used in text messages that are based on the message template.</p>
1454
1454
  * @public
1455
1455
  */
1456
- Body?: string;
1456
+ Body?: string | undefined;
1457
1457
  /**
1458
1458
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1459
1459
  * @public
@@ -1463,7 +1463,7 @@ export interface SMSTemplateResponse {
1463
1463
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1464
1464
  * @public
1465
1465
  */
1466
- DefaultSubstitutions?: string;
1466
+ DefaultSubstitutions?: string | undefined;
1467
1467
  /**
1468
1468
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1469
1469
  * @public
@@ -1473,17 +1473,17 @@ export interface SMSTemplateResponse {
1473
1473
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
1474
1474
  * @public
1475
1475
  */
1476
- RecommenderId?: string;
1476
+ RecommenderId?: string | undefined;
1477
1477
  /**
1478
1478
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1479
1479
  * @public
1480
1480
  */
1481
- tags?: Record<string, string>;
1481
+ tags?: Record<string, string> | undefined;
1482
1482
  /**
1483
1483
  * <p>The custom description of the message template.</p>
1484
1484
  * @public
1485
1485
  */
1486
- TemplateDescription?: string;
1486
+ TemplateDescription?: string | undefined;
1487
1487
  /**
1488
1488
  * <p>The name of the message template.</p>
1489
1489
  * @public
@@ -1498,7 +1498,7 @@ export interface SMSTemplateResponse {
1498
1498
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1499
1499
  * @public
1500
1500
  */
1501
- Version?: string;
1501
+ Version?: string | undefined;
1502
1502
  }
1503
1503
  /**
1504
1504
  * @public
@@ -1568,7 +1568,7 @@ export interface GetVoiceTemplateRequest {
1568
1568
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
1569
1569
  * @public
1570
1570
  */
1571
- Version?: string;
1571
+ Version?: string | undefined;
1572
1572
  }
1573
1573
  /**
1574
1574
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
@@ -1579,12 +1579,12 @@ export interface VoiceTemplateResponse {
1579
1579
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1580
1580
  * @public
1581
1581
  */
1582
- Arn?: string;
1582
+ Arn?: string | undefined;
1583
1583
  /**
1584
1584
  * <p>The text of the script that's used in messages that are based on the message template, in plain text format.</p>
1585
1585
  * @public
1586
1586
  */
1587
- Body?: string;
1587
+ Body?: string | undefined;
1588
1588
  /**
1589
1589
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1590
1590
  * @public
@@ -1594,12 +1594,12 @@ export interface VoiceTemplateResponse {
1594
1594
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1595
1595
  * @public
1596
1596
  */
1597
- DefaultSubstitutions?: string;
1597
+ DefaultSubstitutions?: string | undefined;
1598
1598
  /**
1599
1599
  * <p>The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
1600
1600
  * @public
1601
1601
  */
1602
- LanguageCode?: string;
1602
+ LanguageCode?: string | undefined;
1603
1603
  /**
1604
1604
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1605
1605
  * @public
@@ -1609,12 +1609,12 @@ export interface VoiceTemplateResponse {
1609
1609
  * <p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>
1610
1610
  * @public
1611
1611
  */
1612
- tags?: Record<string, string>;
1612
+ tags?: Record<string, string> | undefined;
1613
1613
  /**
1614
1614
  * <p>The custom description of the message template.</p>
1615
1615
  * @public
1616
1616
  */
1617
- TemplateDescription?: string;
1617
+ TemplateDescription?: string | undefined;
1618
1618
  /**
1619
1619
  * <p>The name of the message template.</p>
1620
1620
  * @public
@@ -1629,12 +1629,12 @@ export interface VoiceTemplateResponse {
1629
1629
  * <p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>
1630
1630
  * @public
1631
1631
  */
1632
- Version?: string;
1632
+ Version?: string | undefined;
1633
1633
  /**
1634
1634
  * <p>The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/what-is.html">Amazon Polly Developer Guide</a>.</p>
1635
1635
  * @public
1636
1636
  */
1637
- VoiceId?: string;
1637
+ VoiceId?: string | undefined;
1638
1638
  }
1639
1639
  /**
1640
1640
  * @public
@@ -1660,7 +1660,7 @@ export interface JourneysResponse {
1660
1660
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1661
1661
  * @public
1662
1662
  */
1663
- NextToken?: string;
1663
+ NextToken?: string | undefined;
1664
1664
  }
1665
1665
  /**
1666
1666
  * <p>Changes the status of a journey.</p>
@@ -1671,7 +1671,7 @@ export interface JourneyStateRequest {
1671
1671
  * <p>The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED</p> <p>If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.</p> <p>After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.</p> <p>When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.</p>
1672
1672
  * @public
1673
1673
  */
1674
- State?: State;
1674
+ State?: State | undefined;
1675
1675
  }
1676
1676
  /**
1677
1677
  * @public
@@ -1686,12 +1686,12 @@ export interface ListJourneysRequest {
1686
1686
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1687
1687
  * @public
1688
1688
  */
1689
- PageSize?: string;
1689
+ PageSize?: string | undefined;
1690
1690
  /**
1691
1691
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1692
1692
  * @public
1693
1693
  */
1694
- Token?: string;
1694
+ Token?: string | undefined;
1695
1695
  }
1696
1696
  /**
1697
1697
  * @public
@@ -1712,7 +1712,7 @@ export interface TemplateResponse {
1712
1712
  * <p>The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.</p>
1713
1713
  * @public
1714
1714
  */
1715
- Arn?: string;
1715
+ Arn?: string | undefined;
1716
1716
  /**
1717
1717
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1718
1718
  * @public
@@ -1722,7 +1722,7 @@ export interface TemplateResponse {
1722
1722
  * <p>The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
1723
1723
  * @public
1724
1724
  */
1725
- DefaultSubstitutions?: string;
1725
+ DefaultSubstitutions?: string | undefined;
1726
1726
  /**
1727
1727
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1728
1728
  * @public
@@ -1732,12 +1732,12 @@ export interface TemplateResponse {
1732
1732
  * <p>A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>
1733
1733
  * @public
1734
1734
  */
1735
- tags?: Record<string, string>;
1735
+ tags?: Record<string, string> | undefined;
1736
1736
  /**
1737
1737
  * <p>The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.</p>
1738
1738
  * @public
1739
1739
  */
1740
- TemplateDescription?: string;
1740
+ TemplateDescription?: string | undefined;
1741
1741
  /**
1742
1742
  * <p>The name of the message template.</p>
1743
1743
  * @public
@@ -1752,7 +1752,7 @@ export interface TemplateResponse {
1752
1752
  * <p>The unique identifier, as an integer, for the active version of the message template.</p>
1753
1753
  * @public
1754
1754
  */
1755
- Version?: string;
1755
+ Version?: string | undefined;
1756
1756
  }
1757
1757
  /**
1758
1758
  * <p>Provides information about a specific version of a message template.</p>
@@ -1768,7 +1768,7 @@ export interface TemplateVersionResponse {
1768
1768
  * <p>A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>
1769
1769
  * @public
1770
1770
  */
1771
- DefaultSubstitutions?: string;
1771
+ DefaultSubstitutions?: string | undefined;
1772
1772
  /**
1773
1773
  * <p>The date, in ISO 8601 format, when the version of the message template was last modified.</p>
1774
1774
  * @public
@@ -1778,7 +1778,7 @@ export interface TemplateVersionResponse {
1778
1778
  * <p>The custom description of the version of the message template.</p>
1779
1779
  * @public
1780
1780
  */
1781
- TemplateDescription?: string;
1781
+ TemplateDescription?: string | undefined;
1782
1782
  /**
1783
1783
  * <p>The name of the message template.</p>
1784
1784
  * @public
@@ -1793,7 +1793,7 @@ export interface TemplateVersionResponse {
1793
1793
  * <p>The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.</p>
1794
1794
  * @public
1795
1795
  */
1796
- Version?: string;
1796
+ Version?: string | undefined;
1797
1797
  }
1798
1798
  /**
1799
1799
  * @public
@@ -1834,22 +1834,22 @@ export interface ListTemplatesRequest {
1834
1834
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1835
1835
  * @public
1836
1836
  */
1837
- NextToken?: string;
1837
+ NextToken?: string | undefined;
1838
1838
  /**
1839
1839
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1840
1840
  * @public
1841
1841
  */
1842
- PageSize?: string;
1842
+ PageSize?: string | undefined;
1843
1843
  /**
1844
1844
  * <p>The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.</p>
1845
1845
  * @public
1846
1846
  */
1847
- Prefix?: string;
1847
+ Prefix?: string | undefined;
1848
1848
  /**
1849
1849
  * <p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>
1850
1850
  * @public
1851
1851
  */
1852
- TemplateType?: string;
1852
+ TemplateType?: string | undefined;
1853
1853
  }
1854
1854
  /**
1855
1855
  * <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
@@ -1865,7 +1865,7 @@ export interface TemplatesResponse {
1865
1865
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1866
1866
  * @public
1867
1867
  */
1868
- NextToken?: string;
1868
+ NextToken?: string | undefined;
1869
1869
  }
1870
1870
  /**
1871
1871
  * @public
@@ -1885,12 +1885,12 @@ export interface ListTemplateVersionsRequest {
1885
1885
  * <p>The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1886
1886
  * @public
1887
1887
  */
1888
- NextToken?: string;
1888
+ NextToken?: string | undefined;
1889
1889
  /**
1890
1890
  * <p>The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.</p>
1891
1891
  * @public
1892
1892
  */
1893
- PageSize?: string;
1893
+ PageSize?: string | undefined;
1894
1894
  /**
1895
1895
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
1896
1896
  * @public
@@ -1916,17 +1916,17 @@ export interface TemplateVersionsResponse {
1916
1916
  * <p>The message that's returned from the API for the request to retrieve information about all the versions of the message template.</p>
1917
1917
  * @public
1918
1918
  */
1919
- Message?: string;
1919
+ Message?: string | undefined;
1920
1920
  /**
1921
1921
  * <p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>
1922
1922
  * @public
1923
1923
  */
1924
- NextToken?: string;
1924
+ NextToken?: string | undefined;
1925
1925
  /**
1926
1926
  * <p>The unique identifier for the request to retrieve information about all the versions of the message template.</p>
1927
1927
  * @public
1928
1928
  */
1929
- RequestID?: string;
1929
+ RequestID?: string | undefined;
1930
1930
  }
1931
1931
  /**
1932
1932
  * @public
@@ -1952,7 +1952,7 @@ export interface MessageResult {
1952
1952
  * <p>The unique identifier for the message that was sent.</p>
1953
1953
  * @public
1954
1954
  */
1955
- MessageId?: string;
1955
+ MessageId?: string | undefined;
1956
1956
  /**
1957
1957
  * <p>The downstream service status code for delivering the message.</p>
1958
1958
  * @public
@@ -1962,12 +1962,12 @@ export interface MessageResult {
1962
1962
  * <p>The status message for delivering the message.</p>
1963
1963
  * @public
1964
1964
  */
1965
- StatusMessage?: string;
1965
+ StatusMessage?: string | undefined;
1966
1966
  /**
1967
1967
  * <p>For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.</p>
1968
1968
  * @public
1969
1969
  */
1970
- UpdatedToken?: string;
1970
+ UpdatedToken?: string | undefined;
1971
1971
  }
1972
1972
  /**
1973
1973
  * <p>Specifies the configuration and other settings for a message.</p>
@@ -1978,17 +1978,17 @@ export interface MessageRequest {
1978
1978
  * <p>A map of key-value pairs, where each key is an address and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object. An address can be a push notification token, a phone number, or an email address. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration">AddressConfiguration</a> object to tailor the message for an address by specifying settings such as content overrides and message variables.</p>
1979
1979
  * @public
1980
1980
  */
1981
- Addresses?: Record<string, AddressConfiguration>;
1981
+ Addresses?: Record<string, AddressConfiguration> | undefined;
1982
1982
  /**
1983
1983
  * <p>A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>
1984
1984
  * @public
1985
1985
  */
1986
- Context?: Record<string, string>;
1986
+ Context?: Record<string, string> | undefined;
1987
1987
  /**
1988
1988
  * <p>A map of key-value pairs, where each key is an endpoint ID and each value is an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.</p>
1989
1989
  * @public
1990
1990
  */
1991
- Endpoints?: Record<string, EndpointSendConfiguration>;
1991
+ Endpoints?: Record<string, EndpointSendConfiguration> | undefined;
1992
1992
  /**
1993
1993
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
1994
1994
  * @public
@@ -1998,12 +1998,12 @@ export interface MessageRequest {
1998
1998
  * <p>The message template to use for the message.</p>
1999
1999
  * @public
2000
2000
  */
2001
- TemplateConfiguration?: TemplateConfiguration;
2001
+ TemplateConfiguration?: TemplateConfiguration | undefined;
2002
2002
  /**
2003
2003
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
2004
2004
  * @public
2005
2005
  */
2006
- TraceId?: string;
2006
+ TraceId?: string | undefined;
2007
2007
  }
2008
2008
  /**
2009
2009
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
@@ -2019,17 +2019,17 @@ export interface MessageResponse {
2019
2019
  * <p>A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.</p>
2020
2020
  * @public
2021
2021
  */
2022
- EndpointResult?: Record<string, EndpointMessageResult>;
2022
+ EndpointResult?: Record<string, EndpointMessageResult> | undefined;
2023
2023
  /**
2024
2024
  * <p>The identifier for the original request that the message was delivered for.</p>
2025
2025
  * @public
2026
2026
  */
2027
- RequestId?: string;
2027
+ RequestId?: string | undefined;
2028
2028
  /**
2029
2029
  * <p>A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.</p>
2030
2030
  * @public
2031
2031
  */
2032
- Result?: Record<string, MessageResult>;
2032
+ Result?: Record<string, MessageResult> | undefined;
2033
2033
  }
2034
2034
  /**
2035
2035
  * <p>Specifies a phone number to validate and retrieve information about.</p>
@@ -2040,12 +2040,12 @@ export interface NumberValidateRequest {
2040
2040
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
2041
2041
  * @public
2042
2042
  */
2043
- IsoCountryCode?: string;
2043
+ IsoCountryCode?: string | undefined;
2044
2044
  /**
2045
2045
  * <p>The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.</p>
2046
2046
  * @public
2047
2047
  */
2048
- PhoneNumber?: string;
2048
+ PhoneNumber?: string | undefined;
2049
2049
  }
2050
2050
  /**
2051
2051
  * <p>Provides information about a phone number.</p>
@@ -2056,73 +2056,73 @@ export interface NumberValidateResponse {
2056
2056
  * <p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>
2057
2057
  * @public
2058
2058
  */
2059
- Carrier?: string;
2059
+ Carrier?: string | undefined;
2060
2060
  /**
2061
2061
  * <p>The name of the city where the phone number was originally registered.</p>
2062
2062
  * @public
2063
2063
  */
2064
- City?: string;
2064
+ City?: string | undefined;
2065
2065
  /**
2066
2066
  * <p>The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.</p>
2067
2067
  * @public
2068
2068
  */
2069
- CleansedPhoneNumberE164?: string;
2069
+ CleansedPhoneNumberE164?: string | undefined;
2070
2070
  /**
2071
2071
  * <p>The cleansed phone number, in the format for the location where the phone number was originally registered.</p>
2072
2072
  * @public
2073
2073
  */
2074
- CleansedPhoneNumberNational?: string;
2074
+ CleansedPhoneNumberNational?: string | undefined;
2075
2075
  /**
2076
2076
  * <p>The name of the country or region where the phone number was originally registered.</p>
2077
2077
  * @public
2078
2078
  */
2079
- Country?: string;
2079
+ Country?: string | undefined;
2080
2080
  /**
2081
2081
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
2082
2082
  * @public
2083
2083
  */
2084
- CountryCodeIso2?: string;
2084
+ CountryCodeIso2?: string | undefined;
2085
2085
  /**
2086
2086
  * <p>The numeric code for the country or region where the phone number was originally registered.</p>
2087
2087
  * @public
2088
2088
  */
2089
- CountryCodeNumeric?: string;
2089
+ CountryCodeNumeric?: string | undefined;
2090
2090
  /**
2091
2091
  * <p>The name of the county where the phone number was originally registered.</p>
2092
2092
  * @public
2093
2093
  */
2094
- County?: string;
2094
+ County?: string | undefined;
2095
2095
  /**
2096
2096
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.</p>
2097
2097
  * @public
2098
2098
  */
2099
- OriginalCountryCodeIso2?: string;
2099
+ OriginalCountryCodeIso2?: string | undefined;
2100
2100
  /**
2101
2101
  * <p>The phone number that was sent in the request body.</p>
2102
2102
  * @public
2103
2103
  */
2104
- OriginalPhoneNumber?: string;
2104
+ OriginalPhoneNumber?: string | undefined;
2105
2105
  /**
2106
2106
  * <p>The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
2107
2107
  * INVALID, PREPAID, and OTHER.</p>
2108
2108
  * @public
2109
2109
  */
2110
- PhoneType?: string;
2110
+ PhoneType?: string | undefined;
2111
2111
  /**
2112
2112
  * <p>The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).</p>
2113
2113
  * @public
2114
2114
  */
2115
- PhoneTypeCode?: number;
2115
+ PhoneTypeCode?: number | undefined;
2116
2116
  /**
2117
2117
  * <p>The time zone for the location where the phone number was originally registered.</p>
2118
2118
  * @public
2119
2119
  */
2120
- Timezone?: string;
2120
+ Timezone?: string | undefined;
2121
2121
  /**
2122
2122
  * <p>The postal or ZIP code for the location where the phone number was originally registered.</p>
2123
2123
  * @public
2124
2124
  */
2125
- ZipCode?: string;
2125
+ ZipCode?: string | undefined;
2126
2126
  }
2127
2127
  /**
2128
2128
  * @public
@@ -2221,7 +2221,7 @@ export interface UpdateAttributesRequest {
2221
2221
  * <p>An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.</p>
2222
2222
  * @public
2223
2223
  */
2224
- Blacklist?: string[];
2224
+ Blacklist?: string[] | undefined;
2225
2225
  }
2226
2226
  /**
2227
2227
  * @public
@@ -2287,7 +2287,7 @@ export interface SendOTPMessageRequestParameters {
2287
2287
  * <p>The attempts allowed to validate an OTP.</p>
2288
2288
  * @public
2289
2289
  */
2290
- AllowedAttempts?: number;
2290
+ AllowedAttempts?: number | undefined;
2291
2291
  /**
2292
2292
  * <p>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</p>
2293
2293
  * @public
@@ -2302,7 +2302,7 @@ export interface SendOTPMessageRequestParameters {
2302
2302
  * <p>The number of characters in the generated OTP.</p>
2303
2303
  * @public
2304
2304
  */
2305
- CodeLength?: number;
2305
+ CodeLength?: number | undefined;
2306
2306
  /**
2307
2307
  * <p>The destination identity to send OTP to.</p>
2308
2308
  * @public
@@ -2312,12 +2312,12 @@ export interface SendOTPMessageRequestParameters {
2312
2312
  * <p>A unique Entity ID received from DLT after entity registration is approved.</p>
2313
2313
  * @public
2314
2314
  */
2315
- EntityId?: string;
2315
+ EntityId?: string | undefined;
2316
2316
  /**
2317
2317
  * <p>The language to be used for the outgoing message body containing the OTP.</p>
2318
2318
  * @public
2319
2319
  */
2320
- Language?: string;
2320
+ Language?: string | undefined;
2321
2321
  /**
2322
2322
  * <p>The origination identity used to send OTP from.</p>
2323
2323
  * @public
@@ -2332,12 +2332,12 @@ export interface SendOTPMessageRequestParameters {
2332
2332
  * <p>A unique Template ID received from DLT after entity registration is approved.</p>
2333
2333
  * @public
2334
2334
  */
2335
- TemplateId?: string;
2335
+ TemplateId?: string | undefined;
2336
2336
  /**
2337
2337
  * <p>The time in minutes before the OTP is no longer valid.</p>
2338
2338
  * @public
2339
2339
  */
2340
- ValidityPeriod?: number;
2340
+ ValidityPeriod?: number | undefined;
2341
2341
  }
2342
2342
  /**
2343
2343
  * @public
@@ -2373,7 +2373,7 @@ export interface SendUsersMessageRequest {
2373
2373
  * <p>A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.</p>
2374
2374
  * @public
2375
2375
  */
2376
- Context?: Record<string, string>;
2376
+ Context?: Record<string, string> | undefined;
2377
2377
  /**
2378
2378
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
2379
2379
  * @public
@@ -2383,12 +2383,12 @@ export interface SendUsersMessageRequest {
2383
2383
  * <p>The message template to use for the message.</p>
2384
2384
  * @public
2385
2385
  */
2386
- TemplateConfiguration?: TemplateConfiguration;
2386
+ TemplateConfiguration?: TemplateConfiguration | undefined;
2387
2387
  /**
2388
2388
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
2389
2389
  * @public
2390
2390
  */
2391
- TraceId?: string;
2391
+ TraceId?: string | undefined;
2392
2392
  /**
2393
2393
  * <p>A map that associates user IDs with <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> objects. You can use an <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration">EndpointSendConfiguration</a> object to tailor the message for a user by specifying settings such as content overrides and message variables.</p>
2394
2394
  * @public
@@ -2424,12 +2424,12 @@ export interface SendUsersMessageResponse {
2424
2424
  * <p>The unique identifier that was assigned to the message request.</p>
2425
2425
  * @public
2426
2426
  */
2427
- RequestId?: string;
2427
+ RequestId?: string | undefined;
2428
2428
  /**
2429
2429
  * <p>An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.</p>
2430
2430
  * @public
2431
2431
  */
2432
- Result?: Record<string, Record<string, EndpointMessageResult>>;
2432
+ Result?: Record<string, Record<string, EndpointMessageResult>> | undefined;
2433
2433
  }
2434
2434
  /**
2435
2435
  * @public
@@ -2605,28 +2605,28 @@ export interface WriteApplicationSettingsRequest {
2605
2605
  * <p>The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.</p> <p>To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource.</p>
2606
2606
  * @public
2607
2607
  */
2608
- CampaignHook?: CampaignHook;
2608
+ CampaignHook?: CampaignHook | undefined;
2609
2609
  /**
2610
2610
  * <p>Specifies whether to enable application-related alarms in Amazon CloudWatch.</p>
2611
2611
  * @public
2612
2612
  */
2613
- CloudWatchMetricsEnabled?: boolean;
2614
- EventTaggingEnabled?: boolean;
2613
+ CloudWatchMetricsEnabled?: boolean | undefined;
2614
+ EventTaggingEnabled?: boolean | undefined;
2615
2615
  /**
2616
2616
  * <p>The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource, respectively.</p>
2617
2617
  * @public
2618
2618
  */
2619
- Limits?: CampaignLimits;
2619
+ Limits?: CampaignLimits | undefined;
2620
2620
  /**
2621
2621
  * <p>The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:</p> <ul><li><p>The EndpointDemographic.Timezone property of the endpoint is set to a valid value.</p></li> <li><p>The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).</p></li> <li><p>The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).</p></li></ul> <p>If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.</p> <p>To override the default quiet time settings for a specific campaign or journey, use the <link linkend="apps-application-id-campaigns-campaign-id">Campaign</link> resource or the <link linkend="apps-application-id-journeys-journey-id">Journey</link> resource to define a custom quiet time for the campaign or journey.</p>
2622
2622
  * @public
2623
2623
  */
2624
- QuietTime?: QuietTime;
2624
+ QuietTime?: QuietTime | undefined;
2625
2625
  /**
2626
2626
  * <p>The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.</p>
2627
2627
  * @public
2628
2628
  */
2629
- JourneyLimits?: ApplicationSettingsJourneyLimits;
2629
+ JourneyLimits?: ApplicationSettingsJourneyLimits | undefined;
2630
2630
  }
2631
2631
  /**
2632
2632
  * @public
@@ -2741,7 +2741,7 @@ export interface UpdateEmailTemplateRequest {
2741
2741
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2742
2742
  * @public
2743
2743
  */
2744
- CreateNewVersion?: boolean;
2744
+ CreateNewVersion?: boolean | undefined;
2745
2745
  /**
2746
2746
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
2747
2747
  * @public
@@ -2756,7 +2756,7 @@ export interface UpdateEmailTemplateRequest {
2756
2756
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2757
2757
  * @public
2758
2758
  */
2759
- Version?: string;
2759
+ Version?: string | undefined;
2760
2760
  }
2761
2761
  /**
2762
2762
  * @public
@@ -2856,7 +2856,7 @@ export interface UpdateInAppTemplateRequest {
2856
2856
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2857
2857
  * @public
2858
2858
  */
2859
- CreateNewVersion?: boolean;
2859
+ CreateNewVersion?: boolean | undefined;
2860
2860
  /**
2861
2861
  * <p>InApp Template Request.</p>
2862
2862
  * @public
@@ -2871,7 +2871,7 @@ export interface UpdateInAppTemplateRequest {
2871
2871
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2872
2872
  * @public
2873
2873
  */
2874
- Version?: string;
2874
+ Version?: string | undefined;
2875
2875
  }
2876
2876
  /**
2877
2877
  * @public
@@ -2951,7 +2951,7 @@ export interface UpdatePushTemplateRequest {
2951
2951
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
2952
2952
  * @public
2953
2953
  */
2954
- CreateNewVersion?: boolean;
2954
+ CreateNewVersion?: boolean | undefined;
2955
2955
  /**
2956
2956
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>
2957
2957
  * @public
@@ -2966,7 +2966,7 @@ export interface UpdatePushTemplateRequest {
2966
2966
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
2967
2967
  * @public
2968
2968
  */
2969
- Version?: string;
2969
+ Version?: string | undefined;
2970
2970
  }
2971
2971
  /**
2972
2972
  * @public
@@ -2987,22 +2987,22 @@ export interface UpdateRecommenderConfigurationShape {
2987
2987
  * <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
2988
2988
  * @public
2989
2989
  */
2990
- Attributes?: Record<string, string>;
2990
+ Attributes?: Record<string, string> | undefined;
2991
2991
  /**
2992
2992
  * <p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.</p>
2993
2993
  * @public
2994
2994
  */
2995
- Description?: string;
2995
+ Description?: string | undefined;
2996
2996
  /**
2997
2997
  * <p>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p>
2998
2998
  * @public
2999
2999
  */
3000
- Name?: string;
3000
+ Name?: string | undefined;
3001
3001
  /**
3002
3002
  * <p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>
3003
3003
  * @public
3004
3004
  */
3005
- RecommendationProviderIdType?: string;
3005
+ RecommendationProviderIdType?: string | undefined;
3006
3006
  /**
3007
3007
  * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>
3008
3008
  * @public
@@ -3017,17 +3017,17 @@ export interface UpdateRecommenderConfigurationShape {
3017
3017
  * <p>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</p>
3018
3018
  * @public
3019
3019
  */
3020
- RecommendationTransformerUri?: string;
3020
+ RecommendationTransformerUri?: string | undefined;
3021
3021
  /**
3022
3022
  * <p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>
3023
3023
  * @public
3024
3024
  */
3025
- RecommendationsDisplayName?: string;
3025
+ RecommendationsDisplayName?: string | undefined;
3026
3026
  /**
3027
3027
  * <p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
3028
3028
  * @public
3029
3029
  */
3030
- RecommendationsPerMessage?: number;
3030
+ RecommendationsPerMessage?: number | undefined;
3031
3031
  }
3032
3032
  /**
3033
3033
  * @public
@@ -3093,17 +3093,17 @@ export interface SMSChannelRequest {
3093
3093
  * <p>Specifies whether to enable the SMS channel for the application.</p>
3094
3094
  * @public
3095
3095
  */
3096
- Enabled?: boolean;
3096
+ Enabled?: boolean | undefined;
3097
3097
  /**
3098
3098
  * <p>The identity that you want to display on recipients' devices when they receive messages from the SMS channel.</p>
3099
3099
  * @public
3100
3100
  */
3101
- SenderId?: string;
3101
+ SenderId?: string | undefined;
3102
3102
  /**
3103
3103
  * <p>The registered short code that you want to use when you send messages through the SMS channel.</p>
3104
3104
  * @public
3105
3105
  */
3106
- ShortCode?: string;
3106
+ ShortCode?: string | undefined;
3107
3107
  }
3108
3108
  /**
3109
3109
  * @public
@@ -3138,7 +3138,7 @@ export interface UpdateSmsTemplateRequest {
3138
3138
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
3139
3139
  * @public
3140
3140
  */
3141
- CreateNewVersion?: boolean;
3141
+ CreateNewVersion?: boolean | undefined;
3142
3142
  /**
3143
3143
  * <p>Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>
3144
3144
  * @public
@@ -3153,7 +3153,7 @@ export interface UpdateSmsTemplateRequest {
3153
3153
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
3154
3154
  * @public
3155
3155
  */
3156
- Version?: string;
3156
+ Version?: string | undefined;
3157
3157
  }
3158
3158
  /**
3159
3159
  * @public
@@ -3174,7 +3174,7 @@ export interface TemplateActiveVersionRequest {
3174
3174
  * <p>The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p>
3175
3175
  * @public
3176
3176
  */
3177
- Version?: string;
3177
+ Version?: string | undefined;
3178
3178
  }
3179
3179
  /**
3180
3180
  * @public
@@ -3215,7 +3215,7 @@ export interface VoiceChannelRequest {
3215
3215
  * <p>Specifies whether to enable the voice channel for the application.</p>
3216
3216
  * @public
3217
3217
  */
3218
- Enabled?: boolean;
3218
+ Enabled?: boolean | undefined;
3219
3219
  }
3220
3220
  /**
3221
3221
  * @public
@@ -3250,7 +3250,7 @@ export interface UpdateVoiceTemplateRequest {
3250
3250
  * <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
3251
3251
  * @public
3252
3252
  */
3253
- CreateNewVersion?: boolean;
3253
+ CreateNewVersion?: boolean | undefined;
3254
3254
  /**
3255
3255
  * <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
3256
3256
  * @public
@@ -3260,7 +3260,7 @@ export interface UpdateVoiceTemplateRequest {
3260
3260
  * <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>
3261
3261
  * @public
3262
3262
  */
3263
- Version?: string;
3263
+ Version?: string | undefined;
3264
3264
  /**
3265
3265
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
3266
3266
  * @public
@@ -3322,7 +3322,7 @@ export interface VerificationResponse {
3322
3322
  * <p>Specifies whether the OTP is valid or not.</p>
3323
3323
  * @public
3324
3324
  */
3325
- Valid?: boolean;
3325
+ Valid?: boolean | undefined;
3326
3326
  }
3327
3327
  /**
3328
3328
  * @public