@aws-sdk/client-pinpoint 3.379.1 → 3.382.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.
Files changed (27) hide show
  1. package/dist-types/commands/CreateCampaignCommand.d.ts +12 -8
  2. package/dist-types/commands/CreateJourneyCommand.d.ts +10 -0
  3. package/dist-types/commands/DeleteCampaignCommand.d.ts +6 -4
  4. package/dist-types/commands/DeleteGcmChannelCommand.d.ts +3 -1
  5. package/dist-types/commands/DeleteJourneyCommand.d.ts +5 -0
  6. package/dist-types/commands/GetApplicationSettingsCommand.d.ts +8 -0
  7. package/dist-types/commands/GetCampaignCommand.d.ts +6 -4
  8. package/dist-types/commands/GetCampaignVersionCommand.d.ts +8 -5
  9. package/dist-types/commands/GetCampaignVersionsCommand.d.ts +7 -6
  10. package/dist-types/commands/GetCampaignsCommand.d.ts +6 -4
  11. package/dist-types/commands/GetGcmChannelCommand.d.ts +3 -1
  12. package/dist-types/commands/GetJourneyCommand.d.ts +5 -0
  13. package/dist-types/commands/ListJourneysCommand.d.ts +5 -0
  14. package/dist-types/commands/SendMessagesCommand.d.ts +5 -0
  15. package/dist-types/commands/SendUsersMessagesCommand.d.ts +5 -0
  16. package/dist-types/commands/UpdateApplicationSettingsCommand.d.ts +16 -0
  17. package/dist-types/commands/UpdateCampaignCommand.d.ts +12 -8
  18. package/dist-types/commands/UpdateGcmChannelCommand.d.ts +6 -2
  19. package/dist-types/commands/UpdateJourneyCommand.d.ts +10 -0
  20. package/dist-types/commands/UpdateJourneyStateCommand.d.ts +5 -0
  21. package/dist-types/models/models_0.d.ts +1180 -33
  22. package/dist-types/models/models_1.d.ts +503 -3
  23. package/dist-types/ts3.4/commands/GetCampaignVersionCommand.d.ts +2 -4
  24. package/dist-types/ts3.4/commands/GetCampaignVersionsCommand.d.ts +4 -2
  25. package/dist-types/ts3.4/models/models_0.d.ts +20 -11
  26. package/dist-types/ts3.4/models/models_1.d.ts +11 -0
  27. package/package.json +5 -5
@@ -1,9 +1,45 @@
1
- import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignEventFilter, CampaignHook, CampaignLimits, CampaignResponse, CampaignsResponse, ChannelsResponse, DefaultPushNotificationTemplate, DeliveryStatus, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EmailTemplateResponse, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointResponse, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobResponse, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobResponse, InAppMessageContent, InAppTemplateRequest, JourneyResponse, Layout, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, State, TemplateConfiguration, TemplateType, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
1
+ import { AddressConfiguration, ADMChannelRequest, ADMChannelResponse, AndroidPushNotificationTemplate, APNSChannelRequest, APNSChannelResponse, APNSPushNotificationTemplate, APNSSandboxChannelRequest, APNSSandboxChannelResponse, APNSVoipChannelRequest, APNSVoipChannelResponse, APNSVoipSandboxChannelRequest, APNSVoipSandboxChannelResponse, ApplicationSettingsJourneyLimits, ApplicationSettingsResource, AttributesResource, BaiduChannelRequest, BaiduChannelResponse, BaseKpiResult, CampaignEventFilter, CampaignHook, CampaignLimits, CampaignResponse, CampaignsResponse, ChannelsResponse, DefaultPushNotificationTemplate, DeliveryStatus, DirectMessageConfiguration, EmailChannelRequest, EmailChannelResponse, EmailTemplateRequest, EmailTemplateResponse, EndpointBatchRequest, EndpointMessageResult, EndpointRequest, EndpointResponse, EndpointSendConfiguration, EndpointsResponse, EventsRequest, EventsResponse, EventStream, ExportJobResponse, ExportJobsResponse, GCMChannelRequest, GCMChannelResponse, ImportJobResponse, InAppMessageContent, InAppTemplateRequest, JourneyResponse, Layout, MessageBody, PushNotificationTemplateRequest, QuietTime, RecommenderConfigurationResponse, SegmentResponse, SMSChannelResponse, SMSTemplateRequest, State, TemplateConfiguration, TemplateType, VoiceChannelResponse, VoiceTemplateRequest, WriteCampaignRequest, WriteJourneyRequest, WriteSegmentRequest } from "./models_0";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface GetCampaignVersionResponse {
6
+ /**
7
+ * @public
8
+ * <p>Provides information about the status, configuration, and other settings for a campaign.</p>
9
+ */
10
+ CampaignResponse: CampaignResponse | undefined;
11
+ }
12
+ /**
13
+ * @public
14
+ */
15
+ export interface GetCampaignVersionsRequest {
16
+ /**
17
+ * @public
18
+ * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
19
+ */
20
+ ApplicationId: string | undefined;
21
+ /**
22
+ * @public
23
+ * <p>The unique identifier for the campaign.</p>
24
+ */
25
+ CampaignId: string | undefined;
26
+ /**
27
+ * @public
28
+ * <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>
29
+ */
30
+ PageSize?: string;
31
+ /**
32
+ * @public
33
+ * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
34
+ */
35
+ Token?: string;
36
+ }
2
37
  /**
3
38
  * @public
4
39
  */
5
40
  export interface GetCampaignVersionsResponse {
6
41
  /**
42
+ * @public
7
43
  * <p>Provides information about the configuration and other settings for all the campaigns that are associated with an application.</p>
8
44
  */
9
45
  CampaignsResponse: CampaignsResponse | undefined;
@@ -13,6 +49,7 @@ export interface GetCampaignVersionsResponse {
13
49
  */
14
50
  export interface GetChannelsRequest {
15
51
  /**
52
+ * @public
16
53
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
17
54
  */
18
55
  ApplicationId: string | undefined;
@@ -22,6 +59,7 @@ export interface GetChannelsRequest {
22
59
  */
23
60
  export interface GetChannelsResponse {
24
61
  /**
62
+ * @public
25
63
  * <p>Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.</p>
26
64
  */
27
65
  ChannelsResponse: ChannelsResponse | undefined;
@@ -31,6 +69,7 @@ export interface GetChannelsResponse {
31
69
  */
32
70
  export interface GetEmailChannelRequest {
33
71
  /**
72
+ * @public
34
73
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
35
74
  */
36
75
  ApplicationId: string | undefined;
@@ -40,6 +79,7 @@ export interface GetEmailChannelRequest {
40
79
  */
41
80
  export interface GetEmailChannelResponse {
42
81
  /**
82
+ * @public
43
83
  * <p>Provides information about the status and settings of the email channel for an application.</p>
44
84
  */
45
85
  EmailChannelResponse: EmailChannelResponse | undefined;
@@ -49,10 +89,12 @@ export interface GetEmailChannelResponse {
49
89
  */
50
90
  export interface GetEmailTemplateRequest {
51
91
  /**
92
+ * @public
52
93
  * <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>
53
94
  */
54
95
  TemplateName: string | undefined;
55
96
  /**
97
+ * @public
56
98
  * <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>
57
99
  */
58
100
  Version?: string;
@@ -62,6 +104,7 @@ export interface GetEmailTemplateRequest {
62
104
  */
63
105
  export interface GetEmailTemplateResponse {
64
106
  /**
107
+ * @public
65
108
  * <p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
66
109
  */
67
110
  EmailTemplateResponse: EmailTemplateResponse | undefined;
@@ -71,10 +114,12 @@ export interface GetEmailTemplateResponse {
71
114
  */
72
115
  export interface GetEndpointRequest {
73
116
  /**
117
+ * @public
74
118
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
75
119
  */
76
120
  ApplicationId: string | undefined;
77
121
  /**
122
+ * @public
78
123
  * <p>The unique identifier for the endpoint.</p>
79
124
  */
80
125
  EndpointId: string | undefined;
@@ -84,6 +129,7 @@ export interface GetEndpointRequest {
84
129
  */
85
130
  export interface GetEndpointResponse {
86
131
  /**
132
+ * @public
87
133
  * <p>Provides information about the channel type and other settings for an endpoint.</p>
88
134
  */
89
135
  EndpointResponse: EndpointResponse | undefined;
@@ -93,6 +139,7 @@ export interface GetEndpointResponse {
93
139
  */
94
140
  export interface GetEventStreamRequest {
95
141
  /**
142
+ * @public
96
143
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
97
144
  */
98
145
  ApplicationId: string | undefined;
@@ -102,6 +149,7 @@ export interface GetEventStreamRequest {
102
149
  */
103
150
  export interface GetEventStreamResponse {
104
151
  /**
152
+ * @public
105
153
  * <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
106
154
  */
107
155
  EventStream: EventStream | undefined;
@@ -111,10 +159,12 @@ export interface GetEventStreamResponse {
111
159
  */
112
160
  export interface GetExportJobRequest {
113
161
  /**
162
+ * @public
114
163
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
115
164
  */
116
165
  ApplicationId: string | undefined;
117
166
  /**
167
+ * @public
118
168
  * <p>The unique identifier for the job.</p>
119
169
  */
120
170
  JobId: string | undefined;
@@ -124,6 +174,7 @@ export interface GetExportJobRequest {
124
174
  */
125
175
  export interface GetExportJobResponse {
126
176
  /**
177
+ * @public
127
178
  * <p>Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.</p>
128
179
  */
129
180
  ExportJobResponse: ExportJobResponse | undefined;
@@ -133,14 +184,17 @@ export interface GetExportJobResponse {
133
184
  */
134
185
  export interface GetExportJobsRequest {
135
186
  /**
187
+ * @public
136
188
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
137
189
  */
138
190
  ApplicationId: string | undefined;
139
191
  /**
192
+ * @public
140
193
  * <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>
141
194
  */
142
195
  PageSize?: string;
143
196
  /**
197
+ * @public
144
198
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
145
199
  */
146
200
  Token?: string;
@@ -150,6 +204,7 @@ export interface GetExportJobsRequest {
150
204
  */
151
205
  export interface GetExportJobsResponse {
152
206
  /**
207
+ * @public
153
208
  * <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
154
209
  */
155
210
  ExportJobsResponse: ExportJobsResponse | undefined;
@@ -159,6 +214,7 @@ export interface GetExportJobsResponse {
159
214
  */
160
215
  export interface GetGcmChannelRequest {
161
216
  /**
217
+ * @public
162
218
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
163
219
  */
164
220
  ApplicationId: string | undefined;
@@ -168,6 +224,7 @@ export interface GetGcmChannelRequest {
168
224
  */
169
225
  export interface GetGcmChannelResponse {
170
226
  /**
227
+ * @public
171
228
  * <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
172
229
  */
173
230
  GCMChannelResponse: GCMChannelResponse | undefined;
@@ -177,10 +234,12 @@ export interface GetGcmChannelResponse {
177
234
  */
178
235
  export interface GetImportJobRequest {
179
236
  /**
237
+ * @public
180
238
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
181
239
  */
182
240
  ApplicationId: string | undefined;
183
241
  /**
242
+ * @public
184
243
  * <p>The unique identifier for the job.</p>
185
244
  */
186
245
  JobId: string | undefined;
@@ -190,6 +249,7 @@ export interface GetImportJobRequest {
190
249
  */
191
250
  export interface GetImportJobResponse {
192
251
  /**
252
+ * @public
193
253
  * <p>Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.</p>
194
254
  */
195
255
  ImportJobResponse: ImportJobResponse | undefined;
@@ -199,14 +259,17 @@ export interface GetImportJobResponse {
199
259
  */
200
260
  export interface GetImportJobsRequest {
201
261
  /**
262
+ * @public
202
263
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
203
264
  */
204
265
  ApplicationId: string | undefined;
205
266
  /**
267
+ * @public
206
268
  * <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>
207
269
  */
208
270
  PageSize?: string;
209
271
  /**
272
+ * @public
210
273
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
211
274
  */
212
275
  Token?: string;
@@ -217,10 +280,12 @@ export interface GetImportJobsRequest {
217
280
  */
218
281
  export interface ImportJobsResponse {
219
282
  /**
283
+ * @public
220
284
  * <p>An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).</p>
221
285
  */
222
286
  Item: ImportJobResponse[] | undefined;
223
287
  /**
288
+ * @public
224
289
  * <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>
225
290
  */
226
291
  NextToken?: string;
@@ -230,6 +295,7 @@ export interface ImportJobsResponse {
230
295
  */
231
296
  export interface GetImportJobsResponse {
232
297
  /**
298
+ * @public
233
299
  * <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>
234
300
  */
235
301
  ImportJobsResponse: ImportJobsResponse | undefined;
@@ -239,10 +305,12 @@ export interface GetImportJobsResponse {
239
305
  */
240
306
  export interface GetInAppMessagesRequest {
241
307
  /**
308
+ * @public
242
309
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
243
310
  */
244
311
  ApplicationId: string | undefined;
245
312
  /**
313
+ * @public
246
314
  * <p>The unique identifier for the endpoint.</p>
247
315
  */
248
316
  EndpointId: string | undefined;
@@ -253,14 +321,17 @@ export interface GetInAppMessagesRequest {
253
321
  */
254
322
  export interface InAppMessage {
255
323
  /**
324
+ * @public
256
325
  * <p>In-app message content.</p>
257
326
  */
258
327
  Content?: InAppMessageContent[];
259
328
  /**
329
+ * @public
260
330
  * <p>Custom config to be sent to SDK.</p>
261
331
  */
262
332
  CustomConfig?: Record<string, string>;
263
333
  /**
334
+ * @public
264
335
  * <p>The layout of the message.</p>
265
336
  */
266
337
  Layout?: Layout | string;
@@ -271,14 +342,17 @@ export interface InAppMessage {
271
342
  */
272
343
  export interface InAppCampaignSchedule {
273
344
  /**
345
+ * @public
274
346
  * <p>The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.</p>
275
347
  */
276
348
  EndDate?: string;
277
349
  /**
350
+ * @public
278
351
  * <p>The event filter the SDK has to use to show the in-app message in the application.</p>
279
352
  */
280
353
  EventFilter?: CampaignEventFilter;
281
354
  /**
355
+ * @public
282
356
  * <p>Time during which the in-app message should not be shown to the user.</p>
283
357
  */
284
358
  QuietTime?: QuietTime;
@@ -289,34 +363,42 @@ export interface InAppCampaignSchedule {
289
363
  */
290
364
  export interface InAppMessageCampaign {
291
365
  /**
366
+ * @public
292
367
  * <p>Campaign id of the corresponding campaign.</p>
293
368
  */
294
369
  CampaignId?: string;
295
370
  /**
371
+ * @public
296
372
  * <p>Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.</p>
297
373
  */
298
374
  DailyCap?: number;
299
375
  /**
376
+ * @public
300
377
  * <p>In-app message content with all fields required for rendering an in-app message.</p>
301
378
  */
302
379
  InAppMessage?: InAppMessage;
303
380
  /**
381
+ * @public
304
382
  * <p>Priority of the in-app message.</p>
305
383
  */
306
384
  Priority?: number;
307
385
  /**
386
+ * @public
308
387
  * <p>Schedule of the campaign.</p>
309
388
  */
310
389
  Schedule?: InAppCampaignSchedule;
311
390
  /**
391
+ * @public
312
392
  * <p>Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.</p>
313
393
  */
314
394
  SessionCap?: number;
315
395
  /**
396
+ * @public
316
397
  * <p>Total cap which controls the number of times an in-app message can be shown to the endpoint.</p>
317
398
  */
318
399
  TotalCap?: number;
319
400
  /**
401
+ * @public
320
402
  * <p>Treatment id of the campaign.</p>
321
403
  */
322
404
  TreatmentId?: string;
@@ -327,6 +409,7 @@ export interface InAppMessageCampaign {
327
409
  */
328
410
  export interface InAppMessagesResponse {
329
411
  /**
412
+ * @public
330
413
  * <p>List of targeted in-app message campaigns.</p>
331
414
  */
332
415
  InAppMessageCampaigns?: InAppMessageCampaign[];
@@ -336,6 +419,7 @@ export interface InAppMessagesResponse {
336
419
  */
337
420
  export interface GetInAppMessagesResponse {
338
421
  /**
422
+ * @public
339
423
  * <p>Get in-app messages response object.</p>
340
424
  */
341
425
  InAppMessagesResponse: InAppMessagesResponse | undefined;
@@ -345,10 +429,12 @@ export interface GetInAppMessagesResponse {
345
429
  */
346
430
  export interface GetInAppTemplateRequest {
347
431
  /**
432
+ * @public
348
433
  * <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>
349
434
  */
350
435
  TemplateName: string | undefined;
351
436
  /**
437
+ * @public
352
438
  * <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>
353
439
  */
354
440
  Version?: string;
@@ -359,46 +445,57 @@ export interface GetInAppTemplateRequest {
359
445
  */
360
446
  export interface InAppTemplateResponse {
361
447
  /**
448
+ * @public
362
449
  * <p>The resource arn of the template.</p>
363
450
  */
364
451
  Arn?: string;
365
452
  /**
453
+ * @public
366
454
  * <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>
367
455
  */
368
456
  Content?: InAppMessageContent[];
369
457
  /**
458
+ * @public
370
459
  * <p>The creation date of the template.</p>
371
460
  */
372
461
  CreationDate: string | undefined;
373
462
  /**
463
+ * @public
374
464
  * <p>Custom config to be sent to client.</p>
375
465
  */
376
466
  CustomConfig?: Record<string, string>;
377
467
  /**
468
+ * @public
378
469
  * <p>The last modified date of the template.</p>
379
470
  */
380
471
  LastModifiedDate: string | undefined;
381
472
  /**
473
+ * @public
382
474
  * <p>The layout of the message.</p>
383
475
  */
384
476
  Layout?: Layout | string;
385
477
  /**
478
+ * @public
386
479
  * <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>
387
480
  */
388
481
  tags?: Record<string, string>;
389
482
  /**
483
+ * @public
390
484
  * <p>The description of the template.</p>
391
485
  */
392
486
  TemplateDescription?: string;
393
487
  /**
488
+ * @public
394
489
  * <p>The name of the template.</p>
395
490
  */
396
491
  TemplateName: string | undefined;
397
492
  /**
493
+ * @public
398
494
  * <p>The type of the template.</p>
399
495
  */
400
496
  TemplateType: TemplateType | string | undefined;
401
497
  /**
498
+ * @public
402
499
  * <p>The version id of the template.</p>
403
500
  */
404
501
  Version?: string;
@@ -408,6 +505,7 @@ export interface InAppTemplateResponse {
408
505
  */
409
506
  export interface GetInAppTemplateResponse {
410
507
  /**
508
+ * @public
411
509
  * <p>In-App Template Response.</p>
412
510
  */
413
511
  InAppTemplateResponse: InAppTemplateResponse | undefined;
@@ -417,10 +515,12 @@ export interface GetInAppTemplateResponse {
417
515
  */
418
516
  export interface GetJourneyRequest {
419
517
  /**
518
+ * @public
420
519
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
421
520
  */
422
521
  ApplicationId: string | undefined;
423
522
  /**
523
+ * @public
424
524
  * <p>The unique identifier for the journey.</p>
425
525
  */
426
526
  JourneyId: string | undefined;
@@ -430,6 +530,7 @@ export interface GetJourneyRequest {
430
530
  */
431
531
  export interface GetJourneyResponse {
432
532
  /**
533
+ * @public
433
534
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
434
535
  */
435
536
  JourneyResponse: JourneyResponse | undefined;
@@ -439,30 +540,37 @@ export interface GetJourneyResponse {
439
540
  */
440
541
  export interface GetJourneyDateRangeKpiRequest {
441
542
  /**
543
+ * @public
442
544
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
443
545
  */
444
546
  ApplicationId: string | undefined;
445
547
  /**
548
+ * @public
446
549
  * <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>
447
550
  */
448
551
  EndTime?: Date;
449
552
  /**
553
+ * @public
450
554
  * <p>The unique identifier for the journey.</p>
451
555
  */
452
556
  JourneyId: string | undefined;
453
557
  /**
558
+ * @public
454
559
  * <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
455
560
  */
456
561
  KpiName: string | undefined;
457
562
  /**
563
+ * @public
458
564
  * <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>
459
565
  */
460
566
  NextToken?: string;
461
567
  /**
568
+ * @public
462
569
  * <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>
463
570
  */
464
571
  PageSize?: string;
465
572
  /**
573
+ * @public
466
574
  * <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>
467
575
  */
468
576
  StartTime?: Date;
@@ -473,30 +581,37 @@ export interface GetJourneyDateRangeKpiRequest {
473
581
  */
474
582
  export interface JourneyDateRangeKpiResponse {
475
583
  /**
584
+ * @public
476
585
  * <p>The unique identifier for the application that the metric applies to.</p>
477
586
  */
478
587
  ApplicationId: string | undefined;
479
588
  /**
589
+ * @public
480
590
  * <p>The last 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>
481
591
  */
482
592
  EndTime: Date | undefined;
483
593
  /**
594
+ * @public
484
595
  * <p>The unique identifier for the journey that the metric applies to.</p>
485
596
  */
486
597
  JourneyId: string | undefined;
487
598
  /**
599
+ * @public
488
600
  * <p>The name of the metric, also referred to as a <i>key performance indicator (KPI)</i>, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
489
601
  */
490
602
  KpiName: string | undefined;
491
603
  /**
604
+ * @public
492
605
  * <p>An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.</p>
493
606
  */
494
607
  KpiResult: BaseKpiResult | undefined;
495
608
  /**
609
+ * @public
496
610
  * <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>
497
611
  */
498
612
  NextToken?: string;
499
613
  /**
614
+ * @public
500
615
  * <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>
501
616
  */
502
617
  StartTime: Date | undefined;
@@ -506,6 +621,7 @@ export interface JourneyDateRangeKpiResponse {
506
621
  */
507
622
  export interface GetJourneyDateRangeKpiResponse {
508
623
  /**
624
+ * @public
509
625
  * <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>
510
626
  */
511
627
  JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponse | undefined;
@@ -515,22 +631,27 @@ export interface GetJourneyDateRangeKpiResponse {
515
631
  */
516
632
  export interface GetJourneyExecutionActivityMetricsRequest {
517
633
  /**
634
+ * @public
518
635
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
519
636
  */
520
637
  ApplicationId: string | undefined;
521
638
  /**
639
+ * @public
522
640
  * <p>The unique identifier for the journey activity.</p>
523
641
  */
524
642
  JourneyActivityId: string | undefined;
525
643
  /**
644
+ * @public
526
645
  * <p>The unique identifier for the journey.</p>
527
646
  */
528
647
  JourneyId: string | undefined;
529
648
  /**
649
+ * @public
530
650
  * <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>
531
651
  */
532
652
  NextToken?: string;
533
653
  /**
654
+ * @public
534
655
  * <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>
535
656
  */
536
657
  PageSize?: string;
@@ -541,26 +662,32 @@ export interface GetJourneyExecutionActivityMetricsRequest {
541
662
  */
542
663
  export interface JourneyExecutionActivityMetricsResponse {
543
664
  /**
665
+ * @public
544
666
  * <p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE – For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>
545
667
  */
546
668
  ActivityType: string | undefined;
547
669
  /**
670
+ * @public
548
671
  * <p>The unique identifier for the application that the metric applies to.</p>
549
672
  */
550
673
  ApplicationId: string | undefined;
551
674
  /**
675
+ * @public
552
676
  * <p>The unique identifier for the activity that the metric applies to.</p>
553
677
  */
554
678
  JourneyActivityId: string | undefined;
555
679
  /**
680
+ * @public
556
681
  * <p>The unique identifier for the journey that the metric applies to.</p>
557
682
  */
558
683
  JourneyId: string | undefined;
559
684
  /**
685
+ * @public
560
686
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.</p>
561
687
  */
562
688
  LastEvaluatedTime: string | undefined;
563
689
  /**
690
+ * @public
564
691
  * <p>A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
565
692
  */
566
693
  Metrics: Record<string, string> | undefined;
@@ -570,6 +697,7 @@ export interface JourneyExecutionActivityMetricsResponse {
570
697
  */
571
698
  export interface GetJourneyExecutionActivityMetricsResponse {
572
699
  /**
700
+ * @public
573
701
  * <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>
574
702
  */
575
703
  JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponse | undefined;
@@ -579,18 +707,22 @@ export interface GetJourneyExecutionActivityMetricsResponse {
579
707
  */
580
708
  export interface GetJourneyExecutionMetricsRequest {
581
709
  /**
710
+ * @public
582
711
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
583
712
  */
584
713
  ApplicationId: string | undefined;
585
714
  /**
715
+ * @public
586
716
  * <p>The unique identifier for the journey.</p>
587
717
  */
588
718
  JourneyId: string | undefined;
589
719
  /**
720
+ * @public
590
721
  * <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>
591
722
  */
592
723
  NextToken?: string;
593
724
  /**
725
+ * @public
594
726
  * <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>
595
727
  */
596
728
  PageSize?: string;
@@ -601,18 +733,22 @@ export interface GetJourneyExecutionMetricsRequest {
601
733
  */
602
734
  export interface JourneyExecutionMetricsResponse {
603
735
  /**
736
+ * @public
604
737
  * <p>The unique identifier for the application that the metric applies to.</p>
605
738
  */
606
739
  ApplicationId: string | undefined;
607
740
  /**
741
+ * @public
608
742
  * <p>The unique identifier for the journey that the metric applies to.</p>
609
743
  */
610
744
  JourneyId: string | undefined;
611
745
  /**
746
+ * @public
612
747
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.</p>
613
748
  */
614
749
  LastEvaluatedTime: string | undefined;
615
750
  /**
751
+ * @public
616
752
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Amazon Pinpoint Developer Guide</a>.</p>
617
753
  */
618
754
  Metrics: Record<string, string> | undefined;
@@ -622,6 +758,7 @@ export interface JourneyExecutionMetricsResponse {
622
758
  */
623
759
  export interface GetJourneyExecutionMetricsResponse {
624
760
  /**
761
+ * @public
625
762
  * <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>
626
763
  */
627
764
  JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse | undefined;
@@ -631,26 +768,32 @@ export interface GetJourneyExecutionMetricsResponse {
631
768
  */
632
769
  export interface GetJourneyRunExecutionActivityMetricsRequest {
633
770
  /**
771
+ * @public
634
772
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
635
773
  */
636
774
  ApplicationId: string | undefined;
637
775
  /**
776
+ * @public
638
777
  * <p>The unique identifier for the journey activity.</p>
639
778
  */
640
779
  JourneyActivityId: string | undefined;
641
780
  /**
781
+ * @public
642
782
  * <p>The unique identifier for the journey.</p>
643
783
  */
644
784
  JourneyId: string | undefined;
645
785
  /**
786
+ * @public
646
787
  * <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>
647
788
  */
648
789
  NextToken?: string;
649
790
  /**
791
+ * @public
650
792
  * <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>
651
793
  */
652
794
  PageSize?: string;
653
795
  /**
796
+ * @public
654
797
  * <p>The unique identifier for the journey run.</p>
655
798
  */
656
799
  RunId: string | undefined;
@@ -661,30 +804,37 @@ export interface GetJourneyRunExecutionActivityMetricsRequest {
661
804
  */
662
805
  export interface JourneyRunExecutionActivityMetricsResponse {
663
806
  /**
807
+ * @public
664
808
  * <p>The type of activity that the metric applies to. Possible values are:</p> <ul><li><p>CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.</p></li> <li><p>HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.</p></li> <li><p>MESSAGE – For an email activity, which is an activity that sends an email message to participants.</p></li> <li><p>MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.</p></li> <li><p>RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.</p></li> <li><p>WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.</p></li></ul>
665
809
  */
666
810
  ActivityType: string | undefined;
667
811
  /**
812
+ * @public
668
813
  * <p>The unique identifier for the application that the metric applies to.</p>
669
814
  */
670
815
  ApplicationId: string | undefined;
671
816
  /**
817
+ * @public
672
818
  * <p>The unique identifier for the activity that the metric applies to.</p>
673
819
  */
674
820
  JourneyActivityId: string | undefined;
675
821
  /**
822
+ * @public
676
823
  * <p>The unique identifier for the journey that the metric applies to.</p>
677
824
  */
678
825
  JourneyId: string | undefined;
679
826
  /**
827
+ * @public
680
828
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.</p>
681
829
  */
682
830
  LastEvaluatedTime: string | undefined;
683
831
  /**
832
+ * @public
684
833
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see see <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
685
834
  */
686
835
  Metrics: Record<string, string> | undefined;
687
836
  /**
837
+ * @public
688
838
  * <p>The unique identifier for the journey run that the metric applies to.</p>
689
839
  */
690
840
  RunId: string | undefined;
@@ -694,6 +844,7 @@ export interface JourneyRunExecutionActivityMetricsResponse {
694
844
  */
695
845
  export interface GetJourneyRunExecutionActivityMetricsResponse {
696
846
  /**
847
+ * @public
697
848
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity for a particular journey run, and provides information about that query.</p>
698
849
  */
699
850
  JourneyRunExecutionActivityMetricsResponse: JourneyRunExecutionActivityMetricsResponse | undefined;
@@ -703,22 +854,27 @@ export interface GetJourneyRunExecutionActivityMetricsResponse {
703
854
  */
704
855
  export interface GetJourneyRunExecutionMetricsRequest {
705
856
  /**
857
+ * @public
706
858
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
707
859
  */
708
860
  ApplicationId: string | undefined;
709
861
  /**
862
+ * @public
710
863
  * <p>The unique identifier for the journey.</p>
711
864
  */
712
865
  JourneyId: string | undefined;
713
866
  /**
867
+ * @public
714
868
  * <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>
715
869
  */
716
870
  NextToken?: string;
717
871
  /**
872
+ * @public
718
873
  * <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>
719
874
  */
720
875
  PageSize?: string;
721
876
  /**
877
+ * @public
722
878
  * <p>The unique identifier for the journey run.</p>
723
879
  */
724
880
  RunId: string | undefined;
@@ -729,22 +885,27 @@ export interface GetJourneyRunExecutionMetricsRequest {
729
885
  */
730
886
  export interface JourneyRunExecutionMetricsResponse {
731
887
  /**
888
+ * @public
732
889
  * <p>The unique identifier for the application that the metric applies to.</p>
733
890
  */
734
891
  ApplicationId: string | undefined;
735
892
  /**
893
+ * @public
736
894
  * <p>The unique identifier for the journey that the metric applies to.</p>
737
895
  */
738
896
  JourneyId: string | undefined;
739
897
  /**
898
+ * @public
740
899
  * <p>The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.</p>
741
900
  */
742
901
  LastEvaluatedTime: string | undefined;
743
902
  /**
903
+ * @public
744
904
  * <p>A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href="https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html">Standard Amazon Pinpoint analytics metrics</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>
745
905
  */
746
906
  Metrics: Record<string, string> | undefined;
747
907
  /**
908
+ * @public
748
909
  * <p>The unique identifier for the journey run that the metric applies to.</p>
749
910
  */
750
911
  RunId: string | undefined;
@@ -754,6 +915,7 @@ export interface JourneyRunExecutionMetricsResponse {
754
915
  */
755
916
  export interface GetJourneyRunExecutionMetricsResponse {
756
917
  /**
918
+ * @public
757
919
  * <p>Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey run, and provides information about that query.</p>
758
920
  */
759
921
  JourneyRunExecutionMetricsResponse: JourneyRunExecutionMetricsResponse | undefined;
@@ -763,18 +925,22 @@ export interface GetJourneyRunExecutionMetricsResponse {
763
925
  */
764
926
  export interface GetJourneyRunsRequest {
765
927
  /**
928
+ * @public
766
929
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
767
930
  */
768
931
  ApplicationId: string | undefined;
769
932
  /**
933
+ * @public
770
934
  * <p>The unique identifier for the journey.</p>
771
935
  */
772
936
  JourneyId: string | undefined;
773
937
  /**
938
+ * @public
774
939
  * <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>
775
940
  */
776
941
  PageSize?: string;
777
942
  /**
943
+ * @public
778
944
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
779
945
  */
780
946
  Token?: string;
@@ -799,18 +965,22 @@ export type JourneyRunStatus = (typeof JourneyRunStatus)[keyof typeof JourneyRun
799
965
  */
800
966
  export interface JourneyRunResponse {
801
967
  /**
968
+ * @public
802
969
  * <p>The time when the journey run was created or scheduled, in ISO 8601 format.</p>
803
970
  */
804
971
  CreationTime: string | undefined;
805
972
  /**
973
+ * @public
806
974
  * <p>The last time the journey run was updated, in ISO 8601 format..</p>
807
975
  */
808
976
  LastUpdateTime: string | undefined;
809
977
  /**
978
+ * @public
810
979
  * <p>The unique identifier for the run.</p>
811
980
  */
812
981
  RunId: string | undefined;
813
982
  /**
983
+ * @public
814
984
  * <p>The current status of the journey run.</p>
815
985
  */
816
986
  Status: JourneyRunStatus | string | undefined;
@@ -821,10 +991,12 @@ export interface JourneyRunResponse {
821
991
  */
822
992
  export interface JourneyRunsResponse {
823
993
  /**
994
+ * @public
824
995
  * <p>An array of responses, one for each run of the journey</p>
825
996
  */
826
997
  Item: JourneyRunResponse[] | undefined;
827
998
  /**
999
+ * @public
828
1000
  * <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>
829
1001
  */
830
1002
  NextToken?: string;
@@ -834,6 +1006,7 @@ export interface JourneyRunsResponse {
834
1006
  */
835
1007
  export interface GetJourneyRunsResponse {
836
1008
  /**
1009
+ * @public
837
1010
  * <p>Provides information from all runs of a journey.</p>
838
1011
  */
839
1012
  JourneyRunsResponse: JourneyRunsResponse | undefined;
@@ -843,10 +1016,12 @@ export interface GetJourneyRunsResponse {
843
1016
  */
844
1017
  export interface GetPushTemplateRequest {
845
1018
  /**
1019
+ * @public
846
1020
  * <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>
847
1021
  */
848
1022
  TemplateName: string | undefined;
849
1023
  /**
1024
+ * @public
850
1025
  * <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>
851
1026
  */
852
1027
  Version?: string;
@@ -857,62 +1032,77 @@ export interface GetPushTemplateRequest {
857
1032
  */
858
1033
  export interface PushNotificationTemplateResponse {
859
1034
  /**
1035
+ * @public
860
1036
  * <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>
861
1037
  */
862
1038
  ADM?: AndroidPushNotificationTemplate;
863
1039
  /**
1040
+ * @public
864
1041
  * <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>
865
1042
  */
866
1043
  APNS?: APNSPushNotificationTemplate;
867
1044
  /**
1045
+ * @public
868
1046
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
869
1047
  */
870
1048
  Arn?: string;
871
1049
  /**
1050
+ * @public
872
1051
  * <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>
873
1052
  */
874
1053
  Baidu?: AndroidPushNotificationTemplate;
875
1054
  /**
1055
+ * @public
876
1056
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
877
1057
  */
878
1058
  CreationDate: string | undefined;
879
1059
  /**
1060
+ * @public
880
1061
  * <p>The default message template that's used for push notification channels.</p>
881
1062
  */
882
1063
  Default?: DefaultPushNotificationTemplate;
883
1064
  /**
1065
+ * @public
884
1066
  * <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>
885
1067
  */
886
1068
  DefaultSubstitutions?: string;
887
1069
  /**
1070
+ * @public
888
1071
  * <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>
889
1072
  */
890
1073
  GCM?: AndroidPushNotificationTemplate;
891
1074
  /**
1075
+ * @public
892
1076
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
893
1077
  */
894
1078
  LastModifiedDate: string | undefined;
895
1079
  /**
1080
+ * @public
896
1081
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
897
1082
  */
898
1083
  RecommenderId?: string;
899
1084
  /**
1085
+ * @public
900
1086
  * <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>
901
1087
  */
902
1088
  tags?: Record<string, string>;
903
1089
  /**
1090
+ * @public
904
1091
  * <p>The custom description of the message template.</p>
905
1092
  */
906
1093
  TemplateDescription?: string;
907
1094
  /**
1095
+ * @public
908
1096
  * <p>The name of the message template.</p>
909
1097
  */
910
1098
  TemplateName: string | undefined;
911
1099
  /**
1100
+ * @public
912
1101
  * <p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>
913
1102
  */
914
1103
  TemplateType: TemplateType | string | undefined;
915
1104
  /**
1105
+ * @public
916
1106
  * <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>
917
1107
  */
918
1108
  Version?: string;
@@ -922,6 +1112,7 @@ export interface PushNotificationTemplateResponse {
922
1112
  */
923
1113
  export interface GetPushTemplateResponse {
924
1114
  /**
1115
+ * @public
925
1116
  * <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>
926
1117
  */
927
1118
  PushNotificationTemplateResponse: PushNotificationTemplateResponse | undefined;
@@ -931,6 +1122,7 @@ export interface GetPushTemplateResponse {
931
1122
  */
932
1123
  export interface GetRecommenderConfigurationRequest {
933
1124
  /**
1125
+ * @public
934
1126
  * <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
935
1127
  */
936
1128
  RecommenderId: string | undefined;
@@ -940,6 +1132,7 @@ export interface GetRecommenderConfigurationRequest {
940
1132
  */
941
1133
  export interface GetRecommenderConfigurationResponse {
942
1134
  /**
1135
+ * @public
943
1136
  * <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
944
1137
  */
945
1138
  RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
@@ -949,10 +1142,12 @@ export interface GetRecommenderConfigurationResponse {
949
1142
  */
950
1143
  export interface GetRecommenderConfigurationsRequest {
951
1144
  /**
1145
+ * @public
952
1146
  * <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>
953
1147
  */
954
1148
  PageSize?: string;
955
1149
  /**
1150
+ * @public
956
1151
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
957
1152
  */
958
1153
  Token?: string;
@@ -963,10 +1158,12 @@ export interface GetRecommenderConfigurationsRequest {
963
1158
  */
964
1159
  export interface ListRecommenderConfigurationsResponse {
965
1160
  /**
1161
+ * @public
966
1162
  * <p>An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.</p>
967
1163
  */
968
1164
  Item: RecommenderConfigurationResponse[] | undefined;
969
1165
  /**
1166
+ * @public
970
1167
  * <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>
971
1168
  */
972
1169
  NextToken?: string;
@@ -976,6 +1173,7 @@ export interface ListRecommenderConfigurationsResponse {
976
1173
  */
977
1174
  export interface GetRecommenderConfigurationsResponse {
978
1175
  /**
1176
+ * @public
979
1177
  * <p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>
980
1178
  */
981
1179
  ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponse | undefined;
@@ -985,10 +1183,12 @@ export interface GetRecommenderConfigurationsResponse {
985
1183
  */
986
1184
  export interface GetSegmentRequest {
987
1185
  /**
1186
+ * @public
988
1187
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
989
1188
  */
990
1189
  ApplicationId: string | undefined;
991
1190
  /**
1191
+ * @public
992
1192
  * <p>The unique identifier for the segment.</p>
993
1193
  */
994
1194
  SegmentId: string | undefined;
@@ -998,6 +1198,7 @@ export interface GetSegmentRequest {
998
1198
  */
999
1199
  export interface GetSegmentResponse {
1000
1200
  /**
1201
+ * @public
1001
1202
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
1002
1203
  */
1003
1204
  SegmentResponse: SegmentResponse | undefined;
@@ -1007,18 +1208,22 @@ export interface GetSegmentResponse {
1007
1208
  */
1008
1209
  export interface GetSegmentExportJobsRequest {
1009
1210
  /**
1211
+ * @public
1010
1212
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1011
1213
  */
1012
1214
  ApplicationId: string | undefined;
1013
1215
  /**
1216
+ * @public
1014
1217
  * <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>
1015
1218
  */
1016
1219
  PageSize?: string;
1017
1220
  /**
1221
+ * @public
1018
1222
  * <p>The unique identifier for the segment.</p>
1019
1223
  */
1020
1224
  SegmentId: string | undefined;
1021
1225
  /**
1226
+ * @public
1022
1227
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1023
1228
  */
1024
1229
  Token?: string;
@@ -1028,6 +1233,7 @@ export interface GetSegmentExportJobsRequest {
1028
1233
  */
1029
1234
  export interface GetSegmentExportJobsResponse {
1030
1235
  /**
1236
+ * @public
1031
1237
  * <p>Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.</p>
1032
1238
  */
1033
1239
  ExportJobsResponse: ExportJobsResponse | undefined;
@@ -1037,18 +1243,22 @@ export interface GetSegmentExportJobsResponse {
1037
1243
  */
1038
1244
  export interface GetSegmentImportJobsRequest {
1039
1245
  /**
1246
+ * @public
1040
1247
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1041
1248
  */
1042
1249
  ApplicationId: string | undefined;
1043
1250
  /**
1251
+ * @public
1044
1252
  * <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>
1045
1253
  */
1046
1254
  PageSize?: string;
1047
1255
  /**
1256
+ * @public
1048
1257
  * <p>The unique identifier for the segment.</p>
1049
1258
  */
1050
1259
  SegmentId: string | undefined;
1051
1260
  /**
1261
+ * @public
1052
1262
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1053
1263
  */
1054
1264
  Token?: string;
@@ -1058,6 +1268,7 @@ export interface GetSegmentImportJobsRequest {
1058
1268
  */
1059
1269
  export interface GetSegmentImportJobsResponse {
1060
1270
  /**
1271
+ * @public
1061
1272
  * <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>
1062
1273
  */
1063
1274
  ImportJobsResponse: ImportJobsResponse | undefined;
@@ -1067,14 +1278,17 @@ export interface GetSegmentImportJobsResponse {
1067
1278
  */
1068
1279
  export interface GetSegmentsRequest {
1069
1280
  /**
1281
+ * @public
1070
1282
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1071
1283
  */
1072
1284
  ApplicationId: string | undefined;
1073
1285
  /**
1286
+ * @public
1074
1287
  * <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>
1075
1288
  */
1076
1289
  PageSize?: string;
1077
1290
  /**
1291
+ * @public
1078
1292
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1079
1293
  */
1080
1294
  Token?: string;
@@ -1085,10 +1299,12 @@ export interface GetSegmentsRequest {
1085
1299
  */
1086
1300
  export interface SegmentsResponse {
1087
1301
  /**
1302
+ * @public
1088
1303
  * <p>An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).</p>
1089
1304
  */
1090
1305
  Item: SegmentResponse[] | undefined;
1091
1306
  /**
1307
+ * @public
1092
1308
  * <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>
1093
1309
  */
1094
1310
  NextToken?: string;
@@ -1098,6 +1314,7 @@ export interface SegmentsResponse {
1098
1314
  */
1099
1315
  export interface GetSegmentsResponse {
1100
1316
  /**
1317
+ * @public
1101
1318
  * <p>Provides information about all the segments that are associated with an application.</p>
1102
1319
  */
1103
1320
  SegmentsResponse: SegmentsResponse | undefined;
@@ -1107,14 +1324,17 @@ export interface GetSegmentsResponse {
1107
1324
  */
1108
1325
  export interface GetSegmentVersionRequest {
1109
1326
  /**
1327
+ * @public
1110
1328
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1111
1329
  */
1112
1330
  ApplicationId: string | undefined;
1113
1331
  /**
1332
+ * @public
1114
1333
  * <p>The unique identifier for the segment.</p>
1115
1334
  */
1116
1335
  SegmentId: string | undefined;
1117
1336
  /**
1337
+ * @public
1118
1338
  * <p>The unique version number (Version property) for the campaign version.</p>
1119
1339
  */
1120
1340
  Version: string | undefined;
@@ -1124,6 +1344,7 @@ export interface GetSegmentVersionRequest {
1124
1344
  */
1125
1345
  export interface GetSegmentVersionResponse {
1126
1346
  /**
1347
+ * @public
1127
1348
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
1128
1349
  */
1129
1350
  SegmentResponse: SegmentResponse | undefined;
@@ -1133,18 +1354,22 @@ export interface GetSegmentVersionResponse {
1133
1354
  */
1134
1355
  export interface GetSegmentVersionsRequest {
1135
1356
  /**
1357
+ * @public
1136
1358
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1137
1359
  */
1138
1360
  ApplicationId: string | undefined;
1139
1361
  /**
1362
+ * @public
1140
1363
  * <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>
1141
1364
  */
1142
1365
  PageSize?: string;
1143
1366
  /**
1367
+ * @public
1144
1368
  * <p>The unique identifier for the segment.</p>
1145
1369
  */
1146
1370
  SegmentId: string | undefined;
1147
1371
  /**
1372
+ * @public
1148
1373
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1149
1374
  */
1150
1375
  Token?: string;
@@ -1154,6 +1379,7 @@ export interface GetSegmentVersionsRequest {
1154
1379
  */
1155
1380
  export interface GetSegmentVersionsResponse {
1156
1381
  /**
1382
+ * @public
1157
1383
  * <p>Provides information about all the segments that are associated with an application.</p>
1158
1384
  */
1159
1385
  SegmentsResponse: SegmentsResponse | undefined;
@@ -1163,6 +1389,7 @@ export interface GetSegmentVersionsResponse {
1163
1389
  */
1164
1390
  export interface GetSmsChannelRequest {
1165
1391
  /**
1392
+ * @public
1166
1393
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1167
1394
  */
1168
1395
  ApplicationId: string | undefined;
@@ -1172,6 +1399,7 @@ export interface GetSmsChannelRequest {
1172
1399
  */
1173
1400
  export interface GetSmsChannelResponse {
1174
1401
  /**
1402
+ * @public
1175
1403
  * <p>Provides information about the status and settings of the SMS channel for an application.</p>
1176
1404
  */
1177
1405
  SMSChannelResponse: SMSChannelResponse | undefined;
@@ -1181,10 +1409,12 @@ export interface GetSmsChannelResponse {
1181
1409
  */
1182
1410
  export interface GetSmsTemplateRequest {
1183
1411
  /**
1412
+ * @public
1184
1413
  * <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>
1185
1414
  */
1186
1415
  TemplateName: string | undefined;
1187
1416
  /**
1417
+ * @public
1188
1418
  * <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>
1189
1419
  */
1190
1420
  Version?: string;
@@ -1195,46 +1425,57 @@ export interface GetSmsTemplateRequest {
1195
1425
  */
1196
1426
  export interface SMSTemplateResponse {
1197
1427
  /**
1428
+ * @public
1198
1429
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1199
1430
  */
1200
1431
  Arn?: string;
1201
1432
  /**
1433
+ * @public
1202
1434
  * <p>The message body that's used in text messages that are based on the message template.</p>
1203
1435
  */
1204
1436
  Body?: string;
1205
1437
  /**
1438
+ * @public
1206
1439
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1207
1440
  */
1208
1441
  CreationDate: string | undefined;
1209
1442
  /**
1443
+ * @public
1210
1444
  * <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>
1211
1445
  */
1212
1446
  DefaultSubstitutions?: string;
1213
1447
  /**
1448
+ * @public
1214
1449
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1215
1450
  */
1216
1451
  LastModifiedDate: string | undefined;
1217
1452
  /**
1453
+ * @public
1218
1454
  * <p>The unique identifier for the recommender model that's used by the message template.</p>
1219
1455
  */
1220
1456
  RecommenderId?: string;
1221
1457
  /**
1458
+ * @public
1222
1459
  * <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>
1223
1460
  */
1224
1461
  tags?: Record<string, string>;
1225
1462
  /**
1463
+ * @public
1226
1464
  * <p>The custom description of the message template.</p>
1227
1465
  */
1228
1466
  TemplateDescription?: string;
1229
1467
  /**
1468
+ * @public
1230
1469
  * <p>The name of the message template.</p>
1231
1470
  */
1232
1471
  TemplateName: string | undefined;
1233
1472
  /**
1473
+ * @public
1234
1474
  * <p>The type of channel that the message template is designed for. For an SMS template, this value is SMS.</p>
1235
1475
  */
1236
1476
  TemplateType: TemplateType | string | undefined;
1237
1477
  /**
1478
+ * @public
1238
1479
  * <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>
1239
1480
  */
1240
1481
  Version?: string;
@@ -1244,6 +1485,7 @@ export interface SMSTemplateResponse {
1244
1485
  */
1245
1486
  export interface GetSmsTemplateResponse {
1246
1487
  /**
1488
+ * @public
1247
1489
  * <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>
1248
1490
  */
1249
1491
  SMSTemplateResponse: SMSTemplateResponse | undefined;
@@ -1253,10 +1495,12 @@ export interface GetSmsTemplateResponse {
1253
1495
  */
1254
1496
  export interface GetUserEndpointsRequest {
1255
1497
  /**
1498
+ * @public
1256
1499
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1257
1500
  */
1258
1501
  ApplicationId: string | undefined;
1259
1502
  /**
1503
+ * @public
1260
1504
  * <p>The unique identifier for the user.</p>
1261
1505
  */
1262
1506
  UserId: string | undefined;
@@ -1266,6 +1510,7 @@ export interface GetUserEndpointsRequest {
1266
1510
  */
1267
1511
  export interface GetUserEndpointsResponse {
1268
1512
  /**
1513
+ * @public
1269
1514
  * <p>Provides information about all the endpoints that are associated with a user ID.</p>
1270
1515
  */
1271
1516
  EndpointsResponse: EndpointsResponse | undefined;
@@ -1275,6 +1520,7 @@ export interface GetUserEndpointsResponse {
1275
1520
  */
1276
1521
  export interface GetVoiceChannelRequest {
1277
1522
  /**
1523
+ * @public
1278
1524
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1279
1525
  */
1280
1526
  ApplicationId: string | undefined;
@@ -1284,6 +1530,7 @@ export interface GetVoiceChannelRequest {
1284
1530
  */
1285
1531
  export interface GetVoiceChannelResponse {
1286
1532
  /**
1533
+ * @public
1287
1534
  * <p>Provides information about the status and settings of the voice channel for an application.</p>
1288
1535
  */
1289
1536
  VoiceChannelResponse: VoiceChannelResponse | undefined;
@@ -1293,10 +1540,12 @@ export interface GetVoiceChannelResponse {
1293
1540
  */
1294
1541
  export interface GetVoiceTemplateRequest {
1295
1542
  /**
1543
+ * @public
1296
1544
  * <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>
1297
1545
  */
1298
1546
  TemplateName: string | undefined;
1299
1547
  /**
1548
+ * @public
1300
1549
  * <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>
1301
1550
  */
1302
1551
  Version?: string;
@@ -1307,50 +1556,62 @@ export interface GetVoiceTemplateRequest {
1307
1556
  */
1308
1557
  export interface VoiceTemplateResponse {
1309
1558
  /**
1559
+ * @public
1310
1560
  * <p>The Amazon Resource Name (ARN) of the message template.</p>
1311
1561
  */
1312
1562
  Arn?: string;
1313
1563
  /**
1564
+ * @public
1314
1565
  * <p>The text of the script that's used in messages that are based on the message template, in plain text format.</p>
1315
1566
  */
1316
1567
  Body?: string;
1317
1568
  /**
1569
+ * @public
1318
1570
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1319
1571
  */
1320
1572
  CreationDate: string | undefined;
1321
1573
  /**
1574
+ * @public
1322
1575
  * <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>
1323
1576
  */
1324
1577
  DefaultSubstitutions?: string;
1325
1578
  /**
1579
+ * @public
1326
1580
  * <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>
1327
1581
  */
1328
1582
  LanguageCode?: string;
1329
1583
  /**
1584
+ * @public
1330
1585
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1331
1586
  */
1332
1587
  LastModifiedDate: string | undefined;
1333
1588
  /**
1589
+ * @public
1334
1590
  * <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>
1335
1591
  */
1336
1592
  tags?: Record<string, string>;
1337
1593
  /**
1594
+ * @public
1338
1595
  * <p>The custom description of the message template.</p>
1339
1596
  */
1340
1597
  TemplateDescription?: string;
1341
1598
  /**
1599
+ * @public
1342
1600
  * <p>The name of the message template.</p>
1343
1601
  */
1344
1602
  TemplateName: string | undefined;
1345
1603
  /**
1604
+ * @public
1346
1605
  * <p>The type of channel that the message template is designed for. For a voice template, this value is VOICE.</p>
1347
1606
  */
1348
1607
  TemplateType: TemplateType | string | undefined;
1349
1608
  /**
1609
+ * @public
1350
1610
  * <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>
1351
1611
  */
1352
1612
  Version?: string;
1353
1613
  /**
1614
+ * @public
1354
1615
  * <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>
1355
1616
  */
1356
1617
  VoiceId?: string;
@@ -1360,6 +1621,7 @@ export interface VoiceTemplateResponse {
1360
1621
  */
1361
1622
  export interface GetVoiceTemplateResponse {
1362
1623
  /**
1624
+ * @public
1363
1625
  * <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>
1364
1626
  */
1365
1627
  VoiceTemplateResponse: VoiceTemplateResponse | undefined;
@@ -1370,10 +1632,12 @@ export interface GetVoiceTemplateResponse {
1370
1632
  */
1371
1633
  export interface JourneysResponse {
1372
1634
  /**
1635
+ * @public
1373
1636
  * <p>An array of responses, one for each journey that's associated with the application.</p>
1374
1637
  */
1375
1638
  Item: JourneyResponse[] | undefined;
1376
1639
  /**
1640
+ * @public
1377
1641
  * <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>
1378
1642
  */
1379
1643
  NextToken?: string;
@@ -1384,6 +1648,7 @@ export interface JourneysResponse {
1384
1648
  */
1385
1649
  export interface JourneyStateRequest {
1386
1650
  /**
1651
+ * @public
1387
1652
  * <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>
1388
1653
  */
1389
1654
  State?: State | string;
@@ -1393,14 +1658,17 @@ export interface JourneyStateRequest {
1393
1658
  */
1394
1659
  export interface ListJourneysRequest {
1395
1660
  /**
1661
+ * @public
1396
1662
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1397
1663
  */
1398
1664
  ApplicationId: string | undefined;
1399
1665
  /**
1666
+ * @public
1400
1667
  * <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>
1401
1668
  */
1402
1669
  PageSize?: string;
1403
1670
  /**
1671
+ * @public
1404
1672
  * <p>The NextToken string that specifies which page of results to return in a paginated response.</p>
1405
1673
  */
1406
1674
  Token?: string;
@@ -1410,6 +1678,7 @@ export interface ListJourneysRequest {
1410
1678
  */
1411
1679
  export interface ListJourneysResponse {
1412
1680
  /**
1681
+ * @public
1413
1682
  * <p>Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.</p>
1414
1683
  */
1415
1684
  JourneysResponse: JourneysResponse | undefined;
@@ -1420,38 +1689,47 @@ export interface ListJourneysResponse {
1420
1689
  */
1421
1690
  export interface TemplateResponse {
1422
1691
  /**
1692
+ * @public
1423
1693
  * <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>
1424
1694
  */
1425
1695
  Arn?: string;
1426
1696
  /**
1697
+ * @public
1427
1698
  * <p>The date, in ISO 8601 format, when the message template was created.</p>
1428
1699
  */
1429
1700
  CreationDate: string | undefined;
1430
1701
  /**
1702
+ * @public
1431
1703
  * <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>
1432
1704
  */
1433
1705
  DefaultSubstitutions?: string;
1434
1706
  /**
1707
+ * @public
1435
1708
  * <p>The date, in ISO 8601 format, when the message template was last modified.</p>
1436
1709
  */
1437
1710
  LastModifiedDate: string | undefined;
1438
1711
  /**
1712
+ * @public
1439
1713
  * <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>
1440
1714
  */
1441
1715
  tags?: Record<string, string>;
1442
1716
  /**
1717
+ * @public
1443
1718
  * <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>
1444
1719
  */
1445
1720
  TemplateDescription?: string;
1446
1721
  /**
1722
+ * @public
1447
1723
  * <p>The name of the message template.</p>
1448
1724
  */
1449
1725
  TemplateName: string | undefined;
1450
1726
  /**
1451
- * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
1727
+ * @public
1728
+ * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
1452
1729
  */
1453
1730
  TemplateType: TemplateType | string | undefined;
1454
1731
  /**
1732
+ * @public
1455
1733
  * <p>The unique identifier, as an integer, for the active version of the message template.</p>
1456
1734
  */
1457
1735
  Version?: string;
@@ -1462,30 +1740,37 @@ export interface TemplateResponse {
1462
1740
  */
1463
1741
  export interface TemplateVersionResponse {
1464
1742
  /**
1743
+ * @public
1465
1744
  * <p>The date, in ISO 8601 format, when the version of the message template was created.</p>
1466
1745
  */
1467
1746
  CreationDate: string | undefined;
1468
1747
  /**
1748
+ * @public
1469
1749
  * <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>
1470
1750
  */
1471
1751
  DefaultSubstitutions?: string;
1472
1752
  /**
1753
+ * @public
1473
1754
  * <p>The date, in ISO 8601 format, when the version of the message template was last modified.</p>
1474
1755
  */
1475
1756
  LastModifiedDate: string | undefined;
1476
1757
  /**
1758
+ * @public
1477
1759
  * <p>The custom description of the version of the message template.</p>
1478
1760
  */
1479
1761
  TemplateDescription?: string;
1480
1762
  /**
1763
+ * @public
1481
1764
  * <p>The name of the message template.</p>
1482
1765
  */
1483
1766
  TemplateName: string | undefined;
1484
1767
  /**
1485
- * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>
1768
+ * @public
1769
+ * <p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.</p>
1486
1770
  */
1487
1771
  TemplateType: string | undefined;
1488
1772
  /**
1773
+ * @public
1489
1774
  * <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>
1490
1775
  */
1491
1776
  Version?: string;
@@ -1495,6 +1780,7 @@ export interface TemplateVersionResponse {
1495
1780
  */
1496
1781
  export interface ListTagsForResourceRequest {
1497
1782
  /**
1783
+ * @public
1498
1784
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1499
1785
  */
1500
1786
  ResourceArn: string | undefined;
@@ -1505,6 +1791,7 @@ export interface ListTagsForResourceRequest {
1505
1791
  */
1506
1792
  export interface TagsModel {
1507
1793
  /**
1794
+ * @public
1508
1795
  * <p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>
1509
1796
  */
1510
1797
  tags: Record<string, string> | undefined;
@@ -1514,6 +1801,7 @@ export interface TagsModel {
1514
1801
  */
1515
1802
  export interface ListTagsForResourceResponse {
1516
1803
  /**
1804
+ * @public
1517
1805
  * <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
1518
1806
  */
1519
1807
  TagsModel: TagsModel | undefined;
@@ -1523,18 +1811,22 @@ export interface ListTagsForResourceResponse {
1523
1811
  */
1524
1812
  export interface ListTemplatesRequest {
1525
1813
  /**
1814
+ * @public
1526
1815
  * <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>
1527
1816
  */
1528
1817
  NextToken?: string;
1529
1818
  /**
1819
+ * @public
1530
1820
  * <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>
1531
1821
  */
1532
1822
  PageSize?: string;
1533
1823
  /**
1824
+ * @public
1534
1825
  * <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>
1535
1826
  */
1536
1827
  Prefix?: string;
1537
1828
  /**
1829
+ * @public
1538
1830
  * <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>
1539
1831
  */
1540
1832
  TemplateType?: string;
@@ -1545,10 +1837,12 @@ export interface ListTemplatesRequest {
1545
1837
  */
1546
1838
  export interface TemplatesResponse {
1547
1839
  /**
1840
+ * @public
1548
1841
  * <p>An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.</p>
1549
1842
  */
1550
1843
  Item: TemplateResponse[] | undefined;
1551
1844
  /**
1845
+ * @public
1552
1846
  * <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>
1553
1847
  */
1554
1848
  NextToken?: string;
@@ -1558,6 +1852,7 @@ export interface TemplatesResponse {
1558
1852
  */
1559
1853
  export interface ListTemplatesResponse {
1560
1854
  /**
1855
+ * @public
1561
1856
  * <p>Provides information about all the message templates that are associated with your Amazon Pinpoint account.</p>
1562
1857
  */
1563
1858
  TemplatesResponse: TemplatesResponse | undefined;
@@ -1567,18 +1862,22 @@ export interface ListTemplatesResponse {
1567
1862
  */
1568
1863
  export interface ListTemplateVersionsRequest {
1569
1864
  /**
1865
+ * @public
1570
1866
  * <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>
1571
1867
  */
1572
1868
  NextToken?: string;
1573
1869
  /**
1870
+ * @public
1574
1871
  * <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>
1575
1872
  */
1576
1873
  PageSize?: string;
1577
1874
  /**
1875
+ * @public
1578
1876
  * <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>
1579
1877
  */
1580
1878
  TemplateName: string | undefined;
1581
1879
  /**
1880
+ * @public
1582
1881
  * <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
1583
1882
  */
1584
1883
  TemplateType: string | undefined;
@@ -1589,18 +1888,22 @@ export interface ListTemplateVersionsRequest {
1589
1888
  */
1590
1889
  export interface TemplateVersionsResponse {
1591
1890
  /**
1891
+ * @public
1592
1892
  * <p>An array of responses, one for each version of the message template.</p>
1593
1893
  */
1594
1894
  Item: TemplateVersionResponse[] | undefined;
1595
1895
  /**
1896
+ * @public
1596
1897
  * <p>The message that's returned from the API for the request to retrieve information about all the versions of the message template.</p>
1597
1898
  */
1598
1899
  Message?: string;
1599
1900
  /**
1901
+ * @public
1600
1902
  * <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>
1601
1903
  */
1602
1904
  NextToken?: string;
1603
1905
  /**
1906
+ * @public
1604
1907
  * <p>The unique identifier for the request to retrieve information about all the versions of the message template.</p>
1605
1908
  */
1606
1909
  RequestID?: string;
@@ -1610,6 +1913,7 @@ export interface TemplateVersionsResponse {
1610
1913
  */
1611
1914
  export interface ListTemplateVersionsResponse {
1612
1915
  /**
1916
+ * @public
1613
1917
  * <p>Provides information about all the versions of a specific message template.</p>
1614
1918
  */
1615
1919
  TemplateVersionsResponse: TemplateVersionsResponse | undefined;
@@ -1620,22 +1924,27 @@ export interface ListTemplateVersionsResponse {
1620
1924
  */
1621
1925
  export interface MessageResult {
1622
1926
  /**
1927
+ * @public
1623
1928
  * <p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>
1624
1929
  */
1625
1930
  DeliveryStatus: DeliveryStatus | string | undefined;
1626
1931
  /**
1932
+ * @public
1627
1933
  * <p>The unique identifier for the message that was sent.</p>
1628
1934
  */
1629
1935
  MessageId?: string;
1630
1936
  /**
1937
+ * @public
1631
1938
  * <p>The downstream service status code for delivering the message.</p>
1632
1939
  */
1633
1940
  StatusCode: number | undefined;
1634
1941
  /**
1942
+ * @public
1635
1943
  * <p>The status message for delivering the message.</p>
1636
1944
  */
1637
1945
  StatusMessage?: string;
1638
1946
  /**
1947
+ * @public
1639
1948
  * <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>
1640
1949
  */
1641
1950
  UpdatedToken?: string;
@@ -1646,26 +1955,32 @@ export interface MessageResult {
1646
1955
  */
1647
1956
  export interface MessageRequest {
1648
1957
  /**
1958
+ * @public
1649
1959
  * <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>
1650
1960
  */
1651
1961
  Addresses?: Record<string, AddressConfiguration>;
1652
1962
  /**
1963
+ * @public
1653
1964
  * <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>
1654
1965
  */
1655
1966
  Context?: Record<string, string>;
1656
1967
  /**
1968
+ * @public
1657
1969
  * <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>
1658
1970
  */
1659
1971
  Endpoints?: Record<string, EndpointSendConfiguration>;
1660
1972
  /**
1973
+ * @public
1661
1974
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
1662
1975
  */
1663
1976
  MessageConfiguration: DirectMessageConfiguration | undefined;
1664
1977
  /**
1978
+ * @public
1665
1979
  * <p>The message template to use for the message.</p>
1666
1980
  */
1667
1981
  TemplateConfiguration?: TemplateConfiguration;
1668
1982
  /**
1983
+ * @public
1669
1984
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
1670
1985
  */
1671
1986
  TraceId?: string;
@@ -1676,18 +1991,22 @@ export interface MessageRequest {
1676
1991
  */
1677
1992
  export interface MessageResponse {
1678
1993
  /**
1994
+ * @public
1679
1995
  * <p>The unique identifier for the application that was used to send the message.</p>
1680
1996
  */
1681
1997
  ApplicationId: string | undefined;
1682
1998
  /**
1999
+ * @public
1683
2000
  * <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>
1684
2001
  */
1685
2002
  EndpointResult?: Record<string, EndpointMessageResult>;
1686
2003
  /**
2004
+ * @public
1687
2005
  * <p>The identifier for the original request that the message was delivered for.</p>
1688
2006
  */
1689
2007
  RequestId?: string;
1690
2008
  /**
2009
+ * @public
1691
2010
  * <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>
1692
2011
  */
1693
2012
  Result?: Record<string, MessageResult>;
@@ -1698,10 +2017,12 @@ export interface MessageResponse {
1698
2017
  */
1699
2018
  export interface NumberValidateRequest {
1700
2019
  /**
2020
+ * @public
1701
2021
  * <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>
1702
2022
  */
1703
2023
  IsoCountryCode?: string;
1704
2024
  /**
2025
+ * @public
1705
2026
  * <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>
1706
2027
  */
1707
2028
  PhoneNumber?: string;
@@ -1712,59 +2033,73 @@ export interface NumberValidateRequest {
1712
2033
  */
1713
2034
  export interface NumberValidateResponse {
1714
2035
  /**
2036
+ * @public
1715
2037
  * <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>
1716
2038
  */
1717
2039
  Carrier?: string;
1718
2040
  /**
2041
+ * @public
1719
2042
  * <p>The name of the city where the phone number was originally registered.</p>
1720
2043
  */
1721
2044
  City?: string;
1722
2045
  /**
2046
+ * @public
1723
2047
  * <p>The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.</p>
1724
2048
  */
1725
2049
  CleansedPhoneNumberE164?: string;
1726
2050
  /**
2051
+ * @public
1727
2052
  * <p>The cleansed phone number, in the format for the location where the phone number was originally registered.</p>
1728
2053
  */
1729
2054
  CleansedPhoneNumberNational?: string;
1730
2055
  /**
2056
+ * @public
1731
2057
  * <p>The name of the country or region where the phone number was originally registered.</p>
1732
2058
  */
1733
2059
  Country?: string;
1734
2060
  /**
2061
+ * @public
1735
2062
  * <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>
1736
2063
  */
1737
2064
  CountryCodeIso2?: string;
1738
2065
  /**
2066
+ * @public
1739
2067
  * <p>The numeric code for the country or region where the phone number was originally registered.</p>
1740
2068
  */
1741
2069
  CountryCodeNumeric?: string;
1742
2070
  /**
2071
+ * @public
1743
2072
  * <p>The name of the county where the phone number was originally registered.</p>
1744
2073
  */
1745
2074
  County?: string;
1746
2075
  /**
2076
+ * @public
1747
2077
  * <p>The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.</p>
1748
2078
  */
1749
2079
  OriginalCountryCodeIso2?: string;
1750
2080
  /**
2081
+ * @public
1751
2082
  * <p>The phone number that was sent in the request body.</p>
1752
2083
  */
1753
2084
  OriginalPhoneNumber?: string;
1754
2085
  /**
2086
+ * @public
1755
2087
  * <p>The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
1756
2088
  * INVALID, PREPAID, and OTHER.</p>
1757
2089
  */
1758
2090
  PhoneType?: string;
1759
2091
  /**
2092
+ * @public
1760
2093
  * <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>
1761
2094
  */
1762
2095
  PhoneTypeCode?: number;
1763
2096
  /**
2097
+ * @public
1764
2098
  * <p>The time zone for the location where the phone number was originally registered.</p>
1765
2099
  */
1766
2100
  Timezone?: string;
1767
2101
  /**
2102
+ * @public
1768
2103
  * <p>The postal or ZIP code for the location where the phone number was originally registered.</p>
1769
2104
  */
1770
2105
  ZipCode?: string;
@@ -1774,6 +2109,7 @@ export interface NumberValidateResponse {
1774
2109
  */
1775
2110
  export interface PhoneNumberValidateRequest {
1776
2111
  /**
2112
+ * @public
1777
2113
  * <p>Specifies a phone number to validate and retrieve information about.</p>
1778
2114
  */
1779
2115
  NumberValidateRequest: NumberValidateRequest | undefined;
@@ -1783,6 +2119,7 @@ export interface PhoneNumberValidateRequest {
1783
2119
  */
1784
2120
  export interface PhoneNumberValidateResponse {
1785
2121
  /**
2122
+ * @public
1786
2123
  * <p>Provides information about a phone number.</p>
1787
2124
  */
1788
2125
  NumberValidateResponse: NumberValidateResponse | undefined;
@@ -1792,10 +2129,12 @@ export interface PhoneNumberValidateResponse {
1792
2129
  */
1793
2130
  export interface PutEventsRequest {
1794
2131
  /**
2132
+ * @public
1795
2133
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1796
2134
  */
1797
2135
  ApplicationId: string | undefined;
1798
2136
  /**
2137
+ * @public
1799
2138
  * <p>Specifies a batch of events to process.</p>
1800
2139
  */
1801
2140
  EventsRequest: EventsRequest | undefined;
@@ -1805,6 +2144,7 @@ export interface PutEventsRequest {
1805
2144
  */
1806
2145
  export interface PutEventsResponse {
1807
2146
  /**
2147
+ * @public
1808
2148
  * <p>Provides information about endpoints and the events that they're associated with.</p>
1809
2149
  */
1810
2150
  EventsResponse: EventsResponse | undefined;
@@ -1815,12 +2155,14 @@ export interface PutEventsResponse {
1815
2155
  */
1816
2156
  export interface WriteEventStream {
1817
2157
  /**
2158
+ * @public
1818
2159
  * <p>The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.</p> <p>For a Kinesis data stream, the ARN format is: arn:aws:kinesis:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:stream/<replaceable>stream_name</replaceable>
1819
2160
  * </p> <p>For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:<replaceable>region</replaceable>:<replaceable>account-id</replaceable>:deliverystream/<replaceable>stream_name</replaceable>
1820
2161
  * </p>
1821
2162
  */
1822
2163
  DestinationStreamArn: string | undefined;
1823
2164
  /**
2165
+ * @public
1824
2166
  * <p>The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.</p>
1825
2167
  */
1826
2168
  RoleArn: string | undefined;
@@ -1830,10 +2172,12 @@ export interface WriteEventStream {
1830
2172
  */
1831
2173
  export interface PutEventStreamRequest {
1832
2174
  /**
2175
+ * @public
1833
2176
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1834
2177
  */
1835
2178
  ApplicationId: string | undefined;
1836
2179
  /**
2180
+ * @public
1837
2181
  * <p>Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.</p>
1838
2182
  */
1839
2183
  WriteEventStream: WriteEventStream | undefined;
@@ -1843,6 +2187,7 @@ export interface PutEventStreamRequest {
1843
2187
  */
1844
2188
  export interface PutEventStreamResponse {
1845
2189
  /**
2190
+ * @public
1846
2191
  * <p>Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.</p>
1847
2192
  */
1848
2193
  EventStream: EventStream | undefined;
@@ -1853,6 +2198,7 @@ export interface PutEventStreamResponse {
1853
2198
  */
1854
2199
  export interface UpdateAttributesRequest {
1855
2200
  /**
2201
+ * @public
1856
2202
  * <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>
1857
2203
  */
1858
2204
  Blacklist?: string[];
@@ -1862,14 +2208,17 @@ export interface UpdateAttributesRequest {
1862
2208
  */
1863
2209
  export interface RemoveAttributesRequest {
1864
2210
  /**
2211
+ * @public
1865
2212
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1866
2213
  */
1867
2214
  ApplicationId: string | undefined;
1868
2215
  /**
2216
+ * @public
1869
2217
  * <p>The type of attribute or attributes to remove. Valid values are:</p> <ul><li><p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li> <li><p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li> <li><p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li></ul>
1870
2218
  */
1871
2219
  AttributeType: string | undefined;
1872
2220
  /**
2221
+ * @public
1873
2222
  * <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
1874
2223
  */
1875
2224
  UpdateAttributesRequest: UpdateAttributesRequest | undefined;
@@ -1879,6 +2228,7 @@ export interface RemoveAttributesRequest {
1879
2228
  */
1880
2229
  export interface RemoveAttributesResponse {
1881
2230
  /**
2231
+ * @public
1882
2232
  * <p>Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.</p>
1883
2233
  */
1884
2234
  AttributesResource: AttributesResource | undefined;
@@ -1888,10 +2238,12 @@ export interface RemoveAttributesResponse {
1888
2238
  */
1889
2239
  export interface SendMessagesRequest {
1890
2240
  /**
2241
+ * @public
1891
2242
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
1892
2243
  */
1893
2244
  ApplicationId: string | undefined;
1894
2245
  /**
2246
+ * @public
1895
2247
  * <p>Specifies the configuration and other settings for a message.</p>
1896
2248
  */
1897
2249
  MessageRequest: MessageRequest | undefined;
@@ -1901,6 +2253,7 @@ export interface SendMessagesRequest {
1901
2253
  */
1902
2254
  export interface SendMessagesResponse {
1903
2255
  /**
2256
+ * @public
1904
2257
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
1905
2258
  */
1906
2259
  MessageResponse: MessageResponse | undefined;
@@ -1911,46 +2264,57 @@ export interface SendMessagesResponse {
1911
2264
  */
1912
2265
  export interface SendOTPMessageRequestParameters {
1913
2266
  /**
2267
+ * @public
1914
2268
  * <p>The attempts allowed to validate an OTP.</p>
1915
2269
  */
1916
2270
  AllowedAttempts?: number;
1917
2271
  /**
2272
+ * @public
1918
2273
  * <p>The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.</p>
1919
2274
  */
1920
2275
  BrandName: string | undefined;
1921
2276
  /**
2277
+ * @public
1922
2278
  * <p>Channel type for the OTP message. Supported values: [SMS].</p>
1923
2279
  */
1924
2280
  Channel: string | undefined;
1925
2281
  /**
2282
+ * @public
1926
2283
  * <p>The number of characters in the generated OTP.</p>
1927
2284
  */
1928
2285
  CodeLength?: number;
1929
2286
  /**
2287
+ * @public
1930
2288
  * <p>The destination identity to send OTP to.</p>
1931
2289
  */
1932
2290
  DestinationIdentity: string | undefined;
1933
2291
  /**
2292
+ * @public
1934
2293
  * <p>A unique Entity ID received from DLT after entity registration is approved.</p>
1935
2294
  */
1936
2295
  EntityId?: string;
1937
2296
  /**
2297
+ * @public
1938
2298
  * <p>The language to be used for the outgoing message body containing the OTP.</p>
1939
2299
  */
1940
2300
  Language?: string;
1941
2301
  /**
2302
+ * @public
1942
2303
  * <p>The origination identity used to send OTP from.</p>
1943
2304
  */
1944
2305
  OriginationIdentity: string | undefined;
1945
2306
  /**
2307
+ * @public
1946
2308
  * <p>Developer-specified reference identifier. Required to match during OTP verification.</p>
1947
2309
  */
1948
2310
  ReferenceId: string | undefined;
1949
2311
  /**
2312
+ * @public
1950
2313
  * <p>A unique Template ID received from DLT after entity registration is approved.</p>
1951
2314
  */
1952
2315
  TemplateId?: string;
1953
2316
  /**
2317
+ * @public
1954
2318
  * <p>The time in minutes before the OTP is no longer valid.</p>
1955
2319
  */
1956
2320
  ValidityPeriod?: number;
@@ -1960,10 +2324,12 @@ export interface SendOTPMessageRequestParameters {
1960
2324
  */
1961
2325
  export interface SendOTPMessageRequest {
1962
2326
  /**
2327
+ * @public
1963
2328
  * <p>The unique ID of your Amazon Pinpoint application.</p>
1964
2329
  */
1965
2330
  ApplicationId: string | undefined;
1966
2331
  /**
2332
+ * @public
1967
2333
  * <p>Send OTP message request parameters.</p>
1968
2334
  */
1969
2335
  SendOTPMessageRequestParameters: SendOTPMessageRequestParameters | undefined;
@@ -1973,6 +2339,7 @@ export interface SendOTPMessageRequest {
1973
2339
  */
1974
2340
  export interface SendOTPMessageResponse {
1975
2341
  /**
2342
+ * @public
1976
2343
  * <p>Provides information about the results of a request to send a message to an endpoint address.</p>
1977
2344
  */
1978
2345
  MessageResponse: MessageResponse | undefined;
@@ -1983,22 +2350,27 @@ export interface SendOTPMessageResponse {
1983
2350
  */
1984
2351
  export interface SendUsersMessageRequest {
1985
2352
  /**
2353
+ * @public
1986
2354
  * <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>
1987
2355
  */
1988
2356
  Context?: Record<string, string>;
1989
2357
  /**
2358
+ * @public
1990
2359
  * <p>The settings and content for the default message and any default messages that you defined for specific channels.</p>
1991
2360
  */
1992
2361
  MessageConfiguration: DirectMessageConfiguration | undefined;
1993
2362
  /**
2363
+ * @public
1994
2364
  * <p>The message template to use for the message.</p>
1995
2365
  */
1996
2366
  TemplateConfiguration?: TemplateConfiguration;
1997
2367
  /**
2368
+ * @public
1998
2369
  * <p>The unique identifier for tracing the message. This identifier is visible to message recipients.</p>
1999
2370
  */
2000
2371
  TraceId?: string;
2001
2372
  /**
2373
+ * @public
2002
2374
  * <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>
2003
2375
  */
2004
2376
  Users: Record<string, EndpointSendConfiguration> | undefined;
@@ -2008,10 +2380,12 @@ export interface SendUsersMessageRequest {
2008
2380
  */
2009
2381
  export interface SendUsersMessagesRequest {
2010
2382
  /**
2383
+ * @public
2011
2384
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2012
2385
  */
2013
2386
  ApplicationId: string | undefined;
2014
2387
  /**
2388
+ * @public
2015
2389
  * <p>Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.</p>
2016
2390
  */
2017
2391
  SendUsersMessageRequest: SendUsersMessageRequest | undefined;
@@ -2022,14 +2396,17 @@ export interface SendUsersMessagesRequest {
2022
2396
  */
2023
2397
  export interface SendUsersMessageResponse {
2024
2398
  /**
2399
+ * @public
2025
2400
  * <p>The unique identifier for the application that was used to send the message.</p>
2026
2401
  */
2027
2402
  ApplicationId: string | undefined;
2028
2403
  /**
2404
+ * @public
2029
2405
  * <p>The unique identifier that was assigned to the message request.</p>
2030
2406
  */
2031
2407
  RequestId?: string;
2032
2408
  /**
2409
+ * @public
2033
2410
  * <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>
2034
2411
  */
2035
2412
  Result?: Record<string, Record<string, EndpointMessageResult>>;
@@ -2039,6 +2416,7 @@ export interface SendUsersMessageResponse {
2039
2416
  */
2040
2417
  export interface SendUsersMessagesResponse {
2041
2418
  /**
2419
+ * @public
2042
2420
  * <p>Provides information about which users and endpoints a message was sent to.</p>
2043
2421
  */
2044
2422
  SendUsersMessageResponse: SendUsersMessageResponse | undefined;
@@ -2048,10 +2426,12 @@ export interface SendUsersMessagesResponse {
2048
2426
  */
2049
2427
  export interface TagResourceRequest {
2050
2428
  /**
2429
+ * @public
2051
2430
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2052
2431
  */
2053
2432
  ResourceArn: string | undefined;
2054
2433
  /**
2434
+ * @public
2055
2435
  * <p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>
2056
2436
  */
2057
2437
  TagsModel: TagsModel | undefined;
@@ -2061,10 +2441,12 @@ export interface TagResourceRequest {
2061
2441
  */
2062
2442
  export interface UntagResourceRequest {
2063
2443
  /**
2444
+ * @public
2064
2445
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
2065
2446
  */
2066
2447
  ResourceArn: string | undefined;
2067
2448
  /**
2449
+ * @public
2068
2450
  * <p>The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&amp;).</p>
2069
2451
  */
2070
2452
  TagKeys: string[] | undefined;
@@ -2074,10 +2456,12 @@ export interface UntagResourceRequest {
2074
2456
  */
2075
2457
  export interface UpdateAdmChannelRequest {
2076
2458
  /**
2459
+ * @public
2077
2460
  * <p>Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
2078
2461
  */
2079
2462
  ADMChannelRequest: ADMChannelRequest | undefined;
2080
2463
  /**
2464
+ * @public
2081
2465
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2082
2466
  */
2083
2467
  ApplicationId: string | undefined;
@@ -2087,6 +2471,7 @@ export interface UpdateAdmChannelRequest {
2087
2471
  */
2088
2472
  export interface UpdateAdmChannelResponse {
2089
2473
  /**
2474
+ * @public
2090
2475
  * <p>Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.</p>
2091
2476
  */
2092
2477
  ADMChannelResponse: ADMChannelResponse | undefined;
@@ -2096,10 +2481,12 @@ export interface UpdateAdmChannelResponse {
2096
2481
  */
2097
2482
  export interface UpdateApnsChannelRequest {
2098
2483
  /**
2484
+ * @public
2099
2485
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
2100
2486
  */
2101
2487
  APNSChannelRequest: APNSChannelRequest | undefined;
2102
2488
  /**
2489
+ * @public
2103
2490
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2104
2491
  */
2105
2492
  ApplicationId: string | undefined;
@@ -2109,6 +2496,7 @@ export interface UpdateApnsChannelRequest {
2109
2496
  */
2110
2497
  export interface UpdateApnsChannelResponse {
2111
2498
  /**
2499
+ * @public
2112
2500
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.</p>
2113
2501
  */
2114
2502
  APNSChannelResponse: APNSChannelResponse | undefined;
@@ -2118,10 +2506,12 @@ export interface UpdateApnsChannelResponse {
2118
2506
  */
2119
2507
  export interface UpdateApnsSandboxChannelRequest {
2120
2508
  /**
2509
+ * @public
2121
2510
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
2122
2511
  */
2123
2512
  APNSSandboxChannelRequest: APNSSandboxChannelRequest | undefined;
2124
2513
  /**
2514
+ * @public
2125
2515
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2126
2516
  */
2127
2517
  ApplicationId: string | undefined;
@@ -2131,6 +2521,7 @@ export interface UpdateApnsSandboxChannelRequest {
2131
2521
  */
2132
2522
  export interface UpdateApnsSandboxChannelResponse {
2133
2523
  /**
2524
+ * @public
2134
2525
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.</p>
2135
2526
  */
2136
2527
  APNSSandboxChannelResponse: APNSSandboxChannelResponse | undefined;
@@ -2140,10 +2531,12 @@ export interface UpdateApnsSandboxChannelResponse {
2140
2531
  */
2141
2532
  export interface UpdateApnsVoipChannelRequest {
2142
2533
  /**
2534
+ * @public
2143
2535
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
2144
2536
  */
2145
2537
  APNSVoipChannelRequest: APNSVoipChannelRequest | undefined;
2146
2538
  /**
2539
+ * @public
2147
2540
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2148
2541
  */
2149
2542
  ApplicationId: string | undefined;
@@ -2153,6 +2546,7 @@ export interface UpdateApnsVoipChannelRequest {
2153
2546
  */
2154
2547
  export interface UpdateApnsVoipChannelResponse {
2155
2548
  /**
2549
+ * @public
2156
2550
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.</p>
2157
2551
  */
2158
2552
  APNSVoipChannelResponse: APNSVoipChannelResponse | undefined;
@@ -2162,10 +2556,12 @@ export interface UpdateApnsVoipChannelResponse {
2162
2556
  */
2163
2557
  export interface UpdateApnsVoipSandboxChannelRequest {
2164
2558
  /**
2559
+ * @public
2165
2560
  * <p>Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
2166
2561
  */
2167
2562
  APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest | undefined;
2168
2563
  /**
2564
+ * @public
2169
2565
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2170
2566
  */
2171
2567
  ApplicationId: string | undefined;
@@ -2175,6 +2571,7 @@ export interface UpdateApnsVoipSandboxChannelRequest {
2175
2571
  */
2176
2572
  export interface UpdateApnsVoipSandboxChannelResponse {
2177
2573
  /**
2574
+ * @public
2178
2575
  * <p>Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.</p>
2179
2576
  */
2180
2577
  APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse | undefined;
@@ -2185,32 +2582,43 @@ export interface UpdateApnsVoipSandboxChannelResponse {
2185
2582
  */
2186
2583
  export interface WriteApplicationSettingsRequest {
2187
2584
  /**
2585
+ * @public
2188
2586
  * <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>
2189
2587
  */
2190
2588
  CampaignHook?: CampaignHook;
2191
2589
  /**
2590
+ * @public
2192
2591
  * <p>Specifies whether to enable application-related alarms in Amazon CloudWatch.</p>
2193
2592
  */
2194
2593
  CloudWatchMetricsEnabled?: boolean;
2195
2594
  EventTaggingEnabled?: boolean;
2196
2595
  /**
2596
+ * @public
2197
2597
  * <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>
2198
2598
  */
2199
2599
  Limits?: CampaignLimits;
2200
2600
  /**
2601
+ * @public
2201
2602
  * <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>
2202
2603
  */
2203
2604
  QuietTime?: QuietTime;
2605
+ /**
2606
+ * @public
2607
+ * <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>
2608
+ */
2609
+ JourneyLimits?: ApplicationSettingsJourneyLimits;
2204
2610
  }
2205
2611
  /**
2206
2612
  * @public
2207
2613
  */
2208
2614
  export interface UpdateApplicationSettingsRequest {
2209
2615
  /**
2616
+ * @public
2210
2617
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2211
2618
  */
2212
2619
  ApplicationId: string | undefined;
2213
2620
  /**
2621
+ * @public
2214
2622
  * <p>Specifies the default settings for an application.</p>
2215
2623
  */
2216
2624
  WriteApplicationSettingsRequest: WriteApplicationSettingsRequest | undefined;
@@ -2220,6 +2628,7 @@ export interface UpdateApplicationSettingsRequest {
2220
2628
  */
2221
2629
  export interface UpdateApplicationSettingsResponse {
2222
2630
  /**
2631
+ * @public
2223
2632
  * <p>Provides information about an application, including the default settings for an application.</p>
2224
2633
  */
2225
2634
  ApplicationSettingsResource: ApplicationSettingsResource | undefined;
@@ -2229,10 +2638,12 @@ export interface UpdateApplicationSettingsResponse {
2229
2638
  */
2230
2639
  export interface UpdateBaiduChannelRequest {
2231
2640
  /**
2641
+ * @public
2232
2642
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2233
2643
  */
2234
2644
  ApplicationId: string | undefined;
2235
2645
  /**
2646
+ * @public
2236
2647
  * <p>Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
2237
2648
  */
2238
2649
  BaiduChannelRequest: BaiduChannelRequest | undefined;
@@ -2242,6 +2653,7 @@ export interface UpdateBaiduChannelRequest {
2242
2653
  */
2243
2654
  export interface UpdateBaiduChannelResponse {
2244
2655
  /**
2656
+ * @public
2245
2657
  * <p>Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.</p>
2246
2658
  */
2247
2659
  BaiduChannelResponse: BaiduChannelResponse | undefined;
@@ -2251,14 +2663,17 @@ export interface UpdateBaiduChannelResponse {
2251
2663
  */
2252
2664
  export interface UpdateCampaignRequest {
2253
2665
  /**
2666
+ * @public
2254
2667
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2255
2668
  */
2256
2669
  ApplicationId: string | undefined;
2257
2670
  /**
2671
+ * @public
2258
2672
  * <p>The unique identifier for the campaign.</p>
2259
2673
  */
2260
2674
  CampaignId: string | undefined;
2261
2675
  /**
2676
+ * @public
2262
2677
  * <p>Specifies the configuration and other settings for a campaign.</p>
2263
2678
  */
2264
2679
  WriteCampaignRequest: WriteCampaignRequest | undefined;
@@ -2268,6 +2683,7 @@ export interface UpdateCampaignRequest {
2268
2683
  */
2269
2684
  export interface UpdateCampaignResponse {
2270
2685
  /**
2686
+ * @public
2271
2687
  * <p>Provides information about the status, configuration, and other settings for a campaign.</p>
2272
2688
  */
2273
2689
  CampaignResponse: CampaignResponse | undefined;
@@ -2277,10 +2693,12 @@ export interface UpdateCampaignResponse {
2277
2693
  */
2278
2694
  export interface UpdateEmailChannelRequest {
2279
2695
  /**
2696
+ * @public
2280
2697
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2281
2698
  */
2282
2699
  ApplicationId: string | undefined;
2283
2700
  /**
2701
+ * @public
2284
2702
  * <p>Specifies the status and settings of the email channel for an application.</p>
2285
2703
  */
2286
2704
  EmailChannelRequest: EmailChannelRequest | undefined;
@@ -2290,6 +2708,7 @@ export interface UpdateEmailChannelRequest {
2290
2708
  */
2291
2709
  export interface UpdateEmailChannelResponse {
2292
2710
  /**
2711
+ * @public
2293
2712
  * <p>Provides information about the status and settings of the email channel for an application.</p>
2294
2713
  */
2295
2714
  EmailChannelResponse: EmailChannelResponse | undefined;
@@ -2299,18 +2718,22 @@ export interface UpdateEmailChannelResponse {
2299
2718
  */
2300
2719
  export interface UpdateEmailTemplateRequest {
2301
2720
  /**
2721
+ * @public
2302
2722
  * <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>
2303
2723
  */
2304
2724
  CreateNewVersion?: boolean;
2305
2725
  /**
2726
+ * @public
2306
2727
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.</p>
2307
2728
  */
2308
2729
  EmailTemplateRequest: EmailTemplateRequest | undefined;
2309
2730
  /**
2731
+ * @public
2310
2732
  * <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>
2311
2733
  */
2312
2734
  TemplateName: string | undefined;
2313
2735
  /**
2736
+ * @public
2314
2737
  * <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>
2315
2738
  */
2316
2739
  Version?: string;
@@ -2320,6 +2743,7 @@ export interface UpdateEmailTemplateRequest {
2320
2743
  */
2321
2744
  export interface UpdateEmailTemplateResponse {
2322
2745
  /**
2746
+ * @public
2323
2747
  * <p>Provides information about an API request or response.</p>
2324
2748
  */
2325
2749
  MessageBody: MessageBody | undefined;
@@ -2329,14 +2753,17 @@ export interface UpdateEmailTemplateResponse {
2329
2753
  */
2330
2754
  export interface UpdateEndpointRequest {
2331
2755
  /**
2756
+ * @public
2332
2757
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2333
2758
  */
2334
2759
  ApplicationId: string | undefined;
2335
2760
  /**
2761
+ * @public
2336
2762
  * <p>The unique identifier for the endpoint.</p>
2337
2763
  */
2338
2764
  EndpointId: string | undefined;
2339
2765
  /**
2766
+ * @public
2340
2767
  * <p>Specifies the channel type and other settings for an endpoint.</p>
2341
2768
  */
2342
2769
  EndpointRequest: EndpointRequest | undefined;
@@ -2346,6 +2773,7 @@ export interface UpdateEndpointRequest {
2346
2773
  */
2347
2774
  export interface UpdateEndpointResponse {
2348
2775
  /**
2776
+ * @public
2349
2777
  * <p>Provides information about an API request or response.</p>
2350
2778
  */
2351
2779
  MessageBody: MessageBody | undefined;
@@ -2355,10 +2783,12 @@ export interface UpdateEndpointResponse {
2355
2783
  */
2356
2784
  export interface UpdateEndpointsBatchRequest {
2357
2785
  /**
2786
+ * @public
2358
2787
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2359
2788
  */
2360
2789
  ApplicationId: string | undefined;
2361
2790
  /**
2791
+ * @public
2362
2792
  * <p>Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.</p>
2363
2793
  */
2364
2794
  EndpointBatchRequest: EndpointBatchRequest | undefined;
@@ -2368,6 +2798,7 @@ export interface UpdateEndpointsBatchRequest {
2368
2798
  */
2369
2799
  export interface UpdateEndpointsBatchResponse {
2370
2800
  /**
2801
+ * @public
2371
2802
  * <p>Provides information about an API request or response.</p>
2372
2803
  */
2373
2804
  MessageBody: MessageBody | undefined;
@@ -2377,10 +2808,12 @@ export interface UpdateEndpointsBatchResponse {
2377
2808
  */
2378
2809
  export interface UpdateGcmChannelRequest {
2379
2810
  /**
2811
+ * @public
2380
2812
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2381
2813
  */
2382
2814
  ApplicationId: string | undefined;
2383
2815
  /**
2816
+ * @public
2384
2817
  * <p>Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
2385
2818
  */
2386
2819
  GCMChannelRequest: GCMChannelRequest | undefined;
@@ -2390,6 +2823,7 @@ export interface UpdateGcmChannelRequest {
2390
2823
  */
2391
2824
  export interface UpdateGcmChannelResponse {
2392
2825
  /**
2826
+ * @public
2393
2827
  * <p>Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.</p>
2394
2828
  */
2395
2829
  GCMChannelResponse: GCMChannelResponse | undefined;
@@ -2399,18 +2833,22 @@ export interface UpdateGcmChannelResponse {
2399
2833
  */
2400
2834
  export interface UpdateInAppTemplateRequest {
2401
2835
  /**
2836
+ * @public
2402
2837
  * <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>
2403
2838
  */
2404
2839
  CreateNewVersion?: boolean;
2405
2840
  /**
2841
+ * @public
2406
2842
  * <p>InApp Template Request.</p>
2407
2843
  */
2408
2844
  InAppTemplateRequest: InAppTemplateRequest | undefined;
2409
2845
  /**
2846
+ * @public
2410
2847
  * <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>
2411
2848
  */
2412
2849
  TemplateName: string | undefined;
2413
2850
  /**
2851
+ * @public
2414
2852
  * <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>
2415
2853
  */
2416
2854
  Version?: string;
@@ -2420,6 +2858,7 @@ export interface UpdateInAppTemplateRequest {
2420
2858
  */
2421
2859
  export interface UpdateInAppTemplateResponse {
2422
2860
  /**
2861
+ * @public
2423
2862
  * <p>Provides information about an API request or response.</p>
2424
2863
  */
2425
2864
  MessageBody: MessageBody | undefined;
@@ -2429,14 +2868,17 @@ export interface UpdateInAppTemplateResponse {
2429
2868
  */
2430
2869
  export interface UpdateJourneyRequest {
2431
2870
  /**
2871
+ * @public
2432
2872
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2433
2873
  */
2434
2874
  ApplicationId: string | undefined;
2435
2875
  /**
2876
+ * @public
2436
2877
  * <p>The unique identifier for the journey.</p>
2437
2878
  */
2438
2879
  JourneyId: string | undefined;
2439
2880
  /**
2881
+ * @public
2440
2882
  * <p>Specifies the configuration and other settings for a journey.</p>
2441
2883
  */
2442
2884
  WriteJourneyRequest: WriteJourneyRequest | undefined;
@@ -2446,6 +2888,7 @@ export interface UpdateJourneyRequest {
2446
2888
  */
2447
2889
  export interface UpdateJourneyResponse {
2448
2890
  /**
2891
+ * @public
2449
2892
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
2450
2893
  */
2451
2894
  JourneyResponse: JourneyResponse | undefined;
@@ -2455,14 +2898,17 @@ export interface UpdateJourneyResponse {
2455
2898
  */
2456
2899
  export interface UpdateJourneyStateRequest {
2457
2900
  /**
2901
+ * @public
2458
2902
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2459
2903
  */
2460
2904
  ApplicationId: string | undefined;
2461
2905
  /**
2906
+ * @public
2462
2907
  * <p>The unique identifier for the journey.</p>
2463
2908
  */
2464
2909
  JourneyId: string | undefined;
2465
2910
  /**
2911
+ * @public
2466
2912
  * <p>Changes the status of a journey.</p>
2467
2913
  */
2468
2914
  JourneyStateRequest: JourneyStateRequest | undefined;
@@ -2472,6 +2918,7 @@ export interface UpdateJourneyStateRequest {
2472
2918
  */
2473
2919
  export interface UpdateJourneyStateResponse {
2474
2920
  /**
2921
+ * @public
2475
2922
  * <p>Provides information about the status, configuration, and other settings for a journey.</p>
2476
2923
  */
2477
2924
  JourneyResponse: JourneyResponse | undefined;
@@ -2481,18 +2928,22 @@ export interface UpdateJourneyStateResponse {
2481
2928
  */
2482
2929
  export interface UpdatePushTemplateRequest {
2483
2930
  /**
2931
+ * @public
2484
2932
  * <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>
2485
2933
  */
2486
2934
  CreateNewVersion?: boolean;
2487
2935
  /**
2936
+ * @public
2488
2937
  * <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>
2489
2938
  */
2490
2939
  PushNotificationTemplateRequest: PushNotificationTemplateRequest | undefined;
2491
2940
  /**
2941
+ * @public
2492
2942
  * <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>
2493
2943
  */
2494
2944
  TemplateName: string | undefined;
2495
2945
  /**
2946
+ * @public
2496
2947
  * <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>
2497
2948
  */
2498
2949
  Version?: string;
@@ -2502,6 +2953,7 @@ export interface UpdatePushTemplateRequest {
2502
2953
  */
2503
2954
  export interface UpdatePushTemplateResponse {
2504
2955
  /**
2956
+ * @public
2505
2957
  * <p>Provides information about an API request or response.</p>
2506
2958
  */
2507
2959
  MessageBody: MessageBody | undefined;
@@ -2512,38 +2964,47 @@ export interface UpdatePushTemplateResponse {
2512
2964
  */
2513
2965
  export interface UpdateRecommenderConfigurationShape {
2514
2966
  /**
2967
+ * @public
2515
2968
  * <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>
2516
2969
  */
2517
2970
  Attributes?: Record<string, string>;
2518
2971
  /**
2972
+ * @public
2519
2973
  * <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>
2520
2974
  */
2521
2975
  Description?: string;
2522
2976
  /**
2977
+ * @public
2523
2978
  * <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>
2524
2979
  */
2525
2980
  Name?: string;
2526
2981
  /**
2982
+ * @public
2527
2983
  * <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>
2528
2984
  */
2529
2985
  RecommendationProviderIdType?: string;
2530
2986
  /**
2987
+ * @public
2531
2988
  * <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>
2532
2989
  */
2533
2990
  RecommendationProviderRoleArn: string | undefined;
2534
2991
  /**
2992
+ * @public
2535
2993
  * <p>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</p>
2536
2994
  */
2537
2995
  RecommendationProviderUri: string | undefined;
2538
2996
  /**
2997
+ * @public
2539
2998
  * <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>
2540
2999
  */
2541
3000
  RecommendationTransformerUri?: string;
2542
3001
  /**
3002
+ * @public
2543
3003
  * <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>
2544
3004
  */
2545
3005
  RecommendationsDisplayName?: string;
2546
3006
  /**
3007
+ * @public
2547
3008
  * <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>
2548
3009
  */
2549
3010
  RecommendationsPerMessage?: number;
@@ -2553,10 +3014,12 @@ export interface UpdateRecommenderConfigurationShape {
2553
3014
  */
2554
3015
  export interface UpdateRecommenderConfigurationRequest {
2555
3016
  /**
3017
+ * @public
2556
3018
  * <p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>
2557
3019
  */
2558
3020
  RecommenderId: string | undefined;
2559
3021
  /**
3022
+ * @public
2560
3023
  * <p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>
2561
3024
  */
2562
3025
  UpdateRecommenderConfiguration: UpdateRecommenderConfigurationShape | undefined;
@@ -2566,6 +3029,7 @@ export interface UpdateRecommenderConfigurationRequest {
2566
3029
  */
2567
3030
  export interface UpdateRecommenderConfigurationResponse {
2568
3031
  /**
3032
+ * @public
2569
3033
  * <p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>
2570
3034
  */
2571
3035
  RecommenderConfigurationResponse: RecommenderConfigurationResponse | undefined;
@@ -2575,14 +3039,17 @@ export interface UpdateRecommenderConfigurationResponse {
2575
3039
  */
2576
3040
  export interface UpdateSegmentRequest {
2577
3041
  /**
3042
+ * @public
2578
3043
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2579
3044
  */
2580
3045
  ApplicationId: string | undefined;
2581
3046
  /**
3047
+ * @public
2582
3048
  * <p>The unique identifier for the segment.</p>
2583
3049
  */
2584
3050
  SegmentId: string | undefined;
2585
3051
  /**
3052
+ * @public
2586
3053
  * <p>Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.</p>
2587
3054
  */
2588
3055
  WriteSegmentRequest: WriteSegmentRequest | undefined;
@@ -2592,6 +3059,7 @@ export interface UpdateSegmentRequest {
2592
3059
  */
2593
3060
  export interface UpdateSegmentResponse {
2594
3061
  /**
3062
+ * @public
2595
3063
  * <p>Provides information about the configuration, dimension, and other settings for a segment.</p>
2596
3064
  */
2597
3065
  SegmentResponse: SegmentResponse | undefined;
@@ -2602,14 +3070,17 @@ export interface UpdateSegmentResponse {
2602
3070
  */
2603
3071
  export interface SMSChannelRequest {
2604
3072
  /**
3073
+ * @public
2605
3074
  * <p>Specifies whether to enable the SMS channel for the application.</p>
2606
3075
  */
2607
3076
  Enabled?: boolean;
2608
3077
  /**
3078
+ * @public
2609
3079
  * <p>The identity that you want to display on recipients' devices when they receive messages from the SMS channel.</p>
2610
3080
  */
2611
3081
  SenderId?: string;
2612
3082
  /**
3083
+ * @public
2613
3084
  * <p>The registered short code that you want to use when you send messages through the SMS channel.</p>
2614
3085
  */
2615
3086
  ShortCode?: string;
@@ -2619,10 +3090,12 @@ export interface SMSChannelRequest {
2619
3090
  */
2620
3091
  export interface UpdateSmsChannelRequest {
2621
3092
  /**
3093
+ * @public
2622
3094
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2623
3095
  */
2624
3096
  ApplicationId: string | undefined;
2625
3097
  /**
3098
+ * @public
2626
3099
  * <p>Specifies the status and settings of the SMS channel for an application.</p>
2627
3100
  */
2628
3101
  SMSChannelRequest: SMSChannelRequest | undefined;
@@ -2632,6 +3105,7 @@ export interface UpdateSmsChannelRequest {
2632
3105
  */
2633
3106
  export interface UpdateSmsChannelResponse {
2634
3107
  /**
3108
+ * @public
2635
3109
  * <p>Provides information about the status and settings of the SMS channel for an application.</p>
2636
3110
  */
2637
3111
  SMSChannelResponse: SMSChannelResponse | undefined;
@@ -2641,18 +3115,22 @@ export interface UpdateSmsChannelResponse {
2641
3115
  */
2642
3116
  export interface UpdateSmsTemplateRequest {
2643
3117
  /**
3118
+ * @public
2644
3119
  * <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>
2645
3120
  */
2646
3121
  CreateNewVersion?: boolean;
2647
3122
  /**
3123
+ * @public
2648
3124
  * <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>
2649
3125
  */
2650
3126
  SMSTemplateRequest: SMSTemplateRequest | undefined;
2651
3127
  /**
3128
+ * @public
2652
3129
  * <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>
2653
3130
  */
2654
3131
  TemplateName: string | undefined;
2655
3132
  /**
3133
+ * @public
2656
3134
  * <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>
2657
3135
  */
2658
3136
  Version?: string;
@@ -2662,6 +3140,7 @@ export interface UpdateSmsTemplateRequest {
2662
3140
  */
2663
3141
  export interface UpdateSmsTemplateResponse {
2664
3142
  /**
3143
+ * @public
2665
3144
  * <p>Provides information about an API request or response.</p>
2666
3145
  */
2667
3146
  MessageBody: MessageBody | undefined;
@@ -2672,6 +3151,7 @@ export interface UpdateSmsTemplateResponse {
2672
3151
  */
2673
3152
  export interface TemplateActiveVersionRequest {
2674
3153
  /**
3154
+ * @public
2675
3155
  * <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>
2676
3156
  */
2677
3157
  Version?: string;
@@ -2681,14 +3161,17 @@ export interface TemplateActiveVersionRequest {
2681
3161
  */
2682
3162
  export interface UpdateTemplateActiveVersionRequest {
2683
3163
  /**
3164
+ * @public
2684
3165
  * <p>Specifies which version of a message template to use as the active version of the template.</p>
2685
3166
  */
2686
3167
  TemplateActiveVersionRequest: TemplateActiveVersionRequest | undefined;
2687
3168
  /**
3169
+ * @public
2688
3170
  * <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>
2689
3171
  */
2690
3172
  TemplateName: string | undefined;
2691
3173
  /**
3174
+ * @public
2692
3175
  * <p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>
2693
3176
  */
2694
3177
  TemplateType: string | undefined;
@@ -2698,6 +3181,7 @@ export interface UpdateTemplateActiveVersionRequest {
2698
3181
  */
2699
3182
  export interface UpdateTemplateActiveVersionResponse {
2700
3183
  /**
3184
+ * @public
2701
3185
  * <p>Provides information about an API request or response.</p>
2702
3186
  */
2703
3187
  MessageBody: MessageBody | undefined;
@@ -2708,6 +3192,7 @@ export interface UpdateTemplateActiveVersionResponse {
2708
3192
  */
2709
3193
  export interface VoiceChannelRequest {
2710
3194
  /**
3195
+ * @public
2711
3196
  * <p>Specifies whether to enable the voice channel for the application.</p>
2712
3197
  */
2713
3198
  Enabled?: boolean;
@@ -2717,10 +3202,12 @@ export interface VoiceChannelRequest {
2717
3202
  */
2718
3203
  export interface UpdateVoiceChannelRequest {
2719
3204
  /**
3205
+ * @public
2720
3206
  * <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
2721
3207
  */
2722
3208
  ApplicationId: string | undefined;
2723
3209
  /**
3210
+ * @public
2724
3211
  * <p>Specifies the status and settings of the voice channel for an application.</p>
2725
3212
  */
2726
3213
  VoiceChannelRequest: VoiceChannelRequest | undefined;
@@ -2730,6 +3217,7 @@ export interface UpdateVoiceChannelRequest {
2730
3217
  */
2731
3218
  export interface UpdateVoiceChannelResponse {
2732
3219
  /**
3220
+ * @public
2733
3221
  * <p>Provides information about the status and settings of the voice channel for an application.</p>
2734
3222
  */
2735
3223
  VoiceChannelResponse: VoiceChannelResponse | undefined;
@@ -2739,18 +3227,22 @@ export interface UpdateVoiceChannelResponse {
2739
3227
  */
2740
3228
  export interface UpdateVoiceTemplateRequest {
2741
3229
  /**
3230
+ * @public
2742
3231
  * <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>
2743
3232
  */
2744
3233
  CreateNewVersion?: boolean;
2745
3234
  /**
3235
+ * @public
2746
3236
  * <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>
2747
3237
  */
2748
3238
  TemplateName: string | undefined;
2749
3239
  /**
3240
+ * @public
2750
3241
  * <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>
2751
3242
  */
2752
3243
  Version?: string;
2753
3244
  /**
3245
+ * @public
2754
3246
  * <p>Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.</p>
2755
3247
  */
2756
3248
  VoiceTemplateRequest: VoiceTemplateRequest | undefined;
@@ -2760,6 +3252,7 @@ export interface UpdateVoiceTemplateRequest {
2760
3252
  */
2761
3253
  export interface UpdateVoiceTemplateResponse {
2762
3254
  /**
3255
+ * @public
2763
3256
  * <p>Provides information about an API request or response.</p>
2764
3257
  */
2765
3258
  MessageBody: MessageBody | undefined;
@@ -2770,14 +3263,17 @@ export interface UpdateVoiceTemplateResponse {
2770
3263
  */
2771
3264
  export interface VerifyOTPMessageRequestParameters {
2772
3265
  /**
3266
+ * @public
2773
3267
  * <p>The destination identity to send OTP to.</p>
2774
3268
  */
2775
3269
  DestinationIdentity: string | undefined;
2776
3270
  /**
3271
+ * @public
2777
3272
  * <p>The OTP the end user provided for verification.</p>
2778
3273
  */
2779
3274
  Otp: string | undefined;
2780
3275
  /**
3276
+ * @public
2781
3277
  * <p>The reference identifier provided when the OTP was previously sent.</p>
2782
3278
  */
2783
3279
  ReferenceId: string | undefined;
@@ -2787,10 +3283,12 @@ export interface VerifyOTPMessageRequestParameters {
2787
3283
  */
2788
3284
  export interface VerifyOTPMessageRequest {
2789
3285
  /**
3286
+ * @public
2790
3287
  * <p>The unique ID of your Amazon Pinpoint application.</p>
2791
3288
  */
2792
3289
  ApplicationId: string | undefined;
2793
3290
  /**
3291
+ * @public
2794
3292
  * <p>Verify OTP message request.</p>
2795
3293
  */
2796
3294
  VerifyOTPMessageRequestParameters: VerifyOTPMessageRequestParameters | undefined;
@@ -2801,6 +3299,7 @@ export interface VerifyOTPMessageRequest {
2801
3299
  */
2802
3300
  export interface VerificationResponse {
2803
3301
  /**
3302
+ * @public
2804
3303
  * <p>Specifies whether the OTP is valid or not.</p>
2805
3304
  */
2806
3305
  Valid?: boolean;
@@ -2810,6 +3309,7 @@ export interface VerificationResponse {
2810
3309
  */
2811
3310
  export interface VerifyOTPMessageResponse {
2812
3311
  /**
3312
+ * @public
2813
3313
  * <p>Verify OTP Message Response.</p>
2814
3314
  */
2815
3315
  VerificationResponse: VerificationResponse | undefined;