@aws-sdk/client-chime-sdk-voice 3.299.0 → 3.301.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist-types/ChimeSDKVoice.d.ts +203 -0
- package/dist-types/ChimeSDKVoiceClient.d.ts +2 -0
- package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.d.ts +52 -0
- package/dist-types/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.d.ts +52 -0
- package/dist-types/commands/BatchDeletePhoneNumberCommand.d.ts +54 -0
- package/dist-types/commands/BatchUpdatePhoneNumberCommand.d.ts +51 -0
- package/dist-types/commands/CreatePhoneNumberOrderCommand.d.ts +51 -0
- package/dist-types/commands/CreateProxySessionCommand.d.ts +60 -0
- package/dist-types/commands/CreateSipMediaApplicationCallCommand.d.ts +58 -0
- package/dist-types/commands/CreateSipMediaApplicationCommand.d.ts +58 -0
- package/dist-types/commands/CreateSipRuleCommand.d.ts +62 -0
- package/dist-types/commands/CreateVoiceConnectorCommand.d.ts +53 -0
- package/dist-types/commands/CreateVoiceConnectorGroupCommand.d.ts +59 -0
- package/dist-types/commands/CreateVoiceProfileCommand.d.ts +63 -0
- package/dist-types/commands/CreateVoiceProfileDomainCommand.d.ts +68 -0
- package/dist-types/commands/DeletePhoneNumberCommand.d.ts +51 -0
- package/dist-types/commands/DeleteProxySessionCommand.d.ts +47 -0
- package/dist-types/commands/DeleteSipMediaApplicationCommand.d.ts +48 -0
- package/dist-types/commands/DeleteSipRuleCommand.d.ts +48 -0
- package/dist-types/commands/DeleteVoiceConnectorCommand.d.ts +50 -0
- package/dist-types/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +46 -0
- package/dist-types/commands/DeleteVoiceConnectorGroupCommand.d.ts +50 -0
- package/dist-types/commands/DeleteVoiceConnectorOriginationCommand.d.ts +49 -0
- package/dist-types/commands/DeleteVoiceConnectorProxyCommand.d.ts +45 -0
- package/dist-types/commands/DeleteVoiceConnectorStreamingConfigurationCommand.d.ts +45 -0
- package/dist-types/commands/DeleteVoiceConnectorTerminationCommand.d.ts +49 -0
- package/dist-types/commands/DeleteVoiceConnectorTerminationCredentialsCommand.d.ts +49 -0
- package/dist-types/commands/DeleteVoiceProfileCommand.d.ts +51 -0
- package/dist-types/commands/DeleteVoiceProfileDomainCommand.d.ts +51 -0
- package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.d.ts +49 -0
- package/dist-types/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.d.ts +49 -0
- package/dist-types/commands/GetGlobalSettingsCommand.d.ts +40 -0
- package/dist-types/commands/GetPhoneNumberCommand.d.ts +46 -0
- package/dist-types/commands/GetPhoneNumberOrderCommand.d.ts +47 -0
- package/dist-types/commands/GetPhoneNumberSettingsCommand.d.ts +41 -0
- package/dist-types/commands/GetProxySessionCommand.d.ts +46 -0
- package/dist-types/commands/GetSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +45 -0
- package/dist-types/commands/GetSipMediaApplicationCommand.d.ts +46 -0
- package/dist-types/commands/GetSipMediaApplicationLoggingConfigurationCommand.d.ts +45 -0
- package/dist-types/commands/GetSipRuleCommand.d.ts +46 -0
- package/dist-types/commands/GetSpeakerSearchTaskCommand.d.ts +52 -0
- package/dist-types/commands/GetVoiceConnectorCommand.d.ts +46 -0
- package/dist-types/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +45 -0
- package/dist-types/commands/GetVoiceConnectorGroupCommand.d.ts +46 -0
- package/dist-types/commands/GetVoiceConnectorLoggingConfigurationCommand.d.ts +46 -0
- package/dist-types/commands/GetVoiceConnectorOriginationCommand.d.ts +45 -0
- package/dist-types/commands/GetVoiceConnectorProxyCommand.d.ts +46 -0
- package/dist-types/commands/GetVoiceConnectorStreamingConfigurationCommand.d.ts +47 -0
- package/dist-types/commands/GetVoiceConnectorTerminationCommand.d.ts +45 -0
- package/dist-types/commands/GetVoiceConnectorTerminationHealthCommand.d.ts +47 -0
- package/dist-types/commands/GetVoiceProfileCommand.d.ts +48 -0
- package/dist-types/commands/GetVoiceProfileDomainCommand.d.ts +48 -0
- package/dist-types/commands/GetVoiceToneAnalysisTaskCommand.d.ts +53 -0
- package/dist-types/commands/ListAvailableVoiceConnectorRegionsCommand.d.ts +40 -0
- package/dist-types/commands/ListPhoneNumberOrdersCommand.d.ts +43 -0
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +52 -0
- package/dist-types/commands/ListProxySessionsCommand.d.ts +48 -0
- package/dist-types/commands/ListSipMediaApplicationsCommand.d.ts +43 -0
- package/dist-types/commands/ListSipRulesCommand.d.ts +44 -0
- package/dist-types/commands/ListSupportedPhoneNumberCountriesCommand.d.ts +45 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +42 -0
- package/dist-types/commands/ListVoiceConnectorGroupsCommand.d.ts +44 -0
- package/dist-types/commands/ListVoiceConnectorTerminationCredentialsCommand.d.ts +45 -0
- package/dist-types/commands/ListVoiceConnectorsCommand.d.ts +44 -0
- package/dist-types/commands/ListVoiceProfileDomainsCommand.d.ts +47 -0
- package/dist-types/commands/ListVoiceProfilesCommand.d.ts +47 -0
- package/dist-types/commands/PutSipMediaApplicationAlexaSkillConfigurationCommand.d.ts +51 -0
- package/dist-types/commands/PutSipMediaApplicationLoggingConfigurationCommand.d.ts +48 -0
- package/dist-types/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.d.ts +54 -0
- package/dist-types/commands/PutVoiceConnectorLoggingConfigurationCommand.d.ts +49 -0
- package/dist-types/commands/PutVoiceConnectorOriginationCommand.d.ts +57 -0
- package/dist-types/commands/PutVoiceConnectorProxyCommand.d.ts +54 -0
- package/dist-types/commands/PutVoiceConnectorStreamingConfigurationCommand.d.ts +58 -0
- package/dist-types/commands/PutVoiceConnectorTerminationCommand.d.ts +59 -0
- package/dist-types/commands/PutVoiceConnectorTerminationCredentialsCommand.d.ts +51 -0
- package/dist-types/commands/RestorePhoneNumberCommand.d.ts +48 -0
- package/dist-types/commands/SearchAvailablePhoneNumbersCommand.d.ts +52 -0
- package/dist-types/commands/StartSpeakerSearchTaskCommand.d.ts +67 -0
- package/dist-types/commands/StartVoiceToneAnalysisTaskCommand.d.ts +69 -0
- package/dist-types/commands/StopSpeakerSearchTaskCommand.d.ts +55 -0
- package/dist-types/commands/StopVoiceToneAnalysisTaskCommand.d.ts +55 -0
- package/dist-types/commands/TagResourceCommand.d.ts +51 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +45 -0
- package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +44 -0
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +57 -0
- package/dist-types/commands/UpdatePhoneNumberSettingsCommand.d.ts +45 -0
- package/dist-types/commands/UpdateProxySessionCommand.d.ts +50 -0
- package/dist-types/commands/UpdateSipMediaApplicationCallCommand.d.ts +54 -0
- package/dist-types/commands/UpdateSipMediaApplicationCommand.d.ts +54 -0
- package/dist-types/commands/UpdateSipRuleCommand.d.ts +60 -0
- package/dist-types/commands/UpdateVoiceConnectorCommand.d.ts +47 -0
- package/dist-types/commands/UpdateVoiceConnectorGroupCommand.d.ts +55 -0
- package/dist-types/commands/UpdateVoiceProfileCommand.d.ts +64 -0
- package/dist-types/commands/UpdateVoiceProfileDomainCommand.d.ts +50 -0
- package/dist-types/commands/ValidateE911AddressCommand.d.ts +54 -0
- package/dist-types/models/models_0.d.ts +1583 -0
- package/package.json +8 -8
|
@@ -23,6 +23,7 @@ export declare enum ErrorCode {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
+
* <p>You don't have the permissions needed to run this action.</p>
|
|
26
27
|
*/
|
|
27
28
|
export declare class AccessDeniedException extends __BaseException {
|
|
28
29
|
readonly name: "AccessDeniedException";
|
|
@@ -36,17 +37,50 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
36
37
|
}
|
|
37
38
|
/**
|
|
38
39
|
* @public
|
|
40
|
+
* <p>A validated address.</p>
|
|
39
41
|
*/
|
|
40
42
|
export interface Address {
|
|
43
|
+
/**
|
|
44
|
+
* <p>The address street, such as <code>8th Avenue</code>.</p>
|
|
45
|
+
*/
|
|
41
46
|
streetName?: string;
|
|
47
|
+
/**
|
|
48
|
+
* <p>The address suffix, such as the <code>N</code> in <code>8th Avenue N</code>.</p>
|
|
49
|
+
*/
|
|
42
50
|
streetSuffix?: string;
|
|
51
|
+
/**
|
|
52
|
+
* <p>An address suffix location, such as the <code>S. Unit A</code> in
|
|
53
|
+
* <code>Central Park S. Unit A</code>.</p>
|
|
54
|
+
*/
|
|
43
55
|
postDirectional?: string;
|
|
56
|
+
/**
|
|
57
|
+
* <p>An address prefix location, such as the <code>N</code> in <code>N. Third St.</code>
|
|
58
|
+
* </p>
|
|
59
|
+
*/
|
|
44
60
|
preDirectional?: string;
|
|
61
|
+
/**
|
|
62
|
+
* <p>The numeric portion of an address.</p>
|
|
63
|
+
*/
|
|
45
64
|
streetNumber?: string;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The city of an address.</p>
|
|
67
|
+
*/
|
|
46
68
|
city?: string;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The state of an address.</p>
|
|
71
|
+
*/
|
|
47
72
|
state?: string;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The postal code of an address.</p>
|
|
75
|
+
*/
|
|
48
76
|
postalCode?: string;
|
|
77
|
+
/**
|
|
78
|
+
* <p>The zip + 4 or postal code + 4 of an address.</p>
|
|
79
|
+
*/
|
|
49
80
|
postalCodePlus4?: string;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The country of an address.</p>
|
|
83
|
+
*/
|
|
50
84
|
country?: string;
|
|
51
85
|
}
|
|
52
86
|
/**
|
|
@@ -60,26 +94,51 @@ export declare enum AlexaSkillStatus {
|
|
|
60
94
|
* @public
|
|
61
95
|
*/
|
|
62
96
|
export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
|
|
97
|
+
/**
|
|
98
|
+
* <p>The Voice Connector ID.</p>
|
|
99
|
+
*/
|
|
63
100
|
VoiceConnectorId: string | undefined;
|
|
101
|
+
/**
|
|
102
|
+
* <p>List of phone numbers, in E.164 format.</p>
|
|
103
|
+
*/
|
|
64
104
|
E164PhoneNumbers: string[] | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* <p>If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.</p>
|
|
107
|
+
*/
|
|
65
108
|
ForceAssociate?: boolean;
|
|
66
109
|
}
|
|
67
110
|
/**
|
|
68
111
|
* @public
|
|
112
|
+
* <p>If a phone number action fails for one or more of the phone numbers in a request,
|
|
113
|
+
* a list of the failed phone numbers is returned, along with error codes and error messages.</p>
|
|
69
114
|
*/
|
|
70
115
|
export interface PhoneNumberError {
|
|
116
|
+
/**
|
|
117
|
+
* <p>The phone number ID for which the action failed.</p>
|
|
118
|
+
*/
|
|
71
119
|
PhoneNumberId?: string;
|
|
120
|
+
/**
|
|
121
|
+
* <p>The error code.</p>
|
|
122
|
+
*/
|
|
72
123
|
ErrorCode?: ErrorCode | string;
|
|
124
|
+
/**
|
|
125
|
+
* <p>The error message.</p>
|
|
126
|
+
*/
|
|
73
127
|
ErrorMessage?: string;
|
|
74
128
|
}
|
|
75
129
|
/**
|
|
76
130
|
* @public
|
|
77
131
|
*/
|
|
78
132
|
export interface AssociatePhoneNumbersWithVoiceConnectorResponse {
|
|
133
|
+
/**
|
|
134
|
+
* <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and
|
|
135
|
+
* error messages.</p>
|
|
136
|
+
*/
|
|
79
137
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
80
138
|
}
|
|
81
139
|
/**
|
|
82
140
|
* @public
|
|
141
|
+
* <p>The input parameters don't match the service's restrictions.</p>
|
|
83
142
|
*/
|
|
84
143
|
export declare class BadRequestException extends __BaseException {
|
|
85
144
|
readonly name: "BadRequestException";
|
|
@@ -93,6 +152,7 @@ export declare class BadRequestException extends __BaseException {
|
|
|
93
152
|
}
|
|
94
153
|
/**
|
|
95
154
|
* @public
|
|
155
|
+
* <p>The client is permanently forbidden from making the request.</p>
|
|
96
156
|
*/
|
|
97
157
|
export declare class ForbiddenException extends __BaseException {
|
|
98
158
|
readonly name: "ForbiddenException";
|
|
@@ -106,6 +166,7 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
106
166
|
}
|
|
107
167
|
/**
|
|
108
168
|
* @public
|
|
169
|
+
* <p>The requested resource couldn't be found.</p>
|
|
109
170
|
*/
|
|
110
171
|
export declare class NotFoundException extends __BaseException {
|
|
111
172
|
readonly name: "NotFoundException";
|
|
@@ -119,6 +180,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
119
180
|
}
|
|
120
181
|
/**
|
|
121
182
|
* @public
|
|
183
|
+
* <p>The service encountered an unexpected error.</p>
|
|
122
184
|
*/
|
|
123
185
|
export declare class ServiceFailureException extends __BaseException {
|
|
124
186
|
readonly name: "ServiceFailureException";
|
|
@@ -132,6 +194,7 @@ export declare class ServiceFailureException extends __BaseException {
|
|
|
132
194
|
}
|
|
133
195
|
/**
|
|
134
196
|
* @public
|
|
197
|
+
* <p>The service is currently unavailable.</p>
|
|
135
198
|
*/
|
|
136
199
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
137
200
|
readonly name: "ServiceUnavailableException";
|
|
@@ -145,6 +208,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
145
208
|
}
|
|
146
209
|
/**
|
|
147
210
|
* @public
|
|
211
|
+
* <p>The number of customer requests exceeds the request rate limit.</p>
|
|
148
212
|
*/
|
|
149
213
|
export declare class ThrottledClientException extends __BaseException {
|
|
150
214
|
readonly name: "ThrottledClientException";
|
|
@@ -158,6 +222,7 @@ export declare class ThrottledClientException extends __BaseException {
|
|
|
158
222
|
}
|
|
159
223
|
/**
|
|
160
224
|
* @public
|
|
225
|
+
* <p>The client isn't authorized to request a resource.</p>
|
|
161
226
|
*/
|
|
162
227
|
export declare class UnauthorizedClientException extends __BaseException {
|
|
163
228
|
readonly name: "UnauthorizedClientException";
|
|
@@ -173,26 +238,45 @@ export declare class UnauthorizedClientException extends __BaseException {
|
|
|
173
238
|
* @public
|
|
174
239
|
*/
|
|
175
240
|
export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
|
|
241
|
+
/**
|
|
242
|
+
* <p>The Amazon Chime SDK Voice Connector group ID.</p>
|
|
243
|
+
*/
|
|
176
244
|
VoiceConnectorGroupId: string | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>List of phone numbers, in E.164 format.</p>
|
|
247
|
+
*/
|
|
177
248
|
E164PhoneNumbers: string[] | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* <p>If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations.
|
|
251
|
+
* If false, does not associate any phone numbers that have previously existing associations.</p>
|
|
252
|
+
*/
|
|
178
253
|
ForceAssociate?: boolean;
|
|
179
254
|
}
|
|
180
255
|
/**
|
|
181
256
|
* @public
|
|
182
257
|
*/
|
|
183
258
|
export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
|
|
259
|
+
/**
|
|
260
|
+
* <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
|
|
261
|
+
*/
|
|
184
262
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
185
263
|
}
|
|
186
264
|
/**
|
|
187
265
|
* @public
|
|
188
266
|
*/
|
|
189
267
|
export interface BatchDeletePhoneNumberRequest {
|
|
268
|
+
/**
|
|
269
|
+
* <p>List of phone number IDs.</p>
|
|
270
|
+
*/
|
|
190
271
|
PhoneNumberIds: string[] | undefined;
|
|
191
272
|
}
|
|
192
273
|
/**
|
|
193
274
|
* @public
|
|
194
275
|
*/
|
|
195
276
|
export interface BatchDeletePhoneNumberResponse {
|
|
277
|
+
/**
|
|
278
|
+
* <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
|
|
279
|
+
*/
|
|
196
280
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
197
281
|
}
|
|
198
282
|
/**
|
|
@@ -204,30 +288,57 @@ export declare enum PhoneNumberProductType {
|
|
|
204
288
|
}
|
|
205
289
|
/**
|
|
206
290
|
* @public
|
|
291
|
+
* <p>The phone number ID, product type, or calling name fields to update,
|
|
292
|
+
* used with the <a>BatchUpdatePhoneNumber</a> and <a>UpdatePhoneNumber</a> actions.</p>
|
|
207
293
|
*/
|
|
208
294
|
export interface UpdatePhoneNumberRequestItem {
|
|
295
|
+
/**
|
|
296
|
+
* <p>The phone number ID to update.</p>
|
|
297
|
+
*/
|
|
209
298
|
PhoneNumberId: string | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* <p>The product type to update.</p>
|
|
301
|
+
*/
|
|
210
302
|
ProductType?: PhoneNumberProductType | string;
|
|
303
|
+
/**
|
|
304
|
+
* <p>The outbound calling name to update.</p>
|
|
305
|
+
*/
|
|
211
306
|
CallingName?: string;
|
|
212
307
|
}
|
|
213
308
|
/**
|
|
214
309
|
* @public
|
|
215
310
|
*/
|
|
216
311
|
export interface BatchUpdatePhoneNumberRequest {
|
|
312
|
+
/**
|
|
313
|
+
* <p>Lists the phone numbers in the update request.</p>
|
|
314
|
+
*/
|
|
217
315
|
UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItem[] | undefined;
|
|
218
316
|
}
|
|
219
317
|
/**
|
|
220
318
|
* @public
|
|
221
319
|
*/
|
|
222
320
|
export interface BatchUpdatePhoneNumberResponse {
|
|
321
|
+
/**
|
|
322
|
+
* <p>A list of failed phone numbers and their error messages.</p>
|
|
323
|
+
*/
|
|
223
324
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
224
325
|
}
|
|
225
326
|
/**
|
|
226
327
|
* @public
|
|
328
|
+
* <p>The details of an Amazon Chime SDK Voice Connector call.</p>
|
|
227
329
|
*/
|
|
228
330
|
export interface CallDetails {
|
|
331
|
+
/**
|
|
332
|
+
* <p>The Voice Connector ID.</p>
|
|
333
|
+
*/
|
|
229
334
|
VoiceConnectorId?: string;
|
|
335
|
+
/**
|
|
336
|
+
* <p>The transaction ID of a Voice Connector call.</p>
|
|
337
|
+
*/
|
|
230
338
|
TransactionId?: string;
|
|
339
|
+
/**
|
|
340
|
+
* <p>Identifies a person as the caller or the callee.</p>
|
|
341
|
+
*/
|
|
231
342
|
IsCaller?: boolean;
|
|
232
343
|
}
|
|
233
344
|
/**
|
|
@@ -241,14 +352,36 @@ export declare enum CallingNameStatus {
|
|
|
241
352
|
}
|
|
242
353
|
/**
|
|
243
354
|
* @public
|
|
355
|
+
* <p>A suggested address.</p>
|
|
244
356
|
*/
|
|
245
357
|
export interface CandidateAddress {
|
|
358
|
+
/**
|
|
359
|
+
* <p>The street information of the candidate address.</p>
|
|
360
|
+
*/
|
|
246
361
|
streetInfo?: string;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The numeric portion of the candidate address.</p>
|
|
364
|
+
*/
|
|
247
365
|
streetNumber?: string;
|
|
366
|
+
/**
|
|
367
|
+
* <p>The city of the candidate address.</p>
|
|
368
|
+
*/
|
|
248
369
|
city?: string;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The state of the candidate address.</p>
|
|
372
|
+
*/
|
|
249
373
|
state?: string;
|
|
374
|
+
/**
|
|
375
|
+
* <p>The postal code of the candidate address.</p>
|
|
376
|
+
*/
|
|
250
377
|
postalCode?: string;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The zip + 4 or postal code +4 of the candidate address.</p>
|
|
380
|
+
*/
|
|
251
381
|
postalCodePlus4?: string;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The country of the candidate address.</p>
|
|
384
|
+
*/
|
|
252
385
|
country?: string;
|
|
253
386
|
}
|
|
254
387
|
/**
|
|
@@ -262,7 +395,13 @@ export declare enum Capability {
|
|
|
262
395
|
* @public
|
|
263
396
|
*/
|
|
264
397
|
export interface CreatePhoneNumberOrderRequest {
|
|
398
|
+
/**
|
|
399
|
+
* <p>The phone number product type.</p>
|
|
400
|
+
*/
|
|
265
401
|
ProductType: PhoneNumberProductType | string | undefined;
|
|
402
|
+
/**
|
|
403
|
+
* <p>List of phone numbers, in E.164 format.</p>
|
|
404
|
+
*/
|
|
266
405
|
E164PhoneNumbers: string[] | undefined;
|
|
267
406
|
}
|
|
268
407
|
/**
|
|
@@ -275,9 +414,16 @@ export declare enum OrderedPhoneNumberStatus {
|
|
|
275
414
|
}
|
|
276
415
|
/**
|
|
277
416
|
* @public
|
|
417
|
+
* <p>A phone number for which an order has been placed.</p>
|
|
278
418
|
*/
|
|
279
419
|
export interface OrderedPhoneNumber {
|
|
420
|
+
/**
|
|
421
|
+
* <p>The phone number, in E.164 format.</p>
|
|
422
|
+
*/
|
|
280
423
|
E164PhoneNumber?: string;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The phone number status.</p>
|
|
426
|
+
*/
|
|
281
427
|
Status?: OrderedPhoneNumberStatus | string;
|
|
282
428
|
}
|
|
283
429
|
/**
|
|
@@ -305,24 +451,51 @@ export declare enum PhoneNumberOrderStatus {
|
|
|
305
451
|
}
|
|
306
452
|
/**
|
|
307
453
|
* @public
|
|
454
|
+
* <p>The details of an Amazon Chime SDK phone number order.</p>
|
|
308
455
|
*/
|
|
309
456
|
export interface PhoneNumberOrder {
|
|
457
|
+
/**
|
|
458
|
+
* <p>The ID of the phone order.</p>
|
|
459
|
+
*/
|
|
310
460
|
PhoneNumberOrderId?: string;
|
|
461
|
+
/**
|
|
462
|
+
* <p>The phone number order product type.</p>
|
|
463
|
+
*/
|
|
311
464
|
ProductType?: PhoneNumberProductType | string;
|
|
465
|
+
/**
|
|
466
|
+
* <p>The status of the phone number order.</p>
|
|
467
|
+
*/
|
|
312
468
|
Status?: PhoneNumberOrderStatus | string;
|
|
469
|
+
/**
|
|
470
|
+
* <p>The type of phone number being ordered, local or toll-free.</p>
|
|
471
|
+
*/
|
|
313
472
|
OrderType?: PhoneNumberOrderType | string;
|
|
473
|
+
/**
|
|
474
|
+
* <p>The ordered phone number details, such as the phone number in E.164 format
|
|
475
|
+
* and the phone number status.</p>
|
|
476
|
+
*/
|
|
314
477
|
OrderedPhoneNumbers?: OrderedPhoneNumber[];
|
|
478
|
+
/**
|
|
479
|
+
* <p>The phone number order creation time stamp, in ISO 8601 format.</p>
|
|
480
|
+
*/
|
|
315
481
|
CreatedTimestamp?: Date;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The updated phone number order time stamp, in ISO 8601 format.</p>
|
|
484
|
+
*/
|
|
316
485
|
UpdatedTimestamp?: Date;
|
|
317
486
|
}
|
|
318
487
|
/**
|
|
319
488
|
* @public
|
|
320
489
|
*/
|
|
321
490
|
export interface CreatePhoneNumberOrderResponse {
|
|
491
|
+
/**
|
|
492
|
+
* <p>The phone number order details.</p>
|
|
493
|
+
*/
|
|
322
494
|
PhoneNumberOrder?: PhoneNumberOrder;
|
|
323
495
|
}
|
|
324
496
|
/**
|
|
325
497
|
* @public
|
|
498
|
+
* <p>The request exceeds the resource limit.</p>
|
|
326
499
|
*/
|
|
327
500
|
export declare class ResourceLimitExceededException extends __BaseException {
|
|
328
501
|
readonly name: "ResourceLimitExceededException";
|
|
@@ -343,9 +516,16 @@ export declare enum GeoMatchLevel {
|
|
|
343
516
|
}
|
|
344
517
|
/**
|
|
345
518
|
* @public
|
|
519
|
+
* <p>The country and area code for a proxy phone number in a proxy phone session.</p>
|
|
346
520
|
*/
|
|
347
521
|
export interface GeoMatchParams {
|
|
522
|
+
/**
|
|
523
|
+
* <p>The country. </p>
|
|
524
|
+
*/
|
|
348
525
|
Country: string | undefined;
|
|
526
|
+
/**
|
|
527
|
+
* <p>The area code.</p>
|
|
528
|
+
*/
|
|
349
529
|
AreaCode: string | undefined;
|
|
350
530
|
}
|
|
351
531
|
/**
|
|
@@ -359,20 +539,52 @@ export declare enum NumberSelectionBehavior {
|
|
|
359
539
|
* @public
|
|
360
540
|
*/
|
|
361
541
|
export interface CreateProxySessionRequest {
|
|
542
|
+
/**
|
|
543
|
+
* <p>The Voice Connector ID.</p>
|
|
544
|
+
*/
|
|
362
545
|
VoiceConnectorId: string | undefined;
|
|
546
|
+
/**
|
|
547
|
+
* <p>The participant phone numbers.</p>
|
|
548
|
+
*/
|
|
363
549
|
ParticipantPhoneNumbers: string[] | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p>The name of the proxy session.</p>
|
|
552
|
+
*/
|
|
364
553
|
Name?: string;
|
|
554
|
+
/**
|
|
555
|
+
* <p>The number of minutes allowed for the proxy session.</p>
|
|
556
|
+
*/
|
|
365
557
|
ExpiryMinutes?: number;
|
|
558
|
+
/**
|
|
559
|
+
* <p>The proxy session's capabilities.</p>
|
|
560
|
+
*/
|
|
366
561
|
Capabilities: (Capability | string)[] | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* <p>The preference for proxy phone number reuse, or stickiness, between the same
|
|
564
|
+
* participants across sessions.</p>
|
|
565
|
+
*/
|
|
367
566
|
NumberSelectionBehavior?: NumberSelectionBehavior | string;
|
|
567
|
+
/**
|
|
568
|
+
* <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
|
|
569
|
+
*/
|
|
368
570
|
GeoMatchLevel?: GeoMatchLevel | string;
|
|
571
|
+
/**
|
|
572
|
+
* <p>The country and area code for the proxy phone number.</p>
|
|
573
|
+
*/
|
|
369
574
|
GeoMatchParams?: GeoMatchParams;
|
|
370
575
|
}
|
|
371
576
|
/**
|
|
372
577
|
* @public
|
|
578
|
+
* <p>The phone number and proxy phone number for a participant in an Amazon Chime SDK Voice Connector proxy session.</p>
|
|
373
579
|
*/
|
|
374
580
|
export interface Participant {
|
|
581
|
+
/**
|
|
582
|
+
* <p>The participant's phone number.</p>
|
|
583
|
+
*/
|
|
375
584
|
PhoneNumber?: string;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The participant's proxy phone number.</p>
|
|
587
|
+
*/
|
|
376
588
|
ProxyPhoneNumber?: string;
|
|
377
589
|
}
|
|
378
590
|
/**
|
|
@@ -385,30 +597,74 @@ export declare enum ProxySessionStatus {
|
|
|
385
597
|
}
|
|
386
598
|
/**
|
|
387
599
|
* @public
|
|
600
|
+
* <p>The proxy session for an Amazon Chime SDK Voice Connector.</p>
|
|
388
601
|
*/
|
|
389
602
|
export interface ProxySession {
|
|
603
|
+
/**
|
|
604
|
+
* <p>The Voice Connector ID.</p>
|
|
605
|
+
*/
|
|
390
606
|
VoiceConnectorId?: string;
|
|
607
|
+
/**
|
|
608
|
+
* <p>The proxy session ID.</p>
|
|
609
|
+
*/
|
|
391
610
|
ProxySessionId?: string;
|
|
611
|
+
/**
|
|
612
|
+
* <p>The proxy session name.</p>
|
|
613
|
+
*/
|
|
392
614
|
Name?: string;
|
|
615
|
+
/**
|
|
616
|
+
* <p>The proxy session status.</p>
|
|
617
|
+
*/
|
|
393
618
|
Status?: ProxySessionStatus | string;
|
|
619
|
+
/**
|
|
620
|
+
* <p>The number of minutes allowed for the proxy session.</p>
|
|
621
|
+
*/
|
|
394
622
|
ExpiryMinutes?: number;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The proxy session capabilities.</p>
|
|
625
|
+
*/
|
|
395
626
|
Capabilities?: (Capability | string)[];
|
|
627
|
+
/**
|
|
628
|
+
* <p>The created time stamp, in ISO 8601 format.</p>
|
|
629
|
+
*/
|
|
396
630
|
CreatedTimestamp?: Date;
|
|
631
|
+
/**
|
|
632
|
+
* <p>The updated time stamp, in ISO 8601 format.</p>
|
|
633
|
+
*/
|
|
397
634
|
UpdatedTimestamp?: Date;
|
|
635
|
+
/**
|
|
636
|
+
* <p>The ended time stamp, in ISO 8601 format.</p>
|
|
637
|
+
*/
|
|
398
638
|
EndedTimestamp?: Date;
|
|
639
|
+
/**
|
|
640
|
+
* <p>The proxy session participants.</p>
|
|
641
|
+
*/
|
|
399
642
|
Participants?: Participant[];
|
|
643
|
+
/**
|
|
644
|
+
* <p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>
|
|
645
|
+
*/
|
|
400
646
|
NumberSelectionBehavior?: NumberSelectionBehavior | string;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
|
|
649
|
+
*/
|
|
401
650
|
GeoMatchLevel?: GeoMatchLevel | string;
|
|
651
|
+
/**
|
|
652
|
+
* <p>The country and area code for the proxy phone number.</p>
|
|
653
|
+
*/
|
|
402
654
|
GeoMatchParams?: GeoMatchParams;
|
|
403
655
|
}
|
|
404
656
|
/**
|
|
405
657
|
* @public
|
|
406
658
|
*/
|
|
407
659
|
export interface CreateProxySessionResponse {
|
|
660
|
+
/**
|
|
661
|
+
* <p>The proxy session details.</p>
|
|
662
|
+
*/
|
|
408
663
|
ProxySession?: ProxySession;
|
|
409
664
|
}
|
|
410
665
|
/**
|
|
411
666
|
* @public
|
|
667
|
+
* <p>Multiple instances of the same request were made simultaneously.</p>
|
|
412
668
|
*/
|
|
413
669
|
export declare class ConflictException extends __BaseException {
|
|
414
670
|
readonly name: "ConflictException";
|
|
@@ -422,63 +678,137 @@ export declare class ConflictException extends __BaseException {
|
|
|
422
678
|
}
|
|
423
679
|
/**
|
|
424
680
|
* @public
|
|
681
|
+
* <p>The endpoint assigned to a SIP media application.</p>
|
|
425
682
|
*/
|
|
426
683
|
export interface SipMediaApplicationEndpoint {
|
|
684
|
+
/**
|
|
685
|
+
* <p>Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias.
|
|
686
|
+
* The function must be created in the same AWS Region as the SIP media application.</p>
|
|
687
|
+
*/
|
|
427
688
|
LambdaArn?: string;
|
|
428
689
|
}
|
|
429
690
|
/**
|
|
430
691
|
* @public
|
|
431
692
|
*/
|
|
432
693
|
export interface CreateSipMediaApplicationRequest {
|
|
694
|
+
/**
|
|
695
|
+
* <p>The AWS Region assigned to the SIP media application.</p>
|
|
696
|
+
*/
|
|
433
697
|
AwsRegion: string | undefined;
|
|
698
|
+
/**
|
|
699
|
+
* <p>The SIP media application's name.</p>
|
|
700
|
+
*/
|
|
434
701
|
Name: string | undefined;
|
|
702
|
+
/**
|
|
703
|
+
* <p>List of endpoints (Lambda ARNs) specified for the SIP media application.</p>
|
|
704
|
+
*/
|
|
435
705
|
Endpoints: SipMediaApplicationEndpoint[] | undefined;
|
|
436
706
|
}
|
|
437
707
|
/**
|
|
438
708
|
* @public
|
|
709
|
+
* <p>The details of the SIP media application, including name and endpoints.
|
|
710
|
+
* An AWS account can have multiple SIP media applications.</p>
|
|
439
711
|
*/
|
|
440
712
|
export interface SipMediaApplication {
|
|
713
|
+
/**
|
|
714
|
+
* <p>A SIP media application's ID.</p>
|
|
715
|
+
*/
|
|
441
716
|
SipMediaApplicationId?: string;
|
|
717
|
+
/**
|
|
718
|
+
* <p>The AWS Region in which the SIP media application is created.</p>
|
|
719
|
+
*/
|
|
442
720
|
AwsRegion?: string;
|
|
721
|
+
/**
|
|
722
|
+
* <p>The SIP media application's name.</p>
|
|
723
|
+
*/
|
|
443
724
|
Name?: string;
|
|
725
|
+
/**
|
|
726
|
+
* <p>List of endpoints for SIP media application. Currently, only one endpoint per
|
|
727
|
+
* SIP media application is permitted.</p>
|
|
728
|
+
*/
|
|
444
729
|
Endpoints?: SipMediaApplicationEndpoint[];
|
|
730
|
+
/**
|
|
731
|
+
* <p>The SIP media application creation timestamp, in ISO 8601 format.</p>
|
|
732
|
+
*/
|
|
445
733
|
CreatedTimestamp?: Date;
|
|
734
|
+
/**
|
|
735
|
+
* <p>The time at which the SIP media application was updated.</p>
|
|
736
|
+
*/
|
|
446
737
|
UpdatedTimestamp?: Date;
|
|
447
738
|
}
|
|
448
739
|
/**
|
|
449
740
|
* @public
|
|
450
741
|
*/
|
|
451
742
|
export interface CreateSipMediaApplicationResponse {
|
|
743
|
+
/**
|
|
744
|
+
* <p>The SIP media application details.</p>
|
|
745
|
+
*/
|
|
452
746
|
SipMediaApplication?: SipMediaApplication;
|
|
453
747
|
}
|
|
454
748
|
/**
|
|
455
749
|
* @public
|
|
456
750
|
*/
|
|
457
751
|
export interface CreateSipMediaApplicationCallRequest {
|
|
752
|
+
/**
|
|
753
|
+
* <p>The phone number that a user calls from. This is a phone number in your
|
|
754
|
+
* Amazon Chime SDK phone number inventory.</p>
|
|
755
|
+
*/
|
|
458
756
|
FromPhoneNumber: string | undefined;
|
|
757
|
+
/**
|
|
758
|
+
* <p>The phone number that the service should call.</p>
|
|
759
|
+
*/
|
|
459
760
|
ToPhoneNumber: string | undefined;
|
|
761
|
+
/**
|
|
762
|
+
* <p>The ID of the SIP media application.</p>
|
|
763
|
+
*/
|
|
460
764
|
SipMediaApplicationId: string | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* <p>The SIP headers added to an outbound call leg.</p>
|
|
767
|
+
*/
|
|
461
768
|
SipHeaders?: Record<string, string>;
|
|
769
|
+
/**
|
|
770
|
+
* <p>Context passed to a CreateSipMediaApplication API call. For example, you could pass
|
|
771
|
+
* key-value pairs such as: <code>"FirstName": "John", "LastName": "Doe"</code>
|
|
772
|
+
* </p>
|
|
773
|
+
*/
|
|
462
774
|
ArgumentsMap?: Record<string, string>;
|
|
463
775
|
}
|
|
464
776
|
/**
|
|
465
777
|
* @public
|
|
778
|
+
* <p>A <code>Call</code> instance for a SIP media application.</p>
|
|
466
779
|
*/
|
|
467
780
|
export interface SipMediaApplicationCall {
|
|
781
|
+
/**
|
|
782
|
+
* <p>The call's transaction ID.</p>
|
|
783
|
+
*/
|
|
468
784
|
TransactionId?: string;
|
|
469
785
|
}
|
|
470
786
|
/**
|
|
471
787
|
* @public
|
|
472
788
|
*/
|
|
473
789
|
export interface CreateSipMediaApplicationCallResponse {
|
|
790
|
+
/**
|
|
791
|
+
* <p>The actual call.</p>
|
|
792
|
+
*/
|
|
474
793
|
SipMediaApplicationCall?: SipMediaApplicationCall;
|
|
475
794
|
}
|
|
476
795
|
/**
|
|
477
796
|
* @public
|
|
797
|
+
* <p>A target SIP media application and other details, such as priority and AWS Region,
|
|
798
|
+
* to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.</p>
|
|
478
799
|
*/
|
|
479
800
|
export interface SipRuleTargetApplication {
|
|
801
|
+
/**
|
|
802
|
+
* <p>The ID of a rule's target SIP media application.</p>
|
|
803
|
+
*/
|
|
480
804
|
SipMediaApplicationId?: string;
|
|
805
|
+
/**
|
|
806
|
+
* <p>The priority setting of a rule's target SIP media application.</p>
|
|
807
|
+
*/
|
|
481
808
|
Priority?: number;
|
|
809
|
+
/**
|
|
810
|
+
* <p>The AWS Region of a rule's target SIP media application.</p>
|
|
811
|
+
*/
|
|
482
812
|
AwsRegion?: string;
|
|
483
813
|
}
|
|
484
814
|
/**
|
|
@@ -492,29 +822,84 @@ export declare enum SipRuleTriggerType {
|
|
|
492
822
|
* @public
|
|
493
823
|
*/
|
|
494
824
|
export interface CreateSipRuleRequest {
|
|
825
|
+
/**
|
|
826
|
+
* <p>The name of the SIP rule.</p>
|
|
827
|
+
*/
|
|
495
828
|
Name: string | undefined;
|
|
829
|
+
/**
|
|
830
|
+
* <p>The type of trigger assigned to the SIP rule in <code>TriggerValue</code>,
|
|
831
|
+
* currently <code>RequestUriHostname</code> or <code>ToPhoneNumber</code>.</p>
|
|
832
|
+
*/
|
|
496
833
|
TriggerType: SipRuleTriggerType | string | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>If <code>TriggerType</code> is <code>RequestUriHostname</code>, the
|
|
836
|
+
* value can be the outbound host name of a Voice Connector. If
|
|
837
|
+
* <code>TriggerType</code> is <code>ToPhoneNumber</code>, the value can
|
|
838
|
+
* be a customer-owned phone number in the E164 format. The
|
|
839
|
+
* <code>SipMediaApplication</code> specified in the <code>SipRule</code> is triggered
|
|
840
|
+
* if the request URI in an incoming SIP request matches the
|
|
841
|
+
* <code>RequestUriHostname</code>, or if the <code>To</code> header in the
|
|
842
|
+
* incoming SIP request matches the <code>ToPhoneNumber</code> value.</p>
|
|
843
|
+
*/
|
|
497
844
|
TriggerValue: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>Disables or enables a SIP rule. You must disable SIP rules
|
|
847
|
+
* before you can delete them.</p>
|
|
848
|
+
*/
|
|
498
849
|
Disabled?: boolean;
|
|
850
|
+
/**
|
|
851
|
+
* <p>List of SIP media applications, with priority and AWS Region. Only one SIP
|
|
852
|
+
* application per AWS Region can be used.</p>
|
|
853
|
+
*/
|
|
499
854
|
TargetApplications?: SipRuleTargetApplication[];
|
|
500
855
|
}
|
|
501
856
|
/**
|
|
502
857
|
* @public
|
|
858
|
+
* <p>The details of a SIP rule, including name, triggers, and target applications.
|
|
859
|
+
* An AWS account can have multiple SIP rules.</p>
|
|
503
860
|
*/
|
|
504
861
|
export interface SipRule {
|
|
862
|
+
/**
|
|
863
|
+
* <p>A SIP rule's ID.</p>
|
|
864
|
+
*/
|
|
505
865
|
SipRuleId?: string;
|
|
866
|
+
/**
|
|
867
|
+
* <p>A SIP rule's name.</p>
|
|
868
|
+
*/
|
|
506
869
|
Name?: string;
|
|
870
|
+
/**
|
|
871
|
+
* <p>Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.</p>
|
|
872
|
+
*/
|
|
507
873
|
Disabled?: boolean;
|
|
874
|
+
/**
|
|
875
|
+
* <p>The type of trigger set for a SIP rule, either a phone number or a URI request host name.</p>
|
|
876
|
+
*/
|
|
508
877
|
TriggerType?: SipRuleTriggerType | string;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.</p>
|
|
880
|
+
*/
|
|
509
881
|
TriggerValue?: string;
|
|
882
|
+
/**
|
|
883
|
+
* <p>The target SIP media application and other details, such as priority and AWS Region,
|
|
884
|
+
* to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.</p>
|
|
885
|
+
*/
|
|
510
886
|
TargetApplications?: SipRuleTargetApplication[];
|
|
887
|
+
/**
|
|
888
|
+
* <p>The time at which the SIP rule was created, in ISO 8601 format.</p>
|
|
889
|
+
*/
|
|
511
890
|
CreatedTimestamp?: Date;
|
|
891
|
+
/**
|
|
892
|
+
* <p>The time at which the SIP rule was updated, in ISO 8601 format.</p>
|
|
893
|
+
*/
|
|
512
894
|
UpdatedTimestamp?: Date;
|
|
513
895
|
}
|
|
514
896
|
/**
|
|
515
897
|
* @public
|
|
516
898
|
*/
|
|
517
899
|
export interface CreateSipRuleResponse {
|
|
900
|
+
/**
|
|
901
|
+
* <p>The SIP rule information, including the rule ID, triggers, and target applications.</p>
|
|
902
|
+
*/
|
|
518
903
|
SipRule?: SipRule;
|
|
519
904
|
}
|
|
520
905
|
/**
|
|
@@ -536,85 +921,194 @@ export declare enum VoiceConnectorAwsRegion {
|
|
|
536
921
|
* @public
|
|
537
922
|
*/
|
|
538
923
|
export interface CreateVoiceConnectorRequest {
|
|
924
|
+
/**
|
|
925
|
+
* <p>The name of the Voice Connector.</p>
|
|
926
|
+
*/
|
|
539
927
|
Name: string | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* <p>The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value:
|
|
930
|
+
* <code>us-east-1</code> .</p>
|
|
931
|
+
*/
|
|
540
932
|
AwsRegion?: VoiceConnectorAwsRegion | string;
|
|
933
|
+
/**
|
|
934
|
+
* <p>Enables or disables encryption for the Voice Connector.</p>
|
|
935
|
+
*/
|
|
541
936
|
RequireEncryption: boolean | undefined;
|
|
542
937
|
}
|
|
543
938
|
/**
|
|
544
939
|
* @public
|
|
940
|
+
* <p>The Amazon Chime SDK Voice Connector configuration, including outbound
|
|
941
|
+
* host name and encryption settings.</p>
|
|
545
942
|
*/
|
|
546
943
|
export interface VoiceConnector {
|
|
944
|
+
/**
|
|
945
|
+
* <p>The Voice Connector's ID.</p>
|
|
946
|
+
*/
|
|
547
947
|
VoiceConnectorId?: string;
|
|
948
|
+
/**
|
|
949
|
+
* <p>The AWS Region in which the Voice Connector is created.
|
|
950
|
+
* Default: us-east-1.</p>
|
|
951
|
+
*/
|
|
548
952
|
AwsRegion?: VoiceConnectorAwsRegion | string;
|
|
953
|
+
/**
|
|
954
|
+
* <p>The Voice Connector's name.</p>
|
|
955
|
+
*/
|
|
549
956
|
Name?: string;
|
|
957
|
+
/**
|
|
958
|
+
* <p>The outbound host name for the Voice Connector.</p>
|
|
959
|
+
*/
|
|
550
960
|
OutboundHostName?: string;
|
|
961
|
+
/**
|
|
962
|
+
* <p>Enables or disables encryption for the Voice Connector.</p>
|
|
963
|
+
*/
|
|
551
964
|
RequireEncryption?: boolean;
|
|
965
|
+
/**
|
|
966
|
+
* <p>The Voice Connector's creation timestamp, in ISO 8601 format.</p>
|
|
967
|
+
*/
|
|
552
968
|
CreatedTimestamp?: Date;
|
|
969
|
+
/**
|
|
970
|
+
* <p>The Voice Connector's updated timestamp, in ISO 8601 format.</p>
|
|
971
|
+
*/
|
|
553
972
|
UpdatedTimestamp?: Date;
|
|
973
|
+
/**
|
|
974
|
+
* <p>The ARN of the Voice Connector.</p>
|
|
975
|
+
*/
|
|
554
976
|
VoiceConnectorArn?: string;
|
|
555
977
|
}
|
|
556
978
|
/**
|
|
557
979
|
* @public
|
|
558
980
|
*/
|
|
559
981
|
export interface CreateVoiceConnectorResponse {
|
|
982
|
+
/**
|
|
983
|
+
* <p>The details of the Voice Connector.</p>
|
|
984
|
+
*/
|
|
560
985
|
VoiceConnector?: VoiceConnector;
|
|
561
986
|
}
|
|
562
987
|
/**
|
|
563
988
|
* @public
|
|
989
|
+
* <p>For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK Voice
|
|
990
|
+
* Connectors to which you route inbound calls. Includes priority configuration
|
|
991
|
+
* settings. Limit: 3 VoiceConnectorItems per Voice Connector group.</p>
|
|
564
992
|
*/
|
|
565
993
|
export interface VoiceConnectorItem {
|
|
994
|
+
/**
|
|
995
|
+
* <p>The Voice Connector ID.</p>
|
|
996
|
+
*/
|
|
566
997
|
VoiceConnectorId: string | undefined;
|
|
998
|
+
/**
|
|
999
|
+
* <p>The priority setting of a Voice Connector item. Calls are routed to hosts
|
|
1000
|
+
* in priority order, with 1 as the highest priority. When hosts have equal priority,
|
|
1001
|
+
* the system distributes calls among them based on their relative weight.</p>
|
|
1002
|
+
*/
|
|
567
1003
|
Priority: number | undefined;
|
|
568
1004
|
}
|
|
569
1005
|
/**
|
|
570
1006
|
* @public
|
|
571
1007
|
*/
|
|
572
1008
|
export interface CreateVoiceConnectorGroupRequest {
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The name of the Voice Connector group.</p>
|
|
1011
|
+
*/
|
|
573
1012
|
Name: string | undefined;
|
|
1013
|
+
/**
|
|
1014
|
+
* <p>Lists the Voice Connectors that inbound calls are routed to.</p>
|
|
1015
|
+
*/
|
|
574
1016
|
VoiceConnectorItems?: VoiceConnectorItem[];
|
|
575
1017
|
}
|
|
576
1018
|
/**
|
|
577
1019
|
* @public
|
|
1020
|
+
* <p>The Amazon Chime SDK Voice Connector group configuration, including
|
|
1021
|
+
* associated Voice Connectors. You can include Voice Connectors from different
|
|
1022
|
+
* AWS Regions in a group. This creates a fault tolerant mechanism for
|
|
1023
|
+
* fallback in case of availability events.</p>
|
|
578
1024
|
*/
|
|
579
1025
|
export interface VoiceConnectorGroup {
|
|
1026
|
+
/**
|
|
1027
|
+
* <p>The ID of a Voice Connector group.</p>
|
|
1028
|
+
*/
|
|
580
1029
|
VoiceConnectorGroupId?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* <p>The name of a Voice Connector group.</p>
|
|
1032
|
+
*/
|
|
581
1033
|
Name?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>The Voice Connectors to which you route inbound calls.</p>
|
|
1036
|
+
*/
|
|
582
1037
|
VoiceConnectorItems?: VoiceConnectorItem[];
|
|
1038
|
+
/**
|
|
1039
|
+
* <p>The Voice Connector group's creation time stamp, in ISO 8601 format.</p>
|
|
1040
|
+
*/
|
|
583
1041
|
CreatedTimestamp?: Date;
|
|
1042
|
+
/**
|
|
1043
|
+
* <p>The Voice Connector group's creation time stamp, in ISO 8601 format.</p>
|
|
1044
|
+
*/
|
|
584
1045
|
UpdatedTimestamp?: Date;
|
|
1046
|
+
/**
|
|
1047
|
+
* <p>The ARN of the Voice Connector group.</p>
|
|
1048
|
+
*/
|
|
585
1049
|
VoiceConnectorGroupArn?: string;
|
|
586
1050
|
}
|
|
587
1051
|
/**
|
|
588
1052
|
* @public
|
|
589
1053
|
*/
|
|
590
1054
|
export interface CreateVoiceConnectorGroupResponse {
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>The details of the Voice Connector group.</p>
|
|
1057
|
+
*/
|
|
591
1058
|
VoiceConnectorGroup?: VoiceConnectorGroup;
|
|
592
1059
|
}
|
|
593
1060
|
/**
|
|
594
1061
|
* @public
|
|
595
1062
|
*/
|
|
596
1063
|
export interface CreateVoiceProfileRequest {
|
|
1064
|
+
/**
|
|
1065
|
+
* <p>The ID of the speaker search task.</p>
|
|
1066
|
+
*/
|
|
597
1067
|
SpeakerSearchTaskId: string | undefined;
|
|
598
1068
|
}
|
|
599
1069
|
/**
|
|
600
1070
|
* @public
|
|
1071
|
+
* <p>The combination of a voice print and caller ID.</p>
|
|
601
1072
|
*/
|
|
602
1073
|
export interface VoiceProfile {
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>The ID of the voice profile.</p>
|
|
1076
|
+
*/
|
|
603
1077
|
VoiceProfileId?: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>The ARN of the voice profile.</p>
|
|
1080
|
+
*/
|
|
604
1081
|
VoiceProfileArn?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* <p>The ID of the domain that contains the voice profile.</p>
|
|
1084
|
+
*/
|
|
605
1085
|
VoiceProfileDomainId?: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* <p>The time at which the voice profile was created and enrolled.</p>
|
|
1088
|
+
*/
|
|
606
1089
|
CreatedTimestamp?: Date;
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>The time at which the voice profile was last updated.</p>
|
|
1092
|
+
*/
|
|
607
1093
|
UpdatedTimestamp?: Date;
|
|
1094
|
+
/**
|
|
1095
|
+
* <p>The time at which a voice profile expires unless you re-enroll the caller via the
|
|
1096
|
+
* <code>UpdateVoiceProfile</code> API.</p>
|
|
1097
|
+
*/
|
|
608
1098
|
ExpirationTimestamp?: Date;
|
|
609
1099
|
}
|
|
610
1100
|
/**
|
|
611
1101
|
* @public
|
|
612
1102
|
*/
|
|
613
1103
|
export interface CreateVoiceProfileResponse {
|
|
1104
|
+
/**
|
|
1105
|
+
* <p>The requested voice profile.</p>
|
|
1106
|
+
*/
|
|
614
1107
|
VoiceProfile?: VoiceProfile;
|
|
615
1108
|
}
|
|
616
1109
|
/**
|
|
617
1110
|
* @public
|
|
1111
|
+
* <p>Access to the target resource is no longer available at the origin server. This condition is likely to be permanent.</p>
|
|
618
1112
|
*/
|
|
619
1113
|
export declare class GoneException extends __BaseException {
|
|
620
1114
|
readonly name: "GoneException";
|
|
@@ -628,173 +1122,308 @@ export declare class GoneException extends __BaseException {
|
|
|
628
1122
|
}
|
|
629
1123
|
/**
|
|
630
1124
|
* @public
|
|
1125
|
+
* <p>A structure that contains the configuration settings for server-side encryption.</p>
|
|
1126
|
+
* <note>
|
|
1127
|
+
* <p>We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.</p>
|
|
1128
|
+
* </note>
|
|
631
1129
|
*/
|
|
632
1130
|
export interface ServerSideEncryptionConfiguration {
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain.
|
|
1133
|
+
* Asymmetric customer managed keys are not supported.</p>
|
|
1134
|
+
*/
|
|
633
1135
|
KmsKeyArn: string | undefined;
|
|
634
1136
|
}
|
|
635
1137
|
/**
|
|
636
1138
|
* @public
|
|
1139
|
+
* <p>Describes a tag applied to a resource.</p>
|
|
637
1140
|
*/
|
|
638
1141
|
export interface Tag {
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The tag's key.</p>
|
|
1144
|
+
*/
|
|
639
1145
|
Key: string | undefined;
|
|
1146
|
+
/**
|
|
1147
|
+
* <p>The tag's value.</p>
|
|
1148
|
+
*/
|
|
640
1149
|
Value: string | undefined;
|
|
641
1150
|
}
|
|
642
1151
|
/**
|
|
643
1152
|
* @public
|
|
644
1153
|
*/
|
|
645
1154
|
export interface CreateVoiceProfileDomainRequest {
|
|
1155
|
+
/**
|
|
1156
|
+
* <p>The name of the voice profile domain.</p>
|
|
1157
|
+
*/
|
|
646
1158
|
Name: string | undefined;
|
|
1159
|
+
/**
|
|
1160
|
+
* <p>A description of the voice profile domain.</p>
|
|
1161
|
+
*/
|
|
647
1162
|
Description?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The server-side encryption configuration for the request.</p>
|
|
1165
|
+
*/
|
|
648
1166
|
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The unique identifier for the client request. Use a different token for different domain creation requests.</p>
|
|
1169
|
+
*/
|
|
649
1170
|
ClientRequestToken?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* <p>The tags assigned to the domain.</p>
|
|
1173
|
+
*/
|
|
650
1174
|
Tags?: Tag[];
|
|
651
1175
|
}
|
|
652
1176
|
/**
|
|
653
1177
|
* @public
|
|
1178
|
+
* <p>A collection of voice profiles.</p>
|
|
654
1179
|
*/
|
|
655
1180
|
export interface VoiceProfileDomain {
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The ID of the voice profile domain.</p>
|
|
1183
|
+
*/
|
|
656
1184
|
VoiceProfileDomainId?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>The voice profile domain's Amazon Resource Number (ARN).</p>
|
|
1187
|
+
*/
|
|
657
1188
|
VoiceProfileDomainArn?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* <p>The name of the voice profile domain.</p>
|
|
1191
|
+
*/
|
|
658
1192
|
Name?: string;
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>The description of the voice profile domain.</p>
|
|
1195
|
+
*/
|
|
659
1196
|
Description?: string;
|
|
1197
|
+
/**
|
|
1198
|
+
* <p>A structure that contains the configuration settings for server-side encryption.</p>
|
|
1199
|
+
*/
|
|
660
1200
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>The time at which the voice profile domain was created.</p>
|
|
1203
|
+
*/
|
|
661
1204
|
CreatedTimestamp?: Date;
|
|
1205
|
+
/**
|
|
1206
|
+
* <p>The time at which the voice profile was last updated.</p>
|
|
1207
|
+
*/
|
|
662
1208
|
UpdatedTimestamp?: Date;
|
|
663
1209
|
}
|
|
664
1210
|
/**
|
|
665
1211
|
* @public
|
|
666
1212
|
*/
|
|
667
1213
|
export interface CreateVoiceProfileDomainResponse {
|
|
1214
|
+
/**
|
|
1215
|
+
* <p>The requested voice profile domain.</p>
|
|
1216
|
+
*/
|
|
668
1217
|
VoiceProfileDomain?: VoiceProfileDomain;
|
|
669
1218
|
}
|
|
670
1219
|
/**
|
|
671
1220
|
* @public
|
|
672
1221
|
*/
|
|
673
1222
|
export interface DeletePhoneNumberRequest {
|
|
1223
|
+
/**
|
|
1224
|
+
* <p>The phone number ID.</p>
|
|
1225
|
+
*/
|
|
674
1226
|
PhoneNumberId: string | undefined;
|
|
675
1227
|
}
|
|
676
1228
|
/**
|
|
677
1229
|
* @public
|
|
678
1230
|
*/
|
|
679
1231
|
export interface DeleteProxySessionRequest {
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The Voice Connector ID.</p>
|
|
1234
|
+
*/
|
|
680
1235
|
VoiceConnectorId: string | undefined;
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The proxy session ID.</p>
|
|
1238
|
+
*/
|
|
681
1239
|
ProxySessionId: string | undefined;
|
|
682
1240
|
}
|
|
683
1241
|
/**
|
|
684
1242
|
* @public
|
|
685
1243
|
*/
|
|
686
1244
|
export interface DeleteSipMediaApplicationRequest {
|
|
1245
|
+
/**
|
|
1246
|
+
* <p>The SIP media application ID.</p>
|
|
1247
|
+
*/
|
|
687
1248
|
SipMediaApplicationId: string | undefined;
|
|
688
1249
|
}
|
|
689
1250
|
/**
|
|
690
1251
|
* @public
|
|
691
1252
|
*/
|
|
692
1253
|
export interface DeleteSipRuleRequest {
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>The SIP rule ID.</p>
|
|
1256
|
+
*/
|
|
693
1257
|
SipRuleId: string | undefined;
|
|
694
1258
|
}
|
|
695
1259
|
/**
|
|
696
1260
|
* @public
|
|
697
1261
|
*/
|
|
698
1262
|
export interface DeleteVoiceConnectorRequest {
|
|
1263
|
+
/**
|
|
1264
|
+
* <p>The Voice Connector ID.</p>
|
|
1265
|
+
*/
|
|
699
1266
|
VoiceConnectorId: string | undefined;
|
|
700
1267
|
}
|
|
701
1268
|
/**
|
|
702
1269
|
* @public
|
|
703
1270
|
*/
|
|
704
1271
|
export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
1272
|
+
/**
|
|
1273
|
+
* <p>The Voice Connector ID.</p>
|
|
1274
|
+
*/
|
|
705
1275
|
VoiceConnectorId: string | undefined;
|
|
706
1276
|
}
|
|
707
1277
|
/**
|
|
708
1278
|
* @public
|
|
709
1279
|
*/
|
|
710
1280
|
export interface DeleteVoiceConnectorGroupRequest {
|
|
1281
|
+
/**
|
|
1282
|
+
* <p>The Voice Connector Group ID.</p>
|
|
1283
|
+
*/
|
|
711
1284
|
VoiceConnectorGroupId: string | undefined;
|
|
712
1285
|
}
|
|
713
1286
|
/**
|
|
714
1287
|
* @public
|
|
715
1288
|
*/
|
|
716
1289
|
export interface DeleteVoiceConnectorOriginationRequest {
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The Voice Connector ID.</p>
|
|
1292
|
+
*/
|
|
717
1293
|
VoiceConnectorId: string | undefined;
|
|
718
1294
|
}
|
|
719
1295
|
/**
|
|
720
1296
|
* @public
|
|
721
1297
|
*/
|
|
722
1298
|
export interface DeleteVoiceConnectorProxyRequest {
|
|
1299
|
+
/**
|
|
1300
|
+
* <p>The Voice Connector ID.</p>
|
|
1301
|
+
*/
|
|
723
1302
|
VoiceConnectorId: string | undefined;
|
|
724
1303
|
}
|
|
725
1304
|
/**
|
|
726
1305
|
* @public
|
|
727
1306
|
*/
|
|
728
1307
|
export interface DeleteVoiceConnectorStreamingConfigurationRequest {
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>The Voice Connector ID.</p>
|
|
1310
|
+
*/
|
|
729
1311
|
VoiceConnectorId: string | undefined;
|
|
730
1312
|
}
|
|
731
1313
|
/**
|
|
732
1314
|
* @public
|
|
733
1315
|
*/
|
|
734
1316
|
export interface DeleteVoiceConnectorTerminationRequest {
|
|
1317
|
+
/**
|
|
1318
|
+
* <p>The Voice Connector ID.</p>
|
|
1319
|
+
*/
|
|
735
1320
|
VoiceConnectorId: string | undefined;
|
|
736
1321
|
}
|
|
737
1322
|
/**
|
|
738
1323
|
* @public
|
|
739
1324
|
*/
|
|
740
1325
|
export interface DeleteVoiceConnectorTerminationCredentialsRequest {
|
|
1326
|
+
/**
|
|
1327
|
+
* <p>The Voice Connector ID.</p>
|
|
1328
|
+
*/
|
|
741
1329
|
VoiceConnectorId: string | undefined;
|
|
1330
|
+
/**
|
|
1331
|
+
* <p>The RFC2617 compliant username associated with the SIP credentials,
|
|
1332
|
+
* in US-ASCII format.</p>
|
|
1333
|
+
*/
|
|
742
1334
|
Usernames: string[] | undefined;
|
|
743
1335
|
}
|
|
744
1336
|
/**
|
|
745
1337
|
* @public
|
|
746
1338
|
*/
|
|
747
1339
|
export interface DeleteVoiceProfileRequest {
|
|
1340
|
+
/**
|
|
1341
|
+
* <p>The voice profile ID.</p>
|
|
1342
|
+
*/
|
|
748
1343
|
VoiceProfileId: string | undefined;
|
|
749
1344
|
}
|
|
750
1345
|
/**
|
|
751
1346
|
* @public
|
|
752
1347
|
*/
|
|
753
1348
|
export interface DeleteVoiceProfileDomainRequest {
|
|
1349
|
+
/**
|
|
1350
|
+
* <p>The voice profile domain ID.</p>
|
|
1351
|
+
*/
|
|
754
1352
|
VoiceProfileDomainId: string | undefined;
|
|
755
1353
|
}
|
|
756
1354
|
/**
|
|
757
1355
|
* @public
|
|
758
1356
|
*/
|
|
759
1357
|
export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The Voice Connector ID.</p>
|
|
1360
|
+
*/
|
|
760
1361
|
VoiceConnectorId: string | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>List of phone numbers, in E.164 format.</p>
|
|
1364
|
+
*/
|
|
761
1365
|
E164PhoneNumbers: string[] | undefined;
|
|
762
1366
|
}
|
|
763
1367
|
/**
|
|
764
1368
|
* @public
|
|
765
1369
|
*/
|
|
766
1370
|
export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>If the action fails for one or more of the phone numbers in the request, a
|
|
1373
|
+
* list of the phone numbers is returned, along with error codes and error messages.</p>
|
|
1374
|
+
*/
|
|
767
1375
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
768
1376
|
}
|
|
769
1377
|
/**
|
|
770
1378
|
* @public
|
|
771
1379
|
*/
|
|
772
1380
|
export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The Voice Connector group ID.</p>
|
|
1383
|
+
*/
|
|
773
1384
|
VoiceConnectorGroupId: string | undefined;
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>The list of phone numbers, in E.164 format.</p>
|
|
1387
|
+
*/
|
|
774
1388
|
E164PhoneNumbers: string[] | undefined;
|
|
775
1389
|
}
|
|
776
1390
|
/**
|
|
777
1391
|
* @public
|
|
778
1392
|
*/
|
|
779
1393
|
export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
|
|
1394
|
+
/**
|
|
1395
|
+
* <p>If the action fails for one or more of the phone numbers in the request,
|
|
1396
|
+
* a list of the phone numbers is returned, along with error codes and error messages.</p>
|
|
1397
|
+
*/
|
|
780
1398
|
PhoneNumberErrors?: PhoneNumberError[];
|
|
781
1399
|
}
|
|
782
1400
|
/**
|
|
783
1401
|
* @public
|
|
1402
|
+
* <p>The Amazon Chime SDK Voice Connector settings. Includes any Amazon
|
|
1403
|
+
* S3 buckets designated for storing call detail records.</p>
|
|
784
1404
|
*/
|
|
785
1405
|
export interface VoiceConnectorSettings {
|
|
1406
|
+
/**
|
|
1407
|
+
* <p>The S3 bucket that stores the Voice Connector's call detail records.</p>
|
|
1408
|
+
*/
|
|
786
1409
|
CdrBucket?: string;
|
|
787
1410
|
}
|
|
788
1411
|
/**
|
|
789
1412
|
* @public
|
|
790
1413
|
*/
|
|
791
1414
|
export interface GetGlobalSettingsResponse {
|
|
1415
|
+
/**
|
|
1416
|
+
* <p>The Voice Connector settings.</p>
|
|
1417
|
+
*/
|
|
792
1418
|
VoiceConnector?: VoiceConnectorSettings;
|
|
793
1419
|
}
|
|
794
1420
|
/**
|
|
795
1421
|
* @public
|
|
796
1422
|
*/
|
|
797
1423
|
export interface GetPhoneNumberRequest {
|
|
1424
|
+
/**
|
|
1425
|
+
* <p>The phone number ID.</p>
|
|
1426
|
+
*/
|
|
798
1427
|
PhoneNumberId: string | undefined;
|
|
799
1428
|
}
|
|
800
1429
|
/**
|
|
@@ -807,21 +1436,52 @@ export declare enum PhoneNumberAssociationName {
|
|
|
807
1436
|
}
|
|
808
1437
|
/**
|
|
809
1438
|
* @public
|
|
1439
|
+
* <p>The phone number associations, such as an Amazon Chime SDK account ID, user ID,
|
|
1440
|
+
* Voice Connector ID, or Voice Connector group ID.</p>
|
|
810
1441
|
*/
|
|
811
1442
|
export interface PhoneNumberAssociation {
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>Contains the ID for the entity specified in Name.</p>
|
|
1445
|
+
*/
|
|
812
1446
|
Value?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.</p>
|
|
1449
|
+
*/
|
|
813
1450
|
Name?: PhoneNumberAssociationName | string;
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>The timestamp of the phone number association, in ISO 8601 format.</p>
|
|
1453
|
+
*/
|
|
814
1454
|
AssociatedTimestamp?: Date;
|
|
815
1455
|
}
|
|
816
1456
|
/**
|
|
817
1457
|
* @public
|
|
1458
|
+
* <p>The phone number capabilities for Amazon Chime SDK phone numbers,
|
|
1459
|
+
* such as enabled inbound and outbound calling, and text messaging.</p>
|
|
818
1460
|
*/
|
|
819
1461
|
export interface PhoneNumberCapabilities {
|
|
1462
|
+
/**
|
|
1463
|
+
* <p>Allows or denies inbound calling for the specified phone number.</p>
|
|
1464
|
+
*/
|
|
820
1465
|
InboundCall?: boolean;
|
|
1466
|
+
/**
|
|
1467
|
+
* <p>Allows or denies outbound calling for the specified phone number.</p>
|
|
1468
|
+
*/
|
|
821
1469
|
OutboundCall?: boolean;
|
|
1470
|
+
/**
|
|
1471
|
+
* <p>Allows or denies inbound SMS messaging for the specified phone number.</p>
|
|
1472
|
+
*/
|
|
822
1473
|
InboundSMS?: boolean;
|
|
1474
|
+
/**
|
|
1475
|
+
* <p>Allows or denies outbound SMS messaging for the specified phone number.</p>
|
|
1476
|
+
*/
|
|
823
1477
|
OutboundSMS?: boolean;
|
|
1478
|
+
/**
|
|
1479
|
+
* <p>Allows or denies inbound MMS messaging for the specified phone number.</p>
|
|
1480
|
+
*/
|
|
824
1481
|
InboundMMS?: boolean;
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>Allows or denies inbound MMS messaging for the specified phone number.</p>
|
|
1484
|
+
*/
|
|
825
1485
|
OutboundMMS?: boolean;
|
|
826
1486
|
}
|
|
827
1487
|
/**
|
|
@@ -849,235 +1509,441 @@ export declare enum PhoneNumberType {
|
|
|
849
1509
|
}
|
|
850
1510
|
/**
|
|
851
1511
|
* @public
|
|
1512
|
+
* <p>A phone number used to call an Amazon
|
|
1513
|
+
* Chime SDK Voice Connector.</p>
|
|
852
1514
|
*/
|
|
853
1515
|
export interface PhoneNumber {
|
|
1516
|
+
/**
|
|
1517
|
+
* <p>The phone number's ID.</p>
|
|
1518
|
+
*/
|
|
854
1519
|
PhoneNumberId?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* <p>The phone number, in E.164 format.</p>
|
|
1522
|
+
*/
|
|
855
1523
|
E164PhoneNumber?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* <p>The phone number's country. Format: ISO 3166-1 alpha-2.</p>
|
|
1526
|
+
*/
|
|
856
1527
|
Country?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* <p>The phone number's type.</p>
|
|
1530
|
+
*/
|
|
857
1531
|
Type?: PhoneNumberType | string;
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>The phone number's product type.</p>
|
|
1534
|
+
*/
|
|
858
1535
|
ProductType?: PhoneNumberProductType | string;
|
|
1536
|
+
/**
|
|
1537
|
+
* <p>The phone number's status.</p>
|
|
1538
|
+
*/
|
|
859
1539
|
Status?: PhoneNumberStatus | string;
|
|
1540
|
+
/**
|
|
1541
|
+
* <p>The phone number's capabilities.</p>
|
|
1542
|
+
*/
|
|
860
1543
|
Capabilities?: PhoneNumberCapabilities;
|
|
1544
|
+
/**
|
|
1545
|
+
* <p>The phone number's associations.</p>
|
|
1546
|
+
*/
|
|
861
1547
|
Associations?: PhoneNumberAssociation[];
|
|
1548
|
+
/**
|
|
1549
|
+
* <p>The outbound calling name associated with the phone number.</p>
|
|
1550
|
+
*/
|
|
862
1551
|
CallingName?: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* <p>The outbound calling name status.</p>
|
|
1554
|
+
*/
|
|
863
1555
|
CallingNameStatus?: CallingNameStatus | string;
|
|
1556
|
+
/**
|
|
1557
|
+
* <p>The phone number creation timestamp, in ISO 8601 format.</p>
|
|
1558
|
+
*/
|
|
864
1559
|
CreatedTimestamp?: Date;
|
|
1560
|
+
/**
|
|
1561
|
+
* <p>The updated phone number timestamp, in ISO 8601 format.</p>
|
|
1562
|
+
*/
|
|
865
1563
|
UpdatedTimestamp?: Date;
|
|
1564
|
+
/**
|
|
1565
|
+
* <p>The deleted phone number timestamp, in ISO 8601 format.</p>
|
|
1566
|
+
*/
|
|
866
1567
|
DeletionTimestamp?: Date;
|
|
1568
|
+
/**
|
|
1569
|
+
* <p>The phone number's order ID.</p>
|
|
1570
|
+
*/
|
|
867
1571
|
OrderId?: string;
|
|
868
1572
|
}
|
|
869
1573
|
/**
|
|
870
1574
|
* @public
|
|
871
1575
|
*/
|
|
872
1576
|
export interface GetPhoneNumberResponse {
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The phone number details.</p>
|
|
1579
|
+
*/
|
|
873
1580
|
PhoneNumber?: PhoneNumber;
|
|
874
1581
|
}
|
|
875
1582
|
/**
|
|
876
1583
|
* @public
|
|
877
1584
|
*/
|
|
878
1585
|
export interface GetPhoneNumberOrderRequest {
|
|
1586
|
+
/**
|
|
1587
|
+
* <p>The ID of the phone number order .</p>
|
|
1588
|
+
*/
|
|
879
1589
|
PhoneNumberOrderId: string | undefined;
|
|
880
1590
|
}
|
|
881
1591
|
/**
|
|
882
1592
|
* @public
|
|
883
1593
|
*/
|
|
884
1594
|
export interface GetPhoneNumberOrderResponse {
|
|
1595
|
+
/**
|
|
1596
|
+
* <p>The phone number order details.</p>
|
|
1597
|
+
*/
|
|
885
1598
|
PhoneNumberOrder?: PhoneNumberOrder;
|
|
886
1599
|
}
|
|
887
1600
|
/**
|
|
888
1601
|
* @public
|
|
889
1602
|
*/
|
|
890
1603
|
export interface GetPhoneNumberSettingsResponse {
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The default outbound calling name for the account.</p>
|
|
1606
|
+
*/
|
|
891
1607
|
CallingName?: string;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>The updated outbound calling name timestamp, in ISO 8601 format.</p>
|
|
1610
|
+
*/
|
|
892
1611
|
CallingNameUpdatedTimestamp?: Date;
|
|
893
1612
|
}
|
|
894
1613
|
/**
|
|
895
1614
|
* @public
|
|
896
1615
|
*/
|
|
897
1616
|
export interface GetProxySessionRequest {
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>The Voice Connector ID.</p>
|
|
1619
|
+
*/
|
|
898
1620
|
VoiceConnectorId: string | undefined;
|
|
1621
|
+
/**
|
|
1622
|
+
* <p>The proxy session ID.</p>
|
|
1623
|
+
*/
|
|
899
1624
|
ProxySessionId: string | undefined;
|
|
900
1625
|
}
|
|
901
1626
|
/**
|
|
902
1627
|
* @public
|
|
903
1628
|
*/
|
|
904
1629
|
export interface GetProxySessionResponse {
|
|
1630
|
+
/**
|
|
1631
|
+
* <p>The proxy session details.</p>
|
|
1632
|
+
*/
|
|
905
1633
|
ProxySession?: ProxySession;
|
|
906
1634
|
}
|
|
907
1635
|
/**
|
|
908
1636
|
* @public
|
|
909
1637
|
*/
|
|
910
1638
|
export interface GetSipMediaApplicationRequest {
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The SIP media application ID .</p>
|
|
1641
|
+
*/
|
|
911
1642
|
SipMediaApplicationId: string | undefined;
|
|
912
1643
|
}
|
|
913
1644
|
/**
|
|
914
1645
|
* @public
|
|
915
1646
|
*/
|
|
916
1647
|
export interface GetSipMediaApplicationResponse {
|
|
1648
|
+
/**
|
|
1649
|
+
* <p>The details of the SIP media application.</p>
|
|
1650
|
+
*/
|
|
917
1651
|
SipMediaApplication?: SipMediaApplication;
|
|
918
1652
|
}
|
|
919
1653
|
/**
|
|
920
1654
|
* @public
|
|
921
1655
|
*/
|
|
922
1656
|
export interface GetSipMediaApplicationAlexaSkillConfigurationRequest {
|
|
1657
|
+
/**
|
|
1658
|
+
* <p>The SIP media application ID.</p>
|
|
1659
|
+
*/
|
|
923
1660
|
SipMediaApplicationId: string | undefined;
|
|
924
1661
|
}
|
|
925
1662
|
/**
|
|
926
1663
|
* @public
|
|
1664
|
+
* <p>The Alexa Skill configuration of a SIP media application.</p>
|
|
927
1665
|
*/
|
|
928
1666
|
export interface SipMediaApplicationAlexaSkillConfiguration {
|
|
1667
|
+
/**
|
|
1668
|
+
* <p>The status of the Alexa Skill configuration.</p>
|
|
1669
|
+
*/
|
|
929
1670
|
AlexaSkillStatus: AlexaSkillStatus | string | undefined;
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>The ID of the Alexa Skill configuration.</p>
|
|
1673
|
+
*/
|
|
930
1674
|
AlexaSkillIds: string[] | undefined;
|
|
931
1675
|
}
|
|
932
1676
|
/**
|
|
933
1677
|
* @public
|
|
934
1678
|
*/
|
|
935
1679
|
export interface GetSipMediaApplicationAlexaSkillConfigurationResponse {
|
|
1680
|
+
/**
|
|
1681
|
+
* <p>Returns the Alexa Skill configuration.</p>
|
|
1682
|
+
*/
|
|
936
1683
|
SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
|
|
937
1684
|
}
|
|
938
1685
|
/**
|
|
939
1686
|
* @public
|
|
940
1687
|
*/
|
|
941
1688
|
export interface GetSipMediaApplicationLoggingConfigurationRequest {
|
|
1689
|
+
/**
|
|
1690
|
+
* <p>The SIP media application ID.</p>
|
|
1691
|
+
*/
|
|
942
1692
|
SipMediaApplicationId: string | undefined;
|
|
943
1693
|
}
|
|
944
1694
|
/**
|
|
945
1695
|
* @public
|
|
1696
|
+
* <p>The logging configuration of a SIP media application.</p>
|
|
946
1697
|
*/
|
|
947
1698
|
export interface SipMediaApplicationLoggingConfiguration {
|
|
1699
|
+
/**
|
|
1700
|
+
* <p>Enables message logging for the specified SIP media application.</p>
|
|
1701
|
+
*/
|
|
948
1702
|
EnableSipMediaApplicationMessageLogs?: boolean;
|
|
949
1703
|
}
|
|
950
1704
|
/**
|
|
951
1705
|
* @public
|
|
952
1706
|
*/
|
|
953
1707
|
export interface GetSipMediaApplicationLoggingConfigurationResponse {
|
|
1708
|
+
/**
|
|
1709
|
+
* <p>The actual logging configuration.</p>
|
|
1710
|
+
*/
|
|
954
1711
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
955
1712
|
}
|
|
956
1713
|
/**
|
|
957
1714
|
* @public
|
|
958
1715
|
*/
|
|
959
1716
|
export interface GetSipRuleRequest {
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>The SIP rule ID.</p>
|
|
1719
|
+
*/
|
|
960
1720
|
SipRuleId: string | undefined;
|
|
961
1721
|
}
|
|
962
1722
|
/**
|
|
963
1723
|
* @public
|
|
964
1724
|
*/
|
|
965
1725
|
export interface GetSipRuleResponse {
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The SIP rule details.</p>
|
|
1728
|
+
*/
|
|
966
1729
|
SipRule?: SipRule;
|
|
967
1730
|
}
|
|
968
1731
|
/**
|
|
969
1732
|
* @public
|
|
970
1733
|
*/
|
|
971
1734
|
export interface GetSpeakerSearchTaskRequest {
|
|
1735
|
+
/**
|
|
1736
|
+
* <p>The Voice Connector ID.</p>
|
|
1737
|
+
*/
|
|
972
1738
|
VoiceConnectorId: string | undefined;
|
|
1739
|
+
/**
|
|
1740
|
+
* <p>The ID of the speaker search task.</p>
|
|
1741
|
+
*/
|
|
973
1742
|
SpeakerSearchTaskId: string | undefined;
|
|
974
1743
|
}
|
|
975
1744
|
/**
|
|
976
1745
|
* @public
|
|
1746
|
+
* <p>The result of a speaker search analysis.</p>
|
|
977
1747
|
*/
|
|
978
1748
|
export interface SpeakerSearchResult {
|
|
1749
|
+
/**
|
|
1750
|
+
* <p>The confidence score in the speaker search analysis.</p>
|
|
1751
|
+
*/
|
|
979
1752
|
ConfidenceScore?: number;
|
|
1753
|
+
/**
|
|
1754
|
+
* <p>The voice profile ID.</p>
|
|
1755
|
+
*/
|
|
980
1756
|
VoiceProfileId?: string;
|
|
981
1757
|
}
|
|
982
1758
|
/**
|
|
983
1759
|
* @public
|
|
1760
|
+
* <p>The details of a speaker search task.</p>
|
|
984
1761
|
*/
|
|
985
1762
|
export interface SpeakerSearchDetails {
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>The result value in the speaker search details.</p>
|
|
1765
|
+
*/
|
|
986
1766
|
Results?: SpeakerSearchResult[];
|
|
1767
|
+
/**
|
|
1768
|
+
* <p>The status of a voice print generation operation, <code>VoiceprintGenerationSuccess</code> or <code>VoiceprintGenerationFailure</code>..</p>
|
|
1769
|
+
*/
|
|
987
1770
|
VoiceprintGenerationStatus?: string;
|
|
988
1771
|
}
|
|
989
1772
|
/**
|
|
990
1773
|
* @public
|
|
1774
|
+
* <p>A representation of an asynchronous request to perform speaker search analysis on a
|
|
1775
|
+
* Voice Connector call.</p>
|
|
991
1776
|
*/
|
|
992
1777
|
export interface SpeakerSearchTask {
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>The speaker search task ID.</p>
|
|
1780
|
+
*/
|
|
993
1781
|
SpeakerSearchTaskId?: string;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>The status of the speaker search task, <code>IN_QUEUE</code>, <code>IN_PROGRESS</code>, <code>PARTIAL_SUCCESS</code>, <code>SUCCEEDED</code>,
|
|
1784
|
+
* <code>FAILED</code>, or <code>STOPPED</code>.</p>
|
|
1785
|
+
*/
|
|
994
1786
|
SpeakerSearchTaskStatus?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>The call details of a speaker search task.</p>
|
|
1789
|
+
*/
|
|
995
1790
|
CallDetails?: CallDetails;
|
|
1791
|
+
/**
|
|
1792
|
+
* <p>The details of a speaker search task.</p>
|
|
1793
|
+
*/
|
|
996
1794
|
SpeakerSearchDetails?: SpeakerSearchDetails;
|
|
1795
|
+
/**
|
|
1796
|
+
* <p>The time at which a speaker search task was created.</p>
|
|
1797
|
+
*/
|
|
997
1798
|
CreatedTimestamp?: Date;
|
|
1799
|
+
/**
|
|
1800
|
+
* <p>The time at which a speaker search task was updated.</p>
|
|
1801
|
+
*/
|
|
998
1802
|
UpdatedTimestamp?: Date;
|
|
1803
|
+
/**
|
|
1804
|
+
* <p>The time at which the speaker search task began.</p>
|
|
1805
|
+
*/
|
|
999
1806
|
StartedTimestamp?: Date;
|
|
1807
|
+
/**
|
|
1808
|
+
* <p>A detailed message about the status of a speaker search.</p>
|
|
1809
|
+
*/
|
|
1000
1810
|
StatusMessage?: string;
|
|
1001
1811
|
}
|
|
1002
1812
|
/**
|
|
1003
1813
|
* @public
|
|
1004
1814
|
*/
|
|
1005
1815
|
export interface GetSpeakerSearchTaskResponse {
|
|
1816
|
+
/**
|
|
1817
|
+
* <p>The details of the speaker search task.</p>
|
|
1818
|
+
*/
|
|
1006
1819
|
SpeakerSearchTask?: SpeakerSearchTask;
|
|
1007
1820
|
}
|
|
1008
1821
|
/**
|
|
1009
1822
|
* @public
|
|
1010
1823
|
*/
|
|
1011
1824
|
export interface GetVoiceConnectorRequest {
|
|
1825
|
+
/**
|
|
1826
|
+
* <p>The Voice Connector ID.</p>
|
|
1827
|
+
*/
|
|
1012
1828
|
VoiceConnectorId: string | undefined;
|
|
1013
1829
|
}
|
|
1014
1830
|
/**
|
|
1015
1831
|
* @public
|
|
1016
1832
|
*/
|
|
1017
1833
|
export interface GetVoiceConnectorResponse {
|
|
1834
|
+
/**
|
|
1835
|
+
* <p>The Voice Connector details.</p>
|
|
1836
|
+
*/
|
|
1018
1837
|
VoiceConnector?: VoiceConnector;
|
|
1019
1838
|
}
|
|
1020
1839
|
/**
|
|
1021
1840
|
* @public
|
|
1022
1841
|
*/
|
|
1023
1842
|
export interface GetVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>The Voice Connector ID.</p>
|
|
1845
|
+
*/
|
|
1024
1846
|
VoiceConnectorId: string | undefined;
|
|
1025
1847
|
}
|
|
1026
1848
|
/**
|
|
1027
1849
|
* @public
|
|
1850
|
+
* <p>The Dialed Number Identification Service (DNIS) emergency calling configuration
|
|
1851
|
+
* details associated with an Amazon Chime SDK Voice Connector's emergency calling
|
|
1852
|
+
* configuration.</p>
|
|
1028
1853
|
*/
|
|
1029
1854
|
export interface DNISEmergencyCallingConfiguration {
|
|
1855
|
+
/**
|
|
1856
|
+
* <p>The DNIS phone number that you route emergency calls to, in E.164 format.</p>
|
|
1857
|
+
*/
|
|
1030
1858
|
EmergencyPhoneNumber: string | undefined;
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>The DNIS phone number for routing test emergency calls to, in E.164 format.</p>
|
|
1861
|
+
*/
|
|
1031
1862
|
TestPhoneNumber?: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* <p>The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.</p>
|
|
1865
|
+
*/
|
|
1032
1866
|
CallingCountry: string | undefined;
|
|
1033
1867
|
}
|
|
1034
1868
|
/**
|
|
1035
1869
|
* @public
|
|
1870
|
+
* <p>The emergency calling configuration details associated with an Amazon Chime SDK
|
|
1871
|
+
* Voice Connector.</p>
|
|
1036
1872
|
*/
|
|
1037
1873
|
export interface EmergencyCallingConfiguration {
|
|
1874
|
+
/**
|
|
1875
|
+
* <p>The Dialed Number Identification Service (DNIS) emergency calling configuration
|
|
1876
|
+
* details.</p>
|
|
1877
|
+
*/
|
|
1038
1878
|
DNIS?: DNISEmergencyCallingConfiguration[];
|
|
1039
1879
|
}
|
|
1040
1880
|
/**
|
|
1041
1881
|
* @public
|
|
1042
1882
|
*/
|
|
1043
1883
|
export interface GetVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
1884
|
+
/**
|
|
1885
|
+
* <p>The details of the emergency calling configuration.</p>
|
|
1886
|
+
*/
|
|
1044
1887
|
EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
|
|
1045
1888
|
}
|
|
1046
1889
|
/**
|
|
1047
1890
|
* @public
|
|
1048
1891
|
*/
|
|
1049
1892
|
export interface GetVoiceConnectorGroupRequest {
|
|
1893
|
+
/**
|
|
1894
|
+
* <p>The Voice Connector group ID.</p>
|
|
1895
|
+
*/
|
|
1050
1896
|
VoiceConnectorGroupId: string | undefined;
|
|
1051
1897
|
}
|
|
1052
1898
|
/**
|
|
1053
1899
|
* @public
|
|
1054
1900
|
*/
|
|
1055
1901
|
export interface GetVoiceConnectorGroupResponse {
|
|
1902
|
+
/**
|
|
1903
|
+
* <p>The details of the Voice Connector group.</p>
|
|
1904
|
+
*/
|
|
1056
1905
|
VoiceConnectorGroup?: VoiceConnectorGroup;
|
|
1057
1906
|
}
|
|
1058
1907
|
/**
|
|
1059
1908
|
* @public
|
|
1060
1909
|
*/
|
|
1061
1910
|
export interface GetVoiceConnectorLoggingConfigurationRequest {
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>The Voice Connector ID.</p>
|
|
1913
|
+
*/
|
|
1062
1914
|
VoiceConnectorId: string | undefined;
|
|
1063
1915
|
}
|
|
1064
1916
|
/**
|
|
1065
1917
|
* @public
|
|
1918
|
+
* <p>The logging configuration associated with an Amazon Chime SDK Voice Connector.
|
|
1919
|
+
* Specifies whether SIP message logs can be sent to Amazon CloudWatch Logs.</p>
|
|
1066
1920
|
*/
|
|
1067
1921
|
export interface LoggingConfiguration {
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>Boolean that enables sending SIP message logs to Amazon CloudWatch logs.</p>
|
|
1924
|
+
*/
|
|
1068
1925
|
EnableSIPLogs?: boolean;
|
|
1926
|
+
/**
|
|
1927
|
+
* <p>Enables or disables media metrics logging.</p>
|
|
1928
|
+
*/
|
|
1069
1929
|
EnableMediaMetricLogs?: boolean;
|
|
1070
1930
|
}
|
|
1071
1931
|
/**
|
|
1072
1932
|
* @public
|
|
1073
1933
|
*/
|
|
1074
1934
|
export interface GetVoiceConnectorLoggingConfigurationResponse {
|
|
1935
|
+
/**
|
|
1936
|
+
* <p>The logging configuration details .</p>
|
|
1937
|
+
*/
|
|
1075
1938
|
LoggingConfiguration?: LoggingConfiguration;
|
|
1076
1939
|
}
|
|
1077
1940
|
/**
|
|
1078
1941
|
* @public
|
|
1079
1942
|
*/
|
|
1080
1943
|
export interface GetVoiceConnectorOriginationRequest {
|
|
1944
|
+
/**
|
|
1945
|
+
* <p>The Voice Connector ID.</p>
|
|
1946
|
+
*/
|
|
1081
1947
|
VoiceConnectorId: string | undefined;
|
|
1082
1948
|
}
|
|
1083
1949
|
/**
|
|
@@ -1089,59 +1955,132 @@ export declare enum OriginationRouteProtocol {
|
|
|
1089
1955
|
}
|
|
1090
1956
|
/**
|
|
1091
1957
|
* @public
|
|
1958
|
+
* <p>Origination routes define call distribution properties for your SIP hosts to
|
|
1959
|
+
* receive inbound calls using an Amazon Chime SDK Voice Connector. Limit: Ten origination
|
|
1960
|
+
* routes for each Voice Connector.</p>
|
|
1961
|
+
* <note>
|
|
1962
|
+
* <p>The parameters listed below are not required, but you must use at least one.</p>
|
|
1963
|
+
* </note>
|
|
1092
1964
|
*/
|
|
1093
1965
|
export interface OriginationRoute {
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>The FQDN or IP address to contact for origination traffic.</p>
|
|
1968
|
+
*/
|
|
1094
1969
|
Host?: string;
|
|
1970
|
+
/**
|
|
1971
|
+
* <p>The designated origination route port. Defaults to 5060.</p>
|
|
1972
|
+
*/
|
|
1095
1973
|
Port?: number;
|
|
1974
|
+
/**
|
|
1975
|
+
* <p>The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
|
|
1976
|
+
* TCP protocol by default.</p>
|
|
1977
|
+
*/
|
|
1096
1978
|
Protocol?: OriginationRouteProtocol | string;
|
|
1979
|
+
/**
|
|
1980
|
+
* <p>The priority associated with the host, with 1 being the highest priority. Higher
|
|
1981
|
+
* priority hosts are attempted first.</p>
|
|
1982
|
+
*/
|
|
1097
1983
|
Priority?: number;
|
|
1984
|
+
/**
|
|
1985
|
+
* <p>The weight assigned to an origination route. When hosts have equal priority,
|
|
1986
|
+
* calls are distributed between them based on their relative weights.</p>
|
|
1987
|
+
*/
|
|
1098
1988
|
Weight?: number;
|
|
1099
1989
|
}
|
|
1100
1990
|
/**
|
|
1101
1991
|
* @public
|
|
1992
|
+
* <p>Origination settings enable your SIP hosts to receive inbound calls using your
|
|
1993
|
+
* Amazon Chime SDK Voice Connector.</p>
|
|
1994
|
+
* <note>
|
|
1995
|
+
* <p>The parameters listed below are not required, but you must use at least
|
|
1996
|
+
* one.</p>
|
|
1997
|
+
* </note>
|
|
1102
1998
|
*/
|
|
1103
1999
|
export interface Origination {
|
|
2000
|
+
/**
|
|
2001
|
+
* <p>The call distribution properties defined for your SIP hosts. Valid range: Minimum
|
|
2002
|
+
* value of 1. Maximum value of 20. This parameter is not required, but you must specify
|
|
2003
|
+
* this parameter or <code>Disabled</code>.</p>
|
|
2004
|
+
*/
|
|
1104
2005
|
Routes?: OriginationRoute[];
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>When origination settings are disabled, inbound calls are not enabled for your
|
|
2008
|
+
* Amazon Chime SDK Voice Connector.
|
|
2009
|
+
* This parameter is not required, but you must specify this parameter or
|
|
2010
|
+
* <code>Routes</code>.</p>
|
|
2011
|
+
*/
|
|
1105
2012
|
Disabled?: boolean;
|
|
1106
2013
|
}
|
|
1107
2014
|
/**
|
|
1108
2015
|
* @public
|
|
1109
2016
|
*/
|
|
1110
2017
|
export interface GetVoiceConnectorOriginationResponse {
|
|
2018
|
+
/**
|
|
2019
|
+
* <p>The origination setting details.</p>
|
|
2020
|
+
*/
|
|
1111
2021
|
Origination?: Origination;
|
|
1112
2022
|
}
|
|
1113
2023
|
/**
|
|
1114
2024
|
* @public
|
|
1115
2025
|
*/
|
|
1116
2026
|
export interface GetVoiceConnectorProxyRequest {
|
|
2027
|
+
/**
|
|
2028
|
+
* <p>The Voice Connector ID.</p>
|
|
2029
|
+
*/
|
|
1117
2030
|
VoiceConnectorId: string | undefined;
|
|
1118
2031
|
}
|
|
1119
2032
|
/**
|
|
1120
2033
|
* @public
|
|
2034
|
+
* <p>The proxy configuration for an Amazon Chime SDK Voice Connector.</p>
|
|
1121
2035
|
*/
|
|
1122
2036
|
export interface Proxy {
|
|
2037
|
+
/**
|
|
2038
|
+
* <p>The default number of minutes allowed for proxy sessions.</p>
|
|
2039
|
+
*/
|
|
1123
2040
|
DefaultSessionExpiryMinutes?: number;
|
|
2041
|
+
/**
|
|
2042
|
+
* <p>When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.</p>
|
|
2043
|
+
*/
|
|
1124
2044
|
Disabled?: boolean;
|
|
2045
|
+
/**
|
|
2046
|
+
* <p>The phone number to route calls to after a proxy session expires.</p>
|
|
2047
|
+
*/
|
|
1125
2048
|
FallBackPhoneNumber?: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>The countries for proxy phone numbers to be selected from.</p>
|
|
2051
|
+
*/
|
|
1126
2052
|
PhoneNumberCountries?: string[];
|
|
1127
2053
|
}
|
|
1128
2054
|
/**
|
|
1129
2055
|
* @public
|
|
1130
2056
|
*/
|
|
1131
2057
|
export interface GetVoiceConnectorProxyResponse {
|
|
2058
|
+
/**
|
|
2059
|
+
* <p>The proxy configuration details.</p>
|
|
2060
|
+
*/
|
|
1132
2061
|
Proxy?: Proxy;
|
|
1133
2062
|
}
|
|
1134
2063
|
/**
|
|
1135
2064
|
* @public
|
|
1136
2065
|
*/
|
|
1137
2066
|
export interface GetVoiceConnectorStreamingConfigurationRequest {
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>The Voice Connector ID.</p>
|
|
2069
|
+
*/
|
|
1138
2070
|
VoiceConnectorId: string | undefined;
|
|
1139
2071
|
}
|
|
1140
2072
|
/**
|
|
1141
2073
|
* @public
|
|
2074
|
+
* <p>The configuration for a call analytics task.</p>
|
|
1142
2075
|
*/
|
|
1143
2076
|
export interface MediaInsightsConfiguration {
|
|
2077
|
+
/**
|
|
2078
|
+
* <p>Denotes the configration as enabled or disabled.</p>
|
|
2079
|
+
*/
|
|
1144
2080
|
Disabled?: boolean;
|
|
2081
|
+
/**
|
|
2082
|
+
* <p>The configuration's ARN.</p>
|
|
2083
|
+
*/
|
|
1145
2084
|
ConfigurationArn?: string;
|
|
1146
2085
|
}
|
|
1147
2086
|
/**
|
|
@@ -1154,491 +2093,940 @@ export declare enum NotificationTarget {
|
|
|
1154
2093
|
}
|
|
1155
2094
|
/**
|
|
1156
2095
|
* @public
|
|
2096
|
+
* <p>The target recipient for a streaming configuration notification.</p>
|
|
1157
2097
|
*/
|
|
1158
2098
|
export interface StreamingNotificationTarget {
|
|
2099
|
+
/**
|
|
2100
|
+
* <p>The streaming notification target.</p>
|
|
2101
|
+
*/
|
|
1159
2102
|
NotificationTarget?: NotificationTarget | string;
|
|
1160
2103
|
}
|
|
1161
2104
|
/**
|
|
1162
2105
|
* @public
|
|
2106
|
+
* <p>The streaming configuration associated with an Amazon Chime SDK Voice Connector.
|
|
2107
|
+
* Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention
|
|
2108
|
+
* period for the Amazon Kinesis data, in hours.</p>
|
|
1163
2109
|
*/
|
|
1164
2110
|
export interface StreamingConfiguration {
|
|
2111
|
+
/**
|
|
2112
|
+
* <p>The amount of time, in hours, to the Kinesis data.</p>
|
|
2113
|
+
*/
|
|
1165
2114
|
DataRetentionInHours: number | undefined;
|
|
2115
|
+
/**
|
|
2116
|
+
* <p>When true, streaming to Kinesis is off.</p>
|
|
2117
|
+
*/
|
|
1166
2118
|
Disabled: boolean | undefined;
|
|
2119
|
+
/**
|
|
2120
|
+
* <p>The streaming notification targets.</p>
|
|
2121
|
+
*/
|
|
1167
2122
|
StreamingNotificationTargets?: StreamingNotificationTarget[];
|
|
2123
|
+
/**
|
|
2124
|
+
* <p>The call analytics configuration.</p>
|
|
2125
|
+
*/
|
|
1168
2126
|
MediaInsightsConfiguration?: MediaInsightsConfiguration;
|
|
1169
2127
|
}
|
|
1170
2128
|
/**
|
|
1171
2129
|
* @public
|
|
1172
2130
|
*/
|
|
1173
2131
|
export interface GetVoiceConnectorStreamingConfigurationResponse {
|
|
2132
|
+
/**
|
|
2133
|
+
* <p>The details of the streaming configuration.</p>
|
|
2134
|
+
*/
|
|
1174
2135
|
StreamingConfiguration?: StreamingConfiguration;
|
|
1175
2136
|
}
|
|
1176
2137
|
/**
|
|
1177
2138
|
* @public
|
|
1178
2139
|
*/
|
|
1179
2140
|
export interface GetVoiceConnectorTerminationRequest {
|
|
2141
|
+
/**
|
|
2142
|
+
* <p>The Voice Connector ID.</p>
|
|
2143
|
+
*/
|
|
1180
2144
|
VoiceConnectorId: string | undefined;
|
|
1181
2145
|
}
|
|
1182
2146
|
/**
|
|
1183
2147
|
* @public
|
|
2148
|
+
* <p>Termination settings enable SIP hosts to make outbound calls using an Amazon Chime SDK Voice Connector.</p>
|
|
1184
2149
|
*/
|
|
1185
2150
|
export interface Termination {
|
|
2151
|
+
/**
|
|
2152
|
+
* <p>The limit on calls per second. Max value based on account service quota. Default value of 1.</p>
|
|
2153
|
+
*/
|
|
1186
2154
|
CpsLimit?: number;
|
|
2155
|
+
/**
|
|
2156
|
+
* <p>The default outbound calling number.</p>
|
|
2157
|
+
*/
|
|
1187
2158
|
DefaultPhoneNumber?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
* <p>The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.</p>
|
|
2161
|
+
*/
|
|
1188
2162
|
CallingRegions?: string[];
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>The IP addresses allowed to make calls, in CIDR format.</p>
|
|
2165
|
+
*/
|
|
1189
2166
|
CidrAllowedList?: string[];
|
|
2167
|
+
/**
|
|
2168
|
+
* <p>When termination is disabled, outbound calls cannot be made.</p>
|
|
2169
|
+
*/
|
|
1190
2170
|
Disabled?: boolean;
|
|
1191
2171
|
}
|
|
1192
2172
|
/**
|
|
1193
2173
|
* @public
|
|
1194
2174
|
*/
|
|
1195
2175
|
export interface GetVoiceConnectorTerminationResponse {
|
|
2176
|
+
/**
|
|
2177
|
+
* <p>The termination setting details.</p>
|
|
2178
|
+
*/
|
|
1196
2179
|
Termination?: Termination;
|
|
1197
2180
|
}
|
|
1198
2181
|
/**
|
|
1199
2182
|
* @public
|
|
1200
2183
|
*/
|
|
1201
2184
|
export interface GetVoiceConnectorTerminationHealthRequest {
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>The Voice Connector ID.</p>
|
|
2187
|
+
*/
|
|
1202
2188
|
VoiceConnectorId: string | undefined;
|
|
1203
2189
|
}
|
|
1204
2190
|
/**
|
|
1205
2191
|
* @public
|
|
2192
|
+
* <p>The termination health details, including the source IP address and timestamp of the last successful <code>SIP OPTIONS</code> message from your SIP infrastructure.</p>
|
|
1206
2193
|
*/
|
|
1207
2194
|
export interface TerminationHealth {
|
|
2195
|
+
/**
|
|
2196
|
+
* <p>The timestamp, in ISO 8601 format.</p>
|
|
2197
|
+
*/
|
|
1208
2198
|
Timestamp?: Date;
|
|
2199
|
+
/**
|
|
2200
|
+
* <p>The source IP address.</p>
|
|
2201
|
+
*/
|
|
1209
2202
|
Source?: string;
|
|
1210
2203
|
}
|
|
1211
2204
|
/**
|
|
1212
2205
|
* @public
|
|
1213
2206
|
*/
|
|
1214
2207
|
export interface GetVoiceConnectorTerminationHealthResponse {
|
|
2208
|
+
/**
|
|
2209
|
+
* <p>The termination health details.</p>
|
|
2210
|
+
*/
|
|
1215
2211
|
TerminationHealth?: TerminationHealth;
|
|
1216
2212
|
}
|
|
1217
2213
|
/**
|
|
1218
2214
|
* @public
|
|
1219
2215
|
*/
|
|
1220
2216
|
export interface GetVoiceProfileRequest {
|
|
2217
|
+
/**
|
|
2218
|
+
* <p>The voice profile ID.</p>
|
|
2219
|
+
*/
|
|
1221
2220
|
VoiceProfileId: string | undefined;
|
|
1222
2221
|
}
|
|
1223
2222
|
/**
|
|
1224
2223
|
* @public
|
|
1225
2224
|
*/
|
|
1226
2225
|
export interface GetVoiceProfileResponse {
|
|
2226
|
+
/**
|
|
2227
|
+
* <p>The voice profile details.</p>
|
|
2228
|
+
*/
|
|
1227
2229
|
VoiceProfile?: VoiceProfile;
|
|
1228
2230
|
}
|
|
1229
2231
|
/**
|
|
1230
2232
|
* @public
|
|
1231
2233
|
*/
|
|
1232
2234
|
export interface GetVoiceProfileDomainRequest {
|
|
2235
|
+
/**
|
|
2236
|
+
* <p>The voice profile domain ID.</p>
|
|
2237
|
+
*/
|
|
1233
2238
|
VoiceProfileDomainId: string | undefined;
|
|
1234
2239
|
}
|
|
1235
2240
|
/**
|
|
1236
2241
|
* @public
|
|
1237
2242
|
*/
|
|
1238
2243
|
export interface GetVoiceProfileDomainResponse {
|
|
2244
|
+
/**
|
|
2245
|
+
* <p>The details of the voice profile domain.</p>
|
|
2246
|
+
*/
|
|
1239
2247
|
VoiceProfileDomain?: VoiceProfileDomain;
|
|
1240
2248
|
}
|
|
1241
2249
|
/**
|
|
1242
2250
|
* @public
|
|
1243
2251
|
*/
|
|
1244
2252
|
export interface GetVoiceToneAnalysisTaskRequest {
|
|
2253
|
+
/**
|
|
2254
|
+
* <p>The Voice Connector ID.</p>
|
|
2255
|
+
*/
|
|
1245
2256
|
VoiceConnectorId: string | undefined;
|
|
2257
|
+
/**
|
|
2258
|
+
* <p>The ID of the voice tone anlysis task.</p>
|
|
2259
|
+
*/
|
|
1246
2260
|
VoiceToneAnalysisTaskId: string | undefined;
|
|
2261
|
+
/**
|
|
2262
|
+
* <p>Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).</p>
|
|
2263
|
+
*/
|
|
1247
2264
|
IsCaller: boolean | undefined;
|
|
1248
2265
|
}
|
|
1249
2266
|
/**
|
|
1250
2267
|
* @public
|
|
2268
|
+
* <p>A representation of an asynchronous request to perform voice tone analysis on a Voice Connector call.</p>
|
|
1251
2269
|
*/
|
|
1252
2270
|
export interface VoiceToneAnalysisTask {
|
|
2271
|
+
/**
|
|
2272
|
+
* <p>The ID of the voice tone analysis task.</p>
|
|
2273
|
+
*/
|
|
1253
2274
|
VoiceToneAnalysisTaskId?: string;
|
|
2275
|
+
/**
|
|
2276
|
+
* <p>The status of a voice tone analysis task, <code>IN_QUEUE</code>, <code>IN_PROGRESS</code>, <code>PARTIAL_SUCCESS</code>, <code>SUCCEEDED</code>,
|
|
2277
|
+
* <code>FAILED</code>, or <code>STOPPED</code>.</p>
|
|
2278
|
+
*/
|
|
1254
2279
|
VoiceToneAnalysisTaskStatus?: string;
|
|
2280
|
+
/**
|
|
2281
|
+
* <p>The call details of a voice tone analysis task.</p>
|
|
2282
|
+
*/
|
|
1255
2283
|
CallDetails?: CallDetails;
|
|
2284
|
+
/**
|
|
2285
|
+
* <p>The time at which a voice tone analysis task was created.</p>
|
|
2286
|
+
*/
|
|
1256
2287
|
CreatedTimestamp?: Date;
|
|
2288
|
+
/**
|
|
2289
|
+
* <p>The time at which a voice tone analysis task was updated.</p>
|
|
2290
|
+
*/
|
|
1257
2291
|
UpdatedTimestamp?: Date;
|
|
2292
|
+
/**
|
|
2293
|
+
* <p>The time at which a voice tone analysis task started.</p>
|
|
2294
|
+
*/
|
|
1258
2295
|
StartedTimestamp?: Date;
|
|
2296
|
+
/**
|
|
2297
|
+
* <p>The status of a voice tone analysis task.</p>
|
|
2298
|
+
*/
|
|
1259
2299
|
StatusMessage?: string;
|
|
1260
2300
|
}
|
|
1261
2301
|
/**
|
|
1262
2302
|
* @public
|
|
1263
2303
|
*/
|
|
1264
2304
|
export interface GetVoiceToneAnalysisTaskResponse {
|
|
2305
|
+
/**
|
|
2306
|
+
* <p>The details of the voice tone analysis task.</p>
|
|
2307
|
+
*/
|
|
1265
2308
|
VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
|
|
1266
2309
|
}
|
|
1267
2310
|
/**
|
|
1268
2311
|
* @public
|
|
1269
2312
|
*/
|
|
1270
2313
|
export interface ListAvailableVoiceConnectorRegionsResponse {
|
|
2314
|
+
/**
|
|
2315
|
+
* <p>The list of AWS Regions.</p>
|
|
2316
|
+
*/
|
|
1271
2317
|
VoiceConnectorRegions?: (VoiceConnectorAwsRegion | string)[];
|
|
1272
2318
|
}
|
|
1273
2319
|
/**
|
|
1274
2320
|
* @public
|
|
1275
2321
|
*/
|
|
1276
2322
|
export interface ListPhoneNumberOrdersRequest {
|
|
2323
|
+
/**
|
|
2324
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2325
|
+
*/
|
|
1277
2326
|
NextToken?: string;
|
|
2327
|
+
/**
|
|
2328
|
+
* <p>The maximum number of results to return in a single call.</p>
|
|
2329
|
+
*/
|
|
1278
2330
|
MaxResults?: number;
|
|
1279
2331
|
}
|
|
1280
2332
|
/**
|
|
1281
2333
|
* @public
|
|
1282
2334
|
*/
|
|
1283
2335
|
export interface ListPhoneNumberOrdersResponse {
|
|
2336
|
+
/**
|
|
2337
|
+
* <p>The phone number order details.</p>
|
|
2338
|
+
*/
|
|
1284
2339
|
PhoneNumberOrders?: PhoneNumberOrder[];
|
|
2340
|
+
/**
|
|
2341
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2342
|
+
*/
|
|
1285
2343
|
NextToken?: string;
|
|
1286
2344
|
}
|
|
1287
2345
|
/**
|
|
1288
2346
|
* @public
|
|
1289
2347
|
*/
|
|
1290
2348
|
export interface ListPhoneNumbersRequest {
|
|
2349
|
+
/**
|
|
2350
|
+
* <p>The status of your organization's phone numbers.</p>
|
|
2351
|
+
*/
|
|
1291
2352
|
Status?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* <p>The phone number product types.</p>
|
|
2355
|
+
*/
|
|
1292
2356
|
ProductType?: PhoneNumberProductType | string;
|
|
2357
|
+
/**
|
|
2358
|
+
* <p>The filter to limit the number of results.</p>
|
|
2359
|
+
*/
|
|
1293
2360
|
FilterName?: PhoneNumberAssociationName | string;
|
|
2361
|
+
/**
|
|
2362
|
+
* <p>The filter value.</p>
|
|
2363
|
+
*/
|
|
1294
2364
|
FilterValue?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* <p>The maximum number of results to return in a single call.</p>
|
|
2367
|
+
*/
|
|
1295
2368
|
MaxResults?: number;
|
|
2369
|
+
/**
|
|
2370
|
+
* <p>The token used to return the next page of results.</p>
|
|
2371
|
+
*/
|
|
1296
2372
|
NextToken?: string;
|
|
1297
2373
|
}
|
|
1298
2374
|
/**
|
|
1299
2375
|
* @public
|
|
1300
2376
|
*/
|
|
1301
2377
|
export interface ListPhoneNumbersResponse {
|
|
2378
|
+
/**
|
|
2379
|
+
* <p>The phone number details.</p>
|
|
2380
|
+
*/
|
|
1302
2381
|
PhoneNumbers?: PhoneNumber[];
|
|
2382
|
+
/**
|
|
2383
|
+
* <p>The token used to return the next page of results.</p>
|
|
2384
|
+
*/
|
|
1303
2385
|
NextToken?: string;
|
|
1304
2386
|
}
|
|
1305
2387
|
/**
|
|
1306
2388
|
* @public
|
|
1307
2389
|
*/
|
|
1308
2390
|
export interface ListProxySessionsRequest {
|
|
2391
|
+
/**
|
|
2392
|
+
* <p>The Voice Connector ID.</p>
|
|
2393
|
+
*/
|
|
1309
2394
|
VoiceConnectorId: string | undefined;
|
|
2395
|
+
/**
|
|
2396
|
+
* <p>The proxy session status.</p>
|
|
2397
|
+
*/
|
|
1310
2398
|
Status?: ProxySessionStatus | string;
|
|
2399
|
+
/**
|
|
2400
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2401
|
+
*/
|
|
1311
2402
|
NextToken?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* <p>The maximum number of results to return in a single call.</p>
|
|
2405
|
+
*/
|
|
1312
2406
|
MaxResults?: number;
|
|
1313
2407
|
}
|
|
1314
2408
|
/**
|
|
1315
2409
|
* @public
|
|
1316
2410
|
*/
|
|
1317
2411
|
export interface ListProxySessionsResponse {
|
|
2412
|
+
/**
|
|
2413
|
+
* <p>The proxy sessions' details.</p>
|
|
2414
|
+
*/
|
|
1318
2415
|
ProxySessions?: ProxySession[];
|
|
2416
|
+
/**
|
|
2417
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2418
|
+
*/
|
|
1319
2419
|
NextToken?: string;
|
|
1320
2420
|
}
|
|
1321
2421
|
/**
|
|
1322
2422
|
* @public
|
|
1323
2423
|
*/
|
|
1324
2424
|
export interface ListSipMediaApplicationsRequest {
|
|
2425
|
+
/**
|
|
2426
|
+
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
2427
|
+
*/
|
|
1325
2428
|
MaxResults?: number;
|
|
2429
|
+
/**
|
|
2430
|
+
* <p>The token used to return the next page of results.</p>
|
|
2431
|
+
*/
|
|
1326
2432
|
NextToken?: string;
|
|
1327
2433
|
}
|
|
1328
2434
|
/**
|
|
1329
2435
|
* @public
|
|
1330
2436
|
*/
|
|
1331
2437
|
export interface ListSipMediaApplicationsResponse {
|
|
2438
|
+
/**
|
|
2439
|
+
* <p>The list of SIP media applications and application details.</p>
|
|
2440
|
+
*/
|
|
1332
2441
|
SipMediaApplications?: SipMediaApplication[];
|
|
2442
|
+
/**
|
|
2443
|
+
* <p>The token used to return the next page of results.</p>
|
|
2444
|
+
*/
|
|
1333
2445
|
NextToken?: string;
|
|
1334
2446
|
}
|
|
1335
2447
|
/**
|
|
1336
2448
|
* @public
|
|
1337
2449
|
*/
|
|
1338
2450
|
export interface ListSipRulesRequest {
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>The SIP media application ID.</p>
|
|
2453
|
+
*/
|
|
1339
2454
|
SipMediaApplicationId?: string;
|
|
2455
|
+
/**
|
|
2456
|
+
* <p>The maximum number of results to return in a single call. Defaults to 100.</p>
|
|
2457
|
+
*/
|
|
1340
2458
|
MaxResults?: number;
|
|
2459
|
+
/**
|
|
2460
|
+
* <p>The token used to return the next page of results.</p>
|
|
2461
|
+
*/
|
|
1341
2462
|
NextToken?: string;
|
|
1342
2463
|
}
|
|
1343
2464
|
/**
|
|
1344
2465
|
* @public
|
|
1345
2466
|
*/
|
|
1346
2467
|
export interface ListSipRulesResponse {
|
|
2468
|
+
/**
|
|
2469
|
+
* <p>The list of SIP rules and details.</p>
|
|
2470
|
+
*/
|
|
1347
2471
|
SipRules?: SipRule[];
|
|
2472
|
+
/**
|
|
2473
|
+
* <p>The token used to return the next page of results.</p>
|
|
2474
|
+
*/
|
|
1348
2475
|
NextToken?: string;
|
|
1349
2476
|
}
|
|
1350
2477
|
/**
|
|
1351
2478
|
* @public
|
|
1352
2479
|
*/
|
|
1353
2480
|
export interface ListSupportedPhoneNumberCountriesRequest {
|
|
2481
|
+
/**
|
|
2482
|
+
* <p>The phone number product type.</p>
|
|
2483
|
+
*/
|
|
1354
2484
|
ProductType: PhoneNumberProductType | string | undefined;
|
|
1355
2485
|
}
|
|
1356
2486
|
/**
|
|
1357
2487
|
* @public
|
|
2488
|
+
* <p>The phone number's country.</p>
|
|
1358
2489
|
*/
|
|
1359
2490
|
export interface PhoneNumberCountry {
|
|
2491
|
+
/**
|
|
2492
|
+
* <p>The phone number country code. Format: ISO 3166-1 alpha-2.</p>
|
|
2493
|
+
*/
|
|
1360
2494
|
CountryCode?: string;
|
|
2495
|
+
/**
|
|
2496
|
+
* <p>The supported phone number types.</p>
|
|
2497
|
+
*/
|
|
1361
2498
|
SupportedPhoneNumberTypes?: (PhoneNumberType | string)[];
|
|
1362
2499
|
}
|
|
1363
2500
|
/**
|
|
1364
2501
|
* @public
|
|
1365
2502
|
*/
|
|
1366
2503
|
export interface ListSupportedPhoneNumberCountriesResponse {
|
|
2504
|
+
/**
|
|
2505
|
+
* <p>The supported phone number countries.</p>
|
|
2506
|
+
*/
|
|
1367
2507
|
PhoneNumberCountries?: PhoneNumberCountry[];
|
|
1368
2508
|
}
|
|
1369
2509
|
/**
|
|
1370
2510
|
* @public
|
|
1371
2511
|
*/
|
|
1372
2512
|
export interface ListTagsForResourceRequest {
|
|
2513
|
+
/**
|
|
2514
|
+
* <p>The resource ARN.</p>
|
|
2515
|
+
*/
|
|
1373
2516
|
ResourceARN: string | undefined;
|
|
1374
2517
|
}
|
|
1375
2518
|
/**
|
|
1376
2519
|
* @public
|
|
1377
2520
|
*/
|
|
1378
2521
|
export interface ListTagsForResourceResponse {
|
|
2522
|
+
/**
|
|
2523
|
+
* <p>The tags in the list.</p>
|
|
2524
|
+
*/
|
|
1379
2525
|
Tags?: Tag[];
|
|
1380
2526
|
}
|
|
1381
2527
|
/**
|
|
1382
2528
|
* @public
|
|
1383
2529
|
*/
|
|
1384
2530
|
export interface ListVoiceConnectorGroupsRequest {
|
|
2531
|
+
/**
|
|
2532
|
+
* <p>The token used to return the next page of results.</p>
|
|
2533
|
+
*/
|
|
1385
2534
|
NextToken?: string;
|
|
2535
|
+
/**
|
|
2536
|
+
* <p>The maximum number of results to return in a single call. </p>
|
|
2537
|
+
*/
|
|
1386
2538
|
MaxResults?: number;
|
|
1387
2539
|
}
|
|
1388
2540
|
/**
|
|
1389
2541
|
* @public
|
|
1390
2542
|
*/
|
|
1391
2543
|
export interface ListVoiceConnectorGroupsResponse {
|
|
2544
|
+
/**
|
|
2545
|
+
* <p>The details of the Voice Connector groups.</p>
|
|
2546
|
+
*/
|
|
1392
2547
|
VoiceConnectorGroups?: VoiceConnectorGroup[];
|
|
2548
|
+
/**
|
|
2549
|
+
* <p>The token used to return the next page of results.</p>
|
|
2550
|
+
*/
|
|
1393
2551
|
NextToken?: string;
|
|
1394
2552
|
}
|
|
1395
2553
|
/**
|
|
1396
2554
|
* @public
|
|
1397
2555
|
*/
|
|
1398
2556
|
export interface ListVoiceConnectorsRequest {
|
|
2557
|
+
/**
|
|
2558
|
+
* <p>The token used to return the next page of results.</p>
|
|
2559
|
+
*/
|
|
1399
2560
|
NextToken?: string;
|
|
2561
|
+
/**
|
|
2562
|
+
* <p>The maximum number of results to return in a single call.</p>
|
|
2563
|
+
*/
|
|
1400
2564
|
MaxResults?: number;
|
|
1401
2565
|
}
|
|
1402
2566
|
/**
|
|
1403
2567
|
* @public
|
|
1404
2568
|
*/
|
|
1405
2569
|
export interface ListVoiceConnectorsResponse {
|
|
2570
|
+
/**
|
|
2571
|
+
* <p>The details of the Voice Connectors.</p>
|
|
2572
|
+
*/
|
|
1406
2573
|
VoiceConnectors?: VoiceConnector[];
|
|
2574
|
+
/**
|
|
2575
|
+
* <p>The token used to return the next page of results.</p>
|
|
2576
|
+
*/
|
|
1407
2577
|
NextToken?: string;
|
|
1408
2578
|
}
|
|
1409
2579
|
/**
|
|
1410
2580
|
* @public
|
|
1411
2581
|
*/
|
|
1412
2582
|
export interface ListVoiceConnectorTerminationCredentialsRequest {
|
|
2583
|
+
/**
|
|
2584
|
+
* <p>The Voice Connector ID.</p>
|
|
2585
|
+
*/
|
|
1413
2586
|
VoiceConnectorId: string | undefined;
|
|
1414
2587
|
}
|
|
1415
2588
|
/**
|
|
1416
2589
|
* @public
|
|
1417
2590
|
*/
|
|
1418
2591
|
export interface ListVoiceConnectorTerminationCredentialsResponse {
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>A list of user names.</p>
|
|
2594
|
+
*/
|
|
1419
2595
|
Usernames?: string[];
|
|
1420
2596
|
}
|
|
1421
2597
|
/**
|
|
1422
2598
|
* @public
|
|
1423
2599
|
*/
|
|
1424
2600
|
export interface ListVoiceProfileDomainsRequest {
|
|
2601
|
+
/**
|
|
2602
|
+
* <p>The token used to return the next page of results.</p>
|
|
2603
|
+
*/
|
|
1425
2604
|
NextToken?: string;
|
|
2605
|
+
/**
|
|
2606
|
+
* <p>The maximum number of results to return in a single call.</p>
|
|
2607
|
+
*/
|
|
1426
2608
|
MaxResults?: number;
|
|
1427
2609
|
}
|
|
1428
2610
|
/**
|
|
1429
2611
|
* @public
|
|
2612
|
+
* <p>A high-level overview of a voice profile domain.</p>
|
|
1430
2613
|
*/
|
|
1431
2614
|
export interface VoiceProfileDomainSummary {
|
|
2615
|
+
/**
|
|
2616
|
+
* <p>The ID of the voice profile domain summary.</p>
|
|
2617
|
+
*/
|
|
1432
2618
|
VoiceProfileDomainId?: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* <p>The ARN of a voice profile in a voice profile domain summary.</p>
|
|
2621
|
+
*/
|
|
1433
2622
|
VoiceProfileDomainArn?: string;
|
|
2623
|
+
/**
|
|
2624
|
+
* <p>The name of the voice profile domain summary.</p>
|
|
2625
|
+
*/
|
|
1434
2626
|
Name?: string;
|
|
2627
|
+
/**
|
|
2628
|
+
* <p>Describes the voice profile domain summary.</p>
|
|
2629
|
+
*/
|
|
1435
2630
|
Description?: string;
|
|
2631
|
+
/**
|
|
2632
|
+
* <p>The time at which the voice profile domain summary was created.</p>
|
|
2633
|
+
*/
|
|
1436
2634
|
CreatedTimestamp?: Date;
|
|
2635
|
+
/**
|
|
2636
|
+
* <p>The time at which the voice profile domain summary was last updated.</p>
|
|
2637
|
+
*/
|
|
1437
2638
|
UpdatedTimestamp?: Date;
|
|
1438
2639
|
}
|
|
1439
2640
|
/**
|
|
1440
2641
|
* @public
|
|
1441
2642
|
*/
|
|
1442
2643
|
export interface ListVoiceProfileDomainsResponse {
|
|
2644
|
+
/**
|
|
2645
|
+
* <p>The list of voice profile domains.</p>
|
|
2646
|
+
*/
|
|
1443
2647
|
VoiceProfileDomains?: VoiceProfileDomainSummary[];
|
|
2648
|
+
/**
|
|
2649
|
+
* <p>The token used to return the next page of results.</p>
|
|
2650
|
+
*/
|
|
1444
2651
|
NextToken?: string;
|
|
1445
2652
|
}
|
|
1446
2653
|
/**
|
|
1447
2654
|
* @public
|
|
1448
2655
|
*/
|
|
1449
2656
|
export interface ListVoiceProfilesRequest {
|
|
2657
|
+
/**
|
|
2658
|
+
* <p>The ID of the voice profile domain.</p>
|
|
2659
|
+
*/
|
|
1450
2660
|
VoiceProfileDomainId: string | undefined;
|
|
2661
|
+
/**
|
|
2662
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2663
|
+
*/
|
|
1451
2664
|
NextToken?: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* <p>The maximum number of results in the request.</p>
|
|
2667
|
+
*/
|
|
1452
2668
|
MaxResults?: number;
|
|
1453
2669
|
}
|
|
1454
2670
|
/**
|
|
1455
2671
|
* @public
|
|
2672
|
+
* <p>A high-level summary of a voice profile.</p>
|
|
1456
2673
|
*/
|
|
1457
2674
|
export interface VoiceProfileSummary {
|
|
2675
|
+
/**
|
|
2676
|
+
* <p>The ID of the voice profile in a voice profile summary.</p>
|
|
2677
|
+
*/
|
|
1458
2678
|
VoiceProfileId?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* <p>The ARN of the voice profile in a voice profile summary.</p>
|
|
2681
|
+
*/
|
|
1459
2682
|
VoiceProfileArn?: string;
|
|
2683
|
+
/**
|
|
2684
|
+
* <p>The ID of the voice profile domain in a voice profile summary.</p>
|
|
2685
|
+
*/
|
|
1460
2686
|
VoiceProfileDomainId?: string;
|
|
2687
|
+
/**
|
|
2688
|
+
* <p>The time at which a voice profile summary was created.</p>
|
|
2689
|
+
*/
|
|
1461
2690
|
CreatedTimestamp?: Date;
|
|
2691
|
+
/**
|
|
2692
|
+
* <p>The time at which a voice profile summary was last updated.</p>
|
|
2693
|
+
*/
|
|
1462
2694
|
UpdatedTimestamp?: Date;
|
|
2695
|
+
/**
|
|
2696
|
+
* <p>Extends the life of the voice profile. You can use <code>UpdateVoiceProfile</code> to refresh an existing voice profile's voice print and extend the life of the summary.</p>
|
|
2697
|
+
*/
|
|
1463
2698
|
ExpirationTimestamp?: Date;
|
|
1464
2699
|
}
|
|
1465
2700
|
/**
|
|
1466
2701
|
* @public
|
|
1467
2702
|
*/
|
|
1468
2703
|
export interface ListVoiceProfilesResponse {
|
|
2704
|
+
/**
|
|
2705
|
+
* <p>The list of voice profiles.</p>
|
|
2706
|
+
*/
|
|
1469
2707
|
VoiceProfiles?: VoiceProfileSummary[];
|
|
2708
|
+
/**
|
|
2709
|
+
* <p>The token used to retrieve the next page of results.</p>
|
|
2710
|
+
*/
|
|
1470
2711
|
NextToken?: string;
|
|
1471
2712
|
}
|
|
1472
2713
|
/**
|
|
1473
2714
|
* @public
|
|
1474
2715
|
*/
|
|
1475
2716
|
export interface PutSipMediaApplicationAlexaSkillConfigurationRequest {
|
|
2717
|
+
/**
|
|
2718
|
+
* <p>The SIP media application ID.</p>
|
|
2719
|
+
*/
|
|
1476
2720
|
SipMediaApplicationId: string | undefined;
|
|
2721
|
+
/**
|
|
2722
|
+
* <p>The Alexa Skill configuration.</p>
|
|
2723
|
+
*/
|
|
1477
2724
|
SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
|
|
1478
2725
|
}
|
|
1479
2726
|
/**
|
|
1480
2727
|
* @public
|
|
1481
2728
|
*/
|
|
1482
2729
|
export interface PutSipMediaApplicationAlexaSkillConfigurationResponse {
|
|
2730
|
+
/**
|
|
2731
|
+
* <p>Returns the Alexa Skill configuration.</p>
|
|
2732
|
+
*/
|
|
1483
2733
|
SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
|
|
1484
2734
|
}
|
|
1485
2735
|
/**
|
|
1486
2736
|
* @public
|
|
1487
2737
|
*/
|
|
1488
2738
|
export interface PutSipMediaApplicationLoggingConfigurationRequest {
|
|
2739
|
+
/**
|
|
2740
|
+
* <p>The SIP media application ID.</p>
|
|
2741
|
+
*/
|
|
1489
2742
|
SipMediaApplicationId: string | undefined;
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>The logging configuration for the specified SIP media application.</p>
|
|
2745
|
+
*/
|
|
1490
2746
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
1491
2747
|
}
|
|
1492
2748
|
/**
|
|
1493
2749
|
* @public
|
|
1494
2750
|
*/
|
|
1495
2751
|
export interface PutSipMediaApplicationLoggingConfigurationResponse {
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>The updated logging configuration for the specified SIP media application.</p>
|
|
2754
|
+
*/
|
|
1496
2755
|
SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
|
|
1497
2756
|
}
|
|
1498
2757
|
/**
|
|
1499
2758
|
* @public
|
|
1500
2759
|
*/
|
|
1501
2760
|
export interface PutVoiceConnectorEmergencyCallingConfigurationRequest {
|
|
2761
|
+
/**
|
|
2762
|
+
* <p>The Voice Connector ID.</p>
|
|
2763
|
+
*/
|
|
1502
2764
|
VoiceConnectorId: string | undefined;
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>The configuration being updated.</p>
|
|
2767
|
+
*/
|
|
1503
2768
|
EmergencyCallingConfiguration: EmergencyCallingConfiguration | undefined;
|
|
1504
2769
|
}
|
|
1505
2770
|
/**
|
|
1506
2771
|
* @public
|
|
1507
2772
|
*/
|
|
1508
2773
|
export interface PutVoiceConnectorEmergencyCallingConfigurationResponse {
|
|
2774
|
+
/**
|
|
2775
|
+
* <p>The updated configuration.</p>
|
|
2776
|
+
*/
|
|
1509
2777
|
EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
|
|
1510
2778
|
}
|
|
1511
2779
|
/**
|
|
1512
2780
|
* @public
|
|
1513
2781
|
*/
|
|
1514
2782
|
export interface PutVoiceConnectorLoggingConfigurationRequest {
|
|
2783
|
+
/**
|
|
2784
|
+
* <p>The Voice Connector ID.</p>
|
|
2785
|
+
*/
|
|
1515
2786
|
VoiceConnectorId: string | undefined;
|
|
2787
|
+
/**
|
|
2788
|
+
* <p>The logging configuration being updated.</p>
|
|
2789
|
+
*/
|
|
1516
2790
|
LoggingConfiguration: LoggingConfiguration | undefined;
|
|
1517
2791
|
}
|
|
1518
2792
|
/**
|
|
1519
2793
|
* @public
|
|
1520
2794
|
*/
|
|
1521
2795
|
export interface PutVoiceConnectorLoggingConfigurationResponse {
|
|
2796
|
+
/**
|
|
2797
|
+
* <p>The updated logging configuration.</p>
|
|
2798
|
+
*/
|
|
1522
2799
|
LoggingConfiguration?: LoggingConfiguration;
|
|
1523
2800
|
}
|
|
1524
2801
|
/**
|
|
1525
2802
|
* @public
|
|
1526
2803
|
*/
|
|
1527
2804
|
export interface PutVoiceConnectorOriginationRequest {
|
|
2805
|
+
/**
|
|
2806
|
+
* <p>The Voice Connector ID.</p>
|
|
2807
|
+
*/
|
|
1528
2808
|
VoiceConnectorId: string | undefined;
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>The origination settings being updated.</p>
|
|
2811
|
+
*/
|
|
1529
2812
|
Origination: Origination | undefined;
|
|
1530
2813
|
}
|
|
1531
2814
|
/**
|
|
1532
2815
|
* @public
|
|
1533
2816
|
*/
|
|
1534
2817
|
export interface PutVoiceConnectorOriginationResponse {
|
|
2818
|
+
/**
|
|
2819
|
+
* <p>The updated origination settings.</p>
|
|
2820
|
+
*/
|
|
1535
2821
|
Origination?: Origination;
|
|
1536
2822
|
}
|
|
1537
2823
|
/**
|
|
1538
2824
|
* @public
|
|
1539
2825
|
*/
|
|
1540
2826
|
export interface PutVoiceConnectorProxyRequest {
|
|
2827
|
+
/**
|
|
2828
|
+
* <p>The Voice Connector ID.</p>
|
|
2829
|
+
*/
|
|
1541
2830
|
VoiceConnectorId: string | undefined;
|
|
2831
|
+
/**
|
|
2832
|
+
* <p>The default number of minutes allowed for proxy session.</p>
|
|
2833
|
+
*/
|
|
1542
2834
|
DefaultSessionExpiryMinutes: number | undefined;
|
|
2835
|
+
/**
|
|
2836
|
+
* <p>The countries for proxy phone numbers to be selected from.</p>
|
|
2837
|
+
*/
|
|
1543
2838
|
PhoneNumberPoolCountries: string[] | undefined;
|
|
2839
|
+
/**
|
|
2840
|
+
* <p>The phone number to route calls to after a proxy session expires.</p>
|
|
2841
|
+
*/
|
|
1544
2842
|
FallBackPhoneNumber?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* <p>When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.</p>
|
|
2845
|
+
*/
|
|
1545
2846
|
Disabled?: boolean;
|
|
1546
2847
|
}
|
|
1547
2848
|
/**
|
|
1548
2849
|
* @public
|
|
1549
2850
|
*/
|
|
1550
2851
|
export interface PutVoiceConnectorProxyResponse {
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>The proxy configuration details.</p>
|
|
2854
|
+
*/
|
|
1551
2855
|
Proxy?: Proxy;
|
|
1552
2856
|
}
|
|
1553
2857
|
/**
|
|
1554
2858
|
* @public
|
|
1555
2859
|
*/
|
|
1556
2860
|
export interface PutVoiceConnectorStreamingConfigurationRequest {
|
|
2861
|
+
/**
|
|
2862
|
+
* <p>The Voice Connector ID.</p>
|
|
2863
|
+
*/
|
|
1557
2864
|
VoiceConnectorId: string | undefined;
|
|
2865
|
+
/**
|
|
2866
|
+
* <p>The streaming settings being updated.</p>
|
|
2867
|
+
*/
|
|
1558
2868
|
StreamingConfiguration: StreamingConfiguration | undefined;
|
|
1559
2869
|
}
|
|
1560
2870
|
/**
|
|
1561
2871
|
* @public
|
|
1562
2872
|
*/
|
|
1563
2873
|
export interface PutVoiceConnectorStreamingConfigurationResponse {
|
|
2874
|
+
/**
|
|
2875
|
+
* <p>The updated streaming settings.</p>
|
|
2876
|
+
*/
|
|
1564
2877
|
StreamingConfiguration?: StreamingConfiguration;
|
|
1565
2878
|
}
|
|
1566
2879
|
/**
|
|
1567
2880
|
* @public
|
|
1568
2881
|
*/
|
|
1569
2882
|
export interface PutVoiceConnectorTerminationRequest {
|
|
2883
|
+
/**
|
|
2884
|
+
* <p>The Voice Connector ID.</p>
|
|
2885
|
+
*/
|
|
1570
2886
|
VoiceConnectorId: string | undefined;
|
|
2887
|
+
/**
|
|
2888
|
+
* <p>The termination settings to be updated.</p>
|
|
2889
|
+
*/
|
|
1571
2890
|
Termination: Termination | undefined;
|
|
1572
2891
|
}
|
|
1573
2892
|
/**
|
|
1574
2893
|
* @public
|
|
1575
2894
|
*/
|
|
1576
2895
|
export interface PutVoiceConnectorTerminationResponse {
|
|
2896
|
+
/**
|
|
2897
|
+
* <p>The updated termination settings.</p>
|
|
2898
|
+
*/
|
|
1577
2899
|
Termination?: Termination;
|
|
1578
2900
|
}
|
|
1579
2901
|
/**
|
|
1580
2902
|
* @public
|
|
2903
|
+
* <p>The SIP credentials used to authenticate requests to an Amazon Chime SDK Voice Connector.</p>
|
|
1581
2904
|
*/
|
|
1582
2905
|
export interface Credential {
|
|
2906
|
+
/**
|
|
2907
|
+
* <p>The RFC2617 compliant user name associated with the SIP credentials, in
|
|
2908
|
+
* US-ASCII format.</p>
|
|
2909
|
+
*/
|
|
1583
2910
|
Username?: string;
|
|
2911
|
+
/**
|
|
2912
|
+
* <p>The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.</p>
|
|
2913
|
+
*/
|
|
1584
2914
|
Password?: string;
|
|
1585
2915
|
}
|
|
1586
2916
|
/**
|
|
1587
2917
|
* @public
|
|
1588
2918
|
*/
|
|
1589
2919
|
export interface PutVoiceConnectorTerminationCredentialsRequest {
|
|
2920
|
+
/**
|
|
2921
|
+
* <p>The Voice Connector ID.</p>
|
|
2922
|
+
*/
|
|
1590
2923
|
VoiceConnectorId: string | undefined;
|
|
2924
|
+
/**
|
|
2925
|
+
* <p>The termination credentials being updated.</p>
|
|
2926
|
+
*/
|
|
1591
2927
|
Credentials?: Credential[];
|
|
1592
2928
|
}
|
|
1593
2929
|
/**
|
|
1594
2930
|
* @public
|
|
1595
2931
|
*/
|
|
1596
2932
|
export interface RestorePhoneNumberRequest {
|
|
2933
|
+
/**
|
|
2934
|
+
* <p>The ID of the phone number being restored.</p>
|
|
2935
|
+
*/
|
|
1597
2936
|
PhoneNumberId: string | undefined;
|
|
1598
2937
|
}
|
|
1599
2938
|
/**
|
|
1600
2939
|
* @public
|
|
1601
2940
|
*/
|
|
1602
2941
|
export interface RestorePhoneNumberResponse {
|
|
2942
|
+
/**
|
|
2943
|
+
* <p>The restored phone number.</p>
|
|
2944
|
+
*/
|
|
1603
2945
|
PhoneNumber?: PhoneNumber;
|
|
1604
2946
|
}
|
|
1605
2947
|
/**
|
|
1606
2948
|
* @public
|
|
1607
2949
|
*/
|
|
1608
2950
|
export interface SearchAvailablePhoneNumbersRequest {
|
|
2951
|
+
/**
|
|
2952
|
+
* <p>Confines a search to just the phone numbers associated with the specified area code.</p>
|
|
2953
|
+
*/
|
|
1609
2954
|
AreaCode?: string;
|
|
2955
|
+
/**
|
|
2956
|
+
* <p>Confines a search to just the phone numbers associated with the specified city.</p>
|
|
2957
|
+
*/
|
|
1610
2958
|
City?: string;
|
|
2959
|
+
/**
|
|
2960
|
+
* <p>Confines a search to just the phone numbers associated with the specified country.</p>
|
|
2961
|
+
*/
|
|
1611
2962
|
Country?: string;
|
|
2963
|
+
/**
|
|
2964
|
+
* <p>Confines a search to just the phone numbers associated with the specified state.</p>
|
|
2965
|
+
*/
|
|
1612
2966
|
State?: string;
|
|
2967
|
+
/**
|
|
2968
|
+
* <p>Confines a search to just the phone numbers associated with the specified toll-free prefix.</p>
|
|
2969
|
+
*/
|
|
1613
2970
|
TollFreePrefix?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* <p>Confines a search to just the phone numbers associated with the specified phone number type, either <b>local</b> or <b>toll-free</b>.</p>
|
|
2973
|
+
*/
|
|
1614
2974
|
PhoneNumberType?: PhoneNumberType | string;
|
|
2975
|
+
/**
|
|
2976
|
+
* <p>The maximum number of results to return.</p>
|
|
2977
|
+
*/
|
|
1615
2978
|
MaxResults?: number;
|
|
2979
|
+
/**
|
|
2980
|
+
* <p>The token used to return the next page of results.</p>
|
|
2981
|
+
*/
|
|
1616
2982
|
NextToken?: string;
|
|
1617
2983
|
}
|
|
1618
2984
|
/**
|
|
1619
2985
|
* @public
|
|
1620
2986
|
*/
|
|
1621
2987
|
export interface SearchAvailablePhoneNumbersResponse {
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>Confines a search to just the phone numbers in the E.164 format.</p>
|
|
2990
|
+
*/
|
|
1622
2991
|
E164PhoneNumbers?: string[];
|
|
2992
|
+
/**
|
|
2993
|
+
* <p>The token used to return the next page of results.</p>
|
|
2994
|
+
*/
|
|
1623
2995
|
NextToken?: string;
|
|
1624
2996
|
}
|
|
1625
2997
|
/**
|
|
1626
2998
|
* @public
|
|
1627
2999
|
*/
|
|
1628
3000
|
export interface StartSpeakerSearchTaskRequest {
|
|
3001
|
+
/**
|
|
3002
|
+
* <p>The Voice Connector ID.</p>
|
|
3003
|
+
*/
|
|
1629
3004
|
VoiceConnectorId: string | undefined;
|
|
3005
|
+
/**
|
|
3006
|
+
* <p>The transaction ID of the call being analyzed.</p>
|
|
3007
|
+
*/
|
|
1630
3008
|
TransactionId: string | undefined;
|
|
3009
|
+
/**
|
|
3010
|
+
* <p>The ID of the voice profile domain that will store the voice profile.</p>
|
|
3011
|
+
*/
|
|
1631
3012
|
VoiceProfileDomainId: string | undefined;
|
|
3013
|
+
/**
|
|
3014
|
+
* <p>The unique identifier for the client request. Use a different token for different speaker search tasks.</p>
|
|
3015
|
+
*/
|
|
1632
3016
|
ClientRequestToken?: string;
|
|
1633
3017
|
}
|
|
1634
3018
|
/**
|
|
1635
3019
|
* @public
|
|
1636
3020
|
*/
|
|
1637
3021
|
export interface StartSpeakerSearchTaskResponse {
|
|
3022
|
+
/**
|
|
3023
|
+
* <p>The details of the speaker search task.</p>
|
|
3024
|
+
*/
|
|
1638
3025
|
SpeakerSearchTask?: SpeakerSearchTask;
|
|
1639
3026
|
}
|
|
1640
3027
|
/**
|
|
1641
3028
|
* @public
|
|
3029
|
+
* <p>A well-formed request couldn't be followed due to semantic errors.</p>
|
|
1642
3030
|
*/
|
|
1643
3031
|
export declare class UnprocessableEntityException extends __BaseException {
|
|
1644
3032
|
readonly name: "UnprocessableEntityException";
|
|
@@ -1660,203 +3048,398 @@ export declare enum LanguageCode {
|
|
|
1660
3048
|
* @public
|
|
1661
3049
|
*/
|
|
1662
3050
|
export interface StartVoiceToneAnalysisTaskRequest {
|
|
3051
|
+
/**
|
|
3052
|
+
* <p>The Voice Connector ID.</p>
|
|
3053
|
+
*/
|
|
1663
3054
|
VoiceConnectorId: string | undefined;
|
|
3055
|
+
/**
|
|
3056
|
+
* <p>The transaction ID.</p>
|
|
3057
|
+
*/
|
|
1664
3058
|
TransactionId: string | undefined;
|
|
3059
|
+
/**
|
|
3060
|
+
* <p>The language code.</p>
|
|
3061
|
+
*/
|
|
1665
3062
|
LanguageCode: LanguageCode | string | undefined;
|
|
3063
|
+
/**
|
|
3064
|
+
* <p>The unique identifier for the client request. Use a different token for different voice tone analysis
|
|
3065
|
+
* tasks.</p>
|
|
3066
|
+
*/
|
|
1666
3067
|
ClientRequestToken?: string;
|
|
1667
3068
|
}
|
|
1668
3069
|
/**
|
|
1669
3070
|
* @public
|
|
1670
3071
|
*/
|
|
1671
3072
|
export interface StartVoiceToneAnalysisTaskResponse {
|
|
3073
|
+
/**
|
|
3074
|
+
* <p>The details of the voice tone analysis task.</p>
|
|
3075
|
+
*/
|
|
1672
3076
|
VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
|
|
1673
3077
|
}
|
|
1674
3078
|
/**
|
|
1675
3079
|
* @public
|
|
1676
3080
|
*/
|
|
1677
3081
|
export interface StopSpeakerSearchTaskRequest {
|
|
3082
|
+
/**
|
|
3083
|
+
* <p>The Voice Connector ID.</p>
|
|
3084
|
+
*/
|
|
1678
3085
|
VoiceConnectorId: string | undefined;
|
|
3086
|
+
/**
|
|
3087
|
+
* <p>The speaker search task ID.</p>
|
|
3088
|
+
*/
|
|
1679
3089
|
SpeakerSearchTaskId: string | undefined;
|
|
1680
3090
|
}
|
|
1681
3091
|
/**
|
|
1682
3092
|
* @public
|
|
1683
3093
|
*/
|
|
1684
3094
|
export interface StopVoiceToneAnalysisTaskRequest {
|
|
3095
|
+
/**
|
|
3096
|
+
* <p>The Voice Connector ID.</p>
|
|
3097
|
+
*/
|
|
1685
3098
|
VoiceConnectorId: string | undefined;
|
|
3099
|
+
/**
|
|
3100
|
+
* <p>The ID of the voice tone analysis task.</p>
|
|
3101
|
+
*/
|
|
1686
3102
|
VoiceToneAnalysisTaskId: string | undefined;
|
|
1687
3103
|
}
|
|
1688
3104
|
/**
|
|
1689
3105
|
* @public
|
|
1690
3106
|
*/
|
|
1691
3107
|
export interface TagResourceRequest {
|
|
3108
|
+
/**
|
|
3109
|
+
* <p>The ARN of the resource being tagged. </p>
|
|
3110
|
+
*/
|
|
1692
3111
|
ResourceARN: string | undefined;
|
|
3112
|
+
/**
|
|
3113
|
+
* <p>A list of the tags being added to the resource.</p>
|
|
3114
|
+
*/
|
|
1693
3115
|
Tags: Tag[] | undefined;
|
|
1694
3116
|
}
|
|
1695
3117
|
/**
|
|
1696
3118
|
* @public
|
|
1697
3119
|
*/
|
|
1698
3120
|
export interface UntagResourceRequest {
|
|
3121
|
+
/**
|
|
3122
|
+
* <p>The ARN of the resource having its tags removed.</p>
|
|
3123
|
+
*/
|
|
1699
3124
|
ResourceARN: string | undefined;
|
|
3125
|
+
/**
|
|
3126
|
+
* <p>The keys of the tags being removed from the resource.</p>
|
|
3127
|
+
*/
|
|
1700
3128
|
TagKeys: string[] | undefined;
|
|
1701
3129
|
}
|
|
1702
3130
|
/**
|
|
1703
3131
|
* @public
|
|
1704
3132
|
*/
|
|
1705
3133
|
export interface UpdateGlobalSettingsRequest {
|
|
3134
|
+
/**
|
|
3135
|
+
* <p>The Voice Connector settings.</p>
|
|
3136
|
+
*/
|
|
1706
3137
|
VoiceConnector?: VoiceConnectorSettings;
|
|
1707
3138
|
}
|
|
1708
3139
|
/**
|
|
1709
3140
|
* @public
|
|
1710
3141
|
*/
|
|
1711
3142
|
export interface UpdatePhoneNumberRequest {
|
|
3143
|
+
/**
|
|
3144
|
+
* <p>The phone number ID.</p>
|
|
3145
|
+
*/
|
|
1712
3146
|
PhoneNumberId: string | undefined;
|
|
3147
|
+
/**
|
|
3148
|
+
* <p>The product type.</p>
|
|
3149
|
+
*/
|
|
1713
3150
|
ProductType?: PhoneNumberProductType | string;
|
|
3151
|
+
/**
|
|
3152
|
+
* <p>The outbound calling name associated with the phone number.</p>
|
|
3153
|
+
*/
|
|
1714
3154
|
CallingName?: string;
|
|
1715
3155
|
}
|
|
1716
3156
|
/**
|
|
1717
3157
|
* @public
|
|
1718
3158
|
*/
|
|
1719
3159
|
export interface UpdatePhoneNumberResponse {
|
|
3160
|
+
/**
|
|
3161
|
+
* <p>The updated phone number details.</p>
|
|
3162
|
+
*/
|
|
1720
3163
|
PhoneNumber?: PhoneNumber;
|
|
1721
3164
|
}
|
|
1722
3165
|
/**
|
|
1723
3166
|
* @public
|
|
1724
3167
|
*/
|
|
1725
3168
|
export interface UpdatePhoneNumberSettingsRequest {
|
|
3169
|
+
/**
|
|
3170
|
+
* <p>The default outbound calling name for the account.</p>
|
|
3171
|
+
*/
|
|
1726
3172
|
CallingName: string | undefined;
|
|
1727
3173
|
}
|
|
1728
3174
|
/**
|
|
1729
3175
|
* @public
|
|
1730
3176
|
*/
|
|
1731
3177
|
export interface UpdateProxySessionRequest {
|
|
3178
|
+
/**
|
|
3179
|
+
* <p>The Voice Connector ID.</p>
|
|
3180
|
+
*/
|
|
1732
3181
|
VoiceConnectorId: string | undefined;
|
|
3182
|
+
/**
|
|
3183
|
+
* <p>The proxy session ID.</p>
|
|
3184
|
+
*/
|
|
1733
3185
|
ProxySessionId: string | undefined;
|
|
3186
|
+
/**
|
|
3187
|
+
* <p>The proxy session capabilities.</p>
|
|
3188
|
+
*/
|
|
1734
3189
|
Capabilities: (Capability | string)[] | undefined;
|
|
3190
|
+
/**
|
|
3191
|
+
* <p>The number of minutes allowed for the proxy session.</p>
|
|
3192
|
+
*/
|
|
1735
3193
|
ExpiryMinutes?: number;
|
|
1736
3194
|
}
|
|
1737
3195
|
/**
|
|
1738
3196
|
* @public
|
|
1739
3197
|
*/
|
|
1740
3198
|
export interface UpdateProxySessionResponse {
|
|
3199
|
+
/**
|
|
3200
|
+
* <p>The updated proxy session details.</p>
|
|
3201
|
+
*/
|
|
1741
3202
|
ProxySession?: ProxySession;
|
|
1742
3203
|
}
|
|
1743
3204
|
/**
|
|
1744
3205
|
* @public
|
|
1745
3206
|
*/
|
|
1746
3207
|
export interface UpdateSipMediaApplicationRequest {
|
|
3208
|
+
/**
|
|
3209
|
+
* <p>The SIP media application ID.</p>
|
|
3210
|
+
*/
|
|
1747
3211
|
SipMediaApplicationId: string | undefined;
|
|
3212
|
+
/**
|
|
3213
|
+
* <p>The new name for the specified SIP media application.</p>
|
|
3214
|
+
*/
|
|
1748
3215
|
Name?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* <p>The new set of endpoints for the specified SIP media application.</p>
|
|
3218
|
+
*/
|
|
1749
3219
|
Endpoints?: SipMediaApplicationEndpoint[];
|
|
1750
3220
|
}
|
|
1751
3221
|
/**
|
|
1752
3222
|
* @public
|
|
1753
3223
|
*/
|
|
1754
3224
|
export interface UpdateSipMediaApplicationResponse {
|
|
3225
|
+
/**
|
|
3226
|
+
* <p>The updated SIP media application’s details.</p>
|
|
3227
|
+
*/
|
|
1755
3228
|
SipMediaApplication?: SipMediaApplication;
|
|
1756
3229
|
}
|
|
1757
3230
|
/**
|
|
1758
3231
|
* @public
|
|
1759
3232
|
*/
|
|
1760
3233
|
export interface UpdateSipMediaApplicationCallRequest {
|
|
3234
|
+
/**
|
|
3235
|
+
* <p>The ID of the SIP media application handling the call.</p>
|
|
3236
|
+
*/
|
|
1761
3237
|
SipMediaApplicationId: string | undefined;
|
|
3238
|
+
/**
|
|
3239
|
+
* <p>The ID of the call transaction.</p>
|
|
3240
|
+
*/
|
|
1762
3241
|
TransactionId: string | undefined;
|
|
3242
|
+
/**
|
|
3243
|
+
* <p>Arguments made available to the Lambda function as part of the
|
|
3244
|
+
* <code>CALL_UPDATE_REQUESTED</code> event. Can contain 0-20 key-value pairs.</p>
|
|
3245
|
+
*/
|
|
1763
3246
|
Arguments: Record<string, string> | undefined;
|
|
1764
3247
|
}
|
|
1765
3248
|
/**
|
|
1766
3249
|
* @public
|
|
1767
3250
|
*/
|
|
1768
3251
|
export interface UpdateSipMediaApplicationCallResponse {
|
|
3252
|
+
/**
|
|
3253
|
+
* <p>A <code>Call</code> instance for a SIP media application.</p>
|
|
3254
|
+
*/
|
|
1769
3255
|
SipMediaApplicationCall?: SipMediaApplicationCall;
|
|
1770
3256
|
}
|
|
1771
3257
|
/**
|
|
1772
3258
|
* @public
|
|
1773
3259
|
*/
|
|
1774
3260
|
export interface UpdateSipRuleRequest {
|
|
3261
|
+
/**
|
|
3262
|
+
* <p>The SIP rule ID.</p>
|
|
3263
|
+
*/
|
|
1775
3264
|
SipRuleId: string | undefined;
|
|
3265
|
+
/**
|
|
3266
|
+
* <p>The new name for the specified SIP rule.</p>
|
|
3267
|
+
*/
|
|
1776
3268
|
Name: string | undefined;
|
|
3269
|
+
/**
|
|
3270
|
+
* <p>The new value that indicates whether the rule is disabled.</p>
|
|
3271
|
+
*/
|
|
1777
3272
|
Disabled?: boolean;
|
|
3273
|
+
/**
|
|
3274
|
+
* <p>The new list of target applications.</p>
|
|
3275
|
+
*/
|
|
1778
3276
|
TargetApplications?: SipRuleTargetApplication[];
|
|
1779
3277
|
}
|
|
1780
3278
|
/**
|
|
1781
3279
|
* @public
|
|
1782
3280
|
*/
|
|
1783
3281
|
export interface UpdateSipRuleResponse {
|
|
3282
|
+
/**
|
|
3283
|
+
* <p>The updated SIP rule details.</p>
|
|
3284
|
+
*/
|
|
1784
3285
|
SipRule?: SipRule;
|
|
1785
3286
|
}
|
|
1786
3287
|
/**
|
|
1787
3288
|
* @public
|
|
1788
3289
|
*/
|
|
1789
3290
|
export interface UpdateVoiceConnectorRequest {
|
|
3291
|
+
/**
|
|
3292
|
+
* <p>The Voice Connector ID.</p>
|
|
3293
|
+
*/
|
|
1790
3294
|
VoiceConnectorId: string | undefined;
|
|
3295
|
+
/**
|
|
3296
|
+
* <p>The name of the Voice Connector.</p>
|
|
3297
|
+
*/
|
|
1791
3298
|
Name: string | undefined;
|
|
3299
|
+
/**
|
|
3300
|
+
* <p>When enabled, requires encryption for the Voice Connector.</p>
|
|
3301
|
+
*/
|
|
1792
3302
|
RequireEncryption: boolean | undefined;
|
|
1793
3303
|
}
|
|
1794
3304
|
/**
|
|
1795
3305
|
* @public
|
|
1796
3306
|
*/
|
|
1797
3307
|
export interface UpdateVoiceConnectorResponse {
|
|
3308
|
+
/**
|
|
3309
|
+
* <p>The updated Voice Connector details.</p>
|
|
3310
|
+
*/
|
|
1798
3311
|
VoiceConnector?: VoiceConnector;
|
|
1799
3312
|
}
|
|
1800
3313
|
/**
|
|
1801
3314
|
* @public
|
|
1802
3315
|
*/
|
|
1803
3316
|
export interface UpdateVoiceConnectorGroupRequest {
|
|
3317
|
+
/**
|
|
3318
|
+
* <p>The Voice Connector ID.</p>
|
|
3319
|
+
*/
|
|
1804
3320
|
VoiceConnectorGroupId: string | undefined;
|
|
3321
|
+
/**
|
|
3322
|
+
* <p>The name of the Voice Connector group.</p>
|
|
3323
|
+
*/
|
|
1805
3324
|
Name: string | undefined;
|
|
3325
|
+
/**
|
|
3326
|
+
* <p>The <code>VoiceConnectorItems</code> to associate with the Voice Connector
|
|
3327
|
+
* group.</p>
|
|
3328
|
+
*/
|
|
1806
3329
|
VoiceConnectorItems: VoiceConnectorItem[] | undefined;
|
|
1807
3330
|
}
|
|
1808
3331
|
/**
|
|
1809
3332
|
* @public
|
|
1810
3333
|
*/
|
|
1811
3334
|
export interface UpdateVoiceConnectorGroupResponse {
|
|
3335
|
+
/**
|
|
3336
|
+
* <p>The updated Voice Connector group.</p>
|
|
3337
|
+
*/
|
|
1812
3338
|
VoiceConnectorGroup?: VoiceConnectorGroup;
|
|
1813
3339
|
}
|
|
1814
3340
|
/**
|
|
1815
3341
|
* @public
|
|
1816
3342
|
*/
|
|
1817
3343
|
export interface UpdateVoiceProfileRequest {
|
|
3344
|
+
/**
|
|
3345
|
+
* <p>The profile ID.</p>
|
|
3346
|
+
*/
|
|
1818
3347
|
VoiceProfileId: string | undefined;
|
|
3348
|
+
/**
|
|
3349
|
+
* <p>The ID of the speaker search task.</p>
|
|
3350
|
+
*/
|
|
1819
3351
|
SpeakerSearchTaskId: string | undefined;
|
|
1820
3352
|
}
|
|
1821
3353
|
/**
|
|
1822
3354
|
* @public
|
|
1823
3355
|
*/
|
|
1824
3356
|
export interface UpdateVoiceProfileResponse {
|
|
3357
|
+
/**
|
|
3358
|
+
* <p>The updated voice profile settings.</p>
|
|
3359
|
+
*/
|
|
1825
3360
|
VoiceProfile?: VoiceProfile;
|
|
1826
3361
|
}
|
|
1827
3362
|
/**
|
|
1828
3363
|
* @public
|
|
1829
3364
|
*/
|
|
1830
3365
|
export interface UpdateVoiceProfileDomainRequest {
|
|
3366
|
+
/**
|
|
3367
|
+
* <p>The domain ID.</p>
|
|
3368
|
+
*/
|
|
1831
3369
|
VoiceProfileDomainId: string | undefined;
|
|
3370
|
+
/**
|
|
3371
|
+
* <p>The name of the voice profile domain.</p>
|
|
3372
|
+
*/
|
|
1832
3373
|
Name?: string;
|
|
3374
|
+
/**
|
|
3375
|
+
* <p>The description of the voice profile domain.</p>
|
|
3376
|
+
*/
|
|
1833
3377
|
Description?: string;
|
|
1834
3378
|
}
|
|
1835
3379
|
/**
|
|
1836
3380
|
* @public
|
|
1837
3381
|
*/
|
|
1838
3382
|
export interface UpdateVoiceProfileDomainResponse {
|
|
3383
|
+
/**
|
|
3384
|
+
* <p>The updated details of the voice profile domain.</p>
|
|
3385
|
+
*/
|
|
1839
3386
|
VoiceProfileDomain?: VoiceProfileDomain;
|
|
1840
3387
|
}
|
|
1841
3388
|
/**
|
|
1842
3389
|
* @public
|
|
1843
3390
|
*/
|
|
1844
3391
|
export interface ValidateE911AddressRequest {
|
|
3392
|
+
/**
|
|
3393
|
+
* <p>The AWS account ID.</p>
|
|
3394
|
+
*/
|
|
1845
3395
|
AwsAccountId: string | undefined;
|
|
3396
|
+
/**
|
|
3397
|
+
* <p>The address street number, such as <code>200</code> or <code>2121</code>.</p>
|
|
3398
|
+
*/
|
|
1846
3399
|
StreetNumber: string | undefined;
|
|
3400
|
+
/**
|
|
3401
|
+
* <p>The address street information, such as <code>8th Avenue</code>.</p>
|
|
3402
|
+
*/
|
|
1847
3403
|
StreetInfo: string | undefined;
|
|
3404
|
+
/**
|
|
3405
|
+
* <p>The address city, such as <code>Portland</code>.</p>
|
|
3406
|
+
*/
|
|
1848
3407
|
City: string | undefined;
|
|
3408
|
+
/**
|
|
3409
|
+
* <p>The address state, such as <code>ME</code>.</p>
|
|
3410
|
+
*/
|
|
1849
3411
|
State: string | undefined;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>The country in the address being validated.</p>
|
|
3414
|
+
*/
|
|
1850
3415
|
Country: string | undefined;
|
|
3416
|
+
/**
|
|
3417
|
+
* <p>The dress postal code, such <code>04352</code>.</p>
|
|
3418
|
+
*/
|
|
1851
3419
|
PostalCode: string | undefined;
|
|
1852
3420
|
}
|
|
1853
3421
|
/**
|
|
1854
3422
|
* @public
|
|
1855
3423
|
*/
|
|
1856
3424
|
export interface ValidateE911AddressResponse {
|
|
3425
|
+
/**
|
|
3426
|
+
* <p>Number indicating the result of address validation. <code>0</code> means the
|
|
3427
|
+
* address was perfect as-is and successfully validated. <code>1</code> means the
|
|
3428
|
+
* address was corrected. <code>2</code> means the address sent was not close
|
|
3429
|
+
* enough and was not validated.</p>
|
|
3430
|
+
*/
|
|
1857
3431
|
ValidationResult?: number;
|
|
3432
|
+
/**
|
|
3433
|
+
* <p>The ID that represents the address.</p>
|
|
3434
|
+
*/
|
|
1858
3435
|
AddressExternalId?: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* <p>The validated address.</p>
|
|
3438
|
+
*/
|
|
1859
3439
|
Address?: Address;
|
|
3440
|
+
/**
|
|
3441
|
+
* <p>The list of address suggestions..</p>
|
|
3442
|
+
*/
|
|
1860
3443
|
CandidateAddressList?: CandidateAddress[];
|
|
1861
3444
|
}
|
|
1862
3445
|
/**
|