@aws-sdk/client-chime-sdk-identity 3.529.1 → 3.535.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/dist-types/ChimeSDKIdentity.d.ts +2 -1
  2. package/dist-types/ChimeSDKIdentityClient.d.ts +1 -1
  3. package/dist-types/commands/CreateAppInstanceAdminCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateAppInstanceBotCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateAppInstanceCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateAppInstanceUserCommand.d.ts +2 -1
  7. package/dist-types/commands/DeleteAppInstanceAdminCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteAppInstanceBotCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteAppInstanceCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteAppInstanceUserCommand.d.ts +2 -1
  11. package/dist-types/commands/DeregisterAppInstanceUserEndpointCommand.d.ts +2 -1
  12. package/dist-types/commands/DescribeAppInstanceAdminCommand.d.ts +2 -1
  13. package/dist-types/commands/DescribeAppInstanceBotCommand.d.ts +2 -1
  14. package/dist-types/commands/DescribeAppInstanceCommand.d.ts +2 -1
  15. package/dist-types/commands/DescribeAppInstanceUserCommand.d.ts +2 -1
  16. package/dist-types/commands/DescribeAppInstanceUserEndpointCommand.d.ts +2 -1
  17. package/dist-types/commands/GetAppInstanceRetentionSettingsCommand.d.ts +2 -1
  18. package/dist-types/commands/ListAppInstanceAdminsCommand.d.ts +2 -1
  19. package/dist-types/commands/ListAppInstanceBotsCommand.d.ts +2 -1
  20. package/dist-types/commands/ListAppInstanceUserEndpointsCommand.d.ts +2 -1
  21. package/dist-types/commands/ListAppInstanceUsersCommand.d.ts +2 -1
  22. package/dist-types/commands/ListAppInstancesCommand.d.ts +2 -1
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  24. package/dist-types/commands/PutAppInstanceRetentionSettingsCommand.d.ts +2 -1
  25. package/dist-types/commands/PutAppInstanceUserExpirationSettingsCommand.d.ts +2 -1
  26. package/dist-types/commands/RegisterAppInstanceUserEndpointCommand.d.ts +2 -1
  27. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  28. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  29. package/dist-types/commands/UpdateAppInstanceBotCommand.d.ts +2 -1
  30. package/dist-types/commands/UpdateAppInstanceCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateAppInstanceUserCommand.d.ts +2 -1
  32. package/dist-types/commands/UpdateAppInstanceUserEndpointCommand.d.ts +2 -1
  33. package/dist-types/models/models_0.d.ts +210 -210
  34. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  35. package/dist-types/runtimeConfig.d.ts +2 -2
  36. package/dist-types/runtimeConfig.native.d.ts +2 -2
  37. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  38. package/dist-types/ts3.4/ChimeSDKIdentity.d.ts +1 -0
  39. package/dist-types/ts3.4/commands/CreateAppInstanceAdminCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/CreateAppInstanceBotCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/CreateAppInstanceCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/CreateAppInstanceUserCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/DeleteAppInstanceAdminCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/DeleteAppInstanceBotCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/DeleteAppInstanceCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/DeleteAppInstanceUserCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/DeregisterAppInstanceUserEndpointCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DescribeAppInstanceAdminCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/DescribeAppInstanceBotCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/DescribeAppInstanceCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/DescribeAppInstanceUserCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/DescribeAppInstanceUserEndpointCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/GetAppInstanceRetentionSettingsCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/ListAppInstanceAdminsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/ListAppInstanceBotsCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/ListAppInstanceUserEndpointsCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/ListAppInstanceUsersCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/ListAppInstancesCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/PutAppInstanceRetentionSettingsCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/PutAppInstanceUserExpirationSettingsCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/RegisterAppInstanceUserEndpointCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/UpdateAppInstanceBotCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/UpdateAppInstanceCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/UpdateAppInstanceUserCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/UpdateAppInstanceUserEndpointCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  70. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  71. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  72. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  73. package/package.json +40 -40
@@ -13,82 +13,82 @@ export declare const AllowMessages: {
13
13
  */
14
14
  export type AllowMessages = (typeof AllowMessages)[keyof typeof AllowMessages];
15
15
  /**
16
- * @public
17
16
  * <p>The details of an <code>AppInstance</code>, an instance of an Amazon Chime SDK messaging
18
17
  * application.</p>
18
+ * @public
19
19
  */
20
20
  export interface AppInstance {
21
21
  /**
22
- * @public
23
22
  * <p>The ARN of the messaging instance.</p>
23
+ * @public
24
24
  */
25
25
  AppInstanceArn?: string;
26
26
  /**
27
- * @public
28
27
  * <p>The name of an <code>AppInstance</code>.</p>
28
+ * @public
29
29
  */
30
30
  Name?: string;
31
31
  /**
32
- * @public
33
32
  * <p>The time at which an <code>AppInstance</code> was created. In epoch milliseconds.</p>
33
+ * @public
34
34
  */
35
35
  CreatedTimestamp?: Date;
36
36
  /**
37
- * @public
38
37
  * <p>The time an <code>AppInstance</code> was last updated. In epoch milliseconds.</p>
38
+ * @public
39
39
  */
40
40
  LastUpdatedTimestamp?: Date;
41
41
  /**
42
- * @public
43
42
  * <p>The metadata of an <code>AppInstance</code>.</p>
43
+ * @public
44
44
  */
45
45
  Metadata?: string;
46
46
  }
47
47
  /**
48
- * @public
49
48
  * <p>The details of a user or bot.</p>
49
+ * @public
50
50
  */
51
51
  export interface Identity {
52
52
  /**
53
- * @public
54
53
  * <p>The ARN in an Identity.</p>
54
+ * @public
55
55
  */
56
56
  Arn?: string;
57
57
  /**
58
- * @public
59
58
  * <p>The name in an Identity.</p>
59
+ * @public
60
60
  */
61
61
  Name?: string;
62
62
  }
63
63
  /**
64
- * @public
65
64
  * <p>The name and ARN of the admin for the <code>AppInstance</code>.</p>
65
+ * @public
66
66
  */
67
67
  export interface AppInstanceAdmin {
68
68
  /**
69
- * @public
70
69
  * <p>The <code>AppInstanceAdmin</code> data.</p>
70
+ * @public
71
71
  */
72
72
  Admin?: Identity;
73
73
  /**
74
- * @public
75
74
  * <p>The ARN of the <code>AppInstance</code> for which the user is an administrator.</p>
75
+ * @public
76
76
  */
77
77
  AppInstanceArn?: string;
78
78
  /**
79
- * @public
80
79
  * <p>The time at which an administrator was created.</p>
80
+ * @public
81
81
  */
82
82
  CreatedTimestamp?: Date;
83
83
  }
84
84
  /**
85
- * @public
86
85
  * <p>Summary of the details of an <code>AppInstanceAdmin</code>.</p>
86
+ * @public
87
87
  */
88
88
  export interface AppInstanceAdminSummary {
89
89
  /**
90
- * @public
91
90
  * <p>The details of the <code>AppInstanceAdmin</code>.</p>
91
+ * @public
92
92
  */
93
93
  Admin?: Identity;
94
94
  }
@@ -119,12 +119,11 @@ export declare const TargetedMessages: {
119
119
  */
120
120
  export type TargetedMessages = (typeof TargetedMessages)[keyof typeof TargetedMessages];
121
121
  /**
122
- * @public
123
122
  * <p>Specifies the type of message that triggers a bot.</p>
123
+ * @public
124
124
  */
125
125
  export interface InvokedBy {
126
126
  /**
127
- * @public
128
127
  * <p>Sets standard messages as the bot trigger. For standard messages:</p>
129
128
  * <ul>
130
129
  * <li>
@@ -146,10 +145,10 @@ export interface InvokedBy {
146
145
  * <code>NONE</code>: The bot processes no standard messages.</p>
147
146
  * </li>
148
147
  * </ul>
148
+ * @public
149
149
  */
150
150
  StandardMessages: StandardMessages | undefined;
151
151
  /**
152
- * @public
153
152
  * <p>Sets targeted messages as the bot trigger. For targeted messages:</p>
154
153
  * <ul>
155
154
  * <li>
@@ -162,6 +161,7 @@ export interface InvokedBy {
162
161
  * <code>NONE</code>: The bot processes no targeted messages.</p>
163
162
  * </li>
164
163
  * </ul>
164
+ * @public
165
165
  */
166
166
  TargetedMessages: TargetedMessages | undefined;
167
167
  }
@@ -177,152 +177,152 @@ export declare const RespondsTo: {
177
177
  */
178
178
  export type RespondsTo = (typeof RespondsTo)[keyof typeof RespondsTo];
179
179
  /**
180
- * @public
181
180
  * <p>The configuration for an Amazon Lex V2 bot.</p>
181
+ * @public
182
182
  */
183
183
  export interface LexConfiguration {
184
184
  /**
185
- * @public
186
185
  * <important>
187
186
  * <p>
188
187
  * <b>Deprecated</b>. Use <code>InvokedBy</code> instead.</p>
189
188
  * </important>
190
189
  * <p>Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.</p>
190
+ * @public
191
191
  */
192
192
  RespondsTo?: RespondsTo;
193
193
  /**
194
- * @public
195
194
  * <p>Specifies the type of message that triggers a bot.</p>
195
+ * @public
196
196
  */
197
197
  InvokedBy?: InvokedBy;
198
198
  /**
199
- * @public
200
199
  * <p>The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format:
201
200
  * <code>arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS</code>
202
201
  * </p>
202
+ * @public
203
203
  */
204
204
  LexBotAliasArn: string | undefined;
205
205
  /**
206
- * @public
207
206
  * <p>Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the
208
207
  * supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same
209
208
  * locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a> in the <i>Amazon Lex V2 Developer Guide</i>.</p>
209
+ * @public
210
210
  */
211
211
  LocaleId: string | undefined;
212
212
  /**
213
- * @public
214
213
  * <p>The name of the welcome intent configured in the Amazon Lex V2 bot.</p>
214
+ * @public
215
215
  */
216
216
  WelcomeIntent?: string;
217
217
  }
218
218
  /**
219
- * @public
220
219
  * <p>A structure that contains configuration data.</p>
220
+ * @public
221
221
  */
222
222
  export interface Configuration {
223
223
  /**
224
- * @public
225
224
  * <p>The configuration for an Amazon Lex V2 bot.</p>
225
+ * @public
226
226
  */
227
227
  Lex: LexConfiguration | undefined;
228
228
  }
229
229
  /**
230
- * @public
231
230
  * <p>An Amazon Lex V2 chat bot created under an <code>AppInstance</code>.</p>
231
+ * @public
232
232
  */
233
233
  export interface AppInstanceBot {
234
234
  /**
235
- * @public
236
235
  * <p>The ARN of the AppInstanceBot.</p>
236
+ * @public
237
237
  */
238
238
  AppInstanceBotArn?: string;
239
239
  /**
240
- * @public
241
240
  * <p>The name of the AppInstanceBot.</p>
241
+ * @public
242
242
  */
243
243
  Name?: string;
244
244
  /**
245
- * @public
246
245
  * <p>The data processing instructions for an AppInstanceBot.</p>
246
+ * @public
247
247
  */
248
248
  Configuration?: Configuration;
249
249
  /**
250
- * @public
251
250
  * <p>The time at which the <code>AppInstanceBot</code> was created.</p>
251
+ * @public
252
252
  */
253
253
  CreatedTimestamp?: Date;
254
254
  /**
255
- * @public
256
255
  * <p>The time at which the <code>AppInstanceBot</code> was last updated.</p>
256
+ * @public
257
257
  */
258
258
  LastUpdatedTimestamp?: Date;
259
259
  /**
260
- * @public
261
260
  * <p>The metadata for an AppInstanceBot.</p>
261
+ * @public
262
262
  */
263
263
  Metadata?: string;
264
264
  }
265
265
  /**
266
- * @public
267
266
  * <p>High-level information about an AppInstanceBot.</p>
267
+ * @public
268
268
  */
269
269
  export interface AppInstanceBotSummary {
270
270
  /**
271
- * @public
272
271
  * <p>The ARN of the AppInstanceBot.</p>
272
+ * @public
273
273
  */
274
274
  AppInstanceBotArn?: string;
275
275
  /**
276
- * @public
277
276
  * <p>The name of the AppInstanceBox.</p>
277
+ * @public
278
278
  */
279
279
  Name?: string;
280
280
  /**
281
- * @public
282
281
  * <p>The metadata of the AppInstanceBot.</p>
282
+ * @public
283
283
  */
284
284
  Metadata?: string;
285
285
  }
286
286
  /**
287
- * @public
288
287
  * <p>Summary of the data for an <code>AppInstance</code>.</p>
288
+ * @public
289
289
  */
290
290
  export interface AppInstanceSummary {
291
291
  /**
292
- * @public
293
292
  * <p>The <code>AppInstance</code> ARN.</p>
293
+ * @public
294
294
  */
295
295
  AppInstanceArn?: string;
296
296
  /**
297
- * @public
298
297
  * <p>The name of the <code>AppInstance</code>.</p>
298
+ * @public
299
299
  */
300
300
  Name?: string;
301
301
  /**
302
- * @public
303
302
  * <p>The metadata of the <code>AppInstance</code>.</p>
303
+ * @public
304
304
  */
305
305
  Metadata?: string;
306
306
  }
307
307
  /**
308
- * @public
309
308
  * <p>The details of the retention settings for a channel.</p>
309
+ * @public
310
310
  */
311
311
  export interface ChannelRetentionSettings {
312
312
  /**
313
- * @public
314
313
  * <p>The time in days to retain the messages in a channel.</p>
314
+ * @public
315
315
  */
316
316
  RetentionDays?: number;
317
317
  }
318
318
  /**
319
- * @public
320
319
  * <p>The details of the data-retention settings for an <code>AppInstance</code>.</p>
320
+ * @public
321
321
  */
322
322
  export interface AppInstanceRetentionSettings {
323
323
  /**
324
- * @public
325
324
  * <p>The length of time in days to retain the messages in a channel.</p>
325
+ * @public
326
326
  */
327
327
  ChannelRetentionSettings?: ChannelRetentionSettings;
328
328
  }
@@ -338,70 +338,70 @@ export declare const ExpirationCriterion: {
338
338
  */
339
339
  export type ExpirationCriterion = (typeof ExpirationCriterion)[keyof typeof ExpirationCriterion];
340
340
  /**
341
- * @public
342
341
  * <p>Determines the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
342
+ * @public
343
343
  */
344
344
  export interface ExpirationSettings {
345
345
  /**
346
- * @public
347
346
  * <p>The period in days after which an <code>AppInstanceUser</code> will be automatically deleted.</p>
347
+ * @public
348
348
  */
349
349
  ExpirationDays: number | undefined;
350
350
  /**
351
- * @public
352
351
  * <p>Specifies the conditions under which an <code>AppInstanceUser</code> will expire.</p>
352
+ * @public
353
353
  */
354
354
  ExpirationCriterion: ExpirationCriterion | undefined;
355
355
  }
356
356
  /**
357
- * @public
358
357
  * <p>The details of an <code>AppInstanceUser</code>.</p>
358
+ * @public
359
359
  */
360
360
  export interface AppInstanceUser {
361
361
  /**
362
- * @public
363
362
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
363
+ * @public
364
364
  */
365
365
  AppInstanceUserArn?: string;
366
366
  /**
367
- * @public
368
367
  * <p>The name of the <code>AppInstanceUser</code>.</p>
368
+ * @public
369
369
  */
370
370
  Name?: string;
371
371
  /**
372
- * @public
373
372
  * <p>The metadata of the <code>AppInstanceUser</code>.</p>
373
+ * @public
374
374
  */
375
375
  Metadata?: string;
376
376
  /**
377
- * @public
378
377
  * <p>The time at which the <code>AppInstanceUser</code> was created.</p>
378
+ * @public
379
379
  */
380
380
  CreatedTimestamp?: Date;
381
381
  /**
382
- * @public
383
382
  * <p>The time at which the <code>AppInstanceUser</code> was last updated.</p>
383
+ * @public
384
384
  */
385
385
  LastUpdatedTimestamp?: Date;
386
386
  /**
387
- * @public
388
387
  * <p>The interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
388
+ * @public
389
389
  */
390
390
  ExpirationSettings?: ExpirationSettings;
391
391
  }
392
392
  /**
393
- * @public
394
393
  * <p>The attributes of an <code>Endpoint</code>.</p>
394
+ * @public
395
395
  */
396
396
  export interface EndpointAttributes {
397
397
  /**
398
- * @public
399
398
  * <p>The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.</p>
399
+ * @public
400
400
  */
401
401
  DeviceToken: string | undefined;
402
402
  /**
403
- * @public
404
403
  * <p>The VOIP device token for the APNS and APNS_SANDBOX endpoint types.</p>
404
+ * @public
405
405
  */
406
406
  VoipDeviceToken?: string;
407
407
  }
@@ -430,7 +430,6 @@ export declare const EndpointStatusReason: {
430
430
  */
431
431
  export type EndpointStatusReason = (typeof EndpointStatusReason)[keyof typeof EndpointStatusReason];
432
432
  /**
433
- * @public
434
433
  * <p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p>
435
434
  * <ul>
436
435
  * <li>
@@ -452,16 +451,17 @@ export type EndpointStatusReason = (typeof EndpointStatusReason)[keyof typeof En
452
451
  * <code>INVALID_PINPOINT_ARN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to an invalid pinpoint ARN that was input through the <code>ResourceArn</code> field.</p>
453
452
  * </li>
454
453
  * </ul>
454
+ * @public
455
455
  */
456
456
  export interface EndpointState {
457
457
  /**
458
- * @public
459
458
  * <p>Enum that indicates the Status of an <code>AppInstanceUserEndpoint</code>.</p>
459
+ * @public
460
460
  */
461
461
  Status: EndpointStatus | undefined;
462
462
  /**
463
- * @public
464
463
  * <p>The reason for the <code>EndpointStatus</code>.</p>
464
+ * @public
465
465
  */
466
466
  StatusReason?: EndpointStatusReason;
467
467
  }
@@ -479,58 +479,57 @@ export declare const AppInstanceUserEndpointType: {
479
479
  */
480
480
  export type AppInstanceUserEndpointType = (typeof AppInstanceUserEndpointType)[keyof typeof AppInstanceUserEndpointType];
481
481
  /**
482
- * @public
483
482
  * <p>An endpoint under an Amazon Chime <code>AppInstanceUser</code> that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.</p>
483
+ * @public
484
484
  */
485
485
  export interface AppInstanceUserEndpoint {
486
486
  /**
487
- * @public
488
487
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
488
+ * @public
489
489
  */
490
490
  AppInstanceUserArn?: string;
491
491
  /**
492
- * @public
493
492
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
493
+ * @public
494
494
  */
495
495
  EndpointId?: string;
496
496
  /**
497
- * @public
498
497
  * <p>The name of the <code>AppInstanceUserEndpoint</code>.</p>
498
+ * @public
499
499
  */
500
500
  Name?: string;
501
501
  /**
502
- * @public
503
502
  * <p>The type of the <code>AppInstanceUserEndpoint</code>.</p>
503
+ * @public
504
504
  */
505
505
  Type?: AppInstanceUserEndpointType;
506
506
  /**
507
- * @public
508
507
  * <p>The ARN of the resource to which the endpoint belongs.</p>
508
+ * @public
509
509
  */
510
510
  ResourceArn?: string;
511
511
  /**
512
- * @public
513
512
  * <p>The attributes of an <code>Endpoint</code>.</p>
513
+ * @public
514
514
  */
515
515
  EndpointAttributes?: EndpointAttributes;
516
516
  /**
517
- * @public
518
517
  * <p>The time at which an <code>AppInstanceUserEndpoint</code> was created.</p>
518
+ * @public
519
519
  */
520
520
  CreatedTimestamp?: Date;
521
521
  /**
522
- * @public
523
522
  * <p>The time at which an <code>AppInstanceUserEndpoint</code> was last updated.</p>
523
+ * @public
524
524
  */
525
525
  LastUpdatedTimestamp?: Date;
526
526
  /**
527
- * @public
528
527
  * <p>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages.
529
528
  * <code>NONE</code> indicates the endpoint will receive no messages.</p>
529
+ * @public
530
530
  */
531
531
  AllowMessages?: AllowMessages;
532
532
  /**
533
- * @public
534
533
  * <p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p>
535
534
  * <ul>
536
535
  * <li>
@@ -552,64 +551,65 @@ export interface AppInstanceUserEndpoint {
552
551
  * through the <code>ResourceArn</code> field.</p>
553
552
  * </li>
554
553
  * </ul>
554
+ * @public
555
555
  */
556
556
  EndpointState?: EndpointState;
557
557
  }
558
558
  /**
559
- * @public
560
559
  * <p>Summary of the details of an <code>AppInstanceUserEndpoint</code>.</p>
560
+ * @public
561
561
  */
562
562
  export interface AppInstanceUserEndpointSummary {
563
563
  /**
564
- * @public
565
564
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
565
+ * @public
566
566
  */
567
567
  AppInstanceUserArn?: string;
568
568
  /**
569
- * @public
570
569
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
570
+ * @public
571
571
  */
572
572
  EndpointId?: string;
573
573
  /**
574
- * @public
575
574
  * <p>The name of the <code>AppInstanceUserEndpoint</code>.</p>
575
+ * @public
576
576
  */
577
577
  Name?: string;
578
578
  /**
579
- * @public
580
579
  * <p>The type of the <code>AppInstanceUserEndpoint</code>.</p>
580
+ * @public
581
581
  */
582
582
  Type?: AppInstanceUserEndpointType;
583
583
  /**
584
- * @public
585
584
  * <p>BBoolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages.
586
585
  * <code>NONE</code> indicates the endpoint will receive no messages.</p>
586
+ * @public
587
587
  */
588
588
  AllowMessages?: AllowMessages;
589
589
  /**
590
- * @public
591
590
  * <p>A read-only field that represent the state of an <code>AppInstanceUserEndpoint</code>.</p>
591
+ * @public
592
592
  */
593
593
  EndpointState?: EndpointState;
594
594
  }
595
595
  /**
596
- * @public
597
596
  * <p>Summary of the details of an <code>AppInstanceUser</code>.</p>
597
+ * @public
598
598
  */
599
599
  export interface AppInstanceUserSummary {
600
600
  /**
601
- * @public
602
601
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
602
+ * @public
603
603
  */
604
604
  AppInstanceUserArn?: string;
605
605
  /**
606
- * @public
607
606
  * <p>The name of an <code>AppInstanceUser</code>.</p>
607
+ * @public
608
608
  */
609
609
  Name?: string;
610
610
  /**
611
- * @public
612
611
  * <p>The metadata of the <code>AppInstanceUser</code>.</p>
612
+ * @public
613
613
  */
614
614
  Metadata?: string;
615
615
  }
@@ -639,8 +639,8 @@ export declare const ErrorCode: {
639
639
  */
640
640
  export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
641
641
  /**
642
- * @public
643
642
  * <p>The input parameters don't match the service's restrictions.</p>
643
+ * @public
644
644
  */
645
645
  export declare class BadRequestException extends __BaseException {
646
646
  readonly name: "BadRequestException";
@@ -653,9 +653,9 @@ export declare class BadRequestException extends __BaseException {
653
653
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
654
654
  }
655
655
  /**
656
- * @public
657
656
  * <p>The request could not be processed because of conflict in the current state of the
658
657
  * resource.</p>
658
+ * @public
659
659
  */
660
660
  export declare class ConflictException extends __BaseException {
661
661
  readonly name: "ConflictException";
@@ -668,18 +668,18 @@ export declare class ConflictException extends __BaseException {
668
668
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
669
669
  }
670
670
  /**
671
- * @public
672
671
  * <p>A tag object containing a key-value pair.</p>
672
+ * @public
673
673
  */
674
674
  export interface Tag {
675
675
  /**
676
- * @public
677
676
  * <p>The key in a tag.</p>
677
+ * @public
678
678
  */
679
679
  Key: string | undefined;
680
680
  /**
681
- * @public
682
681
  * <p>The value in a tag.</p>
682
+ * @public
683
683
  */
684
684
  Value: string | undefined;
685
685
  }
@@ -688,23 +688,23 @@ export interface Tag {
688
688
  */
689
689
  export interface CreateAppInstanceRequest {
690
690
  /**
691
- * @public
692
691
  * <p>The name of the <code>AppInstance</code>.</p>
692
+ * @public
693
693
  */
694
694
  Name: string | undefined;
695
695
  /**
696
- * @public
697
696
  * <p>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</p>
697
+ * @public
698
698
  */
699
699
  Metadata?: string;
700
700
  /**
701
- * @public
702
701
  * <p>The unique ID of the request. Use different tokens to create different <code>AppInstances</code>.</p>
702
+ * @public
703
703
  */
704
704
  ClientRequestToken?: string;
705
705
  /**
706
- * @public
707
706
  * <p>Tags assigned to the <code>AppInstance</code>.</p>
707
+ * @public
708
708
  */
709
709
  Tags?: Tag[];
710
710
  }
@@ -713,14 +713,14 @@ export interface CreateAppInstanceRequest {
713
713
  */
714
714
  export interface CreateAppInstanceResponse {
715
715
  /**
716
- * @public
717
716
  * <p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>
717
+ * @public
718
718
  */
719
719
  AppInstanceArn?: string;
720
720
  }
721
721
  /**
722
- * @public
723
722
  * <p>The client is permanently forbidden from making the request.</p>
723
+ * @public
724
724
  */
725
725
  export declare class ForbiddenException extends __BaseException {
726
726
  readonly name: "ForbiddenException";
@@ -733,8 +733,8 @@ export declare class ForbiddenException extends __BaseException {
733
733
  constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
734
734
  }
735
735
  /**
736
- * @public
737
736
  * <p>The request exceeds the resource limit.</p>
737
+ * @public
738
738
  */
739
739
  export declare class ResourceLimitExceededException extends __BaseException {
740
740
  readonly name: "ResourceLimitExceededException";
@@ -747,8 +747,8 @@ export declare class ResourceLimitExceededException extends __BaseException {
747
747
  constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
748
748
  }
749
749
  /**
750
- * @public
751
750
  * <p>The service encountered an unexpected error.</p>
751
+ * @public
752
752
  */
753
753
  export declare class ServiceFailureException extends __BaseException {
754
754
  readonly name: "ServiceFailureException";
@@ -761,8 +761,8 @@ export declare class ServiceFailureException extends __BaseException {
761
761
  constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
762
762
  }
763
763
  /**
764
- * @public
765
764
  * <p>The service is currently unavailable.</p>
765
+ * @public
766
766
  */
767
767
  export declare class ServiceUnavailableException extends __BaseException {
768
768
  readonly name: "ServiceUnavailableException";
@@ -775,8 +775,8 @@ export declare class ServiceUnavailableException extends __BaseException {
775
775
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
776
776
  }
777
777
  /**
778
- * @public
779
778
  * <p>The client exceeded its request rate limit.</p>
779
+ * @public
780
780
  */
781
781
  export declare class ThrottledClientException extends __BaseException {
782
782
  readonly name: "ThrottledClientException";
@@ -789,8 +789,8 @@ export declare class ThrottledClientException extends __BaseException {
789
789
  constructor(opts: __ExceptionOptionType<ThrottledClientException, __BaseException>);
790
790
  }
791
791
  /**
792
- * @public
793
792
  * <p>The client is not currently authorized to make the request.</p>
793
+ * @public
794
794
  */
795
795
  export declare class UnauthorizedClientException extends __BaseException {
796
796
  readonly name: "UnauthorizedClientException";
@@ -807,13 +807,13 @@ export declare class UnauthorizedClientException extends __BaseException {
807
807
  */
808
808
  export interface CreateAppInstanceAdminRequest {
809
809
  /**
810
- * @public
811
810
  * <p>The ARN of the administrator of the current <code>AppInstance</code>.</p>
811
+ * @public
812
812
  */
813
813
  AppInstanceAdminArn: string | undefined;
814
814
  /**
815
- * @public
816
815
  * <p>The ARN of the <code>AppInstance</code>.</p>
816
+ * @public
817
817
  */
818
818
  AppInstanceArn: string | undefined;
819
819
  }
@@ -822,14 +822,14 @@ export interface CreateAppInstanceAdminRequest {
822
822
  */
823
823
  export interface CreateAppInstanceAdminResponse {
824
824
  /**
825
- * @public
826
825
  * <p>The ARN and name of the administrator, the ARN of the <code>AppInstance</code>, and the created and
827
826
  * last-updated timestamps. All timestamps use epoch milliseconds.</p>
827
+ * @public
828
828
  */
829
829
  AppInstanceAdmin?: Identity;
830
830
  /**
831
- * @public
832
831
  * <p>The ARN of the of the admin for the <code>AppInstance</code>.</p>
832
+ * @public
833
833
  */
834
834
  AppInstanceArn?: string;
835
835
  }
@@ -838,33 +838,33 @@ export interface CreateAppInstanceAdminResponse {
838
838
  */
839
839
  export interface CreateAppInstanceBotRequest {
840
840
  /**
841
- * @public
842
841
  * <p>The ARN of the <code>AppInstance</code> request.</p>
842
+ * @public
843
843
  */
844
844
  AppInstanceArn: string | undefined;
845
845
  /**
846
- * @public
847
846
  * <p>The user's name.</p>
847
+ * @public
848
848
  */
849
849
  Name?: string;
850
850
  /**
851
- * @public
852
851
  * <p>The request metadata. Limited to a 1KB string in UTF-8.</p>
852
+ * @public
853
853
  */
854
854
  Metadata?: string;
855
855
  /**
856
- * @public
857
856
  * <p>The unique ID for the client making the request. Use different tokens for different <code>AppInstanceBots</code>.</p>
857
+ * @public
858
858
  */
859
859
  ClientRequestToken?: string;
860
860
  /**
861
- * @public
862
861
  * <p>The tags assigned to the <code>AppInstanceBot</code>.</p>
862
+ * @public
863
863
  */
864
864
  Tags?: Tag[];
865
865
  /**
866
- * @public
867
866
  * <p>Configuration information about the Amazon Lex V2 V2 bot.</p>
867
+ * @public
868
868
  */
869
869
  Configuration: Configuration | undefined;
870
870
  }
@@ -873,8 +873,8 @@ export interface CreateAppInstanceBotRequest {
873
873
  */
874
874
  export interface CreateAppInstanceBotResponse {
875
875
  /**
876
- * @public
877
876
  * <p>The ARN of the <code>AppinstanceBot</code>.</p>
877
+ * @public
878
878
  */
879
879
  AppInstanceBotArn?: string;
880
880
  }
@@ -883,38 +883,38 @@ export interface CreateAppInstanceBotResponse {
883
883
  */
884
884
  export interface CreateAppInstanceUserRequest {
885
885
  /**
886
- * @public
887
886
  * <p>The ARN of the <code>AppInstance</code> request.</p>
887
+ * @public
888
888
  */
889
889
  AppInstanceArn: string | undefined;
890
890
  /**
891
- * @public
892
891
  * <p>The user ID of the <code>AppInstance</code>.</p>
892
+ * @public
893
893
  */
894
894
  AppInstanceUserId: string | undefined;
895
895
  /**
896
- * @public
897
896
  * <p>The user's name.</p>
897
+ * @public
898
898
  */
899
899
  Name: string | undefined;
900
900
  /**
901
- * @public
902
901
  * <p>The request's metadata. Limited to a 1KB string in UTF-8.</p>
902
+ * @public
903
903
  */
904
904
  Metadata?: string;
905
905
  /**
906
- * @public
907
906
  * <p>The unique ID of the request. Use different tokens to request additional <code>AppInstances</code>.</p>
907
+ * @public
908
908
  */
909
909
  ClientRequestToken?: string;
910
910
  /**
911
- * @public
912
911
  * <p>Tags assigned to the <code>AppInstanceUser</code>.</p>
912
+ * @public
913
913
  */
914
914
  Tags?: Tag[];
915
915
  /**
916
- * @public
917
916
  * <p>Settings that control the interval after which the <code>AppInstanceUser</code> is automatically deleted.</p>
917
+ * @public
918
918
  */
919
919
  ExpirationSettings?: ExpirationSettings;
920
920
  }
@@ -923,8 +923,8 @@ export interface CreateAppInstanceUserRequest {
923
923
  */
924
924
  export interface CreateAppInstanceUserResponse {
925
925
  /**
926
- * @public
927
926
  * <p>The user's ARN.</p>
927
+ * @public
928
928
  */
929
929
  AppInstanceUserArn?: string;
930
930
  }
@@ -933,8 +933,8 @@ export interface CreateAppInstanceUserResponse {
933
933
  */
934
934
  export interface DeleteAppInstanceRequest {
935
935
  /**
936
- * @public
937
936
  * <p>The ARN of the <code>AppInstance</code>.</p>
937
+ * @public
938
938
  */
939
939
  AppInstanceArn: string | undefined;
940
940
  }
@@ -943,13 +943,13 @@ export interface DeleteAppInstanceRequest {
943
943
  */
944
944
  export interface DeleteAppInstanceAdminRequest {
945
945
  /**
946
- * @public
947
946
  * <p>The ARN of the <code>AppInstance</code>'s administrator.</p>
947
+ * @public
948
948
  */
949
949
  AppInstanceAdminArn: string | undefined;
950
950
  /**
951
- * @public
952
951
  * <p>The ARN of the <code>AppInstance</code>.</p>
952
+ * @public
953
953
  */
954
954
  AppInstanceArn: string | undefined;
955
955
  }
@@ -958,8 +958,8 @@ export interface DeleteAppInstanceAdminRequest {
958
958
  */
959
959
  export interface DeleteAppInstanceBotRequest {
960
960
  /**
961
- * @public
962
961
  * <p>The ARN of the <code>AppInstanceBot</code> being deleted.</p>
962
+ * @public
963
963
  */
964
964
  AppInstanceBotArn: string | undefined;
965
965
  }
@@ -968,8 +968,8 @@ export interface DeleteAppInstanceBotRequest {
968
968
  */
969
969
  export interface DeleteAppInstanceUserRequest {
970
970
  /**
971
- * @public
972
971
  * <p>The ARN of the user request being deleted.</p>
972
+ * @public
973
973
  */
974
974
  AppInstanceUserArn: string | undefined;
975
975
  }
@@ -978,13 +978,13 @@ export interface DeleteAppInstanceUserRequest {
978
978
  */
979
979
  export interface DeregisterAppInstanceUserEndpointRequest {
980
980
  /**
981
- * @public
982
981
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
982
+ * @public
983
983
  */
984
984
  AppInstanceUserArn: string | undefined;
985
985
  /**
986
- * @public
987
986
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
987
+ * @public
988
988
  */
989
989
  EndpointId: string | undefined;
990
990
  }
@@ -993,8 +993,8 @@ export interface DeregisterAppInstanceUserEndpointRequest {
993
993
  */
994
994
  export interface DescribeAppInstanceRequest {
995
995
  /**
996
- * @public
997
996
  * <p>The ARN of the <code>AppInstance</code>.</p>
997
+ * @public
998
998
  */
999
999
  AppInstanceArn: string | undefined;
1000
1000
  }
@@ -1003,9 +1003,9 @@ export interface DescribeAppInstanceRequest {
1003
1003
  */
1004
1004
  export interface DescribeAppInstanceResponse {
1005
1005
  /**
1006
- * @public
1007
1006
  * <p>The ARN, metadata, created and last-updated timestamps, and the name of the
1008
1007
  * <code>AppInstance</code>. All timestamps use epoch milliseconds.</p>
1008
+ * @public
1009
1009
  */
1010
1010
  AppInstance?: AppInstance;
1011
1011
  }
@@ -1014,13 +1014,13 @@ export interface DescribeAppInstanceResponse {
1014
1014
  */
1015
1015
  export interface DescribeAppInstanceAdminRequest {
1016
1016
  /**
1017
- * @public
1018
1017
  * <p>The ARN of the <code>AppInstanceAdmin</code>.</p>
1018
+ * @public
1019
1019
  */
1020
1020
  AppInstanceAdminArn: string | undefined;
1021
1021
  /**
1022
- * @public
1023
1022
  * <p>The ARN of the <code>AppInstance</code>.</p>
1023
+ * @public
1024
1024
  */
1025
1025
  AppInstanceArn: string | undefined;
1026
1026
  }
@@ -1029,10 +1029,10 @@ export interface DescribeAppInstanceAdminRequest {
1029
1029
  */
1030
1030
  export interface DescribeAppInstanceAdminResponse {
1031
1031
  /**
1032
- * @public
1033
1032
  * <p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the
1034
1033
  * <code>AppInstance</code>, and the created and last-updated timestamps. All timestamps
1035
1034
  * use epoch milliseconds.</p>
1035
+ * @public
1036
1036
  */
1037
1037
  AppInstanceAdmin?: AppInstanceAdmin;
1038
1038
  }
@@ -1041,8 +1041,8 @@ export interface DescribeAppInstanceAdminResponse {
1041
1041
  */
1042
1042
  export interface DescribeAppInstanceBotRequest {
1043
1043
  /**
1044
- * @public
1045
1044
  * <p>The ARN of the <code>AppInstanceBot</code>.</p>
1045
+ * @public
1046
1046
  */
1047
1047
  AppInstanceBotArn: string | undefined;
1048
1048
  }
@@ -1051,14 +1051,14 @@ export interface DescribeAppInstanceBotRequest {
1051
1051
  */
1052
1052
  export interface DescribeAppInstanceBotResponse {
1053
1053
  /**
1054
- * @public
1055
1054
  * <p>The detials of the <code>AppInstanceBot</code>.</p>
1055
+ * @public
1056
1056
  */
1057
1057
  AppInstanceBot?: AppInstanceBot;
1058
1058
  }
1059
1059
  /**
1060
- * @public
1061
1060
  * <p>One or more of the resources in the request does not exist in the system.</p>
1061
+ * @public
1062
1062
  */
1063
1063
  export declare class NotFoundException extends __BaseException {
1064
1064
  readonly name: "NotFoundException";
@@ -1075,8 +1075,8 @@ export declare class NotFoundException extends __BaseException {
1075
1075
  */
1076
1076
  export interface DescribeAppInstanceUserRequest {
1077
1077
  /**
1078
- * @public
1079
1078
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1079
+ * @public
1080
1080
  */
1081
1081
  AppInstanceUserArn: string | undefined;
1082
1082
  }
@@ -1085,8 +1085,8 @@ export interface DescribeAppInstanceUserRequest {
1085
1085
  */
1086
1086
  export interface DescribeAppInstanceUserResponse {
1087
1087
  /**
1088
- * @public
1089
1088
  * <p>The name of the <code>AppInstanceUser</code>.</p>
1089
+ * @public
1090
1090
  */
1091
1091
  AppInstanceUser?: AppInstanceUser;
1092
1092
  }
@@ -1095,13 +1095,13 @@ export interface DescribeAppInstanceUserResponse {
1095
1095
  */
1096
1096
  export interface DescribeAppInstanceUserEndpointRequest {
1097
1097
  /**
1098
- * @public
1099
1098
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1099
+ * @public
1100
1100
  */
1101
1101
  AppInstanceUserArn: string | undefined;
1102
1102
  /**
1103
- * @public
1104
1103
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
1104
+ * @public
1105
1105
  */
1106
1106
  EndpointId: string | undefined;
1107
1107
  }
@@ -1110,9 +1110,9 @@ export interface DescribeAppInstanceUserEndpointRequest {
1110
1110
  */
1111
1111
  export interface DescribeAppInstanceUserEndpointResponse {
1112
1112
  /**
1113
- * @public
1114
1113
  * <p>The full details of an <code>AppInstanceUserEndpoint</code>: the <code>AppInstanceUserArn</code>, ID, name, type, resource ARN, attributes,
1115
1114
  * allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.</p>
1115
+ * @public
1116
1116
  */
1117
1117
  AppInstanceUserEndpoint?: AppInstanceUserEndpoint;
1118
1118
  }
@@ -1121,8 +1121,8 @@ export interface DescribeAppInstanceUserEndpointResponse {
1121
1121
  */
1122
1122
  export interface GetAppInstanceRetentionSettingsRequest {
1123
1123
  /**
1124
- * @public
1125
1124
  * <p>The ARN of the <code>AppInstance</code>.</p>
1125
+ * @public
1126
1126
  */
1127
1127
  AppInstanceArn: string | undefined;
1128
1128
  }
@@ -1131,14 +1131,14 @@ export interface GetAppInstanceRetentionSettingsRequest {
1131
1131
  */
1132
1132
  export interface GetAppInstanceRetentionSettingsResponse {
1133
1133
  /**
1134
- * @public
1135
1134
  * <p>The retention settings for the <code>AppInstance</code>.</p>
1135
+ * @public
1136
1136
  */
1137
1137
  AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
1138
1138
  /**
1139
- * @public
1140
1139
  * <p>The timestamp representing the time at which the specified items are retained, in Epoch
1141
1140
  * Seconds.</p>
1141
+ * @public
1142
1142
  */
1143
1143
  InitiateDeletionTimestamp?: Date;
1144
1144
  }
@@ -1147,19 +1147,19 @@ export interface GetAppInstanceRetentionSettingsResponse {
1147
1147
  */
1148
1148
  export interface ListAppInstanceAdminsRequest {
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>The ARN of the <code>AppInstance</code>.</p>
1151
+ * @public
1152
1152
  */
1153
1153
  AppInstanceArn: string | undefined;
1154
1154
  /**
1155
- * @public
1156
1155
  * <p>The maximum number of administrators that you want to return.</p>
1156
+ * @public
1157
1157
  */
1158
1158
  MaxResults?: number;
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>The token returned from previous API requests until the number of administrators is
1162
1161
  * reached.</p>
1162
+ * @public
1163
1163
  */
1164
1164
  NextToken?: string;
1165
1165
  }
@@ -1168,19 +1168,19 @@ export interface ListAppInstanceAdminsRequest {
1168
1168
  */
1169
1169
  export interface ListAppInstanceAdminsResponse {
1170
1170
  /**
1171
- * @public
1172
1171
  * <p>The ARN of the <code>AppInstance</code>.</p>
1172
+ * @public
1173
1173
  */
1174
1174
  AppInstanceArn?: string;
1175
1175
  /**
1176
- * @public
1177
1176
  * <p>The information for each administrator.</p>
1177
+ * @public
1178
1178
  */
1179
1179
  AppInstanceAdmins?: AppInstanceAdminSummary[];
1180
1180
  /**
1181
- * @public
1182
1181
  * <p>The token returned from previous API requests until the number of administrators is
1183
1182
  * reached.</p>
1183
+ * @public
1184
1184
  */
1185
1185
  NextToken?: string;
1186
1186
  }
@@ -1189,18 +1189,18 @@ export interface ListAppInstanceAdminsResponse {
1189
1189
  */
1190
1190
  export interface ListAppInstanceBotsRequest {
1191
1191
  /**
1192
- * @public
1193
1192
  * <p>The ARN of the <code>AppInstance</code>.</p>
1193
+ * @public
1194
1194
  */
1195
1195
  AppInstanceArn: string | undefined;
1196
1196
  /**
1197
- * @public
1198
1197
  * <p>The maximum number of requests to return.</p>
1198
+ * @public
1199
1199
  */
1200
1200
  MaxResults?: number;
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>The token passed by previous API calls until all requested bots are returned.</p>
1203
+ * @public
1204
1204
  */
1205
1205
  NextToken?: string;
1206
1206
  }
@@ -1209,18 +1209,18 @@ export interface ListAppInstanceBotsRequest {
1209
1209
  */
1210
1210
  export interface ListAppInstanceBotsResponse {
1211
1211
  /**
1212
- * @public
1213
1212
  * <p>The ARN of the AppInstance.</p>
1213
+ * @public
1214
1214
  */
1215
1215
  AppInstanceArn?: string;
1216
1216
  /**
1217
- * @public
1218
1217
  * <p>The information for each requested <code>AppInstanceBot</code>.</p>
1218
+ * @public
1219
1219
  */
1220
1220
  AppInstanceBots?: AppInstanceBotSummary[];
1221
1221
  /**
1222
- * @public
1223
1222
  * <p>The token passed by previous API calls until all requested bots are returned.</p>
1223
+ * @public
1224
1224
  */
1225
1225
  NextToken?: string;
1226
1226
  }
@@ -1229,14 +1229,14 @@ export interface ListAppInstanceBotsResponse {
1229
1229
  */
1230
1230
  export interface ListAppInstancesRequest {
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>The maximum number of <code>AppInstance</code>s that you want to return.</p>
1233
+ * @public
1234
1234
  */
1235
1235
  MaxResults?: number;
1236
1236
  /**
1237
- * @public
1238
1237
  * <p>The token passed by previous API requests until you reach the maximum number of
1239
1238
  * <code>AppInstances</code>.</p>
1239
+ * @public
1240
1240
  */
1241
1241
  NextToken?: string;
1242
1242
  }
@@ -1245,14 +1245,14 @@ export interface ListAppInstancesRequest {
1245
1245
  */
1246
1246
  export interface ListAppInstancesResponse {
1247
1247
  /**
1248
- * @public
1249
1248
  * <p>The information for each <code>AppInstance</code>.</p>
1249
+ * @public
1250
1250
  */
1251
1251
  AppInstances?: AppInstanceSummary[];
1252
1252
  /**
1253
- * @public
1254
1253
  * <p>The token passed by previous API requests until the maximum number of
1255
1254
  * <code>AppInstance</code>s is reached.</p>
1255
+ * @public
1256
1256
  */
1257
1257
  NextToken?: string;
1258
1258
  }
@@ -1261,18 +1261,18 @@ export interface ListAppInstancesResponse {
1261
1261
  */
1262
1262
  export interface ListAppInstanceUserEndpointsRequest {
1263
1263
  /**
1264
- * @public
1265
1264
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1265
+ * @public
1266
1266
  */
1267
1267
  AppInstanceUserArn: string | undefined;
1268
1268
  /**
1269
- * @public
1270
1269
  * <p>The maximum number of endpoints that you want to return.</p>
1270
+ * @public
1271
1271
  */
1272
1272
  MaxResults?: number;
1273
1273
  /**
1274
- * @public
1275
1274
  * <p>The token passed by previous API calls until all requested endpoints are returned.</p>
1275
+ * @public
1276
1276
  */
1277
1277
  NextToken?: string;
1278
1278
  }
@@ -1281,13 +1281,13 @@ export interface ListAppInstanceUserEndpointsRequest {
1281
1281
  */
1282
1282
  export interface ListAppInstanceUserEndpointsResponse {
1283
1283
  /**
1284
- * @public
1285
1284
  * <p>The information for each requested <code>AppInstanceUserEndpoint</code>.</p>
1285
+ * @public
1286
1286
  */
1287
1287
  AppInstanceUserEndpoints?: AppInstanceUserEndpointSummary[];
1288
1288
  /**
1289
- * @public
1290
1289
  * <p>The token passed by previous API calls until all requested endpoints are returned.</p>
1290
+ * @public
1291
1291
  */
1292
1292
  NextToken?: string;
1293
1293
  }
@@ -1296,18 +1296,18 @@ export interface ListAppInstanceUserEndpointsResponse {
1296
1296
  */
1297
1297
  export interface ListAppInstanceUsersRequest {
1298
1298
  /**
1299
- * @public
1300
1299
  * <p>The ARN of the <code>AppInstance</code>.</p>
1300
+ * @public
1301
1301
  */
1302
1302
  AppInstanceArn: string | undefined;
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The maximum number of requests that you want returned.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  MaxResults?: number;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>The token passed by previous API calls until all requested users are returned.</p>
1310
+ * @public
1311
1311
  */
1312
1312
  NextToken?: string;
1313
1313
  }
@@ -1316,18 +1316,18 @@ export interface ListAppInstanceUsersRequest {
1316
1316
  */
1317
1317
  export interface ListAppInstanceUsersResponse {
1318
1318
  /**
1319
- * @public
1320
1319
  * <p>The ARN of the <code>AppInstance</code>.</p>
1320
+ * @public
1321
1321
  */
1322
1322
  AppInstanceArn?: string;
1323
1323
  /**
1324
- * @public
1325
1324
  * <p>The information for each requested <code>AppInstanceUser</code>.</p>
1325
+ * @public
1326
1326
  */
1327
1327
  AppInstanceUsers?: AppInstanceUserSummary[];
1328
1328
  /**
1329
- * @public
1330
1329
  * <p>The token passed by previous API calls until all requested users are returned.</p>
1330
+ * @public
1331
1331
  */
1332
1332
  NextToken?: string;
1333
1333
  }
@@ -1336,8 +1336,8 @@ export interface ListAppInstanceUsersResponse {
1336
1336
  */
1337
1337
  export interface ListTagsForResourceRequest {
1338
1338
  /**
1339
- * @public
1340
1339
  * <p>The ARN of the resource.</p>
1340
+ * @public
1341
1341
  */
1342
1342
  ResourceARN: string | undefined;
1343
1343
  }
@@ -1346,8 +1346,8 @@ export interface ListTagsForResourceRequest {
1346
1346
  */
1347
1347
  export interface ListTagsForResourceResponse {
1348
1348
  /**
1349
- * @public
1350
1349
  * <p>The tag key-value pairs.</p>
1350
+ * @public
1351
1351
  */
1352
1352
  Tags?: Tag[];
1353
1353
  }
@@ -1356,13 +1356,13 @@ export interface ListTagsForResourceResponse {
1356
1356
  */
1357
1357
  export interface PutAppInstanceRetentionSettingsRequest {
1358
1358
  /**
1359
- * @public
1360
1359
  * <p>The ARN of the <code>AppInstance</code>.</p>
1360
+ * @public
1361
1361
  */
1362
1362
  AppInstanceArn: string | undefined;
1363
1363
  /**
1364
- * @public
1365
1364
  * <p>The time in days to retain data. Data type: number.</p>
1365
+ * @public
1366
1366
  */
1367
1367
  AppInstanceRetentionSettings: AppInstanceRetentionSettings | undefined;
1368
1368
  }
@@ -1371,13 +1371,13 @@ export interface PutAppInstanceRetentionSettingsRequest {
1371
1371
  */
1372
1372
  export interface PutAppInstanceRetentionSettingsResponse {
1373
1373
  /**
1374
- * @public
1375
1374
  * <p>The time in days to retain data. Data type: number.</p>
1375
+ * @public
1376
1376
  */
1377
1377
  AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>The time at which the API deletes data.</p>
1380
+ * @public
1381
1381
  */
1382
1382
  InitiateDeletionTimestamp?: Date;
1383
1383
  }
@@ -1386,13 +1386,13 @@ export interface PutAppInstanceRetentionSettingsResponse {
1386
1386
  */
1387
1387
  export interface PutAppInstanceUserExpirationSettingsRequest {
1388
1388
  /**
1389
- * @public
1390
1389
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1390
+ * @public
1391
1391
  */
1392
1392
  AppInstanceUserArn: string | undefined;
1393
1393
  /**
1394
- * @public
1395
1394
  * <p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
1395
+ * @public
1396
1396
  */
1397
1397
  ExpirationSettings?: ExpirationSettings;
1398
1398
  }
@@ -1401,13 +1401,13 @@ export interface PutAppInstanceUserExpirationSettingsRequest {
1401
1401
  */
1402
1402
  export interface PutAppInstanceUserExpirationSettingsResponse {
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1405
+ * @public
1406
1406
  */
1407
1407
  AppInstanceUserArn?: string;
1408
1408
  /**
1409
- * @public
1410
1409
  * <p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>
1410
+ * @public
1411
1411
  */
1412
1412
  ExpirationSettings?: ExpirationSettings;
1413
1413
  }
@@ -1416,17 +1416,16 @@ export interface PutAppInstanceUserExpirationSettingsResponse {
1416
1416
  */
1417
1417
  export interface RegisterAppInstanceUserEndpointRequest {
1418
1418
  /**
1419
- * @public
1420
1419
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1420
+ * @public
1421
1421
  */
1422
1422
  AppInstanceUserArn: string | undefined;
1423
1423
  /**
1424
- * @public
1425
1424
  * <p>The name of the <code>AppInstanceUserEndpoint</code>.</p>
1425
+ * @public
1426
1426
  */
1427
1427
  Name?: string;
1428
1428
  /**
1429
- * @public
1430
1429
  * <p>The type of the <code>AppInstanceUserEndpoint</code>. Supported types:</p>
1431
1430
  * <ul>
1432
1431
  * <li>
@@ -1443,27 +1442,28 @@ export interface RegisterAppInstanceUserEndpointRequest {
1443
1442
  * </li>
1444
1443
  * </ul>
1445
1444
  * <p>Populate the <code>ResourceArn</code> value of each type as <code>PinpointAppArn</code>.</p>
1445
+ * @public
1446
1446
  */
1447
1447
  Type: AppInstanceUserEndpointType | undefined;
1448
1448
  /**
1449
- * @public
1450
1449
  * <p>The ARN of the resource to which the endpoint belongs.</p>
1450
+ * @public
1451
1451
  */
1452
1452
  ResourceArn: string | undefined;
1453
1453
  /**
1454
- * @public
1455
1454
  * <p>The attributes of an <code>Endpoint</code>.</p>
1455
+ * @public
1456
1456
  */
1457
1457
  EndpointAttributes: EndpointAttributes | undefined;
1458
1458
  /**
1459
- * @public
1460
1459
  * <p>The unique ID assigned to the request. Use different tokens to register other endpoints.</p>
1460
+ * @public
1461
1461
  */
1462
1462
  ClientRequestToken?: string;
1463
1463
  /**
1464
- * @public
1465
1464
  * <p>Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. <code>ALL</code> indicates the endpoint receives all messages.
1466
1465
  * <code>NONE</code> indicates the endpoint receives no messages.</p>
1466
+ * @public
1467
1467
  */
1468
1468
  AllowMessages?: AllowMessages;
1469
1469
  }
@@ -1472,13 +1472,13 @@ export interface RegisterAppInstanceUserEndpointRequest {
1472
1472
  */
1473
1473
  export interface RegisterAppInstanceUserEndpointResponse {
1474
1474
  /**
1475
- * @public
1476
1475
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1476
+ * @public
1477
1477
  */
1478
1478
  AppInstanceUserArn?: string;
1479
1479
  /**
1480
- * @public
1481
1480
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
1481
+ * @public
1482
1482
  */
1483
1483
  EndpointId?: string;
1484
1484
  }
@@ -1487,13 +1487,13 @@ export interface RegisterAppInstanceUserEndpointResponse {
1487
1487
  */
1488
1488
  export interface TagResourceRequest {
1489
1489
  /**
1490
- * @public
1491
1490
  * <p>The resource ARN.</p>
1491
+ * @public
1492
1492
  */
1493
1493
  ResourceARN: string | undefined;
1494
1494
  /**
1495
- * @public
1496
1495
  * <p>The tag key-value pairs.</p>
1496
+ * @public
1497
1497
  */
1498
1498
  Tags: Tag[] | undefined;
1499
1499
  }
@@ -1502,13 +1502,13 @@ export interface TagResourceRequest {
1502
1502
  */
1503
1503
  export interface UntagResourceRequest {
1504
1504
  /**
1505
- * @public
1506
1505
  * <p>The resource ARN.</p>
1506
+ * @public
1507
1507
  */
1508
1508
  ResourceARN: string | undefined;
1509
1509
  /**
1510
- * @public
1511
1510
  * <p>The tag keys.</p>
1511
+ * @public
1512
1512
  */
1513
1513
  TagKeys: string[] | undefined;
1514
1514
  }
@@ -1517,18 +1517,18 @@ export interface UntagResourceRequest {
1517
1517
  */
1518
1518
  export interface UpdateAppInstanceRequest {
1519
1519
  /**
1520
- * @public
1521
1520
  * <p>The ARN of the <code>AppInstance</code>.</p>
1521
+ * @public
1522
1522
  */
1523
1523
  AppInstanceArn: string | undefined;
1524
1524
  /**
1525
- * @public
1526
1525
  * <p>The name that you want to change.</p>
1526
+ * @public
1527
1527
  */
1528
1528
  Name: string | undefined;
1529
1529
  /**
1530
- * @public
1531
1530
  * <p>The metadata that you want to change.</p>
1531
+ * @public
1532
1532
  */
1533
1533
  Metadata: string | undefined;
1534
1534
  }
@@ -1537,8 +1537,8 @@ export interface UpdateAppInstanceRequest {
1537
1537
  */
1538
1538
  export interface UpdateAppInstanceResponse {
1539
1539
  /**
1540
- * @public
1541
1540
  * <p>The ARN of the <code>AppInstance</code>.</p>
1541
+ * @public
1542
1542
  */
1543
1543
  AppInstanceArn?: string;
1544
1544
  }
@@ -1547,23 +1547,23 @@ export interface UpdateAppInstanceResponse {
1547
1547
  */
1548
1548
  export interface UpdateAppInstanceBotRequest {
1549
1549
  /**
1550
- * @public
1551
1550
  * <p>The ARN of the <code>AppInstanceBot</code>.</p>
1551
+ * @public
1552
1552
  */
1553
1553
  AppInstanceBotArn: string | undefined;
1554
1554
  /**
1555
- * @public
1556
1555
  * <p>The name of the <code>AppInstanceBot</code>.</p>
1556
+ * @public
1557
1557
  */
1558
1558
  Name: string | undefined;
1559
1559
  /**
1560
- * @public
1561
1560
  * <p>The metadata of the <code>AppInstanceBot</code>.</p>
1561
+ * @public
1562
1562
  */
1563
1563
  Metadata: string | undefined;
1564
1564
  /**
1565
- * @public
1566
1565
  * <p>The configuration for the bot update.</p>
1566
+ * @public
1567
1567
  */
1568
1568
  Configuration?: Configuration;
1569
1569
  }
@@ -1572,8 +1572,8 @@ export interface UpdateAppInstanceBotRequest {
1572
1572
  */
1573
1573
  export interface UpdateAppInstanceBotResponse {
1574
1574
  /**
1575
- * @public
1576
1575
  * <p>The ARN of the <code>AppInstanceBot</code>.</p>
1576
+ * @public
1577
1577
  */
1578
1578
  AppInstanceBotArn?: string;
1579
1579
  }
@@ -1582,18 +1582,18 @@ export interface UpdateAppInstanceBotResponse {
1582
1582
  */
1583
1583
  export interface UpdateAppInstanceUserRequest {
1584
1584
  /**
1585
- * @public
1586
1585
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1586
+ * @public
1587
1587
  */
1588
1588
  AppInstanceUserArn: string | undefined;
1589
1589
  /**
1590
- * @public
1591
1590
  * <p>The name of the <code>AppInstanceUser</code>.</p>
1591
+ * @public
1592
1592
  */
1593
1593
  Name: string | undefined;
1594
1594
  /**
1595
- * @public
1596
1595
  * <p>The metadata of the <code>AppInstanceUser</code>.</p>
1596
+ * @public
1597
1597
  */
1598
1598
  Metadata: string | undefined;
1599
1599
  }
@@ -1602,8 +1602,8 @@ export interface UpdateAppInstanceUserRequest {
1602
1602
  */
1603
1603
  export interface UpdateAppInstanceUserResponse {
1604
1604
  /**
1605
- * @public
1606
1605
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1606
+ * @public
1607
1607
  */
1608
1608
  AppInstanceUserArn?: string;
1609
1609
  }
@@ -1612,24 +1612,24 @@ export interface UpdateAppInstanceUserResponse {
1612
1612
  */
1613
1613
  export interface UpdateAppInstanceUserEndpointRequest {
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1616
+ * @public
1617
1617
  */
1618
1618
  AppInstanceUserArn: string | undefined;
1619
1619
  /**
1620
- * @public
1621
1620
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
1621
+ * @public
1622
1622
  */
1623
1623
  EndpointId: string | undefined;
1624
1624
  /**
1625
- * @public
1626
1625
  * <p>The name of the <code>AppInstanceUserEndpoint</code>.</p>
1626
+ * @public
1627
1627
  */
1628
1628
  Name?: string;
1629
1629
  /**
1630
- * @public
1631
1630
  * <p>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages.
1632
1631
  * <code>NONE</code> indicates the endpoint will receive no messages.</p>
1632
+ * @public
1633
1633
  */
1634
1634
  AllowMessages?: AllowMessages;
1635
1635
  }
@@ -1638,13 +1638,13 @@ export interface UpdateAppInstanceUserEndpointRequest {
1638
1638
  */
1639
1639
  export interface UpdateAppInstanceUserEndpointResponse {
1640
1640
  /**
1641
- * @public
1642
1641
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
1642
+ * @public
1643
1643
  */
1644
1644
  AppInstanceUserArn?: string;
1645
1645
  /**
1646
- * @public
1647
1646
  * <p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>
1647
+ * @public
1648
1648
  */
1649
1649
  EndpointId?: string;
1650
1650
  }