@aws-sdk/client-chime 3.378.0 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -5,6 +5,7 @@ import { Account, AccountSettings, Address, AlexaForBusinessMetadata, AppInstanc
|
|
|
5
5
|
*/
|
|
6
6
|
export interface RoomRetentionSettings {
|
|
7
7
|
/**
|
|
8
|
+
* @public
|
|
8
9
|
* <p>The number of days for which to retain chat-room messages.</p>
|
|
9
10
|
*/
|
|
10
11
|
RetentionDays?: number;
|
|
@@ -15,10 +16,12 @@ export interface RoomRetentionSettings {
|
|
|
15
16
|
*/
|
|
16
17
|
export interface RetentionSettings {
|
|
17
18
|
/**
|
|
19
|
+
* @public
|
|
18
20
|
* <p>The chat room retention settings.</p>
|
|
19
21
|
*/
|
|
20
22
|
RoomRetentionSettings?: RoomRetentionSettings;
|
|
21
23
|
/**
|
|
24
|
+
* @public
|
|
22
25
|
* <p>The chat conversation retention settings.</p>
|
|
23
26
|
*/
|
|
24
27
|
ConversationRetentionSettings?: ConversationRetentionSettings;
|
|
@@ -28,10 +31,12 @@ export interface RetentionSettings {
|
|
|
28
31
|
*/
|
|
29
32
|
export interface GetRetentionSettingsResponse {
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>The retention settings.</p>
|
|
32
36
|
*/
|
|
33
37
|
RetentionSettings?: RetentionSettings;
|
|
34
38
|
/**
|
|
39
|
+
* @public
|
|
35
40
|
* <p>The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.</p>
|
|
36
41
|
*/
|
|
37
42
|
InitiateDeletionTimestamp?: Date;
|
|
@@ -41,10 +46,12 @@ export interface GetRetentionSettingsResponse {
|
|
|
41
46
|
*/
|
|
42
47
|
export interface GetRoomRequest {
|
|
43
48
|
/**
|
|
49
|
+
* @public
|
|
44
50
|
* <p>The Amazon Chime account ID.</p>
|
|
45
51
|
*/
|
|
46
52
|
AccountId: string | undefined;
|
|
47
53
|
/**
|
|
54
|
+
* @public
|
|
48
55
|
* <p>The room ID.</p>
|
|
49
56
|
*/
|
|
50
57
|
RoomId: string | undefined;
|
|
@@ -54,6 +61,7 @@ export interface GetRoomRequest {
|
|
|
54
61
|
*/
|
|
55
62
|
export interface GetRoomResponse {
|
|
56
63
|
/**
|
|
64
|
+
* @public
|
|
57
65
|
* <p>The room details.</p>
|
|
58
66
|
*/
|
|
59
67
|
Room?: Room;
|
|
@@ -63,6 +71,7 @@ export interface GetRoomResponse {
|
|
|
63
71
|
*/
|
|
64
72
|
export interface GetSipMediaApplicationRequest {
|
|
65
73
|
/**
|
|
74
|
+
* @public
|
|
66
75
|
* <p>The SIP media application ID.</p>
|
|
67
76
|
*/
|
|
68
77
|
SipMediaApplicationId: string | undefined;
|
|
@@ -72,6 +81,7 @@ export interface GetSipMediaApplicationRequest {
|
|
|
72
81
|
*/
|
|
73
82
|
export interface GetSipMediaApplicationResponse {
|
|
74
83
|
/**
|
|
84
|
+
* @public
|
|
75
85
|
* <p>The SIP media application details.</p>
|
|
76
86
|
*/
|
|
77
87
|
SipMediaApplication?: SipMediaApplication;
|
|
@@ -81,6 +91,7 @@ export interface GetSipMediaApplicationResponse {
|
|
|
81
91
|
*/
|
|
82
92
|
export interface GetSipMediaApplicationLoggingConfigurationRequest {
|
|
83
93
|
/**
|
|
94
|
+
* @public
|
|
84
95
|
* <p>The SIP media application ID.</p>
|
|
85
96
|
*/
|
|
86
97
|
SipMediaApplicationId: string | undefined;
|
|
@@ -91,6 +102,7 @@ export interface GetSipMediaApplicationLoggingConfigurationRequest {
|
|
|
91
102
|
*/
|
|
92
103
|
export interface SipMediaApplicationLoggingConfiguration {
|
|
93
104
|
/**
|
|
105
|
+
* @public
|
|
94
106
|
* <p>Enables application message logs for the SIP media application.</p>
|
|
95
107
|
*/
|
|
96
108
|
EnableSipMediaApplicationMessageLogs?: boolean;
|
|
@@ -100,6 +112,7 @@ export interface SipMediaApplicationLoggingConfiguration {
|
|
|
100
112
|
*/
|
|
101
113
|
export interface GetSipMediaApplicationLoggingConfigurationResponse {
|
|
102
114
|
/**
|
|
115
|
+
* @public
|
|
103
116
|
* <p>The actual logging configuration.</p>
|
|
104
117
|
*/
|
|
105
118
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
@@ -109,6 +122,7 @@ export interface GetSipMediaApplicationLoggingConfigurationResponse {
|
|
|
109
122
|
*/
|
|
110
123
|
export interface GetSipRuleRequest {
|
|
111
124
|
/**
|
|
125
|
+
* @public
|
|
112
126
|
* <p>The SIP rule ID.</p>
|
|
113
127
|
*/
|
|
114
128
|
SipRuleId: string | undefined;
|
|
@@ -118,6 +132,7 @@ export interface GetSipRuleRequest {
|
|
|
118
132
|
*/
|
|
119
133
|
export interface GetSipRuleResponse {
|
|
120
134
|
/**
|
|
135
|
+
* @public
|
|
121
136
|
* <p>The SIP rule details.</p>
|
|
122
137
|
*/
|
|
123
138
|
SipRule?: SipRule;
|
|
@@ -127,10 +142,12 @@ export interface GetSipRuleResponse {
|
|
|
127
142
|
*/
|
|
128
143
|
export interface GetUserRequest {
|
|
129
144
|
/**
|
|
145
|
+
* @public
|
|
130
146
|
* <p>The Amazon Chime account ID.</p>
|
|
131
147
|
*/
|
|
132
148
|
AccountId: string | undefined;
|
|
133
149
|
/**
|
|
150
|
+
* @public
|
|
134
151
|
* <p>The user ID.</p>
|
|
135
152
|
*/
|
|
136
153
|
UserId: string | undefined;
|
|
@@ -140,6 +157,7 @@ export interface GetUserRequest {
|
|
|
140
157
|
*/
|
|
141
158
|
export interface GetUserResponse {
|
|
142
159
|
/**
|
|
160
|
+
* @public
|
|
143
161
|
* <p>The user details.</p>
|
|
144
162
|
*/
|
|
145
163
|
User?: User;
|
|
@@ -149,10 +167,12 @@ export interface GetUserResponse {
|
|
|
149
167
|
*/
|
|
150
168
|
export interface GetUserSettingsRequest {
|
|
151
169
|
/**
|
|
170
|
+
* @public
|
|
152
171
|
* <p>The Amazon Chime account ID.</p>
|
|
153
172
|
*/
|
|
154
173
|
AccountId: string | undefined;
|
|
155
174
|
/**
|
|
175
|
+
* @public
|
|
156
176
|
* <p>The user ID.</p>
|
|
157
177
|
*/
|
|
158
178
|
UserId: string | undefined;
|
|
@@ -164,14 +184,17 @@ export interface GetUserSettingsRequest {
|
|
|
164
184
|
*/
|
|
165
185
|
export interface TelephonySettings {
|
|
166
186
|
/**
|
|
187
|
+
* @public
|
|
167
188
|
* <p>Allows or denies inbound calling.</p>
|
|
168
189
|
*/
|
|
169
190
|
InboundCalling: boolean | undefined;
|
|
170
191
|
/**
|
|
192
|
+
* @public
|
|
171
193
|
* <p>Allows or denies outbound calling.</p>
|
|
172
194
|
*/
|
|
173
195
|
OutboundCalling: boolean | undefined;
|
|
174
196
|
/**
|
|
197
|
+
* @public
|
|
175
198
|
* <p>Allows or denies SMS messaging.</p>
|
|
176
199
|
*/
|
|
177
200
|
SMS: boolean | undefined;
|
|
@@ -183,6 +206,7 @@ export interface TelephonySettings {
|
|
|
183
206
|
*/
|
|
184
207
|
export interface UserSettings {
|
|
185
208
|
/**
|
|
209
|
+
* @public
|
|
186
210
|
* <p>The telephony settings associated with the user.</p>
|
|
187
211
|
*/
|
|
188
212
|
Telephony: TelephonySettings | undefined;
|
|
@@ -192,6 +216,7 @@ export interface UserSettings {
|
|
|
192
216
|
*/
|
|
193
217
|
export interface GetUserSettingsResponse {
|
|
194
218
|
/**
|
|
219
|
+
* @public
|
|
195
220
|
* <p>The user settings.</p>
|
|
196
221
|
*/
|
|
197
222
|
UserSettings?: UserSettings;
|
|
@@ -201,6 +226,7 @@ export interface GetUserSettingsResponse {
|
|
|
201
226
|
*/
|
|
202
227
|
export interface GetVoiceConnectorRequest {
|
|
203
228
|
/**
|
|
229
|
+
* @public
|
|
204
230
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
205
231
|
*/
|
|
206
232
|
VoiceConnectorId: string | undefined;
|
|
@@ -210,6 +236,7 @@ export interface GetVoiceConnectorRequest {
|
|
|
210
236
|
*/
|
|
211
237
|
export interface GetVoiceConnectorResponse {
|
|
212
238
|
/**
|
|
239
|
+
* @public
|
|
213
240
|
* <p>The Amazon Chime Voice Connector details.</p>
|
|
214
241
|
*/
|
|
215
242
|
VoiceConnector?: VoiceConnector;
|
|
@@ -219,6 +246,7 @@ export interface GetVoiceConnectorResponse {
|
|
|
219
246
|
*/
|
|
220
247
|
export interface GetVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
221
248
|
/**
|
|
249
|
+
* @public
|
|
222
250
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
223
251
|
*/
|
|
224
252
|
VoiceConnectorId: string | undefined;
|
|
@@ -228,6 +256,7 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
|
228
256
|
*/
|
|
229
257
|
export interface GetVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
230
258
|
/**
|
|
259
|
+
* @public
|
|
231
260
|
* <p>The emergency calling configuration details.</p>
|
|
232
261
|
*/
|
|
233
262
|
EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
|
|
@@ -237,6 +266,7 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
|
237
266
|
*/
|
|
238
267
|
export interface GetVoiceConnectorGroupRequest {
|
|
239
268
|
/**
|
|
269
|
+
* @public
|
|
240
270
|
* <p>The Amazon Chime Voice Connector group ID.</p>
|
|
241
271
|
*/
|
|
242
272
|
VoiceConnectorGroupId: string | undefined;
|
|
@@ -246,6 +276,7 @@ export interface GetVoiceConnectorGroupRequest {
|
|
|
246
276
|
*/
|
|
247
277
|
export interface GetVoiceConnectorGroupResponse {
|
|
248
278
|
/**
|
|
279
|
+
* @public
|
|
249
280
|
* <p>The Amazon Chime Voice Connector group details.</p>
|
|
250
281
|
*/
|
|
251
282
|
VoiceConnectorGroup?: VoiceConnectorGroup;
|
|
@@ -255,6 +286,7 @@ export interface GetVoiceConnectorGroupResponse {
|
|
|
255
286
|
*/
|
|
256
287
|
export interface GetVoiceConnectorLoggingConfigurationRequest {
|
|
257
288
|
/**
|
|
289
|
+
* @public
|
|
258
290
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
259
291
|
*/
|
|
260
292
|
VoiceConnectorId: string | undefined;
|
|
@@ -265,10 +297,12 @@ export interface GetVoiceConnectorLoggingConfigurationRequest {
|
|
|
265
297
|
*/
|
|
266
298
|
export interface LoggingConfiguration {
|
|
267
299
|
/**
|
|
300
|
+
* @public
|
|
268
301
|
* <p>Boolean that enables SIP message logs to Amazon CloudWatch logs.</p>
|
|
269
302
|
*/
|
|
270
303
|
EnableSIPLogs?: boolean;
|
|
271
304
|
/**
|
|
305
|
+
* @public
|
|
272
306
|
* <p>Boolean that enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.</p>
|
|
273
307
|
*/
|
|
274
308
|
EnableMediaMetricLogs?: boolean;
|
|
@@ -278,6 +312,7 @@ export interface LoggingConfiguration {
|
|
|
278
312
|
*/
|
|
279
313
|
export interface GetVoiceConnectorLoggingConfigurationResponse {
|
|
280
314
|
/**
|
|
315
|
+
* @public
|
|
281
316
|
* <p>The logging configuration details.</p>
|
|
282
317
|
*/
|
|
283
318
|
LoggingConfiguration?: LoggingConfiguration;
|
|
@@ -287,6 +322,7 @@ export interface GetVoiceConnectorLoggingConfigurationResponse {
|
|
|
287
322
|
*/
|
|
288
323
|
export interface GetVoiceConnectorOriginationRequest {
|
|
289
324
|
/**
|
|
325
|
+
* @public
|
|
290
326
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
291
327
|
*/
|
|
292
328
|
VoiceConnectorId: string | undefined;
|
|
@@ -314,23 +350,28 @@ export type OriginationRouteProtocol = (typeof OriginationRouteProtocol)[keyof t
|
|
|
314
350
|
*/
|
|
315
351
|
export interface OriginationRoute {
|
|
316
352
|
/**
|
|
353
|
+
* @public
|
|
317
354
|
* <p>The FQDN or IP address to contact for origination traffic.</p>
|
|
318
355
|
*/
|
|
319
356
|
Host?: string;
|
|
320
357
|
/**
|
|
358
|
+
* @public
|
|
321
359
|
* <p>The designated origination route port. Defaults to 5060.</p>
|
|
322
360
|
*/
|
|
323
361
|
Port?: number;
|
|
324
362
|
/**
|
|
363
|
+
* @public
|
|
325
364
|
* <p>The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.</p>
|
|
326
365
|
*/
|
|
327
366
|
Protocol?: OriginationRouteProtocol | string;
|
|
328
367
|
/**
|
|
368
|
+
* @public
|
|
329
369
|
* <p>The priority associated with the host, with 1 being the highest priority. Higher priority
|
|
330
370
|
* hosts are attempted first.</p>
|
|
331
371
|
*/
|
|
332
372
|
Priority?: number;
|
|
333
373
|
/**
|
|
374
|
+
* @public
|
|
334
375
|
* <p>The weight associated with the host. If hosts are equal in priority, calls are redistributed among
|
|
335
376
|
* them based on their relative weight.</p>
|
|
336
377
|
*/
|
|
@@ -346,11 +387,13 @@ export interface OriginationRoute {
|
|
|
346
387
|
*/
|
|
347
388
|
export interface Origination {
|
|
348
389
|
/**
|
|
390
|
+
* @public
|
|
349
391
|
* <p>The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1.
|
|
350
392
|
* Maximum value of 20. This parameter is not required, but you must specify this parameter or <code>Disabled</code>.</p>
|
|
351
393
|
*/
|
|
352
394
|
Routes?: OriginationRoute[];
|
|
353
395
|
/**
|
|
396
|
+
* @public
|
|
354
397
|
* <p>When origination settings are disabled, inbound calls are not enabled for your Amazon Chime
|
|
355
398
|
* Voice Connector. This parameter is not required, but you must specify this parameter or <code>Routes</code>.</p>
|
|
356
399
|
*/
|
|
@@ -361,6 +404,7 @@ export interface Origination {
|
|
|
361
404
|
*/
|
|
362
405
|
export interface GetVoiceConnectorOriginationResponse {
|
|
363
406
|
/**
|
|
407
|
+
* @public
|
|
364
408
|
* <p>The origination setting details.</p>
|
|
365
409
|
*/
|
|
366
410
|
Origination?: Origination;
|
|
@@ -370,6 +414,7 @@ export interface GetVoiceConnectorOriginationResponse {
|
|
|
370
414
|
*/
|
|
371
415
|
export interface GetVoiceConnectorProxyRequest {
|
|
372
416
|
/**
|
|
417
|
+
* @public
|
|
373
418
|
* <p>The Amazon Chime voice connector ID.</p>
|
|
374
419
|
*/
|
|
375
420
|
VoiceConnectorId: string | undefined;
|
|
@@ -380,18 +425,22 @@ export interface GetVoiceConnectorProxyRequest {
|
|
|
380
425
|
*/
|
|
381
426
|
export interface Proxy {
|
|
382
427
|
/**
|
|
428
|
+
* @public
|
|
383
429
|
* <p>The default number of minutes allowed for proxy sessions.</p>
|
|
384
430
|
*/
|
|
385
431
|
DefaultSessionExpiryMinutes?: number;
|
|
386
432
|
/**
|
|
433
|
+
* @public
|
|
387
434
|
* <p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>
|
|
388
435
|
*/
|
|
389
436
|
Disabled?: boolean;
|
|
390
437
|
/**
|
|
438
|
+
* @public
|
|
391
439
|
* <p>The phone number to route calls to after a proxy session expires.</p>
|
|
392
440
|
*/
|
|
393
441
|
FallBackPhoneNumber?: string;
|
|
394
442
|
/**
|
|
443
|
+
* @public
|
|
395
444
|
* <p>The countries for proxy phone numbers to be selected from.</p>
|
|
396
445
|
*/
|
|
397
446
|
PhoneNumberCountries?: string[];
|
|
@@ -401,6 +450,7 @@ export interface Proxy {
|
|
|
401
450
|
*/
|
|
402
451
|
export interface GetVoiceConnectorProxyResponse {
|
|
403
452
|
/**
|
|
453
|
+
* @public
|
|
404
454
|
* <p>The proxy configuration details.</p>
|
|
405
455
|
*/
|
|
406
456
|
Proxy?: Proxy;
|
|
@@ -410,6 +460,7 @@ export interface GetVoiceConnectorProxyResponse {
|
|
|
410
460
|
*/
|
|
411
461
|
export interface GetVoiceConnectorStreamingConfigurationRequest {
|
|
412
462
|
/**
|
|
463
|
+
* @public
|
|
413
464
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
414
465
|
*/
|
|
415
466
|
VoiceConnectorId: string | undefined;
|
|
@@ -433,6 +484,7 @@ export type NotificationTarget = (typeof NotificationTarget)[keyof typeof Notifi
|
|
|
433
484
|
*/
|
|
434
485
|
export interface StreamingNotificationTarget {
|
|
435
486
|
/**
|
|
487
|
+
* @public
|
|
436
488
|
* <p>The streaming notification target.</p>
|
|
437
489
|
*/
|
|
438
490
|
NotificationTarget: NotificationTarget | string | undefined;
|
|
@@ -445,14 +497,17 @@ export interface StreamingNotificationTarget {
|
|
|
445
497
|
*/
|
|
446
498
|
export interface StreamingConfiguration {
|
|
447
499
|
/**
|
|
500
|
+
* @public
|
|
448
501
|
* <p>The retention period, in hours, for the Amazon Kinesis data.</p>
|
|
449
502
|
*/
|
|
450
503
|
DataRetentionInHours: number | undefined;
|
|
451
504
|
/**
|
|
505
|
+
* @public
|
|
452
506
|
* <p>When true, media streaming to Amazon Kinesis is turned off.</p>
|
|
453
507
|
*/
|
|
454
508
|
Disabled?: boolean;
|
|
455
509
|
/**
|
|
510
|
+
* @public
|
|
456
511
|
* <p>The streaming notification targets.</p>
|
|
457
512
|
*/
|
|
458
513
|
StreamingNotificationTargets?: StreamingNotificationTarget[];
|
|
@@ -462,6 +517,7 @@ export interface StreamingConfiguration {
|
|
|
462
517
|
*/
|
|
463
518
|
export interface GetVoiceConnectorStreamingConfigurationResponse {
|
|
464
519
|
/**
|
|
520
|
+
* @public
|
|
465
521
|
* <p>The streaming configuration details.</p>
|
|
466
522
|
*/
|
|
467
523
|
StreamingConfiguration?: StreamingConfiguration;
|
|
@@ -471,6 +527,7 @@ export interface GetVoiceConnectorStreamingConfigurationResponse {
|
|
|
471
527
|
*/
|
|
472
528
|
export interface GetVoiceConnectorTerminationRequest {
|
|
473
529
|
/**
|
|
530
|
+
* @public
|
|
474
531
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
475
532
|
*/
|
|
476
533
|
VoiceConnectorId: string | undefined;
|
|
@@ -482,23 +539,28 @@ export interface GetVoiceConnectorTerminationRequest {
|
|
|
482
539
|
*/
|
|
483
540
|
export interface Termination {
|
|
484
541
|
/**
|
|
542
|
+
* @public
|
|
485
543
|
* <p>The limit on calls per second. Max value based on account service quota. Default value of
|
|
486
544
|
* 1.</p>
|
|
487
545
|
*/
|
|
488
546
|
CpsLimit?: number;
|
|
489
547
|
/**
|
|
548
|
+
* @public
|
|
490
549
|
* <p>The default caller ID phone number.</p>
|
|
491
550
|
*/
|
|
492
551
|
DefaultPhoneNumber?: string;
|
|
493
552
|
/**
|
|
553
|
+
* @public
|
|
494
554
|
* <p>The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.</p>
|
|
495
555
|
*/
|
|
496
556
|
CallingRegions?: string[];
|
|
497
557
|
/**
|
|
558
|
+
* @public
|
|
498
559
|
* <p>The IP addresses allowed to make calls, in CIDR format. Required.</p>
|
|
499
560
|
*/
|
|
500
561
|
CidrAllowedList?: string[];
|
|
501
562
|
/**
|
|
563
|
+
* @public
|
|
502
564
|
* <p>When termination settings are disabled, outbound calls can not be made.</p>
|
|
503
565
|
*/
|
|
504
566
|
Disabled?: boolean;
|
|
@@ -508,6 +570,7 @@ export interface Termination {
|
|
|
508
570
|
*/
|
|
509
571
|
export interface GetVoiceConnectorTerminationResponse {
|
|
510
572
|
/**
|
|
573
|
+
* @public
|
|
511
574
|
* <p>The termination setting details.</p>
|
|
512
575
|
*/
|
|
513
576
|
Termination?: Termination;
|
|
@@ -517,6 +580,7 @@ export interface GetVoiceConnectorTerminationResponse {
|
|
|
517
580
|
*/
|
|
518
581
|
export interface GetVoiceConnectorTerminationHealthRequest {
|
|
519
582
|
/**
|
|
583
|
+
* @public
|
|
520
584
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
521
585
|
*/
|
|
522
586
|
VoiceConnectorId: string | undefined;
|
|
@@ -528,10 +592,12 @@ export interface GetVoiceConnectorTerminationHealthRequest {
|
|
|
528
592
|
*/
|
|
529
593
|
export interface TerminationHealth {
|
|
530
594
|
/**
|
|
595
|
+
* @public
|
|
531
596
|
* <p>The timestamp, in ISO 8601 format.</p>
|
|
532
597
|
*/
|
|
533
598
|
Timestamp?: Date;
|
|
534
599
|
/**
|
|
600
|
+
* @public
|
|
535
601
|
* <p>The source IP address.</p>
|
|
536
602
|
*/
|
|
537
603
|
Source?: string;
|
|
@@ -541,6 +607,7 @@ export interface TerminationHealth {
|
|
|
541
607
|
*/
|
|
542
608
|
export interface GetVoiceConnectorTerminationHealthResponse {
|
|
543
609
|
/**
|
|
610
|
+
* @public
|
|
544
611
|
* <p>The termination health details.</p>
|
|
545
612
|
*/
|
|
546
613
|
TerminationHealth?: TerminationHealth;
|
|
@@ -552,18 +619,22 @@ export interface GetVoiceConnectorTerminationHealthResponse {
|
|
|
552
619
|
*/
|
|
553
620
|
export interface Invite {
|
|
554
621
|
/**
|
|
622
|
+
* @public
|
|
555
623
|
* <p>The invite ID.</p>
|
|
556
624
|
*/
|
|
557
625
|
InviteId?: string;
|
|
558
626
|
/**
|
|
627
|
+
* @public
|
|
559
628
|
* <p>The status of the invite.</p>
|
|
560
629
|
*/
|
|
561
630
|
Status?: InviteStatus | string;
|
|
562
631
|
/**
|
|
632
|
+
* @public
|
|
563
633
|
* <p>The email address to which the invite is sent.</p>
|
|
564
634
|
*/
|
|
565
635
|
EmailAddress?: string;
|
|
566
636
|
/**
|
|
637
|
+
* @public
|
|
567
638
|
* <p>The status of the invite email.</p>
|
|
568
639
|
*/
|
|
569
640
|
EmailStatus?: EmailStatus | string;
|
|
@@ -573,14 +644,17 @@ export interface Invite {
|
|
|
573
644
|
*/
|
|
574
645
|
export interface InviteUsersRequest {
|
|
575
646
|
/**
|
|
647
|
+
* @public
|
|
576
648
|
* <p>The Amazon Chime account ID.</p>
|
|
577
649
|
*/
|
|
578
650
|
AccountId: string | undefined;
|
|
579
651
|
/**
|
|
652
|
+
* @public
|
|
580
653
|
* <p>The user email addresses to which to send the email invitation.</p>
|
|
581
654
|
*/
|
|
582
655
|
UserEmailList: string[] | undefined;
|
|
583
656
|
/**
|
|
657
|
+
* @public
|
|
584
658
|
* <p>The user type.</p>
|
|
585
659
|
*/
|
|
586
660
|
UserType?: UserType | string;
|
|
@@ -590,6 +664,7 @@ export interface InviteUsersRequest {
|
|
|
590
664
|
*/
|
|
591
665
|
export interface InviteUsersResponse {
|
|
592
666
|
/**
|
|
667
|
+
* @public
|
|
593
668
|
* <p>The email invitation details.</p>
|
|
594
669
|
*/
|
|
595
670
|
Invites?: Invite[];
|
|
@@ -599,18 +674,22 @@ export interface InviteUsersResponse {
|
|
|
599
674
|
*/
|
|
600
675
|
export interface ListAccountsRequest {
|
|
601
676
|
/**
|
|
677
|
+
* @public
|
|
602
678
|
* <p>Amazon Chime account name prefix with which to filter results.</p>
|
|
603
679
|
*/
|
|
604
680
|
Name?: string;
|
|
605
681
|
/**
|
|
682
|
+
* @public
|
|
606
683
|
* <p>User email address with which to filter results.</p>
|
|
607
684
|
*/
|
|
608
685
|
UserEmail?: string;
|
|
609
686
|
/**
|
|
687
|
+
* @public
|
|
610
688
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
611
689
|
*/
|
|
612
690
|
NextToken?: string;
|
|
613
691
|
/**
|
|
692
|
+
* @public
|
|
614
693
|
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
615
694
|
*/
|
|
616
695
|
MaxResults?: number;
|
|
@@ -620,10 +699,12 @@ export interface ListAccountsRequest {
|
|
|
620
699
|
*/
|
|
621
700
|
export interface ListAccountsResponse {
|
|
622
701
|
/**
|
|
702
|
+
* @public
|
|
623
703
|
* <p>List of Amazon Chime accounts and account details.</p>
|
|
624
704
|
*/
|
|
625
705
|
Accounts?: Account[];
|
|
626
706
|
/**
|
|
707
|
+
* @public
|
|
627
708
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
628
709
|
*/
|
|
629
710
|
NextToken?: string;
|
|
@@ -633,14 +714,17 @@ export interface ListAccountsResponse {
|
|
|
633
714
|
*/
|
|
634
715
|
export interface ListAppInstanceAdminsRequest {
|
|
635
716
|
/**
|
|
717
|
+
* @public
|
|
636
718
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
637
719
|
*/
|
|
638
720
|
AppInstanceArn: string | undefined;
|
|
639
721
|
/**
|
|
722
|
+
* @public
|
|
640
723
|
* <p>The maximum number of administrators that you want to return.</p>
|
|
641
724
|
*/
|
|
642
725
|
MaxResults?: number;
|
|
643
726
|
/**
|
|
727
|
+
* @public
|
|
644
728
|
* <p>The token returned from previous API requests until the number of administrators is reached.</p>
|
|
645
729
|
*/
|
|
646
730
|
NextToken?: string;
|
|
@@ -650,14 +734,17 @@ export interface ListAppInstanceAdminsRequest {
|
|
|
650
734
|
*/
|
|
651
735
|
export interface ListAppInstanceAdminsResponse {
|
|
652
736
|
/**
|
|
737
|
+
* @public
|
|
653
738
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
654
739
|
*/
|
|
655
740
|
AppInstanceArn?: string;
|
|
656
741
|
/**
|
|
742
|
+
* @public
|
|
657
743
|
* <p>The information for each administrator.</p>
|
|
658
744
|
*/
|
|
659
745
|
AppInstanceAdmins?: AppInstanceAdminSummary[];
|
|
660
746
|
/**
|
|
747
|
+
* @public
|
|
661
748
|
* <p>The token returned from previous API requests until the number of administrators is reached.</p>
|
|
662
749
|
*/
|
|
663
750
|
NextToken?: string;
|
|
@@ -667,10 +754,12 @@ export interface ListAppInstanceAdminsResponse {
|
|
|
667
754
|
*/
|
|
668
755
|
export interface ListAppInstancesRequest {
|
|
669
756
|
/**
|
|
757
|
+
* @public
|
|
670
758
|
* <p>The maximum number of <code>AppInstance</code>s that you want to return.</p>
|
|
671
759
|
*/
|
|
672
760
|
MaxResults?: number;
|
|
673
761
|
/**
|
|
762
|
+
* @public
|
|
674
763
|
* <p>The token passed by previous API requests until you reach the maximum number of <code>AppInstance</code>s.</p>
|
|
675
764
|
*/
|
|
676
765
|
NextToken?: string;
|
|
@@ -680,10 +769,12 @@ export interface ListAppInstancesRequest {
|
|
|
680
769
|
*/
|
|
681
770
|
export interface ListAppInstancesResponse {
|
|
682
771
|
/**
|
|
772
|
+
* @public
|
|
683
773
|
* <p>The information for each <code>AppInstance</code>.</p>
|
|
684
774
|
*/
|
|
685
775
|
AppInstances?: AppInstanceSummary[];
|
|
686
776
|
/**
|
|
777
|
+
* @public
|
|
687
778
|
* <p>The token passed by previous API requests until the maximum number of <code>AppInstance</code>s is reached.</p>
|
|
688
779
|
*/
|
|
689
780
|
NextToken?: string;
|
|
@@ -693,14 +784,17 @@ export interface ListAppInstancesResponse {
|
|
|
693
784
|
*/
|
|
694
785
|
export interface ListAppInstanceUsersRequest {
|
|
695
786
|
/**
|
|
787
|
+
* @public
|
|
696
788
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
697
789
|
*/
|
|
698
790
|
AppInstanceArn: string | undefined;
|
|
699
791
|
/**
|
|
792
|
+
* @public
|
|
700
793
|
* <p>The maximum number of requests that you want returned.</p>
|
|
701
794
|
*/
|
|
702
795
|
MaxResults?: number;
|
|
703
796
|
/**
|
|
797
|
+
* @public
|
|
704
798
|
* <p>The token passed by previous API calls until all requested users are returned.</p>
|
|
705
799
|
*/
|
|
706
800
|
NextToken?: string;
|
|
@@ -710,14 +804,17 @@ export interface ListAppInstanceUsersRequest {
|
|
|
710
804
|
*/
|
|
711
805
|
export interface ListAppInstanceUsersResponse {
|
|
712
806
|
/**
|
|
807
|
+
* @public
|
|
713
808
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
714
809
|
*/
|
|
715
810
|
AppInstanceArn?: string;
|
|
716
811
|
/**
|
|
812
|
+
* @public
|
|
717
813
|
* <p>The information for each requested <code>AppInstanceUser</code>.</p>
|
|
718
814
|
*/
|
|
719
815
|
AppInstanceUsers?: AppInstanceUserSummary[];
|
|
720
816
|
/**
|
|
817
|
+
* @public
|
|
721
818
|
* <p>The token passed by previous API calls until all requested users are returned.</p>
|
|
722
819
|
*/
|
|
723
820
|
NextToken?: string;
|
|
@@ -727,14 +824,17 @@ export interface ListAppInstanceUsersResponse {
|
|
|
727
824
|
*/
|
|
728
825
|
export interface ListAttendeesRequest {
|
|
729
826
|
/**
|
|
827
|
+
* @public
|
|
730
828
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
731
829
|
*/
|
|
732
830
|
MeetingId: string | undefined;
|
|
733
831
|
/**
|
|
832
|
+
* @public
|
|
734
833
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
735
834
|
*/
|
|
736
835
|
NextToken?: string;
|
|
737
836
|
/**
|
|
837
|
+
* @public
|
|
738
838
|
* <p>The maximum number of results to return in a single call.</p>
|
|
739
839
|
*/
|
|
740
840
|
MaxResults?: number;
|
|
@@ -744,10 +844,12 @@ export interface ListAttendeesRequest {
|
|
|
744
844
|
*/
|
|
745
845
|
export interface ListAttendeesResponse {
|
|
746
846
|
/**
|
|
847
|
+
* @public
|
|
747
848
|
* <p>The Amazon Chime SDK attendee information.</p>
|
|
748
849
|
*/
|
|
749
850
|
Attendees?: Attendee[];
|
|
750
851
|
/**
|
|
852
|
+
* @public
|
|
751
853
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
752
854
|
*/
|
|
753
855
|
NextToken?: string;
|
|
@@ -757,10 +859,12 @@ export interface ListAttendeesResponse {
|
|
|
757
859
|
*/
|
|
758
860
|
export interface ListAttendeeTagsRequest {
|
|
759
861
|
/**
|
|
862
|
+
* @public
|
|
760
863
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
761
864
|
*/
|
|
762
865
|
MeetingId: string | undefined;
|
|
763
866
|
/**
|
|
867
|
+
* @public
|
|
764
868
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
765
869
|
*/
|
|
766
870
|
AttendeeId: string | undefined;
|
|
@@ -770,6 +874,7 @@ export interface ListAttendeeTagsRequest {
|
|
|
770
874
|
*/
|
|
771
875
|
export interface ListAttendeeTagsResponse {
|
|
772
876
|
/**
|
|
877
|
+
* @public
|
|
773
878
|
* <p>A list of tag key-value pairs.</p>
|
|
774
879
|
*/
|
|
775
880
|
Tags?: Tag[];
|
|
@@ -779,14 +884,17 @@ export interface ListAttendeeTagsResponse {
|
|
|
779
884
|
*/
|
|
780
885
|
export interface ListBotsRequest {
|
|
781
886
|
/**
|
|
887
|
+
* @public
|
|
782
888
|
* <p>The Amazon Chime account ID.</p>
|
|
783
889
|
*/
|
|
784
890
|
AccountId: string | undefined;
|
|
785
891
|
/**
|
|
892
|
+
* @public
|
|
786
893
|
* <p>The maximum number of results to return in a single call. The default is 10.</p>
|
|
787
894
|
*/
|
|
788
895
|
MaxResults?: number;
|
|
789
896
|
/**
|
|
897
|
+
* @public
|
|
790
898
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
791
899
|
*/
|
|
792
900
|
NextToken?: string;
|
|
@@ -796,10 +904,12 @@ export interface ListBotsRequest {
|
|
|
796
904
|
*/
|
|
797
905
|
export interface ListBotsResponse {
|
|
798
906
|
/**
|
|
907
|
+
* @public
|
|
799
908
|
* <p>List of bots and bot details.</p>
|
|
800
909
|
*/
|
|
801
910
|
Bots?: Bot[];
|
|
802
911
|
/**
|
|
912
|
+
* @public
|
|
803
913
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
804
914
|
*/
|
|
805
915
|
NextToken?: string;
|
|
@@ -809,18 +919,22 @@ export interface ListBotsResponse {
|
|
|
809
919
|
*/
|
|
810
920
|
export interface ListChannelBansRequest {
|
|
811
921
|
/**
|
|
922
|
+
* @public
|
|
812
923
|
* <p>The ARN of the channel.</p>
|
|
813
924
|
*/
|
|
814
925
|
ChannelArn: string | undefined;
|
|
815
926
|
/**
|
|
927
|
+
* @public
|
|
816
928
|
* <p>The maximum number of bans that you want returned.</p>
|
|
817
929
|
*/
|
|
818
930
|
MaxResults?: number;
|
|
819
931
|
/**
|
|
932
|
+
* @public
|
|
820
933
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
821
934
|
*/
|
|
822
935
|
NextToken?: string;
|
|
823
936
|
/**
|
|
937
|
+
* @public
|
|
824
938
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
825
939
|
*/
|
|
826
940
|
ChimeBearer?: string;
|
|
@@ -830,14 +944,17 @@ export interface ListChannelBansRequest {
|
|
|
830
944
|
*/
|
|
831
945
|
export interface ListChannelBansResponse {
|
|
832
946
|
/**
|
|
947
|
+
* @public
|
|
833
948
|
* <p>The ARN of the channel.</p>
|
|
834
949
|
*/
|
|
835
950
|
ChannelArn?: string;
|
|
836
951
|
/**
|
|
952
|
+
* @public
|
|
837
953
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
838
954
|
*/
|
|
839
955
|
NextToken?: string;
|
|
840
956
|
/**
|
|
957
|
+
* @public
|
|
841
958
|
* <p>The information for each requested ban.</p>
|
|
842
959
|
*/
|
|
843
960
|
ChannelBans?: ChannelBanSummary[];
|
|
@@ -847,10 +964,12 @@ export interface ListChannelBansResponse {
|
|
|
847
964
|
*/
|
|
848
965
|
export interface ListChannelMembershipsRequest {
|
|
849
966
|
/**
|
|
967
|
+
* @public
|
|
850
968
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
851
969
|
*/
|
|
852
970
|
ChannelArn: string | undefined;
|
|
853
971
|
/**
|
|
972
|
+
* @public
|
|
854
973
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
855
974
|
* members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
|
|
856
975
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
@@ -858,15 +977,18 @@ export interface ListChannelMembershipsRequest {
|
|
|
858
977
|
*/
|
|
859
978
|
Type?: ChannelMembershipType | string;
|
|
860
979
|
/**
|
|
980
|
+
* @public
|
|
861
981
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
862
982
|
*/
|
|
863
983
|
MaxResults?: number;
|
|
864
984
|
/**
|
|
985
|
+
* @public
|
|
865
986
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
866
987
|
* returned.</p>
|
|
867
988
|
*/
|
|
868
989
|
NextToken?: string;
|
|
869
990
|
/**
|
|
991
|
+
* @public
|
|
870
992
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
871
993
|
*/
|
|
872
994
|
ChimeBearer?: string;
|
|
@@ -876,14 +998,17 @@ export interface ListChannelMembershipsRequest {
|
|
|
876
998
|
*/
|
|
877
999
|
export interface ListChannelMembershipsResponse {
|
|
878
1000
|
/**
|
|
1001
|
+
* @public
|
|
879
1002
|
* <p>The ARN of the channel.</p>
|
|
880
1003
|
*/
|
|
881
1004
|
ChannelArn?: string;
|
|
882
1005
|
/**
|
|
1006
|
+
* @public
|
|
883
1007
|
* <p>The information for the requested channel memberships.</p>
|
|
884
1008
|
*/
|
|
885
1009
|
ChannelMemberships?: ChannelMembershipSummary[];
|
|
886
1010
|
/**
|
|
1011
|
+
* @public
|
|
887
1012
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
888
1013
|
* returned.</p>
|
|
889
1014
|
*/
|
|
@@ -894,18 +1019,22 @@ export interface ListChannelMembershipsResponse {
|
|
|
894
1019
|
*/
|
|
895
1020
|
export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
896
1021
|
/**
|
|
1022
|
+
* @public
|
|
897
1023
|
* <p>The ARN of the <code>AppInstanceUser</code>s</p>
|
|
898
1024
|
*/
|
|
899
1025
|
AppInstanceUserArn?: string;
|
|
900
1026
|
/**
|
|
1027
|
+
* @public
|
|
901
1028
|
* <p>The maximum number of users that you want returned.</p>
|
|
902
1029
|
*/
|
|
903
1030
|
MaxResults?: number;
|
|
904
1031
|
/**
|
|
1032
|
+
* @public
|
|
905
1033
|
* <p>The token returned from previous API requests until the number of channel memberships is reached.</p>
|
|
906
1034
|
*/
|
|
907
1035
|
NextToken?: string;
|
|
908
1036
|
/**
|
|
1037
|
+
* @public
|
|
909
1038
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
910
1039
|
*/
|
|
911
1040
|
ChimeBearer?: string;
|
|
@@ -915,10 +1044,12 @@ export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
|
915
1044
|
*/
|
|
916
1045
|
export interface ListChannelMembershipsForAppInstanceUserResponse {
|
|
917
1046
|
/**
|
|
1047
|
+
* @public
|
|
918
1048
|
* <p>The information for the requested channel memberships.</p>
|
|
919
1049
|
*/
|
|
920
1050
|
ChannelMemberships?: ChannelMembershipForAppInstanceUserSummary[];
|
|
921
1051
|
/**
|
|
1052
|
+
* @public
|
|
922
1053
|
* <p>The token passed by previous API calls until all requested users are returned.</p>
|
|
923
1054
|
*/
|
|
924
1055
|
NextToken?: string;
|
|
@@ -940,31 +1071,38 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
940
1071
|
*/
|
|
941
1072
|
export interface ListChannelMessagesRequest {
|
|
942
1073
|
/**
|
|
1074
|
+
* @public
|
|
943
1075
|
* <p>The ARN of the channel.</p>
|
|
944
1076
|
*/
|
|
945
1077
|
ChannelArn: string | undefined;
|
|
946
1078
|
/**
|
|
1079
|
+
* @public
|
|
947
1080
|
* <p>The order in which you want messages sorted. Default is Descending, based on time
|
|
948
1081
|
* created.</p>
|
|
949
1082
|
*/
|
|
950
1083
|
SortOrder?: SortOrder | string;
|
|
951
1084
|
/**
|
|
1085
|
+
* @public
|
|
952
1086
|
* <p>The initial or starting time stamp for your requested messages.</p>
|
|
953
1087
|
*/
|
|
954
1088
|
NotBefore?: Date;
|
|
955
1089
|
/**
|
|
1090
|
+
* @public
|
|
956
1091
|
* <p>The final or ending time stamp for your requested messages.</p>
|
|
957
1092
|
*/
|
|
958
1093
|
NotAfter?: Date;
|
|
959
1094
|
/**
|
|
1095
|
+
* @public
|
|
960
1096
|
* <p>The maximum number of messages that you want returned.</p>
|
|
961
1097
|
*/
|
|
962
1098
|
MaxResults?: number;
|
|
963
1099
|
/**
|
|
1100
|
+
* @public
|
|
964
1101
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
965
1102
|
*/
|
|
966
1103
|
NextToken?: string;
|
|
967
1104
|
/**
|
|
1105
|
+
* @public
|
|
968
1106
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
969
1107
|
*/
|
|
970
1108
|
ChimeBearer?: string;
|
|
@@ -974,14 +1112,17 @@ export interface ListChannelMessagesRequest {
|
|
|
974
1112
|
*/
|
|
975
1113
|
export interface ListChannelMessagesResponse {
|
|
976
1114
|
/**
|
|
1115
|
+
* @public
|
|
977
1116
|
* <p>The ARN of the channel containing the requested messages.</p>
|
|
978
1117
|
*/
|
|
979
1118
|
ChannelArn?: string;
|
|
980
1119
|
/**
|
|
1120
|
+
* @public
|
|
981
1121
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
982
1122
|
*/
|
|
983
1123
|
NextToken?: string;
|
|
984
1124
|
/**
|
|
1125
|
+
* @public
|
|
985
1126
|
* <p>The information about, and content of, each requested message.</p>
|
|
986
1127
|
*/
|
|
987
1128
|
ChannelMessages?: ChannelMessageSummary[];
|
|
@@ -991,19 +1132,23 @@ export interface ListChannelMessagesResponse {
|
|
|
991
1132
|
*/
|
|
992
1133
|
export interface ListChannelModeratorsRequest {
|
|
993
1134
|
/**
|
|
1135
|
+
* @public
|
|
994
1136
|
* <p>The ARN of the channel.</p>
|
|
995
1137
|
*/
|
|
996
1138
|
ChannelArn: string | undefined;
|
|
997
1139
|
/**
|
|
1140
|
+
* @public
|
|
998
1141
|
* <p>The maximum number of moderators that you want returned.</p>
|
|
999
1142
|
*/
|
|
1000
1143
|
MaxResults?: number;
|
|
1001
1144
|
/**
|
|
1145
|
+
* @public
|
|
1002
1146
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
1003
1147
|
* returned.</p>
|
|
1004
1148
|
*/
|
|
1005
1149
|
NextToken?: string;
|
|
1006
1150
|
/**
|
|
1151
|
+
* @public
|
|
1007
1152
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
1008
1153
|
*/
|
|
1009
1154
|
ChimeBearer?: string;
|
|
@@ -1013,15 +1158,18 @@ export interface ListChannelModeratorsRequest {
|
|
|
1013
1158
|
*/
|
|
1014
1159
|
export interface ListChannelModeratorsResponse {
|
|
1015
1160
|
/**
|
|
1161
|
+
* @public
|
|
1016
1162
|
* <p>The ARN of the channel.</p>
|
|
1017
1163
|
*/
|
|
1018
1164
|
ChannelArn?: string;
|
|
1019
1165
|
/**
|
|
1166
|
+
* @public
|
|
1020
1167
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
1021
1168
|
* returned.</p>
|
|
1022
1169
|
*/
|
|
1023
1170
|
NextToken?: string;
|
|
1024
1171
|
/**
|
|
1172
|
+
* @public
|
|
1025
1173
|
* <p>The information about and names of each moderator.</p>
|
|
1026
1174
|
*/
|
|
1027
1175
|
ChannelModerators?: ChannelModeratorSummary[];
|
|
@@ -1031,24 +1179,29 @@ export interface ListChannelModeratorsResponse {
|
|
|
1031
1179
|
*/
|
|
1032
1180
|
export interface ListChannelsRequest {
|
|
1033
1181
|
/**
|
|
1182
|
+
* @public
|
|
1034
1183
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
1035
1184
|
*/
|
|
1036
1185
|
AppInstanceArn: string | undefined;
|
|
1037
1186
|
/**
|
|
1187
|
+
* @public
|
|
1038
1188
|
* <p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels.
|
|
1039
1189
|
* <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code>
|
|
1040
1190
|
* can retrieve private channels. </p>
|
|
1041
1191
|
*/
|
|
1042
1192
|
Privacy?: ChannelPrivacy | string;
|
|
1043
1193
|
/**
|
|
1194
|
+
* @public
|
|
1044
1195
|
* <p>The maximum number of channels that you want to return.</p>
|
|
1045
1196
|
*/
|
|
1046
1197
|
MaxResults?: number;
|
|
1047
1198
|
/**
|
|
1199
|
+
* @public
|
|
1048
1200
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
1049
1201
|
*/
|
|
1050
1202
|
NextToken?: string;
|
|
1051
1203
|
/**
|
|
1204
|
+
* @public
|
|
1052
1205
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
1053
1206
|
*/
|
|
1054
1207
|
ChimeBearer?: string;
|
|
@@ -1058,10 +1211,12 @@ export interface ListChannelsRequest {
|
|
|
1058
1211
|
*/
|
|
1059
1212
|
export interface ListChannelsResponse {
|
|
1060
1213
|
/**
|
|
1214
|
+
* @public
|
|
1061
1215
|
* <p>The information about each channel.</p>
|
|
1062
1216
|
*/
|
|
1063
1217
|
Channels?: ChannelSummary[];
|
|
1064
1218
|
/**
|
|
1219
|
+
* @public
|
|
1065
1220
|
* <p>The token returned from previous API requests until the number of channels is
|
|
1066
1221
|
* reached.</p>
|
|
1067
1222
|
*/
|
|
@@ -1072,19 +1227,23 @@ export interface ListChannelsResponse {
|
|
|
1072
1227
|
*/
|
|
1073
1228
|
export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
1074
1229
|
/**
|
|
1230
|
+
* @public
|
|
1075
1231
|
* <p>The ARN of the user in the moderated channel.</p>
|
|
1076
1232
|
*/
|
|
1077
1233
|
AppInstanceUserArn?: string;
|
|
1078
1234
|
/**
|
|
1235
|
+
* @public
|
|
1079
1236
|
* <p>The maximum number of channels in the request.</p>
|
|
1080
1237
|
*/
|
|
1081
1238
|
MaxResults?: number;
|
|
1082
1239
|
/**
|
|
1240
|
+
* @public
|
|
1083
1241
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
1084
1242
|
* the user is reached.</p>
|
|
1085
1243
|
*/
|
|
1086
1244
|
NextToken?: string;
|
|
1087
1245
|
/**
|
|
1246
|
+
* @public
|
|
1088
1247
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
1089
1248
|
*/
|
|
1090
1249
|
ChimeBearer?: string;
|
|
@@ -1094,10 +1253,12 @@ export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
|
1094
1253
|
*/
|
|
1095
1254
|
export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
1096
1255
|
/**
|
|
1256
|
+
* @public
|
|
1097
1257
|
* <p>The moderated channels in the request.</p>
|
|
1098
1258
|
*/
|
|
1099
1259
|
Channels?: ChannelModeratedByAppInstanceUserSummary[];
|
|
1100
1260
|
/**
|
|
1261
|
+
* @public
|
|
1101
1262
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
1102
1263
|
* the user is reached.</p>
|
|
1103
1264
|
*/
|
|
@@ -1108,10 +1269,12 @@ export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
|
1108
1269
|
*/
|
|
1109
1270
|
export interface ListMediaCapturePipelinesRequest {
|
|
1110
1271
|
/**
|
|
1272
|
+
* @public
|
|
1111
1273
|
* <p>The token used to retrieve the next page of results.</p>
|
|
1112
1274
|
*/
|
|
1113
1275
|
NextToken?: string;
|
|
1114
1276
|
/**
|
|
1277
|
+
* @public
|
|
1115
1278
|
* <p>The maximum number of results to return in a single call. Valid Range: 1 - 99.</p>
|
|
1116
1279
|
*/
|
|
1117
1280
|
MaxResults?: number;
|
|
@@ -1121,10 +1284,12 @@ export interface ListMediaCapturePipelinesRequest {
|
|
|
1121
1284
|
*/
|
|
1122
1285
|
export interface ListMediaCapturePipelinesResponse {
|
|
1123
1286
|
/**
|
|
1287
|
+
* @public
|
|
1124
1288
|
* <p>The media capture pipeline objects in the list.</p>
|
|
1125
1289
|
*/
|
|
1126
1290
|
MediaCapturePipelines?: MediaCapturePipeline[];
|
|
1127
1291
|
/**
|
|
1292
|
+
* @public
|
|
1128
1293
|
* <p>The token used to retrieve the next page of results. </p>
|
|
1129
1294
|
*/
|
|
1130
1295
|
NextToken?: string;
|
|
@@ -1134,10 +1299,12 @@ export interface ListMediaCapturePipelinesResponse {
|
|
|
1134
1299
|
*/
|
|
1135
1300
|
export interface ListMeetingsRequest {
|
|
1136
1301
|
/**
|
|
1302
|
+
* @public
|
|
1137
1303
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1138
1304
|
*/
|
|
1139
1305
|
NextToken?: string;
|
|
1140
1306
|
/**
|
|
1307
|
+
* @public
|
|
1141
1308
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1142
1309
|
*/
|
|
1143
1310
|
MaxResults?: number;
|
|
@@ -1147,10 +1314,12 @@ export interface ListMeetingsRequest {
|
|
|
1147
1314
|
*/
|
|
1148
1315
|
export interface ListMeetingsResponse {
|
|
1149
1316
|
/**
|
|
1317
|
+
* @public
|
|
1150
1318
|
* <p>The Amazon Chime SDK meeting information.</p>
|
|
1151
1319
|
*/
|
|
1152
1320
|
Meetings?: Meeting[];
|
|
1153
1321
|
/**
|
|
1322
|
+
* @public
|
|
1154
1323
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1155
1324
|
*/
|
|
1156
1325
|
NextToken?: string;
|
|
@@ -1160,6 +1329,7 @@ export interface ListMeetingsResponse {
|
|
|
1160
1329
|
*/
|
|
1161
1330
|
export interface ListMeetingTagsRequest {
|
|
1162
1331
|
/**
|
|
1332
|
+
* @public
|
|
1163
1333
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
1164
1334
|
*/
|
|
1165
1335
|
MeetingId: string | undefined;
|
|
@@ -1169,6 +1339,7 @@ export interface ListMeetingTagsRequest {
|
|
|
1169
1339
|
*/
|
|
1170
1340
|
export interface ListMeetingTagsResponse {
|
|
1171
1341
|
/**
|
|
1342
|
+
* @public
|
|
1172
1343
|
* <p>A list of tag key-value pairs.</p>
|
|
1173
1344
|
*/
|
|
1174
1345
|
Tags?: Tag[];
|
|
@@ -1178,10 +1349,12 @@ export interface ListMeetingTagsResponse {
|
|
|
1178
1349
|
*/
|
|
1179
1350
|
export interface ListPhoneNumberOrdersRequest {
|
|
1180
1351
|
/**
|
|
1352
|
+
* @public
|
|
1181
1353
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1182
1354
|
*/
|
|
1183
1355
|
NextToken?: string;
|
|
1184
1356
|
/**
|
|
1357
|
+
* @public
|
|
1185
1358
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1186
1359
|
*/
|
|
1187
1360
|
MaxResults?: number;
|
|
@@ -1191,10 +1364,12 @@ export interface ListPhoneNumberOrdersRequest {
|
|
|
1191
1364
|
*/
|
|
1192
1365
|
export interface ListPhoneNumberOrdersResponse {
|
|
1193
1366
|
/**
|
|
1367
|
+
* @public
|
|
1194
1368
|
* <p>The phone number order details.</p>
|
|
1195
1369
|
*/
|
|
1196
1370
|
PhoneNumberOrders?: PhoneNumberOrder[];
|
|
1197
1371
|
/**
|
|
1372
|
+
* @public
|
|
1198
1373
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1199
1374
|
*/
|
|
1200
1375
|
NextToken?: string;
|
|
@@ -1204,26 +1379,32 @@ export interface ListPhoneNumberOrdersResponse {
|
|
|
1204
1379
|
*/
|
|
1205
1380
|
export interface ListPhoneNumbersRequest {
|
|
1206
1381
|
/**
|
|
1382
|
+
* @public
|
|
1207
1383
|
* <p>The phone number status.</p>
|
|
1208
1384
|
*/
|
|
1209
1385
|
Status?: PhoneNumberStatus | string;
|
|
1210
1386
|
/**
|
|
1387
|
+
* @public
|
|
1211
1388
|
* <p>The phone number product type.</p>
|
|
1212
1389
|
*/
|
|
1213
1390
|
ProductType?: PhoneNumberProductType | string;
|
|
1214
1391
|
/**
|
|
1392
|
+
* @public
|
|
1215
1393
|
* <p>The filter to use to limit the number of results.</p>
|
|
1216
1394
|
*/
|
|
1217
1395
|
FilterName?: PhoneNumberAssociationName | string;
|
|
1218
1396
|
/**
|
|
1397
|
+
* @public
|
|
1219
1398
|
* <p>The value to use for the filter.</p>
|
|
1220
1399
|
*/
|
|
1221
1400
|
FilterValue?: string;
|
|
1222
1401
|
/**
|
|
1402
|
+
* @public
|
|
1223
1403
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1224
1404
|
*/
|
|
1225
1405
|
MaxResults?: number;
|
|
1226
1406
|
/**
|
|
1407
|
+
* @public
|
|
1227
1408
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1228
1409
|
*/
|
|
1229
1410
|
NextToken?: string;
|
|
@@ -1233,10 +1414,12 @@ export interface ListPhoneNumbersRequest {
|
|
|
1233
1414
|
*/
|
|
1234
1415
|
export interface ListPhoneNumbersResponse {
|
|
1235
1416
|
/**
|
|
1417
|
+
* @public
|
|
1236
1418
|
* <p>The phone number details.</p>
|
|
1237
1419
|
*/
|
|
1238
1420
|
PhoneNumbers?: PhoneNumber[];
|
|
1239
1421
|
/**
|
|
1422
|
+
* @public
|
|
1240
1423
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1241
1424
|
*/
|
|
1242
1425
|
NextToken?: string;
|
|
@@ -1246,18 +1429,22 @@ export interface ListPhoneNumbersResponse {
|
|
|
1246
1429
|
*/
|
|
1247
1430
|
export interface ListProxySessionsRequest {
|
|
1248
1431
|
/**
|
|
1432
|
+
* @public
|
|
1249
1433
|
* <p>The Amazon Chime voice connector ID.</p>
|
|
1250
1434
|
*/
|
|
1251
1435
|
VoiceConnectorId: string | undefined;
|
|
1252
1436
|
/**
|
|
1437
|
+
* @public
|
|
1253
1438
|
* <p>The proxy session status.</p>
|
|
1254
1439
|
*/
|
|
1255
1440
|
Status?: ProxySessionStatus | string;
|
|
1256
1441
|
/**
|
|
1442
|
+
* @public
|
|
1257
1443
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1258
1444
|
*/
|
|
1259
1445
|
NextToken?: string;
|
|
1260
1446
|
/**
|
|
1447
|
+
* @public
|
|
1261
1448
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1262
1449
|
*/
|
|
1263
1450
|
MaxResults?: number;
|
|
@@ -1267,10 +1454,12 @@ export interface ListProxySessionsRequest {
|
|
|
1267
1454
|
*/
|
|
1268
1455
|
export interface ListProxySessionsResponse {
|
|
1269
1456
|
/**
|
|
1457
|
+
* @public
|
|
1270
1458
|
* <p>The proxy session details.</p>
|
|
1271
1459
|
*/
|
|
1272
1460
|
ProxySessions?: ProxySession[];
|
|
1273
1461
|
/**
|
|
1462
|
+
* @public
|
|
1274
1463
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1275
1464
|
*/
|
|
1276
1465
|
NextToken?: string;
|
|
@@ -1280,18 +1469,22 @@ export interface ListProxySessionsResponse {
|
|
|
1280
1469
|
*/
|
|
1281
1470
|
export interface ListRoomMembershipsRequest {
|
|
1282
1471
|
/**
|
|
1472
|
+
* @public
|
|
1283
1473
|
* <p>The Amazon Chime account ID.</p>
|
|
1284
1474
|
*/
|
|
1285
1475
|
AccountId: string | undefined;
|
|
1286
1476
|
/**
|
|
1477
|
+
* @public
|
|
1287
1478
|
* <p>The room ID.</p>
|
|
1288
1479
|
*/
|
|
1289
1480
|
RoomId: string | undefined;
|
|
1290
1481
|
/**
|
|
1482
|
+
* @public
|
|
1291
1483
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1292
1484
|
*/
|
|
1293
1485
|
MaxResults?: number;
|
|
1294
1486
|
/**
|
|
1487
|
+
* @public
|
|
1295
1488
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1296
1489
|
*/
|
|
1297
1490
|
NextToken?: string;
|
|
@@ -1301,10 +1494,12 @@ export interface ListRoomMembershipsRequest {
|
|
|
1301
1494
|
*/
|
|
1302
1495
|
export interface ListRoomMembershipsResponse {
|
|
1303
1496
|
/**
|
|
1497
|
+
* @public
|
|
1304
1498
|
* <p>The room membership details.</p>
|
|
1305
1499
|
*/
|
|
1306
1500
|
RoomMemberships?: RoomMembership[];
|
|
1307
1501
|
/**
|
|
1502
|
+
* @public
|
|
1308
1503
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1309
1504
|
*/
|
|
1310
1505
|
NextToken?: string;
|
|
@@ -1314,18 +1509,22 @@ export interface ListRoomMembershipsResponse {
|
|
|
1314
1509
|
*/
|
|
1315
1510
|
export interface ListRoomsRequest {
|
|
1316
1511
|
/**
|
|
1512
|
+
* @public
|
|
1317
1513
|
* <p>The Amazon Chime account ID.</p>
|
|
1318
1514
|
*/
|
|
1319
1515
|
AccountId: string | undefined;
|
|
1320
1516
|
/**
|
|
1517
|
+
* @public
|
|
1321
1518
|
* <p>The member ID (user ID or bot ID).</p>
|
|
1322
1519
|
*/
|
|
1323
1520
|
MemberId?: string;
|
|
1324
1521
|
/**
|
|
1522
|
+
* @public
|
|
1325
1523
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1326
1524
|
*/
|
|
1327
1525
|
MaxResults?: number;
|
|
1328
1526
|
/**
|
|
1527
|
+
* @public
|
|
1329
1528
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1330
1529
|
*/
|
|
1331
1530
|
NextToken?: string;
|
|
@@ -1335,10 +1534,12 @@ export interface ListRoomsRequest {
|
|
|
1335
1534
|
*/
|
|
1336
1535
|
export interface ListRoomsResponse {
|
|
1337
1536
|
/**
|
|
1537
|
+
* @public
|
|
1338
1538
|
* <p>The room details.</p>
|
|
1339
1539
|
*/
|
|
1340
1540
|
Rooms?: Room[];
|
|
1341
1541
|
/**
|
|
1542
|
+
* @public
|
|
1342
1543
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1343
1544
|
*/
|
|
1344
1545
|
NextToken?: string;
|
|
@@ -1348,10 +1549,12 @@ export interface ListRoomsResponse {
|
|
|
1348
1549
|
*/
|
|
1349
1550
|
export interface ListSipMediaApplicationsRequest {
|
|
1350
1551
|
/**
|
|
1552
|
+
* @public
|
|
1351
1553
|
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
1352
1554
|
*/
|
|
1353
1555
|
MaxResults?: number;
|
|
1354
1556
|
/**
|
|
1557
|
+
* @public
|
|
1355
1558
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1356
1559
|
*/
|
|
1357
1560
|
NextToken?: string;
|
|
@@ -1361,10 +1564,12 @@ export interface ListSipMediaApplicationsRequest {
|
|
|
1361
1564
|
*/
|
|
1362
1565
|
export interface ListSipMediaApplicationsResponse {
|
|
1363
1566
|
/**
|
|
1567
|
+
* @public
|
|
1364
1568
|
* <p>List of SIP media applications and application details.</p>
|
|
1365
1569
|
*/
|
|
1366
1570
|
SipMediaApplications?: SipMediaApplication[];
|
|
1367
1571
|
/**
|
|
1572
|
+
* @public
|
|
1368
1573
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1369
1574
|
*/
|
|
1370
1575
|
NextToken?: string;
|
|
@@ -1374,14 +1579,17 @@ export interface ListSipMediaApplicationsResponse {
|
|
|
1374
1579
|
*/
|
|
1375
1580
|
export interface ListSipRulesRequest {
|
|
1376
1581
|
/**
|
|
1582
|
+
* @public
|
|
1377
1583
|
* <p>The SIP media application ID.</p>
|
|
1378
1584
|
*/
|
|
1379
1585
|
SipMediaApplicationId?: string;
|
|
1380
1586
|
/**
|
|
1587
|
+
* @public
|
|
1381
1588
|
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
1382
1589
|
*/
|
|
1383
1590
|
MaxResults?: number;
|
|
1384
1591
|
/**
|
|
1592
|
+
* @public
|
|
1385
1593
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1386
1594
|
*/
|
|
1387
1595
|
NextToken?: string;
|
|
@@ -1391,10 +1599,12 @@ export interface ListSipRulesRequest {
|
|
|
1391
1599
|
*/
|
|
1392
1600
|
export interface ListSipRulesResponse {
|
|
1393
1601
|
/**
|
|
1602
|
+
* @public
|
|
1394
1603
|
* <p>List of SIP rules and rule details.</p>
|
|
1395
1604
|
*/
|
|
1396
1605
|
SipRules?: SipRule[];
|
|
1397
1606
|
/**
|
|
1607
|
+
* @public
|
|
1398
1608
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1399
1609
|
*/
|
|
1400
1610
|
NextToken?: string;
|
|
@@ -1404,6 +1614,7 @@ export interface ListSipRulesResponse {
|
|
|
1404
1614
|
*/
|
|
1405
1615
|
export interface ListSupportedPhoneNumberCountriesRequest {
|
|
1406
1616
|
/**
|
|
1617
|
+
* @public
|
|
1407
1618
|
* <p>The phone number product type.</p>
|
|
1408
1619
|
*/
|
|
1409
1620
|
ProductType: PhoneNumberProductType | string | undefined;
|
|
@@ -1414,10 +1625,12 @@ export interface ListSupportedPhoneNumberCountriesRequest {
|
|
|
1414
1625
|
*/
|
|
1415
1626
|
export interface PhoneNumberCountry {
|
|
1416
1627
|
/**
|
|
1628
|
+
* @public
|
|
1417
1629
|
* <p>The phone number country code. Format: ISO 3166-1 alpha-2.</p>
|
|
1418
1630
|
*/
|
|
1419
1631
|
CountryCode?: string;
|
|
1420
1632
|
/**
|
|
1633
|
+
* @public
|
|
1421
1634
|
* <p>The supported phone number types. </p>
|
|
1422
1635
|
*/
|
|
1423
1636
|
SupportedPhoneNumberTypes?: (PhoneNumberType | string)[];
|
|
@@ -1427,6 +1640,7 @@ export interface PhoneNumberCountry {
|
|
|
1427
1640
|
*/
|
|
1428
1641
|
export interface ListSupportedPhoneNumberCountriesResponse {
|
|
1429
1642
|
/**
|
|
1643
|
+
* @public
|
|
1430
1644
|
* <p>The supported phone number countries.</p>
|
|
1431
1645
|
*/
|
|
1432
1646
|
PhoneNumberCountries?: PhoneNumberCountry[];
|
|
@@ -1436,6 +1650,7 @@ export interface ListSupportedPhoneNumberCountriesResponse {
|
|
|
1436
1650
|
*/
|
|
1437
1651
|
export interface ListTagsForResourceRequest {
|
|
1438
1652
|
/**
|
|
1653
|
+
* @public
|
|
1439
1654
|
* <p>The resource ARN.</p>
|
|
1440
1655
|
*/
|
|
1441
1656
|
ResourceARN: string | undefined;
|
|
@@ -1445,6 +1660,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1445
1660
|
*/
|
|
1446
1661
|
export interface ListTagsForResourceResponse {
|
|
1447
1662
|
/**
|
|
1663
|
+
* @public
|
|
1448
1664
|
* <p>A list of tag-key value pairs.</p>
|
|
1449
1665
|
*/
|
|
1450
1666
|
Tags?: Tag[];
|
|
@@ -1454,22 +1670,27 @@ export interface ListTagsForResourceResponse {
|
|
|
1454
1670
|
*/
|
|
1455
1671
|
export interface ListUsersRequest {
|
|
1456
1672
|
/**
|
|
1673
|
+
* @public
|
|
1457
1674
|
* <p>The Amazon Chime account ID.</p>
|
|
1458
1675
|
*/
|
|
1459
1676
|
AccountId: string | undefined;
|
|
1460
1677
|
/**
|
|
1678
|
+
* @public
|
|
1461
1679
|
* <p>Optional. The user email address used to filter results. Maximum 1.</p>
|
|
1462
1680
|
*/
|
|
1463
1681
|
UserEmail?: string;
|
|
1464
1682
|
/**
|
|
1683
|
+
* @public
|
|
1465
1684
|
* <p>The user type.</p>
|
|
1466
1685
|
*/
|
|
1467
1686
|
UserType?: UserType | string;
|
|
1468
1687
|
/**
|
|
1688
|
+
* @public
|
|
1469
1689
|
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
1470
1690
|
*/
|
|
1471
1691
|
MaxResults?: number;
|
|
1472
1692
|
/**
|
|
1693
|
+
* @public
|
|
1473
1694
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1474
1695
|
*/
|
|
1475
1696
|
NextToken?: string;
|
|
@@ -1479,10 +1700,12 @@ export interface ListUsersRequest {
|
|
|
1479
1700
|
*/
|
|
1480
1701
|
export interface ListUsersResponse {
|
|
1481
1702
|
/**
|
|
1703
|
+
* @public
|
|
1482
1704
|
* <p>List of users and user details.</p>
|
|
1483
1705
|
*/
|
|
1484
1706
|
Users?: User[];
|
|
1485
1707
|
/**
|
|
1708
|
+
* @public
|
|
1486
1709
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1487
1710
|
*/
|
|
1488
1711
|
NextToken?: string;
|
|
@@ -1492,10 +1715,12 @@ export interface ListUsersResponse {
|
|
|
1492
1715
|
*/
|
|
1493
1716
|
export interface ListVoiceConnectorGroupsRequest {
|
|
1494
1717
|
/**
|
|
1718
|
+
* @public
|
|
1495
1719
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1496
1720
|
*/
|
|
1497
1721
|
NextToken?: string;
|
|
1498
1722
|
/**
|
|
1723
|
+
* @public
|
|
1499
1724
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1500
1725
|
*/
|
|
1501
1726
|
MaxResults?: number;
|
|
@@ -1505,10 +1730,12 @@ export interface ListVoiceConnectorGroupsRequest {
|
|
|
1505
1730
|
*/
|
|
1506
1731
|
export interface ListVoiceConnectorGroupsResponse {
|
|
1507
1732
|
/**
|
|
1733
|
+
* @public
|
|
1508
1734
|
* <p>The details of the Amazon Chime Voice Connector groups.</p>
|
|
1509
1735
|
*/
|
|
1510
1736
|
VoiceConnectorGroups?: VoiceConnectorGroup[];
|
|
1511
1737
|
/**
|
|
1738
|
+
* @public
|
|
1512
1739
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1513
1740
|
*/
|
|
1514
1741
|
NextToken?: string;
|
|
@@ -1518,10 +1745,12 @@ export interface ListVoiceConnectorGroupsResponse {
|
|
|
1518
1745
|
*/
|
|
1519
1746
|
export interface ListVoiceConnectorsRequest {
|
|
1520
1747
|
/**
|
|
1748
|
+
* @public
|
|
1521
1749
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1522
1750
|
*/
|
|
1523
1751
|
NextToken?: string;
|
|
1524
1752
|
/**
|
|
1753
|
+
* @public
|
|
1525
1754
|
* <p>The maximum number of results to return in a single call.</p>
|
|
1526
1755
|
*/
|
|
1527
1756
|
MaxResults?: number;
|
|
@@ -1531,10 +1760,12 @@ export interface ListVoiceConnectorsRequest {
|
|
|
1531
1760
|
*/
|
|
1532
1761
|
export interface ListVoiceConnectorsResponse {
|
|
1533
1762
|
/**
|
|
1763
|
+
* @public
|
|
1534
1764
|
* <p>The details of the Amazon Chime Voice Connectors.</p>
|
|
1535
1765
|
*/
|
|
1536
1766
|
VoiceConnectors?: VoiceConnector[];
|
|
1537
1767
|
/**
|
|
1768
|
+
* @public
|
|
1538
1769
|
* <p>The token to use to retrieve the next page of results.</p>
|
|
1539
1770
|
*/
|
|
1540
1771
|
NextToken?: string;
|
|
@@ -1544,6 +1775,7 @@ export interface ListVoiceConnectorsResponse {
|
|
|
1544
1775
|
*/
|
|
1545
1776
|
export interface ListVoiceConnectorTerminationCredentialsRequest {
|
|
1546
1777
|
/**
|
|
1778
|
+
* @public
|
|
1547
1779
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1548
1780
|
*/
|
|
1549
1781
|
VoiceConnectorId: string | undefined;
|
|
@@ -1553,6 +1785,7 @@ export interface ListVoiceConnectorTerminationCredentialsRequest {
|
|
|
1553
1785
|
*/
|
|
1554
1786
|
export interface ListVoiceConnectorTerminationCredentialsResponse {
|
|
1555
1787
|
/**
|
|
1788
|
+
* @public
|
|
1556
1789
|
* <p>A list of user names.</p>
|
|
1557
1790
|
*/
|
|
1558
1791
|
Usernames?: string[];
|
|
@@ -1562,10 +1795,12 @@ export interface ListVoiceConnectorTerminationCredentialsResponse {
|
|
|
1562
1795
|
*/
|
|
1563
1796
|
export interface LogoutUserRequest {
|
|
1564
1797
|
/**
|
|
1798
|
+
* @public
|
|
1565
1799
|
* <p>The Amazon Chime account ID.</p>
|
|
1566
1800
|
*/
|
|
1567
1801
|
AccountId: string | undefined;
|
|
1568
1802
|
/**
|
|
1803
|
+
* @public
|
|
1569
1804
|
* <p>The user ID.</p>
|
|
1570
1805
|
*/
|
|
1571
1806
|
UserId: string | undefined;
|
|
@@ -1580,10 +1815,12 @@ export interface LogoutUserResponse {
|
|
|
1580
1815
|
*/
|
|
1581
1816
|
export interface PutAppInstanceRetentionSettingsRequest {
|
|
1582
1817
|
/**
|
|
1818
|
+
* @public
|
|
1583
1819
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
1584
1820
|
*/
|
|
1585
1821
|
AppInstanceArn: string | undefined;
|
|
1586
1822
|
/**
|
|
1823
|
+
* @public
|
|
1587
1824
|
* <p>The time in days to retain data. Data type: number.</p>
|
|
1588
1825
|
*/
|
|
1589
1826
|
AppInstanceRetentionSettings: AppInstanceRetentionSettings | undefined;
|
|
@@ -1593,10 +1830,12 @@ export interface PutAppInstanceRetentionSettingsRequest {
|
|
|
1593
1830
|
*/
|
|
1594
1831
|
export interface PutAppInstanceRetentionSettingsResponse {
|
|
1595
1832
|
/**
|
|
1833
|
+
* @public
|
|
1596
1834
|
* <p>The time in days to retain data. Data type: number.</p>
|
|
1597
1835
|
*/
|
|
1598
1836
|
AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
|
|
1599
1837
|
/**
|
|
1838
|
+
* @public
|
|
1600
1839
|
* <p>The time at which the API deletes data.</p>
|
|
1601
1840
|
*/
|
|
1602
1841
|
InitiateDeletionTimestamp?: Date;
|
|
@@ -1606,10 +1845,12 @@ export interface PutAppInstanceRetentionSettingsResponse {
|
|
|
1606
1845
|
*/
|
|
1607
1846
|
export interface PutAppInstanceStreamingConfigurationsRequest {
|
|
1608
1847
|
/**
|
|
1848
|
+
* @public
|
|
1609
1849
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
1610
1850
|
*/
|
|
1611
1851
|
AppInstanceArn: string | undefined;
|
|
1612
1852
|
/**
|
|
1853
|
+
* @public
|
|
1613
1854
|
* <p>The streaming configurations set for an <code>AppInstance</code>.</p>
|
|
1614
1855
|
*/
|
|
1615
1856
|
AppInstanceStreamingConfigurations: AppInstanceStreamingConfiguration[] | undefined;
|
|
@@ -1619,6 +1860,7 @@ export interface PutAppInstanceStreamingConfigurationsRequest {
|
|
|
1619
1860
|
*/
|
|
1620
1861
|
export interface PutAppInstanceStreamingConfigurationsResponse {
|
|
1621
1862
|
/**
|
|
1863
|
+
* @public
|
|
1622
1864
|
* <p>The streaming configurations of an <code>AppInstance</code>.</p>
|
|
1623
1865
|
*/
|
|
1624
1866
|
AppInstanceStreamingConfigurations?: AppInstanceStreamingConfiguration[];
|
|
@@ -1628,18 +1870,22 @@ export interface PutAppInstanceStreamingConfigurationsResponse {
|
|
|
1628
1870
|
*/
|
|
1629
1871
|
export interface PutEventsConfigurationRequest {
|
|
1630
1872
|
/**
|
|
1873
|
+
* @public
|
|
1631
1874
|
* <p>The Amazon Chime account ID.</p>
|
|
1632
1875
|
*/
|
|
1633
1876
|
AccountId: string | undefined;
|
|
1634
1877
|
/**
|
|
1878
|
+
* @public
|
|
1635
1879
|
* <p>The bot ID.</p>
|
|
1636
1880
|
*/
|
|
1637
1881
|
BotId: string | undefined;
|
|
1638
1882
|
/**
|
|
1883
|
+
* @public
|
|
1639
1884
|
* <p>HTTPS endpoint that allows the bot to receive outgoing events.</p>
|
|
1640
1885
|
*/
|
|
1641
1886
|
OutboundEventsHTTPSEndpoint?: string;
|
|
1642
1887
|
/**
|
|
1888
|
+
* @public
|
|
1643
1889
|
* <p>Lambda function ARN that allows the bot to receive outgoing events.</p>
|
|
1644
1890
|
*/
|
|
1645
1891
|
LambdaFunctionArn?: string;
|
|
@@ -1649,6 +1895,7 @@ export interface PutEventsConfigurationRequest {
|
|
|
1649
1895
|
*/
|
|
1650
1896
|
export interface PutEventsConfigurationResponse {
|
|
1651
1897
|
/**
|
|
1898
|
+
* @public
|
|
1652
1899
|
* <p>The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an
|
|
1653
1900
|
* AWS Lambda function ARN.</p>
|
|
1654
1901
|
*/
|
|
@@ -1659,10 +1906,12 @@ export interface PutEventsConfigurationResponse {
|
|
|
1659
1906
|
*/
|
|
1660
1907
|
export interface PutRetentionSettingsRequest {
|
|
1661
1908
|
/**
|
|
1909
|
+
* @public
|
|
1662
1910
|
* <p>The Amazon Chime account ID.</p>
|
|
1663
1911
|
*/
|
|
1664
1912
|
AccountId: string | undefined;
|
|
1665
1913
|
/**
|
|
1914
|
+
* @public
|
|
1666
1915
|
* <p>The retention settings.</p>
|
|
1667
1916
|
*/
|
|
1668
1917
|
RetentionSettings: RetentionSettings | undefined;
|
|
@@ -1672,10 +1921,12 @@ export interface PutRetentionSettingsRequest {
|
|
|
1672
1921
|
*/
|
|
1673
1922
|
export interface PutRetentionSettingsResponse {
|
|
1674
1923
|
/**
|
|
1924
|
+
* @public
|
|
1675
1925
|
* <p>The retention settings.</p>
|
|
1676
1926
|
*/
|
|
1677
1927
|
RetentionSettings?: RetentionSettings;
|
|
1678
1928
|
/**
|
|
1929
|
+
* @public
|
|
1679
1930
|
* <p>The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.</p>
|
|
1680
1931
|
*/
|
|
1681
1932
|
InitiateDeletionTimestamp?: Date;
|
|
@@ -1685,10 +1936,12 @@ export interface PutRetentionSettingsResponse {
|
|
|
1685
1936
|
*/
|
|
1686
1937
|
export interface PutSipMediaApplicationLoggingConfigurationRequest {
|
|
1687
1938
|
/**
|
|
1939
|
+
* @public
|
|
1688
1940
|
* <p>The SIP media application ID.</p>
|
|
1689
1941
|
*/
|
|
1690
1942
|
SipMediaApplicationId: string | undefined;
|
|
1691
1943
|
/**
|
|
1944
|
+
* @public
|
|
1692
1945
|
* <p>The actual logging configuration.</p>
|
|
1693
1946
|
*/
|
|
1694
1947
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
@@ -1698,6 +1951,7 @@ export interface PutSipMediaApplicationLoggingConfigurationRequest {
|
|
|
1698
1951
|
*/
|
|
1699
1952
|
export interface PutSipMediaApplicationLoggingConfigurationResponse {
|
|
1700
1953
|
/**
|
|
1954
|
+
* @public
|
|
1701
1955
|
* <p>The logging configuration of the SIP media application.</p>
|
|
1702
1956
|
*/
|
|
1703
1957
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
@@ -1707,10 +1961,12 @@ export interface PutSipMediaApplicationLoggingConfigurationResponse {
|
|
|
1707
1961
|
*/
|
|
1708
1962
|
export interface PutVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
1709
1963
|
/**
|
|
1964
|
+
* @public
|
|
1710
1965
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1711
1966
|
*/
|
|
1712
1967
|
VoiceConnectorId: string | undefined;
|
|
1713
1968
|
/**
|
|
1969
|
+
* @public
|
|
1714
1970
|
* <p>The emergency calling configuration details.</p>
|
|
1715
1971
|
*/
|
|
1716
1972
|
EmergencyCallingConfiguration: EmergencyCallingConfiguration | undefined;
|
|
@@ -1720,6 +1976,7 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
|
1720
1976
|
*/
|
|
1721
1977
|
export interface PutVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
1722
1978
|
/**
|
|
1979
|
+
* @public
|
|
1723
1980
|
* <p>The emergency calling configuration details.</p>
|
|
1724
1981
|
*/
|
|
1725
1982
|
EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
|
|
@@ -1729,10 +1986,12 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
|
1729
1986
|
*/
|
|
1730
1987
|
export interface PutVoiceConnectorLoggingConfigurationRequest {
|
|
1731
1988
|
/**
|
|
1989
|
+
* @public
|
|
1732
1990
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1733
1991
|
*/
|
|
1734
1992
|
VoiceConnectorId: string | undefined;
|
|
1735
1993
|
/**
|
|
1994
|
+
* @public
|
|
1736
1995
|
* <p>The logging configuration details to add.</p>
|
|
1737
1996
|
*/
|
|
1738
1997
|
LoggingConfiguration: LoggingConfiguration | undefined;
|
|
@@ -1742,6 +2001,7 @@ export interface PutVoiceConnectorLoggingConfigurationRequest {
|
|
|
1742
2001
|
*/
|
|
1743
2002
|
export interface PutVoiceConnectorLoggingConfigurationResponse {
|
|
1744
2003
|
/**
|
|
2004
|
+
* @public
|
|
1745
2005
|
* <p>The updated logging configuration details.</p>
|
|
1746
2006
|
*/
|
|
1747
2007
|
LoggingConfiguration?: LoggingConfiguration;
|
|
@@ -1751,10 +2011,12 @@ export interface PutVoiceConnectorLoggingConfigurationResponse {
|
|
|
1751
2011
|
*/
|
|
1752
2012
|
export interface PutVoiceConnectorOriginationRequest {
|
|
1753
2013
|
/**
|
|
2014
|
+
* @public
|
|
1754
2015
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1755
2016
|
*/
|
|
1756
2017
|
VoiceConnectorId: string | undefined;
|
|
1757
2018
|
/**
|
|
2019
|
+
* @public
|
|
1758
2020
|
* <p>The origination setting details to add.</p>
|
|
1759
2021
|
*/
|
|
1760
2022
|
Origination: Origination | undefined;
|
|
@@ -1764,6 +2026,7 @@ export interface PutVoiceConnectorOriginationRequest {
|
|
|
1764
2026
|
*/
|
|
1765
2027
|
export interface PutVoiceConnectorOriginationResponse {
|
|
1766
2028
|
/**
|
|
2029
|
+
* @public
|
|
1767
2030
|
* <p>The updated origination setting details.</p>
|
|
1768
2031
|
*/
|
|
1769
2032
|
Origination?: Origination;
|
|
@@ -1773,22 +2036,27 @@ export interface PutVoiceConnectorOriginationResponse {
|
|
|
1773
2036
|
*/
|
|
1774
2037
|
export interface PutVoiceConnectorProxyRequest {
|
|
1775
2038
|
/**
|
|
2039
|
+
* @public
|
|
1776
2040
|
* <p>The Amazon Chime voice connector ID.</p>
|
|
1777
2041
|
*/
|
|
1778
2042
|
VoiceConnectorId: string | undefined;
|
|
1779
2043
|
/**
|
|
2044
|
+
* @public
|
|
1780
2045
|
* <p>The default number of minutes allowed for proxy sessions.</p>
|
|
1781
2046
|
*/
|
|
1782
2047
|
DefaultSessionExpiryMinutes: number | undefined;
|
|
1783
2048
|
/**
|
|
2049
|
+
* @public
|
|
1784
2050
|
* <p>The countries for proxy phone numbers to be selected from.</p>
|
|
1785
2051
|
*/
|
|
1786
2052
|
PhoneNumberPoolCountries: string[] | undefined;
|
|
1787
2053
|
/**
|
|
2054
|
+
* @public
|
|
1788
2055
|
* <p>The phone number to route calls to after a proxy session expires.</p>
|
|
1789
2056
|
*/
|
|
1790
2057
|
FallBackPhoneNumber?: string;
|
|
1791
2058
|
/**
|
|
2059
|
+
* @public
|
|
1792
2060
|
* <p>When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.</p>
|
|
1793
2061
|
*/
|
|
1794
2062
|
Disabled?: boolean;
|
|
@@ -1798,6 +2066,7 @@ export interface PutVoiceConnectorProxyRequest {
|
|
|
1798
2066
|
*/
|
|
1799
2067
|
export interface PutVoiceConnectorProxyResponse {
|
|
1800
2068
|
/**
|
|
2069
|
+
* @public
|
|
1801
2070
|
* <p>The proxy configuration details.</p>
|
|
1802
2071
|
*/
|
|
1803
2072
|
Proxy?: Proxy;
|
|
@@ -1807,10 +2076,12 @@ export interface PutVoiceConnectorProxyResponse {
|
|
|
1807
2076
|
*/
|
|
1808
2077
|
export interface PutVoiceConnectorStreamingConfigurationRequest {
|
|
1809
2078
|
/**
|
|
2079
|
+
* @public
|
|
1810
2080
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1811
2081
|
*/
|
|
1812
2082
|
VoiceConnectorId: string | undefined;
|
|
1813
2083
|
/**
|
|
2084
|
+
* @public
|
|
1814
2085
|
* <p>The streaming configuration details to add.</p>
|
|
1815
2086
|
*/
|
|
1816
2087
|
StreamingConfiguration: StreamingConfiguration | undefined;
|
|
@@ -1820,6 +2091,7 @@ export interface PutVoiceConnectorStreamingConfigurationRequest {
|
|
|
1820
2091
|
*/
|
|
1821
2092
|
export interface PutVoiceConnectorStreamingConfigurationResponse {
|
|
1822
2093
|
/**
|
|
2094
|
+
* @public
|
|
1823
2095
|
* <p>The updated streaming configuration details.</p>
|
|
1824
2096
|
*/
|
|
1825
2097
|
StreamingConfiguration?: StreamingConfiguration;
|
|
@@ -1829,10 +2101,12 @@ export interface PutVoiceConnectorStreamingConfigurationResponse {
|
|
|
1829
2101
|
*/
|
|
1830
2102
|
export interface PutVoiceConnectorTerminationRequest {
|
|
1831
2103
|
/**
|
|
2104
|
+
* @public
|
|
1832
2105
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1833
2106
|
*/
|
|
1834
2107
|
VoiceConnectorId: string | undefined;
|
|
1835
2108
|
/**
|
|
2109
|
+
* @public
|
|
1836
2110
|
* <p>The termination setting details to add.</p>
|
|
1837
2111
|
*/
|
|
1838
2112
|
Termination: Termination | undefined;
|
|
@@ -1842,6 +2116,7 @@ export interface PutVoiceConnectorTerminationRequest {
|
|
|
1842
2116
|
*/
|
|
1843
2117
|
export interface PutVoiceConnectorTerminationResponse {
|
|
1844
2118
|
/**
|
|
2119
|
+
* @public
|
|
1845
2120
|
* <p>The updated termination setting details.</p>
|
|
1846
2121
|
*/
|
|
1847
2122
|
Termination?: Termination;
|
|
@@ -1851,10 +2126,12 @@ export interface PutVoiceConnectorTerminationResponse {
|
|
|
1851
2126
|
*/
|
|
1852
2127
|
export interface PutVoiceConnectorTerminationCredentialsRequest {
|
|
1853
2128
|
/**
|
|
2129
|
+
* @public
|
|
1854
2130
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
1855
2131
|
*/
|
|
1856
2132
|
VoiceConnectorId: string | undefined;
|
|
1857
2133
|
/**
|
|
2134
|
+
* @public
|
|
1858
2135
|
* <p>The termination SIP credentials.</p>
|
|
1859
2136
|
*/
|
|
1860
2137
|
Credentials?: Credential[];
|
|
@@ -1864,14 +2141,17 @@ export interface PutVoiceConnectorTerminationCredentialsRequest {
|
|
|
1864
2141
|
*/
|
|
1865
2142
|
export interface RedactChannelMessageRequest {
|
|
1866
2143
|
/**
|
|
2144
|
+
* @public
|
|
1867
2145
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
1868
2146
|
*/
|
|
1869
2147
|
ChannelArn: string | undefined;
|
|
1870
2148
|
/**
|
|
2149
|
+
* @public
|
|
1871
2150
|
* <p>The ID of the message being redacted.</p>
|
|
1872
2151
|
*/
|
|
1873
2152
|
MessageId: string | undefined;
|
|
1874
2153
|
/**
|
|
2154
|
+
* @public
|
|
1875
2155
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
1876
2156
|
*/
|
|
1877
2157
|
ChimeBearer?: string;
|
|
@@ -1881,10 +2161,12 @@ export interface RedactChannelMessageRequest {
|
|
|
1881
2161
|
*/
|
|
1882
2162
|
export interface RedactChannelMessageResponse {
|
|
1883
2163
|
/**
|
|
2164
|
+
* @public
|
|
1884
2165
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
1885
2166
|
*/
|
|
1886
2167
|
ChannelArn?: string;
|
|
1887
2168
|
/**
|
|
2169
|
+
* @public
|
|
1888
2170
|
* <p>The ID of the message being redacted.</p>
|
|
1889
2171
|
*/
|
|
1890
2172
|
MessageId?: string;
|
|
@@ -1894,14 +2176,17 @@ export interface RedactChannelMessageResponse {
|
|
|
1894
2176
|
*/
|
|
1895
2177
|
export interface RedactConversationMessageRequest {
|
|
1896
2178
|
/**
|
|
2179
|
+
* @public
|
|
1897
2180
|
* <p>The Amazon Chime account ID.</p>
|
|
1898
2181
|
*/
|
|
1899
2182
|
AccountId: string | undefined;
|
|
1900
2183
|
/**
|
|
2184
|
+
* @public
|
|
1901
2185
|
* <p>The conversation ID.</p>
|
|
1902
2186
|
*/
|
|
1903
2187
|
ConversationId: string | undefined;
|
|
1904
2188
|
/**
|
|
2189
|
+
* @public
|
|
1905
2190
|
* <p>The message ID.</p>
|
|
1906
2191
|
*/
|
|
1907
2192
|
MessageId: string | undefined;
|
|
@@ -1916,14 +2201,17 @@ export interface RedactConversationMessageResponse {
|
|
|
1916
2201
|
*/
|
|
1917
2202
|
export interface RedactRoomMessageRequest {
|
|
1918
2203
|
/**
|
|
2204
|
+
* @public
|
|
1919
2205
|
* <p>The Amazon Chime account ID.</p>
|
|
1920
2206
|
*/
|
|
1921
2207
|
AccountId: string | undefined;
|
|
1922
2208
|
/**
|
|
2209
|
+
* @public
|
|
1923
2210
|
* <p>The room ID.</p>
|
|
1924
2211
|
*/
|
|
1925
2212
|
RoomId: string | undefined;
|
|
1926
2213
|
/**
|
|
2214
|
+
* @public
|
|
1927
2215
|
* <p>The message ID.</p>
|
|
1928
2216
|
*/
|
|
1929
2217
|
MessageId: string | undefined;
|
|
@@ -1938,10 +2226,12 @@ export interface RedactRoomMessageResponse {
|
|
|
1938
2226
|
*/
|
|
1939
2227
|
export interface RegenerateSecurityTokenRequest {
|
|
1940
2228
|
/**
|
|
2229
|
+
* @public
|
|
1941
2230
|
* <p>The Amazon Chime account ID.</p>
|
|
1942
2231
|
*/
|
|
1943
2232
|
AccountId: string | undefined;
|
|
1944
2233
|
/**
|
|
2234
|
+
* @public
|
|
1945
2235
|
* <p>The bot ID.</p>
|
|
1946
2236
|
*/
|
|
1947
2237
|
BotId: string | undefined;
|
|
@@ -1951,6 +2241,7 @@ export interface RegenerateSecurityTokenRequest {
|
|
|
1951
2241
|
*/
|
|
1952
2242
|
export interface RegenerateSecurityTokenResponse {
|
|
1953
2243
|
/**
|
|
2244
|
+
* @public
|
|
1954
2245
|
* <p>A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.</p>
|
|
1955
2246
|
*/
|
|
1956
2247
|
Bot?: Bot;
|
|
@@ -1960,10 +2251,12 @@ export interface RegenerateSecurityTokenResponse {
|
|
|
1960
2251
|
*/
|
|
1961
2252
|
export interface ResetPersonalPINRequest {
|
|
1962
2253
|
/**
|
|
2254
|
+
* @public
|
|
1963
2255
|
* <p>The Amazon Chime account ID.</p>
|
|
1964
2256
|
*/
|
|
1965
2257
|
AccountId: string | undefined;
|
|
1966
2258
|
/**
|
|
2259
|
+
* @public
|
|
1967
2260
|
* <p>The user ID.</p>
|
|
1968
2261
|
*/
|
|
1969
2262
|
UserId: string | undefined;
|
|
@@ -1973,6 +2266,7 @@ export interface ResetPersonalPINRequest {
|
|
|
1973
2266
|
*/
|
|
1974
2267
|
export interface ResetPersonalPINResponse {
|
|
1975
2268
|
/**
|
|
2269
|
+
* @public
|
|
1976
2270
|
* <p>The user details and new personal meeting PIN.</p>
|
|
1977
2271
|
*/
|
|
1978
2272
|
User?: User;
|
|
@@ -1982,6 +2276,7 @@ export interface ResetPersonalPINResponse {
|
|
|
1982
2276
|
*/
|
|
1983
2277
|
export interface RestorePhoneNumberRequest {
|
|
1984
2278
|
/**
|
|
2279
|
+
* @public
|
|
1985
2280
|
* <p>The phone number.</p>
|
|
1986
2281
|
*/
|
|
1987
2282
|
PhoneNumberId: string | undefined;
|
|
@@ -1991,6 +2286,7 @@ export interface RestorePhoneNumberRequest {
|
|
|
1991
2286
|
*/
|
|
1992
2287
|
export interface RestorePhoneNumberResponse {
|
|
1993
2288
|
/**
|
|
2289
|
+
* @public
|
|
1994
2290
|
* <p>The phone number details.</p>
|
|
1995
2291
|
*/
|
|
1996
2292
|
PhoneNumber?: PhoneNumber;
|
|
@@ -2000,34 +2296,42 @@ export interface RestorePhoneNumberResponse {
|
|
|
2000
2296
|
*/
|
|
2001
2297
|
export interface SearchAvailablePhoneNumbersRequest {
|
|
2002
2298
|
/**
|
|
2299
|
+
* @public
|
|
2003
2300
|
* <p>The area code used to filter results. Only applies to the US.</p>
|
|
2004
2301
|
*/
|
|
2005
2302
|
AreaCode?: string;
|
|
2006
2303
|
/**
|
|
2304
|
+
* @public
|
|
2007
2305
|
* <p>The city used to filter results. Only applies to the US.</p>
|
|
2008
2306
|
*/
|
|
2009
2307
|
City?: string;
|
|
2010
2308
|
/**
|
|
2309
|
+
* @public
|
|
2011
2310
|
* <p>The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.</p>
|
|
2012
2311
|
*/
|
|
2013
2312
|
Country?: string;
|
|
2014
2313
|
/**
|
|
2314
|
+
* @public
|
|
2015
2315
|
* <p>The state used to filter results. Required only if you provide <code>City</code>. Only applies to the US.</p>
|
|
2016
2316
|
*/
|
|
2017
2317
|
State?: string;
|
|
2018
2318
|
/**
|
|
2319
|
+
* @public
|
|
2019
2320
|
* <p>The toll-free prefix that you use to filter results. Only applies to the US.</p>
|
|
2020
2321
|
*/
|
|
2021
2322
|
TollFreePrefix?: string;
|
|
2022
2323
|
/**
|
|
2324
|
+
* @public
|
|
2023
2325
|
* <p>The phone number type used to filter results. Required for non-US numbers.</p>
|
|
2024
2326
|
*/
|
|
2025
2327
|
PhoneNumberType?: PhoneNumberType | string;
|
|
2026
2328
|
/**
|
|
2329
|
+
* @public
|
|
2027
2330
|
* <p>The maximum number of results to return in a single call.</p>
|
|
2028
2331
|
*/
|
|
2029
2332
|
MaxResults?: number;
|
|
2030
2333
|
/**
|
|
2334
|
+
* @public
|
|
2031
2335
|
* <p>The token used to retrieve the next page of results.</p>
|
|
2032
2336
|
*/
|
|
2033
2337
|
NextToken?: string;
|
|
@@ -2037,10 +2341,12 @@ export interface SearchAvailablePhoneNumbersRequest {
|
|
|
2037
2341
|
*/
|
|
2038
2342
|
export interface SearchAvailablePhoneNumbersResponse {
|
|
2039
2343
|
/**
|
|
2344
|
+
* @public
|
|
2040
2345
|
* <p>List of phone numbers, in E.164 format.</p>
|
|
2041
2346
|
*/
|
|
2042
2347
|
E164PhoneNumbers?: string[];
|
|
2043
2348
|
/**
|
|
2349
|
+
* @public
|
|
2044
2350
|
* <p>The token used to retrieve the next page of search results.</p>
|
|
2045
2351
|
*/
|
|
2046
2352
|
NextToken?: string;
|
|
@@ -2050,30 +2356,37 @@ export interface SearchAvailablePhoneNumbersResponse {
|
|
|
2050
2356
|
*/
|
|
2051
2357
|
export interface SendChannelMessageRequest {
|
|
2052
2358
|
/**
|
|
2359
|
+
* @public
|
|
2053
2360
|
* <p>The ARN of the channel.</p>
|
|
2054
2361
|
*/
|
|
2055
2362
|
ChannelArn: string | undefined;
|
|
2056
2363
|
/**
|
|
2364
|
+
* @public
|
|
2057
2365
|
* <p>The content of the message.</p>
|
|
2058
2366
|
*/
|
|
2059
2367
|
Content: string | undefined;
|
|
2060
2368
|
/**
|
|
2369
|
+
* @public
|
|
2061
2370
|
* <p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p>
|
|
2062
2371
|
*/
|
|
2063
2372
|
Type: ChannelMessageType | string | undefined;
|
|
2064
2373
|
/**
|
|
2374
|
+
* @public
|
|
2065
2375
|
* <p>Boolean that controls whether the message is persisted on the back end. Required.</p>
|
|
2066
2376
|
*/
|
|
2067
2377
|
Persistence: ChannelMessagePersistenceType | string | undefined;
|
|
2068
2378
|
/**
|
|
2379
|
+
* @public
|
|
2069
2380
|
* <p>The optional metadata for each message.</p>
|
|
2070
2381
|
*/
|
|
2071
2382
|
Metadata?: string;
|
|
2072
2383
|
/**
|
|
2384
|
+
* @public
|
|
2073
2385
|
* <p>The <code>Idempotency</code> token for each client request.</p>
|
|
2074
2386
|
*/
|
|
2075
2387
|
ClientRequestToken?: string;
|
|
2076
2388
|
/**
|
|
2389
|
+
* @public
|
|
2077
2390
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
2078
2391
|
*/
|
|
2079
2392
|
ChimeBearer?: string;
|
|
@@ -2083,10 +2396,12 @@ export interface SendChannelMessageRequest {
|
|
|
2083
2396
|
*/
|
|
2084
2397
|
export interface SendChannelMessageResponse {
|
|
2085
2398
|
/**
|
|
2399
|
+
* @public
|
|
2086
2400
|
* <p>The ARN of the channel.</p>
|
|
2087
2401
|
*/
|
|
2088
2402
|
ChannelArn?: string;
|
|
2089
2403
|
/**
|
|
2404
|
+
* @public
|
|
2090
2405
|
* <p>The ID string assigned to each message.</p>
|
|
2091
2406
|
*/
|
|
2092
2407
|
MessageId?: string;
|
|
@@ -2097,10 +2412,12 @@ export interface SendChannelMessageResponse {
|
|
|
2097
2412
|
*/
|
|
2098
2413
|
export interface TranscriptionConfiguration {
|
|
2099
2414
|
/**
|
|
2415
|
+
* @public
|
|
2100
2416
|
* <p>The transcription configuration settings passed to Amazon Transcribe.</p>
|
|
2101
2417
|
*/
|
|
2102
2418
|
EngineTranscribeSettings?: EngineTranscribeSettings;
|
|
2103
2419
|
/**
|
|
2420
|
+
* @public
|
|
2104
2421
|
* <p>The transcription configuration settings passed to Amazon Transcribe Medical.</p>
|
|
2105
2422
|
*/
|
|
2106
2423
|
EngineTranscribeMedicalSettings?: EngineTranscribeMedicalSettings;
|
|
@@ -2110,10 +2427,12 @@ export interface TranscriptionConfiguration {
|
|
|
2110
2427
|
*/
|
|
2111
2428
|
export interface StartMeetingTranscriptionRequest {
|
|
2112
2429
|
/**
|
|
2430
|
+
* @public
|
|
2113
2431
|
* <p>The unique ID of the meeting being transcribed.</p>
|
|
2114
2432
|
*/
|
|
2115
2433
|
MeetingId: string | undefined;
|
|
2116
2434
|
/**
|
|
2435
|
+
* @public
|
|
2117
2436
|
* <p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or <code>EngineTranscribeMedicalSettings</code>.</p>
|
|
2118
2437
|
*/
|
|
2119
2438
|
TranscriptionConfiguration: TranscriptionConfiguration | undefined;
|
|
@@ -2128,6 +2447,7 @@ export interface StartMeetingTranscriptionResponse {
|
|
|
2128
2447
|
*/
|
|
2129
2448
|
export interface StopMeetingTranscriptionRequest {
|
|
2130
2449
|
/**
|
|
2450
|
+
* @public
|
|
2131
2451
|
* <p>The unique ID of the meeting for which you stop transcription.</p>
|
|
2132
2452
|
*/
|
|
2133
2453
|
MeetingId: string | undefined;
|
|
@@ -2142,14 +2462,17 @@ export interface StopMeetingTranscriptionResponse {
|
|
|
2142
2462
|
*/
|
|
2143
2463
|
export interface TagAttendeeRequest {
|
|
2144
2464
|
/**
|
|
2465
|
+
* @public
|
|
2145
2466
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
2146
2467
|
*/
|
|
2147
2468
|
MeetingId: string | undefined;
|
|
2148
2469
|
/**
|
|
2470
|
+
* @public
|
|
2149
2471
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
2150
2472
|
*/
|
|
2151
2473
|
AttendeeId: string | undefined;
|
|
2152
2474
|
/**
|
|
2475
|
+
* @public
|
|
2153
2476
|
* <p>The tag key-value pairs.</p>
|
|
2154
2477
|
*/
|
|
2155
2478
|
Tags: Tag[] | undefined;
|
|
@@ -2159,10 +2482,12 @@ export interface TagAttendeeRequest {
|
|
|
2159
2482
|
*/
|
|
2160
2483
|
export interface TagMeetingRequest {
|
|
2161
2484
|
/**
|
|
2485
|
+
* @public
|
|
2162
2486
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
2163
2487
|
*/
|
|
2164
2488
|
MeetingId: string | undefined;
|
|
2165
2489
|
/**
|
|
2490
|
+
* @public
|
|
2166
2491
|
* <p>The tag key-value pairs.</p>
|
|
2167
2492
|
*/
|
|
2168
2493
|
Tags: Tag[] | undefined;
|
|
@@ -2172,10 +2497,12 @@ export interface TagMeetingRequest {
|
|
|
2172
2497
|
*/
|
|
2173
2498
|
export interface TagResourceRequest {
|
|
2174
2499
|
/**
|
|
2500
|
+
* @public
|
|
2175
2501
|
* <p>The resource ARN.</p>
|
|
2176
2502
|
*/
|
|
2177
2503
|
ResourceARN: string | undefined;
|
|
2178
2504
|
/**
|
|
2505
|
+
* @public
|
|
2179
2506
|
* <p>The tag key-value pairs.</p>
|
|
2180
2507
|
*/
|
|
2181
2508
|
Tags: Tag[] | undefined;
|
|
@@ -2185,14 +2512,17 @@ export interface TagResourceRequest {
|
|
|
2185
2512
|
*/
|
|
2186
2513
|
export interface UntagAttendeeRequest {
|
|
2187
2514
|
/**
|
|
2515
|
+
* @public
|
|
2188
2516
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
2189
2517
|
*/
|
|
2190
2518
|
MeetingId: string | undefined;
|
|
2191
2519
|
/**
|
|
2520
|
+
* @public
|
|
2192
2521
|
* <p>The Amazon Chime SDK attendee ID.</p>
|
|
2193
2522
|
*/
|
|
2194
2523
|
AttendeeId: string | undefined;
|
|
2195
2524
|
/**
|
|
2525
|
+
* @public
|
|
2196
2526
|
* <p>The tag keys.</p>
|
|
2197
2527
|
*/
|
|
2198
2528
|
TagKeys: string[] | undefined;
|
|
@@ -2202,10 +2532,12 @@ export interface UntagAttendeeRequest {
|
|
|
2202
2532
|
*/
|
|
2203
2533
|
export interface UntagMeetingRequest {
|
|
2204
2534
|
/**
|
|
2535
|
+
* @public
|
|
2205
2536
|
* <p>The Amazon Chime SDK meeting ID.</p>
|
|
2206
2537
|
*/
|
|
2207
2538
|
MeetingId: string | undefined;
|
|
2208
2539
|
/**
|
|
2540
|
+
* @public
|
|
2209
2541
|
* <p>The tag keys.</p>
|
|
2210
2542
|
*/
|
|
2211
2543
|
TagKeys: string[] | undefined;
|
|
@@ -2215,10 +2547,12 @@ export interface UntagMeetingRequest {
|
|
|
2215
2547
|
*/
|
|
2216
2548
|
export interface UntagResourceRequest {
|
|
2217
2549
|
/**
|
|
2550
|
+
* @public
|
|
2218
2551
|
* <p>The resource ARN.</p>
|
|
2219
2552
|
*/
|
|
2220
2553
|
ResourceARN: string | undefined;
|
|
2221
2554
|
/**
|
|
2555
|
+
* @public
|
|
2222
2556
|
* <p>The tag keys.</p>
|
|
2223
2557
|
*/
|
|
2224
2558
|
TagKeys: string[] | undefined;
|
|
@@ -2228,14 +2562,17 @@ export interface UntagResourceRequest {
|
|
|
2228
2562
|
*/
|
|
2229
2563
|
export interface UpdateAccountRequest {
|
|
2230
2564
|
/**
|
|
2565
|
+
* @public
|
|
2231
2566
|
* <p>The Amazon Chime account ID.</p>
|
|
2232
2567
|
*/
|
|
2233
2568
|
AccountId: string | undefined;
|
|
2234
2569
|
/**
|
|
2570
|
+
* @public
|
|
2235
2571
|
* <p>The new name for the specified Amazon Chime account.</p>
|
|
2236
2572
|
*/
|
|
2237
2573
|
Name?: string;
|
|
2238
2574
|
/**
|
|
2575
|
+
* @public
|
|
2239
2576
|
* <p>The default license applied when you add users to an Amazon Chime account.</p>
|
|
2240
2577
|
*/
|
|
2241
2578
|
DefaultLicense?: License | string;
|
|
@@ -2245,6 +2582,7 @@ export interface UpdateAccountRequest {
|
|
|
2245
2582
|
*/
|
|
2246
2583
|
export interface UpdateAccountResponse {
|
|
2247
2584
|
/**
|
|
2585
|
+
* @public
|
|
2248
2586
|
* <p>The updated Amazon Chime account details.</p>
|
|
2249
2587
|
*/
|
|
2250
2588
|
Account?: Account;
|
|
@@ -2254,10 +2592,12 @@ export interface UpdateAccountResponse {
|
|
|
2254
2592
|
*/
|
|
2255
2593
|
export interface UpdateAccountSettingsRequest {
|
|
2256
2594
|
/**
|
|
2595
|
+
* @public
|
|
2257
2596
|
* <p>The Amazon Chime account ID.</p>
|
|
2258
2597
|
*/
|
|
2259
2598
|
AccountId: string | undefined;
|
|
2260
2599
|
/**
|
|
2600
|
+
* @public
|
|
2261
2601
|
* <p>The Amazon Chime account settings to update.</p>
|
|
2262
2602
|
*/
|
|
2263
2603
|
AccountSettings: AccountSettings | undefined;
|
|
@@ -2272,14 +2612,17 @@ export interface UpdateAccountSettingsResponse {
|
|
|
2272
2612
|
*/
|
|
2273
2613
|
export interface UpdateAppInstanceRequest {
|
|
2274
2614
|
/**
|
|
2615
|
+
* @public
|
|
2275
2616
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
2276
2617
|
*/
|
|
2277
2618
|
AppInstanceArn: string | undefined;
|
|
2278
2619
|
/**
|
|
2620
|
+
* @public
|
|
2279
2621
|
* <p>The name that you want to change.</p>
|
|
2280
2622
|
*/
|
|
2281
2623
|
Name: string | undefined;
|
|
2282
2624
|
/**
|
|
2625
|
+
* @public
|
|
2283
2626
|
* <p>The metadata that you want to change.</p>
|
|
2284
2627
|
*/
|
|
2285
2628
|
Metadata?: string;
|
|
@@ -2289,6 +2632,7 @@ export interface UpdateAppInstanceRequest {
|
|
|
2289
2632
|
*/
|
|
2290
2633
|
export interface UpdateAppInstanceResponse {
|
|
2291
2634
|
/**
|
|
2635
|
+
* @public
|
|
2292
2636
|
* <p>The ARN of the <code>AppInstance</code>. </p>
|
|
2293
2637
|
*/
|
|
2294
2638
|
AppInstanceArn?: string;
|
|
@@ -2298,14 +2642,17 @@ export interface UpdateAppInstanceResponse {
|
|
|
2298
2642
|
*/
|
|
2299
2643
|
export interface UpdateAppInstanceUserRequest {
|
|
2300
2644
|
/**
|
|
2645
|
+
* @public
|
|
2301
2646
|
* <p>The ARN of the <code>AppInstanceUser</code>.</p>
|
|
2302
2647
|
*/
|
|
2303
2648
|
AppInstanceUserArn: string | undefined;
|
|
2304
2649
|
/**
|
|
2650
|
+
* @public
|
|
2305
2651
|
* <p>The name of the <code>AppInstanceUser</code>.</p>
|
|
2306
2652
|
*/
|
|
2307
2653
|
Name: string | undefined;
|
|
2308
2654
|
/**
|
|
2655
|
+
* @public
|
|
2309
2656
|
* <p>The metadata of the <code>AppInstanceUser</code>.</p>
|
|
2310
2657
|
*/
|
|
2311
2658
|
Metadata?: string;
|
|
@@ -2315,6 +2662,7 @@ export interface UpdateAppInstanceUserRequest {
|
|
|
2315
2662
|
*/
|
|
2316
2663
|
export interface UpdateAppInstanceUserResponse {
|
|
2317
2664
|
/**
|
|
2665
|
+
* @public
|
|
2318
2666
|
* <p>The ARN of the <code>AppInstanceUser</code>.</p>
|
|
2319
2667
|
*/
|
|
2320
2668
|
AppInstanceUserArn?: string;
|
|
@@ -2324,14 +2672,17 @@ export interface UpdateAppInstanceUserResponse {
|
|
|
2324
2672
|
*/
|
|
2325
2673
|
export interface UpdateBotRequest {
|
|
2326
2674
|
/**
|
|
2675
|
+
* @public
|
|
2327
2676
|
* <p>The Amazon Chime account ID.</p>
|
|
2328
2677
|
*/
|
|
2329
2678
|
AccountId: string | undefined;
|
|
2330
2679
|
/**
|
|
2680
|
+
* @public
|
|
2331
2681
|
* <p>The bot ID.</p>
|
|
2332
2682
|
*/
|
|
2333
2683
|
BotId: string | undefined;
|
|
2334
2684
|
/**
|
|
2685
|
+
* @public
|
|
2335
2686
|
* <p>When true, stops the specified bot from running in your account.</p>
|
|
2336
2687
|
*/
|
|
2337
2688
|
Disabled?: boolean;
|
|
@@ -2341,6 +2692,7 @@ export interface UpdateBotRequest {
|
|
|
2341
2692
|
*/
|
|
2342
2693
|
export interface UpdateBotResponse {
|
|
2343
2694
|
/**
|
|
2695
|
+
* @public
|
|
2344
2696
|
* <p>The updated bot details.</p>
|
|
2345
2697
|
*/
|
|
2346
2698
|
Bot?: Bot;
|
|
@@ -2350,22 +2702,27 @@ export interface UpdateBotResponse {
|
|
|
2350
2702
|
*/
|
|
2351
2703
|
export interface UpdateChannelRequest {
|
|
2352
2704
|
/**
|
|
2705
|
+
* @public
|
|
2353
2706
|
* <p>The ARN of the channel.</p>
|
|
2354
2707
|
*/
|
|
2355
2708
|
ChannelArn: string | undefined;
|
|
2356
2709
|
/**
|
|
2710
|
+
* @public
|
|
2357
2711
|
* <p>The name of the channel.</p>
|
|
2358
2712
|
*/
|
|
2359
2713
|
Name: string | undefined;
|
|
2360
2714
|
/**
|
|
2715
|
+
* @public
|
|
2361
2716
|
* <p>The mode of the update request.</p>
|
|
2362
2717
|
*/
|
|
2363
2718
|
Mode: ChannelMode | string | undefined;
|
|
2364
2719
|
/**
|
|
2720
|
+
* @public
|
|
2365
2721
|
* <p>The metadata for the update request.</p>
|
|
2366
2722
|
*/
|
|
2367
2723
|
Metadata?: string;
|
|
2368
2724
|
/**
|
|
2725
|
+
* @public
|
|
2369
2726
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
2370
2727
|
*/
|
|
2371
2728
|
ChimeBearer?: string;
|
|
@@ -2375,6 +2732,7 @@ export interface UpdateChannelRequest {
|
|
|
2375
2732
|
*/
|
|
2376
2733
|
export interface UpdateChannelResponse {
|
|
2377
2734
|
/**
|
|
2735
|
+
* @public
|
|
2378
2736
|
* <p>The ARN of the channel.</p>
|
|
2379
2737
|
*/
|
|
2380
2738
|
ChannelArn?: string;
|
|
@@ -2384,22 +2742,27 @@ export interface UpdateChannelResponse {
|
|
|
2384
2742
|
*/
|
|
2385
2743
|
export interface UpdateChannelMessageRequest {
|
|
2386
2744
|
/**
|
|
2745
|
+
* @public
|
|
2387
2746
|
* <p>The ARN of the channel.</p>
|
|
2388
2747
|
*/
|
|
2389
2748
|
ChannelArn: string | undefined;
|
|
2390
2749
|
/**
|
|
2750
|
+
* @public
|
|
2391
2751
|
* <p>The ID string of the message being updated.</p>
|
|
2392
2752
|
*/
|
|
2393
2753
|
MessageId: string | undefined;
|
|
2394
2754
|
/**
|
|
2755
|
+
* @public
|
|
2395
2756
|
* <p>The content of the message being updated.</p>
|
|
2396
2757
|
*/
|
|
2397
2758
|
Content?: string;
|
|
2398
2759
|
/**
|
|
2760
|
+
* @public
|
|
2399
2761
|
* <p>The metadata of the message being updated.</p>
|
|
2400
2762
|
*/
|
|
2401
2763
|
Metadata?: string;
|
|
2402
2764
|
/**
|
|
2765
|
+
* @public
|
|
2403
2766
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
2404
2767
|
*/
|
|
2405
2768
|
ChimeBearer?: string;
|
|
@@ -2409,10 +2772,12 @@ export interface UpdateChannelMessageRequest {
|
|
|
2409
2772
|
*/
|
|
2410
2773
|
export interface UpdateChannelMessageResponse {
|
|
2411
2774
|
/**
|
|
2775
|
+
* @public
|
|
2412
2776
|
* <p>The ARN of the channel.</p>
|
|
2413
2777
|
*/
|
|
2414
2778
|
ChannelArn?: string;
|
|
2415
2779
|
/**
|
|
2780
|
+
* @public
|
|
2416
2781
|
* <p>The ID string of the message being updated.</p>
|
|
2417
2782
|
*/
|
|
2418
2783
|
MessageId?: string;
|
|
@@ -2422,10 +2787,12 @@ export interface UpdateChannelMessageResponse {
|
|
|
2422
2787
|
*/
|
|
2423
2788
|
export interface UpdateChannelReadMarkerRequest {
|
|
2424
2789
|
/**
|
|
2790
|
+
* @public
|
|
2425
2791
|
* <p>The ARN of the channel.</p>
|
|
2426
2792
|
*/
|
|
2427
2793
|
ChannelArn: string | undefined;
|
|
2428
2794
|
/**
|
|
2795
|
+
* @public
|
|
2429
2796
|
* <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
|
|
2430
2797
|
*/
|
|
2431
2798
|
ChimeBearer?: string;
|
|
@@ -2435,6 +2802,7 @@ export interface UpdateChannelReadMarkerRequest {
|
|
|
2435
2802
|
*/
|
|
2436
2803
|
export interface UpdateChannelReadMarkerResponse {
|
|
2437
2804
|
/**
|
|
2805
|
+
* @public
|
|
2438
2806
|
* <p>The ARN of the channel.</p>
|
|
2439
2807
|
*/
|
|
2440
2808
|
ChannelArn?: string;
|
|
@@ -2444,10 +2812,12 @@ export interface UpdateChannelReadMarkerResponse {
|
|
|
2444
2812
|
*/
|
|
2445
2813
|
export interface UpdateGlobalSettingsRequest {
|
|
2446
2814
|
/**
|
|
2815
|
+
* @public
|
|
2447
2816
|
* <p>The Amazon Chime Business Calling settings.</p>
|
|
2448
2817
|
*/
|
|
2449
2818
|
BusinessCalling?: BusinessCallingSettings;
|
|
2450
2819
|
/**
|
|
2820
|
+
* @public
|
|
2451
2821
|
* <p>The Amazon Chime Voice Connector settings.</p>
|
|
2452
2822
|
*/
|
|
2453
2823
|
VoiceConnector?: VoiceConnectorSettings;
|
|
@@ -2457,14 +2827,17 @@ export interface UpdateGlobalSettingsRequest {
|
|
|
2457
2827
|
*/
|
|
2458
2828
|
export interface UpdatePhoneNumberRequest {
|
|
2459
2829
|
/**
|
|
2830
|
+
* @public
|
|
2460
2831
|
* <p>The phone number ID.</p>
|
|
2461
2832
|
*/
|
|
2462
2833
|
PhoneNumberId: string | undefined;
|
|
2463
2834
|
/**
|
|
2835
|
+
* @public
|
|
2464
2836
|
* <p>The product type.</p>
|
|
2465
2837
|
*/
|
|
2466
2838
|
ProductType?: PhoneNumberProductType | string;
|
|
2467
2839
|
/**
|
|
2840
|
+
* @public
|
|
2468
2841
|
* <p>The outbound calling name associated with the phone number.</p>
|
|
2469
2842
|
*/
|
|
2470
2843
|
CallingName?: string;
|
|
@@ -2474,6 +2847,7 @@ export interface UpdatePhoneNumberRequest {
|
|
|
2474
2847
|
*/
|
|
2475
2848
|
export interface UpdatePhoneNumberResponse {
|
|
2476
2849
|
/**
|
|
2850
|
+
* @public
|
|
2477
2851
|
* <p>The updated phone number details.</p>
|
|
2478
2852
|
*/
|
|
2479
2853
|
PhoneNumber?: PhoneNumber;
|
|
@@ -2483,6 +2857,7 @@ export interface UpdatePhoneNumberResponse {
|
|
|
2483
2857
|
*/
|
|
2484
2858
|
export interface UpdatePhoneNumberSettingsRequest {
|
|
2485
2859
|
/**
|
|
2860
|
+
* @public
|
|
2486
2861
|
* <p>The default outbound calling name for the account.</p>
|
|
2487
2862
|
*/
|
|
2488
2863
|
CallingName: string | undefined;
|
|
@@ -2492,18 +2867,22 @@ export interface UpdatePhoneNumberSettingsRequest {
|
|
|
2492
2867
|
*/
|
|
2493
2868
|
export interface UpdateProxySessionRequest {
|
|
2494
2869
|
/**
|
|
2870
|
+
* @public
|
|
2495
2871
|
* <p>The Amazon Chime voice connector ID.</p>
|
|
2496
2872
|
*/
|
|
2497
2873
|
VoiceConnectorId: string | undefined;
|
|
2498
2874
|
/**
|
|
2875
|
+
* @public
|
|
2499
2876
|
* <p>The proxy session ID.</p>
|
|
2500
2877
|
*/
|
|
2501
2878
|
ProxySessionId: string | undefined;
|
|
2502
2879
|
/**
|
|
2880
|
+
* @public
|
|
2503
2881
|
* <p>The proxy session capabilities.</p>
|
|
2504
2882
|
*/
|
|
2505
2883
|
Capabilities: (Capability | string)[] | undefined;
|
|
2506
2884
|
/**
|
|
2885
|
+
* @public
|
|
2507
2886
|
* <p>The number of minutes allowed for the proxy session.</p>
|
|
2508
2887
|
*/
|
|
2509
2888
|
ExpiryMinutes?: number;
|
|
@@ -2513,6 +2892,7 @@ export interface UpdateProxySessionRequest {
|
|
|
2513
2892
|
*/
|
|
2514
2893
|
export interface UpdateProxySessionResponse {
|
|
2515
2894
|
/**
|
|
2895
|
+
* @public
|
|
2516
2896
|
* <p>The proxy session details.</p>
|
|
2517
2897
|
*/
|
|
2518
2898
|
ProxySession?: ProxySession;
|
|
@@ -2522,14 +2902,17 @@ export interface UpdateProxySessionResponse {
|
|
|
2522
2902
|
*/
|
|
2523
2903
|
export interface UpdateRoomRequest {
|
|
2524
2904
|
/**
|
|
2905
|
+
* @public
|
|
2525
2906
|
* <p>The Amazon Chime account ID.</p>
|
|
2526
2907
|
*/
|
|
2527
2908
|
AccountId: string | undefined;
|
|
2528
2909
|
/**
|
|
2910
|
+
* @public
|
|
2529
2911
|
* <p>The room ID.</p>
|
|
2530
2912
|
*/
|
|
2531
2913
|
RoomId: string | undefined;
|
|
2532
2914
|
/**
|
|
2915
|
+
* @public
|
|
2533
2916
|
* <p>The room name.</p>
|
|
2534
2917
|
*/
|
|
2535
2918
|
Name?: string;
|
|
@@ -2539,6 +2922,7 @@ export interface UpdateRoomRequest {
|
|
|
2539
2922
|
*/
|
|
2540
2923
|
export interface UpdateRoomResponse {
|
|
2541
2924
|
/**
|
|
2925
|
+
* @public
|
|
2542
2926
|
* <p>The room details.</p>
|
|
2543
2927
|
*/
|
|
2544
2928
|
Room?: Room;
|
|
@@ -2548,18 +2932,22 @@ export interface UpdateRoomResponse {
|
|
|
2548
2932
|
*/
|
|
2549
2933
|
export interface UpdateRoomMembershipRequest {
|
|
2550
2934
|
/**
|
|
2935
|
+
* @public
|
|
2551
2936
|
* <p>The Amazon Chime account ID.</p>
|
|
2552
2937
|
*/
|
|
2553
2938
|
AccountId: string | undefined;
|
|
2554
2939
|
/**
|
|
2940
|
+
* @public
|
|
2555
2941
|
* <p>The room ID.</p>
|
|
2556
2942
|
*/
|
|
2557
2943
|
RoomId: string | undefined;
|
|
2558
2944
|
/**
|
|
2945
|
+
* @public
|
|
2559
2946
|
* <p>The member ID.</p>
|
|
2560
2947
|
*/
|
|
2561
2948
|
MemberId: string | undefined;
|
|
2562
2949
|
/**
|
|
2950
|
+
* @public
|
|
2563
2951
|
* <p>The role of the member.</p>
|
|
2564
2952
|
*/
|
|
2565
2953
|
Role?: RoomMembershipRole | string;
|
|
@@ -2569,6 +2957,7 @@ export interface UpdateRoomMembershipRequest {
|
|
|
2569
2957
|
*/
|
|
2570
2958
|
export interface UpdateRoomMembershipResponse {
|
|
2571
2959
|
/**
|
|
2960
|
+
* @public
|
|
2572
2961
|
* <p>The room membership details.</p>
|
|
2573
2962
|
*/
|
|
2574
2963
|
RoomMembership?: RoomMembership;
|
|
@@ -2578,14 +2967,17 @@ export interface UpdateRoomMembershipResponse {
|
|
|
2578
2967
|
*/
|
|
2579
2968
|
export interface UpdateSipMediaApplicationRequest {
|
|
2580
2969
|
/**
|
|
2970
|
+
* @public
|
|
2581
2971
|
* <p>The SIP media application ID.</p>
|
|
2582
2972
|
*/
|
|
2583
2973
|
SipMediaApplicationId: string | undefined;
|
|
2584
2974
|
/**
|
|
2975
|
+
* @public
|
|
2585
2976
|
* <p>The new name for the specified SIP media application.</p>
|
|
2586
2977
|
*/
|
|
2587
2978
|
Name?: string;
|
|
2588
2979
|
/**
|
|
2980
|
+
* @public
|
|
2589
2981
|
* <p>The new set of endpoints for the specified SIP media application.</p>
|
|
2590
2982
|
*/
|
|
2591
2983
|
Endpoints?: SipMediaApplicationEndpoint[];
|
|
@@ -2595,6 +2987,7 @@ export interface UpdateSipMediaApplicationRequest {
|
|
|
2595
2987
|
*/
|
|
2596
2988
|
export interface UpdateSipMediaApplicationResponse {
|
|
2597
2989
|
/**
|
|
2990
|
+
* @public
|
|
2598
2991
|
* <p>The updated SIP media application details.</p>
|
|
2599
2992
|
*/
|
|
2600
2993
|
SipMediaApplication?: SipMediaApplication;
|
|
@@ -2604,14 +2997,17 @@ export interface UpdateSipMediaApplicationResponse {
|
|
|
2604
2997
|
*/
|
|
2605
2998
|
export interface UpdateSipMediaApplicationCallRequest {
|
|
2606
2999
|
/**
|
|
3000
|
+
* @public
|
|
2607
3001
|
* <p>The ID of the SIP media application handling the call.</p>
|
|
2608
3002
|
*/
|
|
2609
3003
|
SipMediaApplicationId: string | undefined;
|
|
2610
3004
|
/**
|
|
3005
|
+
* @public
|
|
2611
3006
|
* <p>The ID of the call transaction.</p>
|
|
2612
3007
|
*/
|
|
2613
3008
|
TransactionId: string | undefined;
|
|
2614
3009
|
/**
|
|
3010
|
+
* @public
|
|
2615
3011
|
* <p>Arguments made available to the Lambda function as part of the <code>CALL_UPDATE_REQUESTED</code> event. Can contain 0-20 key-value pairs.</p>
|
|
2616
3012
|
*/
|
|
2617
3013
|
Arguments: Record<string, string> | undefined;
|
|
@@ -2621,6 +3017,7 @@ export interface UpdateSipMediaApplicationCallRequest {
|
|
|
2621
3017
|
*/
|
|
2622
3018
|
export interface UpdateSipMediaApplicationCallResponse {
|
|
2623
3019
|
/**
|
|
3020
|
+
* @public
|
|
2624
3021
|
* <p>A <code>Call</code> instance for a SIP media application.</p>
|
|
2625
3022
|
*/
|
|
2626
3023
|
SipMediaApplicationCall?: SipMediaApplicationCall;
|
|
@@ -2630,18 +3027,22 @@ export interface UpdateSipMediaApplicationCallResponse {
|
|
|
2630
3027
|
*/
|
|
2631
3028
|
export interface UpdateSipRuleRequest {
|
|
2632
3029
|
/**
|
|
3030
|
+
* @public
|
|
2633
3031
|
* <p>The SIP rule ID.</p>
|
|
2634
3032
|
*/
|
|
2635
3033
|
SipRuleId: string | undefined;
|
|
2636
3034
|
/**
|
|
3035
|
+
* @public
|
|
2637
3036
|
* <p>The new name for the specified SIP rule.</p>
|
|
2638
3037
|
*/
|
|
2639
3038
|
Name: string | undefined;
|
|
2640
3039
|
/**
|
|
3040
|
+
* @public
|
|
2641
3041
|
* <p>The new value specified to indicate whether the rule is disabled.</p>
|
|
2642
3042
|
*/
|
|
2643
3043
|
Disabled?: boolean;
|
|
2644
3044
|
/**
|
|
3045
|
+
* @public
|
|
2645
3046
|
* <p>The new value of the list of target applications.</p>
|
|
2646
3047
|
*/
|
|
2647
3048
|
TargetApplications?: SipRuleTargetApplication[];
|
|
@@ -2651,6 +3052,7 @@ export interface UpdateSipRuleRequest {
|
|
|
2651
3052
|
*/
|
|
2652
3053
|
export interface UpdateSipRuleResponse {
|
|
2653
3054
|
/**
|
|
3055
|
+
* @public
|
|
2654
3056
|
* <p>Updated SIP rule details.</p>
|
|
2655
3057
|
*/
|
|
2656
3058
|
SipRule?: SipRule;
|
|
@@ -2660,23 +3062,28 @@ export interface UpdateSipRuleResponse {
|
|
|
2660
3062
|
*/
|
|
2661
3063
|
export interface UpdateUserRequest {
|
|
2662
3064
|
/**
|
|
3065
|
+
* @public
|
|
2663
3066
|
* <p>The Amazon Chime account ID.</p>
|
|
2664
3067
|
*/
|
|
2665
3068
|
AccountId: string | undefined;
|
|
2666
3069
|
/**
|
|
3070
|
+
* @public
|
|
2667
3071
|
* <p>The user ID.</p>
|
|
2668
3072
|
*/
|
|
2669
3073
|
UserId: string | undefined;
|
|
2670
3074
|
/**
|
|
3075
|
+
* @public
|
|
2671
3076
|
* <p>The user license type to update. This must be a supported license type for the Amazon Chime
|
|
2672
3077
|
* account that the user belongs to.</p>
|
|
2673
3078
|
*/
|
|
2674
3079
|
LicenseType?: License | string;
|
|
2675
3080
|
/**
|
|
3081
|
+
* @public
|
|
2676
3082
|
* <p>The user type.</p>
|
|
2677
3083
|
*/
|
|
2678
3084
|
UserType?: UserType | string;
|
|
2679
3085
|
/**
|
|
3086
|
+
* @public
|
|
2680
3087
|
* <p>The Alexa for Business metadata.</p>
|
|
2681
3088
|
*/
|
|
2682
3089
|
AlexaForBusinessMetadata?: AlexaForBusinessMetadata;
|
|
@@ -2686,6 +3093,7 @@ export interface UpdateUserRequest {
|
|
|
2686
3093
|
*/
|
|
2687
3094
|
export interface UpdateUserResponse {
|
|
2688
3095
|
/**
|
|
3096
|
+
* @public
|
|
2689
3097
|
* <p>The updated user details.</p>
|
|
2690
3098
|
*/
|
|
2691
3099
|
User?: User;
|
|
@@ -2695,14 +3103,17 @@ export interface UpdateUserResponse {
|
|
|
2695
3103
|
*/
|
|
2696
3104
|
export interface UpdateUserSettingsRequest {
|
|
2697
3105
|
/**
|
|
3106
|
+
* @public
|
|
2698
3107
|
* <p>The Amazon Chime account ID.</p>
|
|
2699
3108
|
*/
|
|
2700
3109
|
AccountId: string | undefined;
|
|
2701
3110
|
/**
|
|
3111
|
+
* @public
|
|
2702
3112
|
* <p>The user ID.</p>
|
|
2703
3113
|
*/
|
|
2704
3114
|
UserId: string | undefined;
|
|
2705
3115
|
/**
|
|
3116
|
+
* @public
|
|
2706
3117
|
* <p>The user settings to update.</p>
|
|
2707
3118
|
*/
|
|
2708
3119
|
UserSettings: UserSettings | undefined;
|
|
@@ -2712,14 +3123,17 @@ export interface UpdateUserSettingsRequest {
|
|
|
2712
3123
|
*/
|
|
2713
3124
|
export interface UpdateVoiceConnectorRequest {
|
|
2714
3125
|
/**
|
|
3126
|
+
* @public
|
|
2715
3127
|
* <p>The Amazon Chime Voice Connector ID.</p>
|
|
2716
3128
|
*/
|
|
2717
3129
|
VoiceConnectorId: string | undefined;
|
|
2718
3130
|
/**
|
|
3131
|
+
* @public
|
|
2719
3132
|
* <p>The name of the Amazon Chime Voice Connector.</p>
|
|
2720
3133
|
*/
|
|
2721
3134
|
Name: string | undefined;
|
|
2722
3135
|
/**
|
|
3136
|
+
* @public
|
|
2723
3137
|
* <p>When enabled, requires encryption for the Amazon Chime Voice Connector.</p>
|
|
2724
3138
|
*/
|
|
2725
3139
|
RequireEncryption: boolean | undefined;
|
|
@@ -2729,6 +3143,7 @@ export interface UpdateVoiceConnectorRequest {
|
|
|
2729
3143
|
*/
|
|
2730
3144
|
export interface UpdateVoiceConnectorResponse {
|
|
2731
3145
|
/**
|
|
3146
|
+
* @public
|
|
2732
3147
|
* <p>The updated Amazon Chime Voice Connector details.</p>
|
|
2733
3148
|
*/
|
|
2734
3149
|
VoiceConnector?: VoiceConnector;
|
|
@@ -2738,14 +3153,17 @@ export interface UpdateVoiceConnectorResponse {
|
|
|
2738
3153
|
*/
|
|
2739
3154
|
export interface UpdateVoiceConnectorGroupRequest {
|
|
2740
3155
|
/**
|
|
3156
|
+
* @public
|
|
2741
3157
|
* <p>The Amazon Chime Voice Connector group ID.</p>
|
|
2742
3158
|
*/
|
|
2743
3159
|
VoiceConnectorGroupId: string | undefined;
|
|
2744
3160
|
/**
|
|
3161
|
+
* @public
|
|
2745
3162
|
* <p>The name of the Amazon Chime Voice Connector group.</p>
|
|
2746
3163
|
*/
|
|
2747
3164
|
Name: string | undefined;
|
|
2748
3165
|
/**
|
|
3166
|
+
* @public
|
|
2749
3167
|
* <p>The <code>VoiceConnectorItems</code> to associate with the group.</p>
|
|
2750
3168
|
*/
|
|
2751
3169
|
VoiceConnectorItems: VoiceConnectorItem[] | undefined;
|
|
@@ -2755,6 +3173,7 @@ export interface UpdateVoiceConnectorGroupRequest {
|
|
|
2755
3173
|
*/
|
|
2756
3174
|
export interface UpdateVoiceConnectorGroupResponse {
|
|
2757
3175
|
/**
|
|
3176
|
+
* @public
|
|
2758
3177
|
* <p>The updated Amazon Chime Voice Connector group details.</p>
|
|
2759
3178
|
*/
|
|
2760
3179
|
VoiceConnectorGroup?: VoiceConnectorGroup;
|
|
@@ -2764,30 +3183,37 @@ export interface UpdateVoiceConnectorGroupResponse {
|
|
|
2764
3183
|
*/
|
|
2765
3184
|
export interface ValidateE911AddressRequest {
|
|
2766
3185
|
/**
|
|
3186
|
+
* @public
|
|
2767
3187
|
* <p>The AWS account ID.</p>
|
|
2768
3188
|
*/
|
|
2769
3189
|
AwsAccountId: string | undefined;
|
|
2770
3190
|
/**
|
|
3191
|
+
* @public
|
|
2771
3192
|
* <p>The address street number, such as <code>200</code> or <code>2121</code>.</p>
|
|
2772
3193
|
*/
|
|
2773
3194
|
StreetNumber: string | undefined;
|
|
2774
3195
|
/**
|
|
3196
|
+
* @public
|
|
2775
3197
|
* <p>The address street information, such as <code>8th Avenue</code>.</p>
|
|
2776
3198
|
*/
|
|
2777
3199
|
StreetInfo: string | undefined;
|
|
2778
3200
|
/**
|
|
3201
|
+
* @public
|
|
2779
3202
|
* <p>The address city, such as <code>Portland</code>.</p>
|
|
2780
3203
|
*/
|
|
2781
3204
|
City: string | undefined;
|
|
2782
3205
|
/**
|
|
3206
|
+
* @public
|
|
2783
3207
|
* <p>The address state, such as <code>ME</code>.</p>
|
|
2784
3208
|
*/
|
|
2785
3209
|
State: string | undefined;
|
|
2786
3210
|
/**
|
|
3211
|
+
* @public
|
|
2787
3212
|
* <p>The address country, such as <code>US</code>. </p>
|
|
2788
3213
|
*/
|
|
2789
3214
|
Country: string | undefined;
|
|
2790
3215
|
/**
|
|
3216
|
+
* @public
|
|
2791
3217
|
* <p>The address postal code, such as <code>04352</code>.</p>
|
|
2792
3218
|
*/
|
|
2793
3219
|
PostalCode: string | undefined;
|
|
@@ -2797,6 +3223,7 @@ export interface ValidateE911AddressRequest {
|
|
|
2797
3223
|
*/
|
|
2798
3224
|
export interface ValidateE911AddressResponse {
|
|
2799
3225
|
/**
|
|
3226
|
+
* @public
|
|
2800
3227
|
* <p>Number indicating the result of address validation.
|
|
2801
3228
|
* <code>0</code> means the address was perfect as is and successfully validated.
|
|
2802
3229
|
* <code>1</code> means the address was corrected. <code>2</code> means the address sent was
|
|
@@ -2804,14 +3231,17 @@ export interface ValidateE911AddressResponse {
|
|
|
2804
3231
|
*/
|
|
2805
3232
|
ValidationResult?: number;
|
|
2806
3233
|
/**
|
|
3234
|
+
* @public
|
|
2807
3235
|
* <p>The ID that represents the address.</p>
|
|
2808
3236
|
*/
|
|
2809
3237
|
AddressExternalId?: string;
|
|
2810
3238
|
/**
|
|
3239
|
+
* @public
|
|
2811
3240
|
* <p>The validated address.</p>
|
|
2812
3241
|
*/
|
|
2813
3242
|
Address?: Address;
|
|
2814
3243
|
/**
|
|
3244
|
+
* @public
|
|
2815
3245
|
* <p>The list of address suggestions.</p>
|
|
2816
3246
|
*/
|
|
2817
3247
|
CandidateAddressList?: CandidateAddress[];
|