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