aws-sdk-chimesdkvoice 1.3.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkvoice/client.rb +610 -1
- data/lib/aws-sdk-chimesdkvoice/types.rb +756 -0
- data/lib/aws-sdk-chimesdkvoice.rb +1 -1
- metadata +2 -2
@@ -10,38 +10,53 @@
|
|
10
10
|
module Aws::ChimeSDKVoice
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# You don't have the permissions needed to run this action.
|
14
|
+
#
|
13
15
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AccessDeniedException AWS API Documentation
|
14
16
|
#
|
15
17
|
class AccessDeniedException < Aws::EmptyStructure; end
|
16
18
|
|
19
|
+
# A validated address.
|
20
|
+
#
|
17
21
|
# @!attribute [rw] street_name
|
22
|
+
# The address street, such as `8th Avenue`.
|
18
23
|
# @return [String]
|
19
24
|
#
|
20
25
|
# @!attribute [rw] street_suffix
|
26
|
+
# The address suffix, such as the `N` in `8th Avenue N`.
|
21
27
|
# @return [String]
|
22
28
|
#
|
23
29
|
# @!attribute [rw] post_directional
|
30
|
+
# An address suffix location, such as the `S. Unit A` in `Central Park
|
31
|
+
# S. Unit A`.
|
24
32
|
# @return [String]
|
25
33
|
#
|
26
34
|
# @!attribute [rw] pre_directional
|
35
|
+
# An address prefix location, such as the `N` in `N. Third St.`
|
27
36
|
# @return [String]
|
28
37
|
#
|
29
38
|
# @!attribute [rw] street_number
|
39
|
+
# The numeric portion of an address.
|
30
40
|
# @return [String]
|
31
41
|
#
|
32
42
|
# @!attribute [rw] city
|
43
|
+
# The city of an address.
|
33
44
|
# @return [String]
|
34
45
|
#
|
35
46
|
# @!attribute [rw] state
|
47
|
+
# The state of an address.
|
36
48
|
# @return [String]
|
37
49
|
#
|
38
50
|
# @!attribute [rw] postal_code
|
51
|
+
# The postal code of an address.
|
39
52
|
# @return [String]
|
40
53
|
#
|
41
54
|
# @!attribute [rw] postal_code_plus_4
|
55
|
+
# The zip + 4 or postal code + 4 of an address.
|
42
56
|
# @return [String]
|
43
57
|
#
|
44
58
|
# @!attribute [rw] country
|
59
|
+
# The country of an address.
|
45
60
|
# @return [String]
|
46
61
|
#
|
47
62
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Address AWS API Documentation
|
@@ -62,12 +77,18 @@ module Aws::ChimeSDKVoice
|
|
62
77
|
end
|
63
78
|
|
64
79
|
# @!attribute [rw] voice_connector_group_id
|
80
|
+
# The Amazon Chime SDK Voice Connector group ID.
|
65
81
|
# @return [String]
|
66
82
|
#
|
67
83
|
# @!attribute [rw] e164_phone_numbers
|
84
|
+
# List of phone numbers, in E.164 format.
|
68
85
|
# @return [Array<String>]
|
69
86
|
#
|
70
87
|
# @!attribute [rw] force_associate
|
88
|
+
# If true, associates the provided phone numbers with the provided
|
89
|
+
# Amazon Chime SDK Voice Connector Group and removes any previously
|
90
|
+
# existing associations. If false, does not associate any phone
|
91
|
+
# numbers that have previously existing associations.
|
71
92
|
# @return [Boolean]
|
72
93
|
#
|
73
94
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroupRequest AWS API Documentation
|
@@ -81,6 +102,9 @@ module Aws::ChimeSDKVoice
|
|
81
102
|
end
|
82
103
|
|
83
104
|
# @!attribute [rw] phone_number_errors
|
105
|
+
# If the action fails for one or more of the phone numbers in the
|
106
|
+
# request, a list of the phone numbers is returned, along with error
|
107
|
+
# codes and error messages.
|
84
108
|
# @return [Array<Types::PhoneNumberError>]
|
85
109
|
#
|
86
110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroupResponse AWS API Documentation
|
@@ -92,12 +116,18 @@ module Aws::ChimeSDKVoice
|
|
92
116
|
end
|
93
117
|
|
94
118
|
# @!attribute [rw] voice_connector_id
|
119
|
+
# The Voice Connector ID.
|
95
120
|
# @return [String]
|
96
121
|
#
|
97
122
|
# @!attribute [rw] e164_phone_numbers
|
123
|
+
# List of phone numbers, in E.164 format.
|
98
124
|
# @return [Array<String>]
|
99
125
|
#
|
100
126
|
# @!attribute [rw] force_associate
|
127
|
+
# If true, associates the provided phone numbers with the provided
|
128
|
+
# Amazon Chime SDK Voice Connector and removes any previously existing
|
129
|
+
# associations. If false, does not associate any phone numbers that
|
130
|
+
# have previously existing associations.
|
101
131
|
# @return [Boolean]
|
102
132
|
#
|
103
133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorRequest AWS API Documentation
|
@@ -111,6 +141,9 @@ module Aws::ChimeSDKVoice
|
|
111
141
|
end
|
112
142
|
|
113
143
|
# @!attribute [rw] phone_number_errors
|
144
|
+
# If the action fails for one or more of the phone numbers in the
|
145
|
+
# request, a list of the phone numbers is returned, along with error
|
146
|
+
# codes and error messages.
|
114
147
|
# @return [Array<Types::PhoneNumberError>]
|
115
148
|
#
|
116
149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorResponse AWS API Documentation
|
@@ -121,11 +154,14 @@ module Aws::ChimeSDKVoice
|
|
121
154
|
include Aws::Structure
|
122
155
|
end
|
123
156
|
|
157
|
+
# The input parameters don't match the service's restrictions.
|
158
|
+
#
|
124
159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BadRequestException AWS API Documentation
|
125
160
|
#
|
126
161
|
class BadRequestException < Aws::EmptyStructure; end
|
127
162
|
|
128
163
|
# @!attribute [rw] phone_number_ids
|
164
|
+
# List of phone number IDs.
|
129
165
|
# @return [Array<String>]
|
130
166
|
#
|
131
167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumberRequest AWS API Documentation
|
@@ -137,6 +173,9 @@ module Aws::ChimeSDKVoice
|
|
137
173
|
end
|
138
174
|
|
139
175
|
# @!attribute [rw] phone_number_errors
|
176
|
+
# If the action fails for one or more of the phone numbers in the
|
177
|
+
# request, a list of the phone numbers is returned, along with error
|
178
|
+
# codes and error messages.
|
140
179
|
# @return [Array<Types::PhoneNumberError>]
|
141
180
|
#
|
142
181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumberResponse AWS API Documentation
|
@@ -148,6 +187,7 @@ module Aws::ChimeSDKVoice
|
|
148
187
|
end
|
149
188
|
|
150
189
|
# @!attribute [rw] update_phone_number_request_items
|
190
|
+
# Lists the phone numbers in the update request.
|
151
191
|
# @return [Array<Types::UpdatePhoneNumberRequestItem>]
|
152
192
|
#
|
153
193
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumberRequest AWS API Documentation
|
@@ -159,6 +199,7 @@ module Aws::ChimeSDKVoice
|
|
159
199
|
end
|
160
200
|
|
161
201
|
# @!attribute [rw] phone_number_errors
|
202
|
+
# A list of failed phone numbers and their error messages.
|
162
203
|
# @return [Array<Types::PhoneNumberError>]
|
163
204
|
#
|
164
205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumberResponse AWS API Documentation
|
@@ -169,13 +210,18 @@ module Aws::ChimeSDKVoice
|
|
169
210
|
include Aws::Structure
|
170
211
|
end
|
171
212
|
|
213
|
+
# The details of an Amazon Chime SDK Voice Connector call.
|
214
|
+
#
|
172
215
|
# @!attribute [rw] voice_connector_id
|
216
|
+
# The Voice Connector ID.
|
173
217
|
# @return [String]
|
174
218
|
#
|
175
219
|
# @!attribute [rw] transaction_id
|
220
|
+
# The transaction ID of a Voice Connector call.
|
176
221
|
# @return [String]
|
177
222
|
#
|
178
223
|
# @!attribute [rw] is_caller
|
224
|
+
# Identifies a person as the caller or the callee.
|
179
225
|
# @return [Boolean]
|
180
226
|
#
|
181
227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CallDetails AWS API Documentation
|
@@ -188,25 +234,34 @@ module Aws::ChimeSDKVoice
|
|
188
234
|
include Aws::Structure
|
189
235
|
end
|
190
236
|
|
237
|
+
# A suggested address.
|
238
|
+
#
|
191
239
|
# @!attribute [rw] street_info
|
240
|
+
# The street information of the candidate address.
|
192
241
|
# @return [String]
|
193
242
|
#
|
194
243
|
# @!attribute [rw] street_number
|
244
|
+
# The numeric portion of the candidate address.
|
195
245
|
# @return [String]
|
196
246
|
#
|
197
247
|
# @!attribute [rw] city
|
248
|
+
# The city of the candidate address.
|
198
249
|
# @return [String]
|
199
250
|
#
|
200
251
|
# @!attribute [rw] state
|
252
|
+
# The state of the candidate address.
|
201
253
|
# @return [String]
|
202
254
|
#
|
203
255
|
# @!attribute [rw] postal_code
|
256
|
+
# The postal code of the candidate address.
|
204
257
|
# @return [String]
|
205
258
|
#
|
206
259
|
# @!attribute [rw] postal_code_plus_4
|
260
|
+
# The zip + 4 or postal code +4 of the candidate address.
|
207
261
|
# @return [String]
|
208
262
|
#
|
209
263
|
# @!attribute [rw] country
|
264
|
+
# The country of the candidate address.
|
210
265
|
# @return [String]
|
211
266
|
#
|
212
267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CandidateAddress AWS API Documentation
|
@@ -223,14 +278,18 @@ module Aws::ChimeSDKVoice
|
|
223
278
|
include Aws::Structure
|
224
279
|
end
|
225
280
|
|
281
|
+
# Multiple instances of the same request were made simultaneously.
|
282
|
+
#
|
226
283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ConflictException AWS API Documentation
|
227
284
|
#
|
228
285
|
class ConflictException < Aws::EmptyStructure; end
|
229
286
|
|
230
287
|
# @!attribute [rw] product_type
|
288
|
+
# The phone number product type.
|
231
289
|
# @return [String]
|
232
290
|
#
|
233
291
|
# @!attribute [rw] e164_phone_numbers
|
292
|
+
# List of phone numbers, in E.164 format.
|
234
293
|
# @return [Array<String>]
|
235
294
|
#
|
236
295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrderRequest AWS API Documentation
|
@@ -243,6 +302,7 @@ module Aws::ChimeSDKVoice
|
|
243
302
|
end
|
244
303
|
|
245
304
|
# @!attribute [rw] phone_number_order
|
305
|
+
# The phone number order details.
|
246
306
|
# @return [Types::PhoneNumberOrder]
|
247
307
|
#
|
248
308
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrderResponse AWS API Documentation
|
@@ -254,27 +314,37 @@ module Aws::ChimeSDKVoice
|
|
254
314
|
end
|
255
315
|
|
256
316
|
# @!attribute [rw] voice_connector_id
|
317
|
+
# The Voice Connector ID.
|
257
318
|
# @return [String]
|
258
319
|
#
|
259
320
|
# @!attribute [rw] participant_phone_numbers
|
321
|
+
# The participant phone numbers.
|
260
322
|
# @return [Array<String>]
|
261
323
|
#
|
262
324
|
# @!attribute [rw] name
|
325
|
+
# The name of the proxy session.
|
263
326
|
# @return [String]
|
264
327
|
#
|
265
328
|
# @!attribute [rw] expiry_minutes
|
329
|
+
# The number of minutes allowed for the proxy session.
|
266
330
|
# @return [Integer]
|
267
331
|
#
|
268
332
|
# @!attribute [rw] capabilities
|
333
|
+
# The proxy session's capabilities.
|
269
334
|
# @return [Array<String>]
|
270
335
|
#
|
271
336
|
# @!attribute [rw] number_selection_behavior
|
337
|
+
# The preference for proxy phone number reuse, or stickiness, between
|
338
|
+
# the same participants across sessions.
|
272
339
|
# @return [String]
|
273
340
|
#
|
274
341
|
# @!attribute [rw] geo_match_level
|
342
|
+
# The preference for matching the country or area code of the proxy
|
343
|
+
# phone number with that of the first participant.
|
275
344
|
# @return [String]
|
276
345
|
#
|
277
346
|
# @!attribute [rw] geo_match_params
|
347
|
+
# The country and area code for the proxy phone number.
|
278
348
|
# @return [Types::GeoMatchParams]
|
279
349
|
#
|
280
350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySessionRequest AWS API Documentation
|
@@ -293,6 +363,7 @@ module Aws::ChimeSDKVoice
|
|
293
363
|
end
|
294
364
|
|
295
365
|
# @!attribute [rw] proxy_session
|
366
|
+
# The proxy session details.
|
296
367
|
# @return [Types::ProxySession]
|
297
368
|
#
|
298
369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySessionResponse AWS API Documentation
|
@@ -304,18 +375,26 @@ module Aws::ChimeSDKVoice
|
|
304
375
|
end
|
305
376
|
|
306
377
|
# @!attribute [rw] from_phone_number
|
378
|
+
# The phone number that a user calls from. This is a phone number in
|
379
|
+
# your Amazon Chime SDK phone number inventory.
|
307
380
|
# @return [String]
|
308
381
|
#
|
309
382
|
# @!attribute [rw] to_phone_number
|
383
|
+
# The phone number that the service should call.
|
310
384
|
# @return [String]
|
311
385
|
#
|
312
386
|
# @!attribute [rw] sip_media_application_id
|
387
|
+
# The ID of the SIP media application.
|
313
388
|
# @return [String]
|
314
389
|
#
|
315
390
|
# @!attribute [rw] sip_headers
|
391
|
+
# The SIP headers added to an outbound call leg.
|
316
392
|
# @return [Hash<String,String>]
|
317
393
|
#
|
318
394
|
# @!attribute [rw] arguments_map
|
395
|
+
# Context passed to a CreateSipMediaApplication API call. For example,
|
396
|
+
# you could pass key-value pairs such as: `"FirstName": "John",
|
397
|
+
# "LastName": "Doe"`
|
319
398
|
# @return [Hash<String,String>]
|
320
399
|
#
|
321
400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCallRequest AWS API Documentation
|
@@ -331,6 +410,7 @@ module Aws::ChimeSDKVoice
|
|
331
410
|
end
|
332
411
|
|
333
412
|
# @!attribute [rw] sip_media_application_call
|
413
|
+
# The actual call.
|
334
414
|
# @return [Types::SipMediaApplicationCall]
|
335
415
|
#
|
336
416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCallResponse AWS API Documentation
|
@@ -342,12 +422,16 @@ module Aws::ChimeSDKVoice
|
|
342
422
|
end
|
343
423
|
|
344
424
|
# @!attribute [rw] aws_region
|
425
|
+
# The AWS Region assigned to the SIP media application.
|
345
426
|
# @return [String]
|
346
427
|
#
|
347
428
|
# @!attribute [rw] name
|
429
|
+
# The SIP media application's name.
|
348
430
|
# @return [String]
|
349
431
|
#
|
350
432
|
# @!attribute [rw] endpoints
|
433
|
+
# List of endpoints (Lambda ARNs) specified for the SIP media
|
434
|
+
# application.
|
351
435
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
352
436
|
#
|
353
437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationRequest AWS API Documentation
|
@@ -361,6 +445,7 @@ module Aws::ChimeSDKVoice
|
|
361
445
|
end
|
362
446
|
|
363
447
|
# @!attribute [rw] sip_media_application
|
448
|
+
# The SIP media application details.
|
364
449
|
# @return [Types::SipMediaApplication]
|
365
450
|
#
|
366
451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationResponse AWS API Documentation
|
@@ -372,18 +457,32 @@ module Aws::ChimeSDKVoice
|
|
372
457
|
end
|
373
458
|
|
374
459
|
# @!attribute [rw] name
|
460
|
+
# The name of the SIP rule.
|
375
461
|
# @return [String]
|
376
462
|
#
|
377
463
|
# @!attribute [rw] trigger_type
|
464
|
+
# The type of trigger assigned to the SIP rule in `TriggerValue`,
|
465
|
+
# currently `RequestUriHostname` or `ToPhoneNumber`.
|
378
466
|
# @return [String]
|
379
467
|
#
|
380
468
|
# @!attribute [rw] trigger_value
|
469
|
+
# If `TriggerType` is `RequestUriHostname`, the value can be the
|
470
|
+
# outbound host name of a Voice Connector. If `TriggerType` is
|
471
|
+
# `ToPhoneNumber`, the value can be a customer-owned phone number in
|
472
|
+
# the E164 format. The `SipMediaApplication` specified in the
|
473
|
+
# `SipRule` is triggered if the request URI in an incoming SIP request
|
474
|
+
# matches the `RequestUriHostname`, or if the `To` header in the
|
475
|
+
# incoming SIP request matches the `ToPhoneNumber` value.
|
381
476
|
# @return [String]
|
382
477
|
#
|
383
478
|
# @!attribute [rw] disabled
|
479
|
+
# Disables or enables a SIP rule. You must disable SIP rules before
|
480
|
+
# you can delete them.
|
384
481
|
# @return [Boolean]
|
385
482
|
#
|
386
483
|
# @!attribute [rw] target_applications
|
484
|
+
# List of SIP media applications, with priority and AWS Region. Only
|
485
|
+
# one SIP application per AWS Region can be used.
|
387
486
|
# @return [Array<Types::SipRuleTargetApplication>]
|
388
487
|
#
|
389
488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRuleRequest AWS API Documentation
|
@@ -399,6 +498,8 @@ module Aws::ChimeSDKVoice
|
|
399
498
|
end
|
400
499
|
|
401
500
|
# @!attribute [rw] sip_rule
|
501
|
+
# The SIP rule information, including the rule ID, triggers, and
|
502
|
+
# target applications.
|
402
503
|
# @return [Types::SipRule]
|
403
504
|
#
|
404
505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRuleResponse AWS API Documentation
|
@@ -410,9 +511,11 @@ module Aws::ChimeSDKVoice
|
|
410
511
|
end
|
411
512
|
|
412
513
|
# @!attribute [rw] name
|
514
|
+
# The name of the Voice Connector group.
|
413
515
|
# @return [String]
|
414
516
|
#
|
415
517
|
# @!attribute [rw] voice_connector_items
|
518
|
+
# Lists the Voice Connectors that inbound calls are routed to.
|
416
519
|
# @return [Array<Types::VoiceConnectorItem>]
|
417
520
|
#
|
418
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroupRequest AWS API Documentation
|
@@ -425,6 +528,7 @@ module Aws::ChimeSDKVoice
|
|
425
528
|
end
|
426
529
|
|
427
530
|
# @!attribute [rw] voice_connector_group
|
531
|
+
# The details of the Voice Connector group.
|
428
532
|
# @return [Types::VoiceConnectorGroup]
|
429
533
|
#
|
430
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroupResponse AWS API Documentation
|
@@ -436,12 +540,16 @@ module Aws::ChimeSDKVoice
|
|
436
540
|
end
|
437
541
|
|
438
542
|
# @!attribute [rw] name
|
543
|
+
# The name of the Voice Connector.
|
439
544
|
# @return [String]
|
440
545
|
#
|
441
546
|
# @!attribute [rw] aws_region
|
547
|
+
# The AWS Region in which the Amazon Chime SDK Voice Connector is
|
548
|
+
# created. Default value: `us-east-1` .
|
442
549
|
# @return [String]
|
443
550
|
#
|
444
551
|
# @!attribute [rw] require_encryption
|
552
|
+
# Enables or disables encryption for the Voice Connector.
|
445
553
|
# @return [Boolean]
|
446
554
|
#
|
447
555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorRequest AWS API Documentation
|
@@ -455,6 +563,7 @@ module Aws::ChimeSDKVoice
|
|
455
563
|
end
|
456
564
|
|
457
565
|
# @!attribute [rw] voice_connector
|
566
|
+
# The details of the Voice Connector.
|
458
567
|
# @return [Types::VoiceConnector]
|
459
568
|
#
|
460
569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorResponse AWS API Documentation
|
@@ -466,18 +575,24 @@ module Aws::ChimeSDKVoice
|
|
466
575
|
end
|
467
576
|
|
468
577
|
# @!attribute [rw] name
|
578
|
+
# The name of the voice profile domain.
|
469
579
|
# @return [String]
|
470
580
|
#
|
471
581
|
# @!attribute [rw] description
|
582
|
+
# A description of the voice profile domain.
|
472
583
|
# @return [String]
|
473
584
|
#
|
474
585
|
# @!attribute [rw] server_side_encryption_configuration
|
586
|
+
# The server-side encryption configuration for the request.
|
475
587
|
# @return [Types::ServerSideEncryptionConfiguration]
|
476
588
|
#
|
477
589
|
# @!attribute [rw] client_request_token
|
590
|
+
# The unique identifier for the client request. Use a different token
|
591
|
+
# for different domain creation requests.
|
478
592
|
# @return [String]
|
479
593
|
#
|
480
594
|
# @!attribute [rw] tags
|
595
|
+
# The tags assigned to the domain.
|
481
596
|
# @return [Array<Types::Tag>]
|
482
597
|
#
|
483
598
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomainRequest AWS API Documentation
|
@@ -493,6 +608,7 @@ module Aws::ChimeSDKVoice
|
|
493
608
|
end
|
494
609
|
|
495
610
|
# @!attribute [rw] voice_profile_domain
|
611
|
+
# The requested voice profile domain.
|
496
612
|
# @return [Types::VoiceProfileDomain]
|
497
613
|
#
|
498
614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomainResponse AWS API Documentation
|
@@ -504,6 +620,7 @@ module Aws::ChimeSDKVoice
|
|
504
620
|
end
|
505
621
|
|
506
622
|
# @!attribute [rw] speaker_search_task_id
|
623
|
+
# The ID of the speaker search task.
|
507
624
|
# @return [String]
|
508
625
|
#
|
509
626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileRequest AWS API Documentation
|
@@ -515,6 +632,7 @@ module Aws::ChimeSDKVoice
|
|
515
632
|
end
|
516
633
|
|
517
634
|
# @!attribute [rw] voice_profile
|
635
|
+
# The requested voice profile.
|
518
636
|
# @return [Types::VoiceProfile]
|
519
637
|
#
|
520
638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileResponse AWS API Documentation
|
@@ -525,10 +643,17 @@ module Aws::ChimeSDKVoice
|
|
525
643
|
include Aws::Structure
|
526
644
|
end
|
527
645
|
|
646
|
+
# The SIP credentials used to authenticate requests to an Amazon Chime
|
647
|
+
# SDK Voice Connector.
|
648
|
+
#
|
528
649
|
# @!attribute [rw] username
|
650
|
+
# The RFC2617 compliant user name associated with the SIP credentials,
|
651
|
+
# in US-ASCII format.
|
529
652
|
# @return [String]
|
530
653
|
#
|
531
654
|
# @!attribute [rw] password
|
655
|
+
# The RFC2617 compliant password associated with the SIP credentials,
|
656
|
+
# in US-ASCII format.
|
532
657
|
# @return [String]
|
533
658
|
#
|
534
659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Credential AWS API Documentation
|
@@ -540,13 +665,23 @@ module Aws::ChimeSDKVoice
|
|
540
665
|
include Aws::Structure
|
541
666
|
end
|
542
667
|
|
668
|
+
# The Dialed Number Identification Service (DNIS) emergency calling
|
669
|
+
# configuration details associated with an Amazon Chime SDK Voice
|
670
|
+
# Connector's emergency calling configuration.
|
671
|
+
#
|
543
672
|
# @!attribute [rw] emergency_phone_number
|
673
|
+
# The DNIS phone number that you route emergency calls to, in E.164
|
674
|
+
# format.
|
544
675
|
# @return [String]
|
545
676
|
#
|
546
677
|
# @!attribute [rw] test_phone_number
|
678
|
+
# The DNIS phone number for routing test emergency calls to, in E.164
|
679
|
+
# format.
|
547
680
|
# @return [String]
|
548
681
|
#
|
549
682
|
# @!attribute [rw] calling_country
|
683
|
+
# The country from which emergency calls are allowed, in ISO 3166-1
|
684
|
+
# alpha-2 format.
|
550
685
|
# @return [String]
|
551
686
|
#
|
552
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DNISEmergencyCallingConfiguration AWS API Documentation
|
@@ -560,6 +695,7 @@ module Aws::ChimeSDKVoice
|
|
560
695
|
end
|
561
696
|
|
562
697
|
# @!attribute [rw] phone_number_id
|
698
|
+
# The phone number ID.
|
563
699
|
# @return [String]
|
564
700
|
#
|
565
701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeletePhoneNumberRequest AWS API Documentation
|
@@ -571,9 +707,11 @@ module Aws::ChimeSDKVoice
|
|
571
707
|
end
|
572
708
|
|
573
709
|
# @!attribute [rw] voice_connector_id
|
710
|
+
# The Voice Connector ID.
|
574
711
|
# @return [String]
|
575
712
|
#
|
576
713
|
# @!attribute [rw] proxy_session_id
|
714
|
+
# The proxy session ID.
|
577
715
|
# @return [String]
|
578
716
|
#
|
579
717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteProxySessionRequest AWS API Documentation
|
@@ -586,6 +724,7 @@ module Aws::ChimeSDKVoice
|
|
586
724
|
end
|
587
725
|
|
588
726
|
# @!attribute [rw] sip_media_application_id
|
727
|
+
# The SIP media application ID.
|
589
728
|
# @return [String]
|
590
729
|
#
|
591
730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipMediaApplicationRequest AWS API Documentation
|
@@ -597,6 +736,7 @@ module Aws::ChimeSDKVoice
|
|
597
736
|
end
|
598
737
|
|
599
738
|
# @!attribute [rw] sip_rule_id
|
739
|
+
# The SIP rule ID.
|
600
740
|
# @return [String]
|
601
741
|
#
|
602
742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipRuleRequest AWS API Documentation
|
@@ -608,6 +748,7 @@ module Aws::ChimeSDKVoice
|
|
608
748
|
end
|
609
749
|
|
610
750
|
# @!attribute [rw] voice_connector_id
|
751
|
+
# The Voice Connector ID.
|
611
752
|
# @return [String]
|
612
753
|
#
|
613
754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -619,6 +760,7 @@ module Aws::ChimeSDKVoice
|
|
619
760
|
end
|
620
761
|
|
621
762
|
# @!attribute [rw] voice_connector_group_id
|
763
|
+
# The Voice Connector Group ID.
|
622
764
|
# @return [String]
|
623
765
|
#
|
624
766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroupRequest AWS API Documentation
|
@@ -630,6 +772,7 @@ module Aws::ChimeSDKVoice
|
|
630
772
|
end
|
631
773
|
|
632
774
|
# @!attribute [rw] voice_connector_id
|
775
|
+
# The Voice Connector ID.
|
633
776
|
# @return [String]
|
634
777
|
#
|
635
778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -641,6 +784,7 @@ module Aws::ChimeSDKVoice
|
|
641
784
|
end
|
642
785
|
|
643
786
|
# @!attribute [rw] voice_connector_id
|
787
|
+
# The Voice Connector ID.
|
644
788
|
# @return [String]
|
645
789
|
#
|
646
790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxyRequest AWS API Documentation
|
@@ -652,6 +796,7 @@ module Aws::ChimeSDKVoice
|
|
652
796
|
end
|
653
797
|
|
654
798
|
# @!attribute [rw] voice_connector_id
|
799
|
+
# The Voice Connector ID.
|
655
800
|
# @return [String]
|
656
801
|
#
|
657
802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorRequest AWS API Documentation
|
@@ -663,6 +808,7 @@ module Aws::ChimeSDKVoice
|
|
663
808
|
end
|
664
809
|
|
665
810
|
# @!attribute [rw] voice_connector_id
|
811
|
+
# The Voice Connector ID.
|
666
812
|
# @return [String]
|
667
813
|
#
|
668
814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -674,9 +820,12 @@ module Aws::ChimeSDKVoice
|
|
674
820
|
end
|
675
821
|
|
676
822
|
# @!attribute [rw] voice_connector_id
|
823
|
+
# The Voice Connector ID.
|
677
824
|
# @return [String]
|
678
825
|
#
|
679
826
|
# @!attribute [rw] usernames
|
827
|
+
# The RFC2617 compliant username associated with the SIP credentials,
|
828
|
+
# in US-ASCII format.
|
680
829
|
# @return [Array<String>]
|
681
830
|
#
|
682
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -689,6 +838,7 @@ module Aws::ChimeSDKVoice
|
|
689
838
|
end
|
690
839
|
|
691
840
|
# @!attribute [rw] voice_connector_id
|
841
|
+
# The Voice Connector ID.
|
692
842
|
# @return [String]
|
693
843
|
#
|
694
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -700,6 +850,7 @@ module Aws::ChimeSDKVoice
|
|
700
850
|
end
|
701
851
|
|
702
852
|
# @!attribute [rw] voice_profile_domain_id
|
853
|
+
# The voice profile domain ID.
|
703
854
|
# @return [String]
|
704
855
|
#
|
705
856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomainRequest AWS API Documentation
|
@@ -711,6 +862,7 @@ module Aws::ChimeSDKVoice
|
|
711
862
|
end
|
712
863
|
|
713
864
|
# @!attribute [rw] voice_profile_id
|
865
|
+
# The voice profile ID.
|
714
866
|
# @return [String]
|
715
867
|
#
|
716
868
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileRequest AWS API Documentation
|
@@ -722,9 +874,11 @@ module Aws::ChimeSDKVoice
|
|
722
874
|
end
|
723
875
|
|
724
876
|
# @!attribute [rw] voice_connector_group_id
|
877
|
+
# The Voice Connector group ID.
|
725
878
|
# @return [String]
|
726
879
|
#
|
727
880
|
# @!attribute [rw] e164_phone_numbers
|
881
|
+
# The list of phone numbers, in E.164 format.
|
728
882
|
# @return [Array<String>]
|
729
883
|
#
|
730
884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroupRequest AWS API Documentation
|
@@ -737,6 +891,9 @@ module Aws::ChimeSDKVoice
|
|
737
891
|
end
|
738
892
|
|
739
893
|
# @!attribute [rw] phone_number_errors
|
894
|
+
# If the action fails for one or more of the phone numbers in the
|
895
|
+
# request, a list of the phone numbers is returned, along with error
|
896
|
+
# codes and error messages.
|
740
897
|
# @return [Array<Types::PhoneNumberError>]
|
741
898
|
#
|
742
899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroupResponse AWS API Documentation
|
@@ -748,9 +905,11 @@ module Aws::ChimeSDKVoice
|
|
748
905
|
end
|
749
906
|
|
750
907
|
# @!attribute [rw] voice_connector_id
|
908
|
+
# The Voice Connector ID.
|
751
909
|
# @return [String]
|
752
910
|
#
|
753
911
|
# @!attribute [rw] e164_phone_numbers
|
912
|
+
# List of phone numbers, in E.164 format.
|
754
913
|
# @return [Array<String>]
|
755
914
|
#
|
756
915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorRequest AWS API Documentation
|
@@ -763,6 +922,9 @@ module Aws::ChimeSDKVoice
|
|
763
922
|
end
|
764
923
|
|
765
924
|
# @!attribute [rw] phone_number_errors
|
925
|
+
# If the action fails for one or more of the phone numbers in the
|
926
|
+
# request, a list of the phone numbers is returned, along with error
|
927
|
+
# codes and error messages.
|
766
928
|
# @return [Array<Types::PhoneNumberError>]
|
767
929
|
#
|
768
930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorResponse AWS API Documentation
|
@@ -773,7 +935,12 @@ module Aws::ChimeSDKVoice
|
|
773
935
|
include Aws::Structure
|
774
936
|
end
|
775
937
|
|
938
|
+
# The emergency calling configuration details associated with an Amazon
|
939
|
+
# Chime SDK Voice Connector.
|
940
|
+
#
|
776
941
|
# @!attribute [rw] dnis
|
942
|
+
# The Dialed Number Identification Service (DNIS) emergency calling
|
943
|
+
# configuration details.
|
777
944
|
# @return [Array<Types::DNISEmergencyCallingConfiguration>]
|
778
945
|
#
|
779
946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/EmergencyCallingConfiguration AWS API Documentation
|
@@ -784,14 +951,21 @@ module Aws::ChimeSDKVoice
|
|
784
951
|
include Aws::Structure
|
785
952
|
end
|
786
953
|
|
954
|
+
# The client is permanently forbidden from making the request.
|
955
|
+
#
|
787
956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ForbiddenException AWS API Documentation
|
788
957
|
#
|
789
958
|
class ForbiddenException < Aws::EmptyStructure; end
|
790
959
|
|
960
|
+
# The country and area code for a proxy phone number in a proxy phone
|
961
|
+
# session.
|
962
|
+
#
|
791
963
|
# @!attribute [rw] country
|
964
|
+
# The country.
|
792
965
|
# @return [String]
|
793
966
|
#
|
794
967
|
# @!attribute [rw] area_code
|
968
|
+
# The area code.
|
795
969
|
# @return [String]
|
796
970
|
#
|
797
971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GeoMatchParams AWS API Documentation
|
@@ -804,6 +978,7 @@ module Aws::ChimeSDKVoice
|
|
804
978
|
end
|
805
979
|
|
806
980
|
# @!attribute [rw] voice_connector
|
981
|
+
# The Voice Connector settings.
|
807
982
|
# @return [Types::VoiceConnectorSettings]
|
808
983
|
#
|
809
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetGlobalSettingsResponse AWS API Documentation
|
@@ -815,6 +990,7 @@ module Aws::ChimeSDKVoice
|
|
815
990
|
end
|
816
991
|
|
817
992
|
# @!attribute [rw] phone_number_order_id
|
993
|
+
# The ID of the phone number order .
|
818
994
|
# @return [String]
|
819
995
|
#
|
820
996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrderRequest AWS API Documentation
|
@@ -826,6 +1002,7 @@ module Aws::ChimeSDKVoice
|
|
826
1002
|
end
|
827
1003
|
|
828
1004
|
# @!attribute [rw] phone_number_order
|
1005
|
+
# The phone number order details.
|
829
1006
|
# @return [Types::PhoneNumberOrder]
|
830
1007
|
#
|
831
1008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrderResponse AWS API Documentation
|
@@ -837,6 +1014,7 @@ module Aws::ChimeSDKVoice
|
|
837
1014
|
end
|
838
1015
|
|
839
1016
|
# @!attribute [rw] phone_number_id
|
1017
|
+
# The phone number ID.
|
840
1018
|
# @return [String]
|
841
1019
|
#
|
842
1020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberRequest AWS API Documentation
|
@@ -848,6 +1026,7 @@ module Aws::ChimeSDKVoice
|
|
848
1026
|
end
|
849
1027
|
|
850
1028
|
# @!attribute [rw] phone_number
|
1029
|
+
# The phone number details.
|
851
1030
|
# @return [Types::PhoneNumber]
|
852
1031
|
#
|
853
1032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberResponse AWS API Documentation
|
@@ -859,9 +1038,11 @@ module Aws::ChimeSDKVoice
|
|
859
1038
|
end
|
860
1039
|
|
861
1040
|
# @!attribute [rw] calling_name
|
1041
|
+
# The default outbound calling name for the account.
|
862
1042
|
# @return [String]
|
863
1043
|
#
|
864
1044
|
# @!attribute [rw] calling_name_updated_timestamp
|
1045
|
+
# The updated outbound calling name timestamp, in ISO 8601 format.
|
865
1046
|
# @return [Time]
|
866
1047
|
#
|
867
1048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberSettingsResponse AWS API Documentation
|
@@ -874,9 +1055,11 @@ module Aws::ChimeSDKVoice
|
|
874
1055
|
end
|
875
1056
|
|
876
1057
|
# @!attribute [rw] voice_connector_id
|
1058
|
+
# The Voice Connector ID.
|
877
1059
|
# @return [String]
|
878
1060
|
#
|
879
1061
|
# @!attribute [rw] proxy_session_id
|
1062
|
+
# The proxy session ID.
|
880
1063
|
# @return [String]
|
881
1064
|
#
|
882
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySessionRequest AWS API Documentation
|
@@ -889,6 +1072,7 @@ module Aws::ChimeSDKVoice
|
|
889
1072
|
end
|
890
1073
|
|
891
1074
|
# @!attribute [rw] proxy_session
|
1075
|
+
# The proxy session details.
|
892
1076
|
# @return [Types::ProxySession]
|
893
1077
|
#
|
894
1078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySessionResponse AWS API Documentation
|
@@ -900,6 +1084,7 @@ module Aws::ChimeSDKVoice
|
|
900
1084
|
end
|
901
1085
|
|
902
1086
|
# @!attribute [rw] sip_media_application_id
|
1087
|
+
# The SIP media application ID.
|
903
1088
|
# @return [String]
|
904
1089
|
#
|
905
1090
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfigurationRequest AWS API Documentation
|
@@ -911,6 +1096,7 @@ module Aws::ChimeSDKVoice
|
|
911
1096
|
end
|
912
1097
|
|
913
1098
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
1099
|
+
# Returns the Alexa Skill configuration.
|
914
1100
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
915
1101
|
#
|
916
1102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfigurationResponse AWS API Documentation
|
@@ -922,6 +1108,7 @@ module Aws::ChimeSDKVoice
|
|
922
1108
|
end
|
923
1109
|
|
924
1110
|
# @!attribute [rw] sip_media_application_id
|
1111
|
+
# The SIP media application ID.
|
925
1112
|
# @return [String]
|
926
1113
|
#
|
927
1114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
|
@@ -933,6 +1120,7 @@ module Aws::ChimeSDKVoice
|
|
933
1120
|
end
|
934
1121
|
|
935
1122
|
# @!attribute [rw] sip_media_application_logging_configuration
|
1123
|
+
# The actual logging configuration.
|
936
1124
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
937
1125
|
#
|
938
1126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
|
@@ -944,6 +1132,7 @@ module Aws::ChimeSDKVoice
|
|
944
1132
|
end
|
945
1133
|
|
946
1134
|
# @!attribute [rw] sip_media_application_id
|
1135
|
+
# The SIP media application ID .
|
947
1136
|
# @return [String]
|
948
1137
|
#
|
949
1138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationRequest AWS API Documentation
|
@@ -955,6 +1144,7 @@ module Aws::ChimeSDKVoice
|
|
955
1144
|
end
|
956
1145
|
|
957
1146
|
# @!attribute [rw] sip_media_application
|
1147
|
+
# The details of the SIP media application.
|
958
1148
|
# @return [Types::SipMediaApplication]
|
959
1149
|
#
|
960
1150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationResponse AWS API Documentation
|
@@ -966,6 +1156,7 @@ module Aws::ChimeSDKVoice
|
|
966
1156
|
end
|
967
1157
|
|
968
1158
|
# @!attribute [rw] sip_rule_id
|
1159
|
+
# The SIP rule ID.
|
969
1160
|
# @return [String]
|
970
1161
|
#
|
971
1162
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRuleRequest AWS API Documentation
|
@@ -977,6 +1168,7 @@ module Aws::ChimeSDKVoice
|
|
977
1168
|
end
|
978
1169
|
|
979
1170
|
# @!attribute [rw] sip_rule
|
1171
|
+
# The SIP rule details.
|
980
1172
|
# @return [Types::SipRule]
|
981
1173
|
#
|
982
1174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRuleResponse AWS API Documentation
|
@@ -988,9 +1180,11 @@ module Aws::ChimeSDKVoice
|
|
988
1180
|
end
|
989
1181
|
|
990
1182
|
# @!attribute [rw] voice_connector_id
|
1183
|
+
# The Voice Connector ID.
|
991
1184
|
# @return [String]
|
992
1185
|
#
|
993
1186
|
# @!attribute [rw] speaker_search_task_id
|
1187
|
+
# The ID of the speaker search task.
|
994
1188
|
# @return [String]
|
995
1189
|
#
|
996
1190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTaskRequest AWS API Documentation
|
@@ -1003,6 +1197,7 @@ module Aws::ChimeSDKVoice
|
|
1003
1197
|
end
|
1004
1198
|
|
1005
1199
|
# @!attribute [rw] speaker_search_task
|
1200
|
+
# The details of the speaker search task.
|
1006
1201
|
# @return [Types::SpeakerSearchTask]
|
1007
1202
|
#
|
1008
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTaskResponse AWS API Documentation
|
@@ -1014,6 +1209,7 @@ module Aws::ChimeSDKVoice
|
|
1014
1209
|
end
|
1015
1210
|
|
1016
1211
|
# @!attribute [rw] voice_connector_id
|
1212
|
+
# The Voice Connector ID.
|
1017
1213
|
# @return [String]
|
1018
1214
|
#
|
1019
1215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -1025,6 +1221,7 @@ module Aws::ChimeSDKVoice
|
|
1025
1221
|
end
|
1026
1222
|
|
1027
1223
|
# @!attribute [rw] emergency_calling_configuration
|
1224
|
+
# The details of the emergency calling configuration.
|
1028
1225
|
# @return [Types::EmergencyCallingConfiguration]
|
1029
1226
|
#
|
1030
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfigurationResponse AWS API Documentation
|
@@ -1036,6 +1233,7 @@ module Aws::ChimeSDKVoice
|
|
1036
1233
|
end
|
1037
1234
|
|
1038
1235
|
# @!attribute [rw] voice_connector_group_id
|
1236
|
+
# The Voice Connector group ID.
|
1039
1237
|
# @return [String]
|
1040
1238
|
#
|
1041
1239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroupRequest AWS API Documentation
|
@@ -1047,6 +1245,7 @@ module Aws::ChimeSDKVoice
|
|
1047
1245
|
end
|
1048
1246
|
|
1049
1247
|
# @!attribute [rw] voice_connector_group
|
1248
|
+
# The details of the Voice Connector group.
|
1050
1249
|
# @return [Types::VoiceConnectorGroup]
|
1051
1250
|
#
|
1052
1251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroupResponse AWS API Documentation
|
@@ -1058,6 +1257,7 @@ module Aws::ChimeSDKVoice
|
|
1058
1257
|
end
|
1059
1258
|
|
1060
1259
|
# @!attribute [rw] voice_connector_id
|
1260
|
+
# The Voice Connector ID.
|
1061
1261
|
# @return [String]
|
1062
1262
|
#
|
1063
1263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfigurationRequest AWS API Documentation
|
@@ -1069,6 +1269,7 @@ module Aws::ChimeSDKVoice
|
|
1069
1269
|
end
|
1070
1270
|
|
1071
1271
|
# @!attribute [rw] logging_configuration
|
1272
|
+
# The logging configuration details .
|
1072
1273
|
# @return [Types::LoggingConfiguration]
|
1073
1274
|
#
|
1074
1275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfigurationResponse AWS API Documentation
|
@@ -1080,6 +1281,7 @@ module Aws::ChimeSDKVoice
|
|
1080
1281
|
end
|
1081
1282
|
|
1082
1283
|
# @!attribute [rw] voice_connector_id
|
1284
|
+
# The Voice Connector ID.
|
1083
1285
|
# @return [String]
|
1084
1286
|
#
|
1085
1287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -1091,6 +1293,7 @@ module Aws::ChimeSDKVoice
|
|
1091
1293
|
end
|
1092
1294
|
|
1093
1295
|
# @!attribute [rw] origination
|
1296
|
+
# The origination setting details.
|
1094
1297
|
# @return [Types::Origination]
|
1095
1298
|
#
|
1096
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOriginationResponse AWS API Documentation
|
@@ -1102,6 +1305,7 @@ module Aws::ChimeSDKVoice
|
|
1102
1305
|
end
|
1103
1306
|
|
1104
1307
|
# @!attribute [rw] voice_connector_id
|
1308
|
+
# The Voice Connector ID.
|
1105
1309
|
# @return [String]
|
1106
1310
|
#
|
1107
1311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxyRequest AWS API Documentation
|
@@ -1113,6 +1317,7 @@ module Aws::ChimeSDKVoice
|
|
1113
1317
|
end
|
1114
1318
|
|
1115
1319
|
# @!attribute [rw] proxy
|
1320
|
+
# The proxy configuration details.
|
1116
1321
|
# @return [Types::Proxy]
|
1117
1322
|
#
|
1118
1323
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxyResponse AWS API Documentation
|
@@ -1124,6 +1329,7 @@ module Aws::ChimeSDKVoice
|
|
1124
1329
|
end
|
1125
1330
|
|
1126
1331
|
# @!attribute [rw] voice_connector_id
|
1332
|
+
# The Voice Connector ID.
|
1127
1333
|
# @return [String]
|
1128
1334
|
#
|
1129
1335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorRequest AWS API Documentation
|
@@ -1135,6 +1341,7 @@ module Aws::ChimeSDKVoice
|
|
1135
1341
|
end
|
1136
1342
|
|
1137
1343
|
# @!attribute [rw] voice_connector
|
1344
|
+
# The Voice Connector details.
|
1138
1345
|
# @return [Types::VoiceConnector]
|
1139
1346
|
#
|
1140
1347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorResponse AWS API Documentation
|
@@ -1146,6 +1353,7 @@ module Aws::ChimeSDKVoice
|
|
1146
1353
|
end
|
1147
1354
|
|
1148
1355
|
# @!attribute [rw] voice_connector_id
|
1356
|
+
# The Voice Connector ID.
|
1149
1357
|
# @return [String]
|
1150
1358
|
#
|
1151
1359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -1157,6 +1365,7 @@ module Aws::ChimeSDKVoice
|
|
1157
1365
|
end
|
1158
1366
|
|
1159
1367
|
# @!attribute [rw] streaming_configuration
|
1368
|
+
# The details of the streaming configuration.
|
1160
1369
|
# @return [Types::StreamingConfiguration]
|
1161
1370
|
#
|
1162
1371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfigurationResponse AWS API Documentation
|
@@ -1168,6 +1377,7 @@ module Aws::ChimeSDKVoice
|
|
1168
1377
|
end
|
1169
1378
|
|
1170
1379
|
# @!attribute [rw] voice_connector_id
|
1380
|
+
# The Voice Connector ID.
|
1171
1381
|
# @return [String]
|
1172
1382
|
#
|
1173
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealthRequest AWS API Documentation
|
@@ -1179,6 +1389,7 @@ module Aws::ChimeSDKVoice
|
|
1179
1389
|
end
|
1180
1390
|
|
1181
1391
|
# @!attribute [rw] termination_health
|
1392
|
+
# The termination health details.
|
1182
1393
|
# @return [Types::TerminationHealth]
|
1183
1394
|
#
|
1184
1395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealthResponse AWS API Documentation
|
@@ -1190,6 +1401,7 @@ module Aws::ChimeSDKVoice
|
|
1190
1401
|
end
|
1191
1402
|
|
1192
1403
|
# @!attribute [rw] voice_connector_id
|
1404
|
+
# The Voice Connector ID.
|
1193
1405
|
# @return [String]
|
1194
1406
|
#
|
1195
1407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -1201,6 +1413,7 @@ module Aws::ChimeSDKVoice
|
|
1201
1413
|
end
|
1202
1414
|
|
1203
1415
|
# @!attribute [rw] termination
|
1416
|
+
# The termination setting details.
|
1204
1417
|
# @return [Types::Termination]
|
1205
1418
|
#
|
1206
1419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationResponse AWS API Documentation
|
@@ -1212,6 +1425,7 @@ module Aws::ChimeSDKVoice
|
|
1212
1425
|
end
|
1213
1426
|
|
1214
1427
|
# @!attribute [rw] voice_profile_domain_id
|
1428
|
+
# The voice profile domain ID.
|
1215
1429
|
# @return [String]
|
1216
1430
|
#
|
1217
1431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomainRequest AWS API Documentation
|
@@ -1223,6 +1437,7 @@ module Aws::ChimeSDKVoice
|
|
1223
1437
|
end
|
1224
1438
|
|
1225
1439
|
# @!attribute [rw] voice_profile_domain
|
1440
|
+
# The details of the voice profile domain.
|
1226
1441
|
# @return [Types::VoiceProfileDomain]
|
1227
1442
|
#
|
1228
1443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomainResponse AWS API Documentation
|
@@ -1234,6 +1449,7 @@ module Aws::ChimeSDKVoice
|
|
1234
1449
|
end
|
1235
1450
|
|
1236
1451
|
# @!attribute [rw] voice_profile_id
|
1452
|
+
# The voice profile ID.
|
1237
1453
|
# @return [String]
|
1238
1454
|
#
|
1239
1455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileRequest AWS API Documentation
|
@@ -1245,6 +1461,7 @@ module Aws::ChimeSDKVoice
|
|
1245
1461
|
end
|
1246
1462
|
|
1247
1463
|
# @!attribute [rw] voice_profile
|
1464
|
+
# The voice profile details.
|
1248
1465
|
# @return [Types::VoiceProfile]
|
1249
1466
|
#
|
1250
1467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileResponse AWS API Documentation
|
@@ -1256,12 +1473,16 @@ module Aws::ChimeSDKVoice
|
|
1256
1473
|
end
|
1257
1474
|
|
1258
1475
|
# @!attribute [rw] voice_connector_id
|
1476
|
+
# The Voice Connector ID.
|
1259
1477
|
# @return [String]
|
1260
1478
|
#
|
1261
1479
|
# @!attribute [rw] voice_tone_analysis_task_id
|
1480
|
+
# The ID of the voice tone anlysis task.
|
1262
1481
|
# @return [String]
|
1263
1482
|
#
|
1264
1483
|
# @!attribute [rw] is_caller
|
1484
|
+
# Specifies whether the voice being analyzed is the caller
|
1485
|
+
# (originator) or the callee (responder).
|
1265
1486
|
# @return [Boolean]
|
1266
1487
|
#
|
1267
1488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTaskRequest AWS API Documentation
|
@@ -1275,6 +1496,7 @@ module Aws::ChimeSDKVoice
|
|
1275
1496
|
end
|
1276
1497
|
|
1277
1498
|
# @!attribute [rw] voice_tone_analysis_task
|
1499
|
+
# The details of the voice tone analysis task.
|
1278
1500
|
# @return [Types::VoiceToneAnalysisTask]
|
1279
1501
|
#
|
1280
1502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTaskResponse AWS API Documentation
|
@@ -1285,11 +1507,15 @@ module Aws::ChimeSDKVoice
|
|
1285
1507
|
include Aws::Structure
|
1286
1508
|
end
|
1287
1509
|
|
1510
|
+
# Access to the target resource is no longer available at the origin
|
1511
|
+
# server. This condition is likely to be permanent.
|
1512
|
+
#
|
1288
1513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GoneException AWS API Documentation
|
1289
1514
|
#
|
1290
1515
|
class GoneException < Aws::EmptyStructure; end
|
1291
1516
|
|
1292
1517
|
# @!attribute [rw] voice_connector_regions
|
1518
|
+
# The list of AWS Regions.
|
1293
1519
|
# @return [Array<String>]
|
1294
1520
|
#
|
1295
1521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegionsResponse AWS API Documentation
|
@@ -1301,9 +1527,11 @@ module Aws::ChimeSDKVoice
|
|
1301
1527
|
end
|
1302
1528
|
|
1303
1529
|
# @!attribute [rw] next_token
|
1530
|
+
# The token used to retrieve the next page of results.
|
1304
1531
|
# @return [String]
|
1305
1532
|
#
|
1306
1533
|
# @!attribute [rw] max_results
|
1534
|
+
# The maximum number of results to return in a single call.
|
1307
1535
|
# @return [Integer]
|
1308
1536
|
#
|
1309
1537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrdersRequest AWS API Documentation
|
@@ -1316,9 +1544,11 @@ module Aws::ChimeSDKVoice
|
|
1316
1544
|
end
|
1317
1545
|
|
1318
1546
|
# @!attribute [rw] phone_number_orders
|
1547
|
+
# The phone number order details.
|
1319
1548
|
# @return [Array<Types::PhoneNumberOrder>]
|
1320
1549
|
#
|
1321
1550
|
# @!attribute [rw] next_token
|
1551
|
+
# The token used to retrieve the next page of results.
|
1322
1552
|
# @return [String]
|
1323
1553
|
#
|
1324
1554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrdersResponse AWS API Documentation
|
@@ -1331,21 +1561,27 @@ module Aws::ChimeSDKVoice
|
|
1331
1561
|
end
|
1332
1562
|
|
1333
1563
|
# @!attribute [rw] status
|
1564
|
+
# The status of your organization's phone numbers.
|
1334
1565
|
# @return [String]
|
1335
1566
|
#
|
1336
1567
|
# @!attribute [rw] product_type
|
1568
|
+
# The phone number product types.
|
1337
1569
|
# @return [String]
|
1338
1570
|
#
|
1339
1571
|
# @!attribute [rw] filter_name
|
1572
|
+
# The filter to limit the number of results.
|
1340
1573
|
# @return [String]
|
1341
1574
|
#
|
1342
1575
|
# @!attribute [rw] filter_value
|
1576
|
+
# The filter value.
|
1343
1577
|
# @return [String]
|
1344
1578
|
#
|
1345
1579
|
# @!attribute [rw] max_results
|
1580
|
+
# The maximum number of results to return in a single call.
|
1346
1581
|
# @return [Integer]
|
1347
1582
|
#
|
1348
1583
|
# @!attribute [rw] next_token
|
1584
|
+
# The token used to return the next page of results.
|
1349
1585
|
# @return [String]
|
1350
1586
|
#
|
1351
1587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbersRequest AWS API Documentation
|
@@ -1362,9 +1598,11 @@ module Aws::ChimeSDKVoice
|
|
1362
1598
|
end
|
1363
1599
|
|
1364
1600
|
# @!attribute [rw] phone_numbers
|
1601
|
+
# The phone number details.
|
1365
1602
|
# @return [Array<Types::PhoneNumber>]
|
1366
1603
|
#
|
1367
1604
|
# @!attribute [rw] next_token
|
1605
|
+
# The token used to return the next page of results.
|
1368
1606
|
# @return [String]
|
1369
1607
|
#
|
1370
1608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbersResponse AWS API Documentation
|
@@ -1377,15 +1615,19 @@ module Aws::ChimeSDKVoice
|
|
1377
1615
|
end
|
1378
1616
|
|
1379
1617
|
# @!attribute [rw] voice_connector_id
|
1618
|
+
# The Voice Connector ID.
|
1380
1619
|
# @return [String]
|
1381
1620
|
#
|
1382
1621
|
# @!attribute [rw] status
|
1622
|
+
# The proxy session status.
|
1383
1623
|
# @return [String]
|
1384
1624
|
#
|
1385
1625
|
# @!attribute [rw] next_token
|
1626
|
+
# The token used to retrieve the next page of results.
|
1386
1627
|
# @return [String]
|
1387
1628
|
#
|
1388
1629
|
# @!attribute [rw] max_results
|
1630
|
+
# The maximum number of results to return in a single call.
|
1389
1631
|
# @return [Integer]
|
1390
1632
|
#
|
1391
1633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessionsRequest AWS API Documentation
|
@@ -1400,9 +1642,11 @@ module Aws::ChimeSDKVoice
|
|
1400
1642
|
end
|
1401
1643
|
|
1402
1644
|
# @!attribute [rw] proxy_sessions
|
1645
|
+
# The proxy sessions' details.
|
1403
1646
|
# @return [Array<Types::ProxySession>]
|
1404
1647
|
#
|
1405
1648
|
# @!attribute [rw] next_token
|
1649
|
+
# The token used to retrieve the next page of results.
|
1406
1650
|
# @return [String]
|
1407
1651
|
#
|
1408
1652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessionsResponse AWS API Documentation
|
@@ -1415,9 +1659,12 @@ module Aws::ChimeSDKVoice
|
|
1415
1659
|
end
|
1416
1660
|
|
1417
1661
|
# @!attribute [rw] max_results
|
1662
|
+
# The maximum number of results to return in a single call. Defaults
|
1663
|
+
# to 100.
|
1418
1664
|
# @return [Integer]
|
1419
1665
|
#
|
1420
1666
|
# @!attribute [rw] next_token
|
1667
|
+
# The token used to return the next page of results.
|
1421
1668
|
# @return [String]
|
1422
1669
|
#
|
1423
1670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplicationsRequest AWS API Documentation
|
@@ -1430,9 +1677,11 @@ module Aws::ChimeSDKVoice
|
|
1430
1677
|
end
|
1431
1678
|
|
1432
1679
|
# @!attribute [rw] sip_media_applications
|
1680
|
+
# The list of SIP media applications and application details.
|
1433
1681
|
# @return [Array<Types::SipMediaApplication>]
|
1434
1682
|
#
|
1435
1683
|
# @!attribute [rw] next_token
|
1684
|
+
# The token used to return the next page of results.
|
1436
1685
|
# @return [String]
|
1437
1686
|
#
|
1438
1687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplicationsResponse AWS API Documentation
|
@@ -1445,12 +1694,16 @@ module Aws::ChimeSDKVoice
|
|
1445
1694
|
end
|
1446
1695
|
|
1447
1696
|
# @!attribute [rw] sip_media_application_id
|
1697
|
+
# The SIP media application ID.
|
1448
1698
|
# @return [String]
|
1449
1699
|
#
|
1450
1700
|
# @!attribute [rw] max_results
|
1701
|
+
# The maximum number of results to return in a single call. Defaults
|
1702
|
+
# to 100.
|
1451
1703
|
# @return [Integer]
|
1452
1704
|
#
|
1453
1705
|
# @!attribute [rw] next_token
|
1706
|
+
# The token used to return the next page of results.
|
1454
1707
|
# @return [String]
|
1455
1708
|
#
|
1456
1709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRulesRequest AWS API Documentation
|
@@ -1464,9 +1717,11 @@ module Aws::ChimeSDKVoice
|
|
1464
1717
|
end
|
1465
1718
|
|
1466
1719
|
# @!attribute [rw] sip_rules
|
1720
|
+
# The list of SIP rules and details.
|
1467
1721
|
# @return [Array<Types::SipRule>]
|
1468
1722
|
#
|
1469
1723
|
# @!attribute [rw] next_token
|
1724
|
+
# The token used to return the next page of results.
|
1470
1725
|
# @return [String]
|
1471
1726
|
#
|
1472
1727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRulesResponse AWS API Documentation
|
@@ -1479,6 +1734,7 @@ module Aws::ChimeSDKVoice
|
|
1479
1734
|
end
|
1480
1735
|
|
1481
1736
|
# @!attribute [rw] product_type
|
1737
|
+
# The phone number product type.
|
1482
1738
|
# @return [String]
|
1483
1739
|
#
|
1484
1740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountriesRequest AWS API Documentation
|
@@ -1490,6 +1746,7 @@ module Aws::ChimeSDKVoice
|
|
1490
1746
|
end
|
1491
1747
|
|
1492
1748
|
# @!attribute [rw] phone_number_countries
|
1749
|
+
# The supported phone number countries.
|
1493
1750
|
# @return [Array<Types::PhoneNumberCountry>]
|
1494
1751
|
#
|
1495
1752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountriesResponse AWS API Documentation
|
@@ -1501,6 +1758,7 @@ module Aws::ChimeSDKVoice
|
|
1501
1758
|
end
|
1502
1759
|
|
1503
1760
|
# @!attribute [rw] resource_arn
|
1761
|
+
# The resource ARN.
|
1504
1762
|
# @return [String]
|
1505
1763
|
#
|
1506
1764
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResourceRequest AWS API Documentation
|
@@ -1512,6 +1770,7 @@ module Aws::ChimeSDKVoice
|
|
1512
1770
|
end
|
1513
1771
|
|
1514
1772
|
# @!attribute [rw] tags
|
1773
|
+
# The tags in the list.
|
1515
1774
|
# @return [Array<Types::Tag>]
|
1516
1775
|
#
|
1517
1776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResourceResponse AWS API Documentation
|
@@ -1523,9 +1782,11 @@ module Aws::ChimeSDKVoice
|
|
1523
1782
|
end
|
1524
1783
|
|
1525
1784
|
# @!attribute [rw] next_token
|
1785
|
+
# The token used to return the next page of results.
|
1526
1786
|
# @return [String]
|
1527
1787
|
#
|
1528
1788
|
# @!attribute [rw] max_results
|
1789
|
+
# The maximum number of results to return in a single call.
|
1529
1790
|
# @return [Integer]
|
1530
1791
|
#
|
1531
1792
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroupsRequest AWS API Documentation
|
@@ -1538,9 +1799,11 @@ module Aws::ChimeSDKVoice
|
|
1538
1799
|
end
|
1539
1800
|
|
1540
1801
|
# @!attribute [rw] voice_connector_groups
|
1802
|
+
# The details of the Voice Connector groups.
|
1541
1803
|
# @return [Array<Types::VoiceConnectorGroup>]
|
1542
1804
|
#
|
1543
1805
|
# @!attribute [rw] next_token
|
1806
|
+
# The token used to return the next page of results.
|
1544
1807
|
# @return [String]
|
1545
1808
|
#
|
1546
1809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroupsResponse AWS API Documentation
|
@@ -1553,6 +1816,7 @@ module Aws::ChimeSDKVoice
|
|
1553
1816
|
end
|
1554
1817
|
|
1555
1818
|
# @!attribute [rw] voice_connector_id
|
1819
|
+
# The Voice Connector ID.
|
1556
1820
|
# @return [String]
|
1557
1821
|
#
|
1558
1822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -1564,6 +1828,7 @@ module Aws::ChimeSDKVoice
|
|
1564
1828
|
end
|
1565
1829
|
|
1566
1830
|
# @!attribute [rw] usernames
|
1831
|
+
# A list of user names.
|
1567
1832
|
# @return [Array<String>]
|
1568
1833
|
#
|
1569
1834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentialsResponse AWS API Documentation
|
@@ -1575,9 +1840,11 @@ module Aws::ChimeSDKVoice
|
|
1575
1840
|
end
|
1576
1841
|
|
1577
1842
|
# @!attribute [rw] next_token
|
1843
|
+
# The token used to return the next page of results.
|
1578
1844
|
# @return [String]
|
1579
1845
|
#
|
1580
1846
|
# @!attribute [rw] max_results
|
1847
|
+
# The maximum number of results to return in a single call.
|
1581
1848
|
# @return [Integer]
|
1582
1849
|
#
|
1583
1850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorsRequest AWS API Documentation
|
@@ -1590,9 +1857,11 @@ module Aws::ChimeSDKVoice
|
|
1590
1857
|
end
|
1591
1858
|
|
1592
1859
|
# @!attribute [rw] voice_connectors
|
1860
|
+
# The details of the Voice Connectors.
|
1593
1861
|
# @return [Array<Types::VoiceConnector>]
|
1594
1862
|
#
|
1595
1863
|
# @!attribute [rw] next_token
|
1864
|
+
# The token used to return the next page of results.
|
1596
1865
|
# @return [String]
|
1597
1866
|
#
|
1598
1867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorsResponse AWS API Documentation
|
@@ -1605,9 +1874,11 @@ module Aws::ChimeSDKVoice
|
|
1605
1874
|
end
|
1606
1875
|
|
1607
1876
|
# @!attribute [rw] next_token
|
1877
|
+
# The token used to return the next page of results.
|
1608
1878
|
# @return [String]
|
1609
1879
|
#
|
1610
1880
|
# @!attribute [rw] max_results
|
1881
|
+
# The maximum number of results to return in a single call.
|
1611
1882
|
# @return [Integer]
|
1612
1883
|
#
|
1613
1884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomainsRequest AWS API Documentation
|
@@ -1620,9 +1891,11 @@ module Aws::ChimeSDKVoice
|
|
1620
1891
|
end
|
1621
1892
|
|
1622
1893
|
# @!attribute [rw] voice_profile_domains
|
1894
|
+
# The list of voice profile domains.
|
1623
1895
|
# @return [Array<Types::VoiceProfileDomainSummary>]
|
1624
1896
|
#
|
1625
1897
|
# @!attribute [rw] next_token
|
1898
|
+
# The token used to return the next page of results.
|
1626
1899
|
# @return [String]
|
1627
1900
|
#
|
1628
1901
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomainsResponse AWS API Documentation
|
@@ -1635,12 +1908,15 @@ module Aws::ChimeSDKVoice
|
|
1635
1908
|
end
|
1636
1909
|
|
1637
1910
|
# @!attribute [rw] voice_profile_domain_id
|
1911
|
+
# The ID of the voice profile domain.
|
1638
1912
|
# @return [String]
|
1639
1913
|
#
|
1640
1914
|
# @!attribute [rw] next_token
|
1915
|
+
# The token used to retrieve the next page of results.
|
1641
1916
|
# @return [String]
|
1642
1917
|
#
|
1643
1918
|
# @!attribute [rw] max_results
|
1919
|
+
# The maximum number of results in the request.
|
1644
1920
|
# @return [Integer]
|
1645
1921
|
#
|
1646
1922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfilesRequest AWS API Documentation
|
@@ -1654,9 +1930,11 @@ module Aws::ChimeSDKVoice
|
|
1654
1930
|
end
|
1655
1931
|
|
1656
1932
|
# @!attribute [rw] voice_profiles
|
1933
|
+
# The list of voice profiles.
|
1657
1934
|
# @return [Array<Types::VoiceProfileSummary>]
|
1658
1935
|
#
|
1659
1936
|
# @!attribute [rw] next_token
|
1937
|
+
# The token used to retrieve the next page of results.
|
1660
1938
|
# @return [String]
|
1661
1939
|
#
|
1662
1940
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfilesResponse AWS API Documentation
|
@@ -1668,10 +1946,17 @@ module Aws::ChimeSDKVoice
|
|
1668
1946
|
include Aws::Structure
|
1669
1947
|
end
|
1670
1948
|
|
1949
|
+
# The logging configuration associated with an Amazon Chime SDK Voice
|
1950
|
+
# Connector. Specifies whether SIP message logs can be sent to Amazon
|
1951
|
+
# CloudWatch Logs.
|
1952
|
+
#
|
1671
1953
|
# @!attribute [rw] enable_sip_logs
|
1954
|
+
# Boolean that enables sending SIP message logs to Amazon CloudWatch
|
1955
|
+
# logs.
|
1672
1956
|
# @return [Boolean]
|
1673
1957
|
#
|
1674
1958
|
# @!attribute [rw] enable_media_metric_logs
|
1959
|
+
# Enables or disables media metrics logging.
|
1675
1960
|
# @return [Boolean]
|
1676
1961
|
#
|
1677
1962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/LoggingConfiguration AWS API Documentation
|
@@ -1683,10 +1968,14 @@ module Aws::ChimeSDKVoice
|
|
1683
1968
|
include Aws::Structure
|
1684
1969
|
end
|
1685
1970
|
|
1971
|
+
# The configuration for a call analytics task.
|
1972
|
+
#
|
1686
1973
|
# @!attribute [rw] disabled
|
1974
|
+
# Denotes the configration as enabled or disabled.
|
1687
1975
|
# @return [Boolean]
|
1688
1976
|
#
|
1689
1977
|
# @!attribute [rw] configuration_arn
|
1978
|
+
# The configuration's ARN.
|
1690
1979
|
# @return [String]
|
1691
1980
|
#
|
1692
1981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/MediaInsightsConfiguration AWS API Documentation
|
@@ -1698,14 +1987,20 @@ module Aws::ChimeSDKVoice
|
|
1698
1987
|
include Aws::Structure
|
1699
1988
|
end
|
1700
1989
|
|
1990
|
+
# The requested resource couldn't be found.
|
1991
|
+
#
|
1701
1992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/NotFoundException AWS API Documentation
|
1702
1993
|
#
|
1703
1994
|
class NotFoundException < Aws::EmptyStructure; end
|
1704
1995
|
|
1996
|
+
# A phone number for which an order has been placed.
|
1997
|
+
#
|
1705
1998
|
# @!attribute [rw] e164_phone_number
|
1999
|
+
# The phone number, in E.164 format.
|
1706
2000
|
# @return [String]
|
1707
2001
|
#
|
1708
2002
|
# @!attribute [rw] status
|
2003
|
+
# The phone number status.
|
1709
2004
|
# @return [String]
|
1710
2005
|
#
|
1711
2006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/OrderedPhoneNumber AWS API Documentation
|
@@ -1717,10 +2012,24 @@ module Aws::ChimeSDKVoice
|
|
1717
2012
|
include Aws::Structure
|
1718
2013
|
end
|
1719
2014
|
|
2015
|
+
# Origination settings enable your SIP hosts to receive inbound calls
|
2016
|
+
# using your Amazon Chime SDK Voice Connector.
|
2017
|
+
#
|
2018
|
+
# <note markdown="1"> The parameters listed below are not required, but you must use at
|
2019
|
+
# least one.
|
2020
|
+
#
|
2021
|
+
# </note>
|
2022
|
+
#
|
1720
2023
|
# @!attribute [rw] routes
|
2024
|
+
# The call distribution properties defined for your SIP hosts. Valid
|
2025
|
+
# range: Minimum value of 1. Maximum value of 20. This parameter is
|
2026
|
+
# not required, but you must specify this parameter or `Disabled`.
|
1721
2027
|
# @return [Array<Types::OriginationRoute>]
|
1722
2028
|
#
|
1723
2029
|
# @!attribute [rw] disabled
|
2030
|
+
# When origination settings are disabled, inbound calls are not
|
2031
|
+
# enabled for your Amazon Chime SDK Voice Connector. This parameter is
|
2032
|
+
# not required, but you must specify this parameter or `Routes`.
|
1724
2033
|
# @return [Boolean]
|
1725
2034
|
#
|
1726
2035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Origination AWS API Documentation
|
@@ -1732,19 +2041,37 @@ module Aws::ChimeSDKVoice
|
|
1732
2041
|
include Aws::Structure
|
1733
2042
|
end
|
1734
2043
|
|
2044
|
+
# Origination routes define call distribution properties for your SIP
|
2045
|
+
# hosts to receive inbound calls using an Amazon Chime SDK Voice
|
2046
|
+
# Connector. Limit: Ten origination routes for each Voice Connector.
|
2047
|
+
#
|
2048
|
+
# <note markdown="1"> The parameters listed below are not required, but you must use at
|
2049
|
+
# least one.
|
2050
|
+
#
|
2051
|
+
# </note>
|
2052
|
+
#
|
1735
2053
|
# @!attribute [rw] host
|
2054
|
+
# The FQDN or IP address to contact for origination traffic.
|
1736
2055
|
# @return [String]
|
1737
2056
|
#
|
1738
2057
|
# @!attribute [rw] port
|
2058
|
+
# The designated origination route port. Defaults to 5060.
|
1739
2059
|
# @return [Integer]
|
1740
2060
|
#
|
1741
2061
|
# @!attribute [rw] protocol
|
2062
|
+
# The protocol to use for the origination route. Encryption-enabled
|
2063
|
+
# Amazon Chime SDK Voice Connectors use TCP protocol by default.
|
1742
2064
|
# @return [String]
|
1743
2065
|
#
|
1744
2066
|
# @!attribute [rw] priority
|
2067
|
+
# The priority associated with the host, with 1 being the highest
|
2068
|
+
# priority. Higher priority hosts are attempted first.
|
1745
2069
|
# @return [Integer]
|
1746
2070
|
#
|
1747
2071
|
# @!attribute [rw] weight
|
2072
|
+
# The weight assigned to an origination route. When hosts have equal
|
2073
|
+
# priority, calls are distributed between them based on their relative
|
2074
|
+
# weights.
|
1748
2075
|
# @return [Integer]
|
1749
2076
|
#
|
1750
2077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/OriginationRoute AWS API Documentation
|
@@ -1759,10 +2086,15 @@ module Aws::ChimeSDKVoice
|
|
1759
2086
|
include Aws::Structure
|
1760
2087
|
end
|
1761
2088
|
|
2089
|
+
# The phone number and proxy phone number for a participant in an Amazon
|
2090
|
+
# Chime SDK Voice Connector proxy session.
|
2091
|
+
#
|
1762
2092
|
# @!attribute [rw] phone_number
|
2093
|
+
# The participant's phone number.
|
1763
2094
|
# @return [String]
|
1764
2095
|
#
|
1765
2096
|
# @!attribute [rw] proxy_phone_number
|
2097
|
+
# The participant's proxy phone number.
|
1766
2098
|
# @return [String]
|
1767
2099
|
#
|
1768
2100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Participant AWS API Documentation
|
@@ -1774,46 +2106,62 @@ module Aws::ChimeSDKVoice
|
|
1774
2106
|
include Aws::Structure
|
1775
2107
|
end
|
1776
2108
|
|
2109
|
+
# A phone number used to call an Amazon Chime SDK Voice Connector.
|
2110
|
+
#
|
1777
2111
|
# @!attribute [rw] phone_number_id
|
2112
|
+
# The phone number's ID.
|
1778
2113
|
# @return [String]
|
1779
2114
|
#
|
1780
2115
|
# @!attribute [rw] e164_phone_number
|
2116
|
+
# The phone number, in E.164 format.
|
1781
2117
|
# @return [String]
|
1782
2118
|
#
|
1783
2119
|
# @!attribute [rw] country
|
2120
|
+
# The phone number's country. Format: ISO 3166-1 alpha-2.
|
1784
2121
|
# @return [String]
|
1785
2122
|
#
|
1786
2123
|
# @!attribute [rw] type
|
2124
|
+
# The phone number's type.
|
1787
2125
|
# @return [String]
|
1788
2126
|
#
|
1789
2127
|
# @!attribute [rw] product_type
|
2128
|
+
# The phone number's product type.
|
1790
2129
|
# @return [String]
|
1791
2130
|
#
|
1792
2131
|
# @!attribute [rw] status
|
2132
|
+
# The phone number's status.
|
1793
2133
|
# @return [String]
|
1794
2134
|
#
|
1795
2135
|
# @!attribute [rw] capabilities
|
2136
|
+
# The phone number's capabilities.
|
1796
2137
|
# @return [Types::PhoneNumberCapabilities]
|
1797
2138
|
#
|
1798
2139
|
# @!attribute [rw] associations
|
2140
|
+
# The phone number's associations.
|
1799
2141
|
# @return [Array<Types::PhoneNumberAssociation>]
|
1800
2142
|
#
|
1801
2143
|
# @!attribute [rw] calling_name
|
2144
|
+
# The outbound calling name associated with the phone number.
|
1802
2145
|
# @return [String]
|
1803
2146
|
#
|
1804
2147
|
# @!attribute [rw] calling_name_status
|
2148
|
+
# The outbound calling name status.
|
1805
2149
|
# @return [String]
|
1806
2150
|
#
|
1807
2151
|
# @!attribute [rw] created_timestamp
|
2152
|
+
# The phone number creation timestamp, in ISO 8601 format.
|
1808
2153
|
# @return [Time]
|
1809
2154
|
#
|
1810
2155
|
# @!attribute [rw] updated_timestamp
|
2156
|
+
# The updated phone number timestamp, in ISO 8601 format.
|
1811
2157
|
# @return [Time]
|
1812
2158
|
#
|
1813
2159
|
# @!attribute [rw] deletion_timestamp
|
2160
|
+
# The deleted phone number timestamp, in ISO 8601 format.
|
1814
2161
|
# @return [Time]
|
1815
2162
|
#
|
1816
2163
|
# @!attribute [rw] order_id
|
2164
|
+
# The phone number's order ID.
|
1817
2165
|
# @return [String]
|
1818
2166
|
#
|
1819
2167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumber AWS API Documentation
|
@@ -1837,13 +2185,20 @@ module Aws::ChimeSDKVoice
|
|
1837
2185
|
include Aws::Structure
|
1838
2186
|
end
|
1839
2187
|
|
2188
|
+
# The phone number associations, such as an Amazon Chime SDK account ID,
|
2189
|
+
# user ID, Voice Connector ID, or Voice Connector group ID.
|
2190
|
+
#
|
1840
2191
|
# @!attribute [rw] value
|
2192
|
+
# Contains the ID for the entity specified in Name.
|
1841
2193
|
# @return [String]
|
1842
2194
|
#
|
1843
2195
|
# @!attribute [rw] name
|
2196
|
+
# Defines the association with an Amazon Chime SDK account ID, user
|
2197
|
+
# ID, Voice Connector ID, or Voice Connector group ID.
|
1844
2198
|
# @return [String]
|
1845
2199
|
#
|
1846
2200
|
# @!attribute [rw] associated_timestamp
|
2201
|
+
# The timestamp of the phone number association, in ISO 8601 format.
|
1847
2202
|
# @return [Time]
|
1848
2203
|
#
|
1849
2204
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberAssociation AWS API Documentation
|
@@ -1856,22 +2211,35 @@ module Aws::ChimeSDKVoice
|
|
1856
2211
|
include Aws::Structure
|
1857
2212
|
end
|
1858
2213
|
|
2214
|
+
# The phone number capabilities for Amazon Chime SDK phone numbers, such
|
2215
|
+
# as enabled inbound and outbound calling, and text messaging.
|
2216
|
+
#
|
1859
2217
|
# @!attribute [rw] inbound_call
|
2218
|
+
# Allows or denies inbound calling for the specified phone number.
|
1860
2219
|
# @return [Boolean]
|
1861
2220
|
#
|
1862
2221
|
# @!attribute [rw] outbound_call
|
2222
|
+
# Allows or denies outbound calling for the specified phone number.
|
1863
2223
|
# @return [Boolean]
|
1864
2224
|
#
|
1865
2225
|
# @!attribute [rw] inbound_sms
|
2226
|
+
# Allows or denies inbound SMS messaging for the specified phone
|
2227
|
+
# number.
|
1866
2228
|
# @return [Boolean]
|
1867
2229
|
#
|
1868
2230
|
# @!attribute [rw] outbound_sms
|
2231
|
+
# Allows or denies outbound SMS messaging for the specified phone
|
2232
|
+
# number.
|
1869
2233
|
# @return [Boolean]
|
1870
2234
|
#
|
1871
2235
|
# @!attribute [rw] inbound_mms
|
2236
|
+
# Allows or denies inbound MMS messaging for the specified phone
|
2237
|
+
# number.
|
1872
2238
|
# @return [Boolean]
|
1873
2239
|
#
|
1874
2240
|
# @!attribute [rw] outbound_mms
|
2241
|
+
# Allows or denies inbound MMS messaging for the specified phone
|
2242
|
+
# number.
|
1875
2243
|
# @return [Boolean]
|
1876
2244
|
#
|
1877
2245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberCapabilities AWS API Documentation
|
@@ -1887,10 +2255,14 @@ module Aws::ChimeSDKVoice
|
|
1887
2255
|
include Aws::Structure
|
1888
2256
|
end
|
1889
2257
|
|
2258
|
+
# The phone number's country.
|
2259
|
+
#
|
1890
2260
|
# @!attribute [rw] country_code
|
2261
|
+
# The phone number country code. Format: ISO 3166-1 alpha-2.
|
1891
2262
|
# @return [String]
|
1892
2263
|
#
|
1893
2264
|
# @!attribute [rw] supported_phone_number_types
|
2265
|
+
# The supported phone number types.
|
1894
2266
|
# @return [Array<String>]
|
1895
2267
|
#
|
1896
2268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberCountry AWS API Documentation
|
@@ -1902,13 +2274,20 @@ module Aws::ChimeSDKVoice
|
|
1902
2274
|
include Aws::Structure
|
1903
2275
|
end
|
1904
2276
|
|
2277
|
+
# If a phone number action fails for one or more of the phone numbers in
|
2278
|
+
# a request, a list of the failed phone numbers is returned, along with
|
2279
|
+
# error codes and error messages.
|
2280
|
+
#
|
1905
2281
|
# @!attribute [rw] phone_number_id
|
2282
|
+
# The phone number ID for which the action failed.
|
1906
2283
|
# @return [String]
|
1907
2284
|
#
|
1908
2285
|
# @!attribute [rw] error_code
|
2286
|
+
# The error code.
|
1909
2287
|
# @return [String]
|
1910
2288
|
#
|
1911
2289
|
# @!attribute [rw] error_message
|
2290
|
+
# The error message.
|
1912
2291
|
# @return [String]
|
1913
2292
|
#
|
1914
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberError AWS API Documentation
|
@@ -1921,25 +2300,35 @@ module Aws::ChimeSDKVoice
|
|
1921
2300
|
include Aws::Structure
|
1922
2301
|
end
|
1923
2302
|
|
2303
|
+
# The details of an Amazon Chime SDK phone number order.
|
2304
|
+
#
|
1924
2305
|
# @!attribute [rw] phone_number_order_id
|
2306
|
+
# The ID of the phone order.
|
1925
2307
|
# @return [String]
|
1926
2308
|
#
|
1927
2309
|
# @!attribute [rw] product_type
|
2310
|
+
# The phone number order product type.
|
1928
2311
|
# @return [String]
|
1929
2312
|
#
|
1930
2313
|
# @!attribute [rw] status
|
2314
|
+
# The status of the phone number order.
|
1931
2315
|
# @return [String]
|
1932
2316
|
#
|
1933
2317
|
# @!attribute [rw] order_type
|
2318
|
+
# The type of phone number being ordered, local or toll-free.
|
1934
2319
|
# @return [String]
|
1935
2320
|
#
|
1936
2321
|
# @!attribute [rw] ordered_phone_numbers
|
2322
|
+
# The ordered phone number details, such as the phone number in E.164
|
2323
|
+
# format and the phone number status.
|
1937
2324
|
# @return [Array<Types::OrderedPhoneNumber>]
|
1938
2325
|
#
|
1939
2326
|
# @!attribute [rw] created_timestamp
|
2327
|
+
# The phone number order creation time stamp, in ISO 8601 format.
|
1940
2328
|
# @return [Time]
|
1941
2329
|
#
|
1942
2330
|
# @!attribute [rw] updated_timestamp
|
2331
|
+
# The updated phone number order time stamp, in ISO 8601 format.
|
1943
2332
|
# @return [Time]
|
1944
2333
|
#
|
1945
2334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberOrder AWS API Documentation
|
@@ -1956,16 +2345,23 @@ module Aws::ChimeSDKVoice
|
|
1956
2345
|
include Aws::Structure
|
1957
2346
|
end
|
1958
2347
|
|
2348
|
+
# The proxy configuration for an Amazon Chime SDK Voice Connector.
|
2349
|
+
#
|
1959
2350
|
# @!attribute [rw] default_session_expiry_minutes
|
2351
|
+
# The default number of minutes allowed for proxy sessions.
|
1960
2352
|
# @return [Integer]
|
1961
2353
|
#
|
1962
2354
|
# @!attribute [rw] disabled
|
2355
|
+
# When true, stops proxy sessions from being created on the specified
|
2356
|
+
# Amazon Chime SDK Voice Connector.
|
1963
2357
|
# @return [Boolean]
|
1964
2358
|
#
|
1965
2359
|
# @!attribute [rw] fall_back_phone_number
|
2360
|
+
# The phone number to route calls to after a proxy session expires.
|
1966
2361
|
# @return [String]
|
1967
2362
|
#
|
1968
2363
|
# @!attribute [rw] phone_number_countries
|
2364
|
+
# The countries for proxy phone numbers to be selected from.
|
1969
2365
|
# @return [Array<String>]
|
1970
2366
|
#
|
1971
2367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Proxy AWS API Documentation
|
@@ -1979,43 +2375,60 @@ module Aws::ChimeSDKVoice
|
|
1979
2375
|
include Aws::Structure
|
1980
2376
|
end
|
1981
2377
|
|
2378
|
+
# The proxy session for an Amazon Chime SDK Voice Connector.
|
2379
|
+
#
|
1982
2380
|
# @!attribute [rw] voice_connector_id
|
2381
|
+
# The Voice Connector ID.
|
1983
2382
|
# @return [String]
|
1984
2383
|
#
|
1985
2384
|
# @!attribute [rw] proxy_session_id
|
2385
|
+
# The proxy session ID.
|
1986
2386
|
# @return [String]
|
1987
2387
|
#
|
1988
2388
|
# @!attribute [rw] name
|
2389
|
+
# The proxy session name.
|
1989
2390
|
# @return [String]
|
1990
2391
|
#
|
1991
2392
|
# @!attribute [rw] status
|
2393
|
+
# The proxy session status.
|
1992
2394
|
# @return [String]
|
1993
2395
|
#
|
1994
2396
|
# @!attribute [rw] expiry_minutes
|
2397
|
+
# The number of minutes allowed for the proxy session.
|
1995
2398
|
# @return [Integer]
|
1996
2399
|
#
|
1997
2400
|
# @!attribute [rw] capabilities
|
2401
|
+
# The proxy session capabilities.
|
1998
2402
|
# @return [Array<String>]
|
1999
2403
|
#
|
2000
2404
|
# @!attribute [rw] created_timestamp
|
2405
|
+
# The created time stamp, in ISO 8601 format.
|
2001
2406
|
# @return [Time]
|
2002
2407
|
#
|
2003
2408
|
# @!attribute [rw] updated_timestamp
|
2409
|
+
# The updated time stamp, in ISO 8601 format.
|
2004
2410
|
# @return [Time]
|
2005
2411
|
#
|
2006
2412
|
# @!attribute [rw] ended_timestamp
|
2413
|
+
# The ended time stamp, in ISO 8601 format.
|
2007
2414
|
# @return [Time]
|
2008
2415
|
#
|
2009
2416
|
# @!attribute [rw] participants
|
2417
|
+
# The proxy session participants.
|
2010
2418
|
# @return [Array<Types::Participant>]
|
2011
2419
|
#
|
2012
2420
|
# @!attribute [rw] number_selection_behavior
|
2421
|
+
# The preference for proxy phone number reuse, or stickiness, between
|
2422
|
+
# the same participants across sessions.
|
2013
2423
|
# @return [String]
|
2014
2424
|
#
|
2015
2425
|
# @!attribute [rw] geo_match_level
|
2426
|
+
# The preference for matching the country or area code of the proxy
|
2427
|
+
# phone number with that of the first participant.
|
2016
2428
|
# @return [String]
|
2017
2429
|
#
|
2018
2430
|
# @!attribute [rw] geo_match_params
|
2431
|
+
# The country and area code for the proxy phone number.
|
2019
2432
|
# @return [Types::GeoMatchParams]
|
2020
2433
|
#
|
2021
2434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ProxySession AWS API Documentation
|
@@ -2039,9 +2452,11 @@ module Aws::ChimeSDKVoice
|
|
2039
2452
|
end
|
2040
2453
|
|
2041
2454
|
# @!attribute [rw] sip_media_application_id
|
2455
|
+
# The SIP media application ID.
|
2042
2456
|
# @return [String]
|
2043
2457
|
#
|
2044
2458
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
2459
|
+
# The Alexa Skill configuration.
|
2045
2460
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
2046
2461
|
#
|
2047
2462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfigurationRequest AWS API Documentation
|
@@ -2054,6 +2469,7 @@ module Aws::ChimeSDKVoice
|
|
2054
2469
|
end
|
2055
2470
|
|
2056
2471
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
2472
|
+
# Returns the Alexa Skill configuration.
|
2057
2473
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
2058
2474
|
#
|
2059
2475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfigurationResponse AWS API Documentation
|
@@ -2065,9 +2481,11 @@ module Aws::ChimeSDKVoice
|
|
2065
2481
|
end
|
2066
2482
|
|
2067
2483
|
# @!attribute [rw] sip_media_application_id
|
2484
|
+
# The SIP media application ID.
|
2068
2485
|
# @return [String]
|
2069
2486
|
#
|
2070
2487
|
# @!attribute [rw] sip_media_application_logging_configuration
|
2488
|
+
# The logging configuration for the specified SIP media application.
|
2071
2489
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
2072
2490
|
#
|
2073
2491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
|
@@ -2080,6 +2498,8 @@ module Aws::ChimeSDKVoice
|
|
2080
2498
|
end
|
2081
2499
|
|
2082
2500
|
# @!attribute [rw] sip_media_application_logging_configuration
|
2501
|
+
# The updated logging configuration for the specified SIP media
|
2502
|
+
# application.
|
2083
2503
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
2084
2504
|
#
|
2085
2505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
|
@@ -2091,9 +2511,11 @@ module Aws::ChimeSDKVoice
|
|
2091
2511
|
end
|
2092
2512
|
|
2093
2513
|
# @!attribute [rw] voice_connector_id
|
2514
|
+
# The Voice Connector ID.
|
2094
2515
|
# @return [String]
|
2095
2516
|
#
|
2096
2517
|
# @!attribute [rw] emergency_calling_configuration
|
2518
|
+
# The configuration being updated.
|
2097
2519
|
# @return [Types::EmergencyCallingConfiguration]
|
2098
2520
|
#
|
2099
2521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -2106,6 +2528,7 @@ module Aws::ChimeSDKVoice
|
|
2106
2528
|
end
|
2107
2529
|
|
2108
2530
|
# @!attribute [rw] emergency_calling_configuration
|
2531
|
+
# The updated configuration.
|
2109
2532
|
# @return [Types::EmergencyCallingConfiguration]
|
2110
2533
|
#
|
2111
2534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfigurationResponse AWS API Documentation
|
@@ -2117,9 +2540,11 @@ module Aws::ChimeSDKVoice
|
|
2117
2540
|
end
|
2118
2541
|
|
2119
2542
|
# @!attribute [rw] voice_connector_id
|
2543
|
+
# The Voice Connector ID.
|
2120
2544
|
# @return [String]
|
2121
2545
|
#
|
2122
2546
|
# @!attribute [rw] logging_configuration
|
2547
|
+
# The logging configuration being updated.
|
2123
2548
|
# @return [Types::LoggingConfiguration]
|
2124
2549
|
#
|
2125
2550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfigurationRequest AWS API Documentation
|
@@ -2132,6 +2557,7 @@ module Aws::ChimeSDKVoice
|
|
2132
2557
|
end
|
2133
2558
|
|
2134
2559
|
# @!attribute [rw] logging_configuration
|
2560
|
+
# The updated logging configuration.
|
2135
2561
|
# @return [Types::LoggingConfiguration]
|
2136
2562
|
#
|
2137
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfigurationResponse AWS API Documentation
|
@@ -2143,9 +2569,11 @@ module Aws::ChimeSDKVoice
|
|
2143
2569
|
end
|
2144
2570
|
|
2145
2571
|
# @!attribute [rw] voice_connector_id
|
2572
|
+
# The Voice Connector ID.
|
2146
2573
|
# @return [String]
|
2147
2574
|
#
|
2148
2575
|
# @!attribute [rw] origination
|
2576
|
+
# The origination settings being updated.
|
2149
2577
|
# @return [Types::Origination]
|
2150
2578
|
#
|
2151
2579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -2158,6 +2586,7 @@ module Aws::ChimeSDKVoice
|
|
2158
2586
|
end
|
2159
2587
|
|
2160
2588
|
# @!attribute [rw] origination
|
2589
|
+
# The updated origination settings.
|
2161
2590
|
# @return [Types::Origination]
|
2162
2591
|
#
|
2163
2592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOriginationResponse AWS API Documentation
|
@@ -2169,18 +2598,24 @@ module Aws::ChimeSDKVoice
|
|
2169
2598
|
end
|
2170
2599
|
|
2171
2600
|
# @!attribute [rw] voice_connector_id
|
2601
|
+
# The Voice Connector ID.
|
2172
2602
|
# @return [String]
|
2173
2603
|
#
|
2174
2604
|
# @!attribute [rw] default_session_expiry_minutes
|
2605
|
+
# The default number of minutes allowed for proxy session.
|
2175
2606
|
# @return [Integer]
|
2176
2607
|
#
|
2177
2608
|
# @!attribute [rw] phone_number_pool_countries
|
2609
|
+
# The countries for proxy phone numbers to be selected from.
|
2178
2610
|
# @return [Array<String>]
|
2179
2611
|
#
|
2180
2612
|
# @!attribute [rw] fall_back_phone_number
|
2613
|
+
# The phone number to route calls to after a proxy session expires.
|
2181
2614
|
# @return [String]
|
2182
2615
|
#
|
2183
2616
|
# @!attribute [rw] disabled
|
2617
|
+
# When true, stops proxy sessions from being created on the specified
|
2618
|
+
# Amazon Chime SDK Voice Connector.
|
2184
2619
|
# @return [Boolean]
|
2185
2620
|
#
|
2186
2621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxyRequest AWS API Documentation
|
@@ -2196,6 +2631,7 @@ module Aws::ChimeSDKVoice
|
|
2196
2631
|
end
|
2197
2632
|
|
2198
2633
|
# @!attribute [rw] proxy
|
2634
|
+
# The proxy configuration details.
|
2199
2635
|
# @return [Types::Proxy]
|
2200
2636
|
#
|
2201
2637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxyResponse AWS API Documentation
|
@@ -2207,9 +2643,11 @@ module Aws::ChimeSDKVoice
|
|
2207
2643
|
end
|
2208
2644
|
|
2209
2645
|
# @!attribute [rw] voice_connector_id
|
2646
|
+
# The Voice Connector ID.
|
2210
2647
|
# @return [String]
|
2211
2648
|
#
|
2212
2649
|
# @!attribute [rw] streaming_configuration
|
2650
|
+
# The streaming settings being updated.
|
2213
2651
|
# @return [Types::StreamingConfiguration]
|
2214
2652
|
#
|
2215
2653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -2222,6 +2660,7 @@ module Aws::ChimeSDKVoice
|
|
2222
2660
|
end
|
2223
2661
|
|
2224
2662
|
# @!attribute [rw] streaming_configuration
|
2663
|
+
# The updated streaming settings.
|
2225
2664
|
# @return [Types::StreamingConfiguration]
|
2226
2665
|
#
|
2227
2666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfigurationResponse AWS API Documentation
|
@@ -2233,9 +2672,11 @@ module Aws::ChimeSDKVoice
|
|
2233
2672
|
end
|
2234
2673
|
|
2235
2674
|
# @!attribute [rw] voice_connector_id
|
2675
|
+
# The Voice Connector ID.
|
2236
2676
|
# @return [String]
|
2237
2677
|
#
|
2238
2678
|
# @!attribute [rw] credentials
|
2679
|
+
# The termination credentials being updated.
|
2239
2680
|
# @return [Array<Types::Credential>]
|
2240
2681
|
#
|
2241
2682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -2248,9 +2689,11 @@ module Aws::ChimeSDKVoice
|
|
2248
2689
|
end
|
2249
2690
|
|
2250
2691
|
# @!attribute [rw] voice_connector_id
|
2692
|
+
# The Voice Connector ID.
|
2251
2693
|
# @return [String]
|
2252
2694
|
#
|
2253
2695
|
# @!attribute [rw] termination
|
2696
|
+
# The termination settings to be updated.
|
2254
2697
|
# @return [Types::Termination]
|
2255
2698
|
#
|
2256
2699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -2263,6 +2706,7 @@ module Aws::ChimeSDKVoice
|
|
2263
2706
|
end
|
2264
2707
|
|
2265
2708
|
# @!attribute [rw] termination
|
2709
|
+
# The updated termination settings.
|
2266
2710
|
# @return [Types::Termination]
|
2267
2711
|
#
|
2268
2712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationResponse AWS API Documentation
|
@@ -2273,11 +2717,14 @@ module Aws::ChimeSDKVoice
|
|
2273
2717
|
include Aws::Structure
|
2274
2718
|
end
|
2275
2719
|
|
2720
|
+
# The request exceeds the resource limit.
|
2721
|
+
#
|
2276
2722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ResourceLimitExceededException AWS API Documentation
|
2277
2723
|
#
|
2278
2724
|
class ResourceLimitExceededException < Aws::EmptyStructure; end
|
2279
2725
|
|
2280
2726
|
# @!attribute [rw] phone_number_id
|
2727
|
+
# The ID of the phone number being restored.
|
2281
2728
|
# @return [String]
|
2282
2729
|
#
|
2283
2730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumberRequest AWS API Documentation
|
@@ -2289,6 +2736,7 @@ module Aws::ChimeSDKVoice
|
|
2289
2736
|
end
|
2290
2737
|
|
2291
2738
|
# @!attribute [rw] phone_number
|
2739
|
+
# The restored phone number.
|
2292
2740
|
# @return [Types::PhoneNumber]
|
2293
2741
|
#
|
2294
2742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumberResponse AWS API Documentation
|
@@ -2300,27 +2748,41 @@ module Aws::ChimeSDKVoice
|
|
2300
2748
|
end
|
2301
2749
|
|
2302
2750
|
# @!attribute [rw] area_code
|
2751
|
+
# Confines a search to just the phone numbers associated with the
|
2752
|
+
# specified area code.
|
2303
2753
|
# @return [String]
|
2304
2754
|
#
|
2305
2755
|
# @!attribute [rw] city
|
2756
|
+
# Confines a search to just the phone numbers associated with the
|
2757
|
+
# specified city.
|
2306
2758
|
# @return [String]
|
2307
2759
|
#
|
2308
2760
|
# @!attribute [rw] country
|
2761
|
+
# Confines a search to just the phone numbers associated with the
|
2762
|
+
# specified country.
|
2309
2763
|
# @return [String]
|
2310
2764
|
#
|
2311
2765
|
# @!attribute [rw] state
|
2766
|
+
# Confines a search to just the phone numbers associated with the
|
2767
|
+
# specified state.
|
2312
2768
|
# @return [String]
|
2313
2769
|
#
|
2314
2770
|
# @!attribute [rw] toll_free_prefix
|
2771
|
+
# Confines a search to just the phone numbers associated with the
|
2772
|
+
# specified toll-free prefix.
|
2315
2773
|
# @return [String]
|
2316
2774
|
#
|
2317
2775
|
# @!attribute [rw] phone_number_type
|
2776
|
+
# Confines a search to just the phone numbers associated with the
|
2777
|
+
# specified phone number type, either **local** or **toll-free**.
|
2318
2778
|
# @return [String]
|
2319
2779
|
#
|
2320
2780
|
# @!attribute [rw] max_results
|
2781
|
+
# The maximum number of results to return.
|
2321
2782
|
# @return [Integer]
|
2322
2783
|
#
|
2323
2784
|
# @!attribute [rw] next_token
|
2785
|
+
# The token used to return the next page of results.
|
2324
2786
|
# @return [String]
|
2325
2787
|
#
|
2326
2788
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbersRequest AWS API Documentation
|
@@ -2339,9 +2801,11 @@ module Aws::ChimeSDKVoice
|
|
2339
2801
|
end
|
2340
2802
|
|
2341
2803
|
# @!attribute [rw] e164_phone_numbers
|
2804
|
+
# Confines a search to just the phone numbers in the E.164 format.
|
2342
2805
|
# @return [Array<String>]
|
2343
2806
|
#
|
2344
2807
|
# @!attribute [rw] next_token
|
2808
|
+
# The token used to return the next page of results.
|
2345
2809
|
# @return [String]
|
2346
2810
|
#
|
2347
2811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbersResponse AWS API Documentation
|
@@ -2353,7 +2817,18 @@ module Aws::ChimeSDKVoice
|
|
2353
2817
|
include Aws::Structure
|
2354
2818
|
end
|
2355
2819
|
|
2820
|
+
# A structure that contains the configuration settings for server-side
|
2821
|
+
# encryption.
|
2822
|
+
#
|
2823
|
+
# <note markdown="1"> We only support symmetric keys. Do not use asymmetric or HMAC keys, or
|
2824
|
+
# KMS aliases.
|
2825
|
+
#
|
2826
|
+
# </note>
|
2827
|
+
#
|
2356
2828
|
# @!attribute [rw] kms_key_arn
|
2829
|
+
# The ARN of the KMS key used to encrypt the enrollment data in a
|
2830
|
+
# voice profile domain. Asymmetric customer managed keys are not
|
2831
|
+
# supported.
|
2357
2832
|
# @return [String]
|
2358
2833
|
#
|
2359
2834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServerSideEncryptionConfiguration AWS API Documentation
|
@@ -2364,30 +2839,44 @@ module Aws::ChimeSDKVoice
|
|
2364
2839
|
include Aws::Structure
|
2365
2840
|
end
|
2366
2841
|
|
2842
|
+
# The service encountered an unexpected error.
|
2843
|
+
#
|
2367
2844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServiceFailureException AWS API Documentation
|
2368
2845
|
#
|
2369
2846
|
class ServiceFailureException < Aws::EmptyStructure; end
|
2370
2847
|
|
2848
|
+
# The service is currently unavailable.
|
2849
|
+
#
|
2371
2850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServiceUnavailableException AWS API Documentation
|
2372
2851
|
#
|
2373
2852
|
class ServiceUnavailableException < Aws::EmptyStructure; end
|
2374
2853
|
|
2854
|
+
# The details of the SIP media application, including name and
|
2855
|
+
# endpoints. An AWS account can have multiple SIP media applications.
|
2856
|
+
#
|
2375
2857
|
# @!attribute [rw] sip_media_application_id
|
2858
|
+
# A SIP media application's ID.
|
2376
2859
|
# @return [String]
|
2377
2860
|
#
|
2378
2861
|
# @!attribute [rw] aws_region
|
2862
|
+
# The AWS Region in which the SIP media application is created.
|
2379
2863
|
# @return [String]
|
2380
2864
|
#
|
2381
2865
|
# @!attribute [rw] name
|
2866
|
+
# The SIP media application's name.
|
2382
2867
|
# @return [String]
|
2383
2868
|
#
|
2384
2869
|
# @!attribute [rw] endpoints
|
2870
|
+
# List of endpoints for SIP media application. Currently, only one
|
2871
|
+
# endpoint per SIP media application is permitted.
|
2385
2872
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
2386
2873
|
#
|
2387
2874
|
# @!attribute [rw] created_timestamp
|
2875
|
+
# The SIP media application creation timestamp, in ISO 8601 format.
|
2388
2876
|
# @return [Time]
|
2389
2877
|
#
|
2390
2878
|
# @!attribute [rw] updated_timestamp
|
2879
|
+
# The time at which the SIP media application was updated.
|
2391
2880
|
# @return [Time]
|
2392
2881
|
#
|
2393
2882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplication AWS API Documentation
|
@@ -2403,10 +2892,14 @@ module Aws::ChimeSDKVoice
|
|
2403
2892
|
include Aws::Structure
|
2404
2893
|
end
|
2405
2894
|
|
2895
|
+
# The Alexa Skill configuration of a SIP media application.
|
2896
|
+
#
|
2406
2897
|
# @!attribute [rw] alexa_skill_status
|
2898
|
+
# The status of the Alexa Skill configuration.
|
2407
2899
|
# @return [String]
|
2408
2900
|
#
|
2409
2901
|
# @!attribute [rw] alexa_skill_ids
|
2902
|
+
# The ID of the Alexa Skill configuration.
|
2410
2903
|
# @return [Array<String>]
|
2411
2904
|
#
|
2412
2905
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationAlexaSkillConfiguration AWS API Documentation
|
@@ -2418,7 +2911,10 @@ module Aws::ChimeSDKVoice
|
|
2418
2911
|
include Aws::Structure
|
2419
2912
|
end
|
2420
2913
|
|
2914
|
+
# A `Call` instance for a SIP media application.
|
2915
|
+
#
|
2421
2916
|
# @!attribute [rw] transaction_id
|
2917
|
+
# The call's transaction ID.
|
2422
2918
|
# @return [String]
|
2423
2919
|
#
|
2424
2920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationCall AWS API Documentation
|
@@ -2429,7 +2925,12 @@ module Aws::ChimeSDKVoice
|
|
2429
2925
|
include Aws::Structure
|
2430
2926
|
end
|
2431
2927
|
|
2928
|
+
# The endpoint assigned to a SIP media application.
|
2929
|
+
#
|
2432
2930
|
# @!attribute [rw] lambda_arn
|
2931
|
+
# Valid Amazon Resource Name (ARN) of the Lambda function, version, or
|
2932
|
+
# alias. The function must be created in the same AWS Region as the
|
2933
|
+
# SIP media application.
|
2433
2934
|
# @return [String]
|
2434
2935
|
#
|
2435
2936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationEndpoint AWS API Documentation
|
@@ -2440,7 +2941,10 @@ module Aws::ChimeSDKVoice
|
|
2440
2941
|
include Aws::Structure
|
2441
2942
|
end
|
2442
2943
|
|
2944
|
+
# The logging configuration of a SIP media application.
|
2945
|
+
#
|
2443
2946
|
# @!attribute [rw] enable_sip_media_application_message_logs
|
2947
|
+
# Enables message logging for the specified SIP media application.
|
2444
2948
|
# @return [Boolean]
|
2445
2949
|
#
|
2446
2950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationLoggingConfiguration AWS API Documentation
|
@@ -2451,28 +2955,44 @@ module Aws::ChimeSDKVoice
|
|
2451
2955
|
include Aws::Structure
|
2452
2956
|
end
|
2453
2957
|
|
2958
|
+
# The details of a SIP rule, including name, triggers, and target
|
2959
|
+
# applications. An AWS account can have multiple SIP rules.
|
2960
|
+
#
|
2454
2961
|
# @!attribute [rw] sip_rule_id
|
2962
|
+
# A SIP rule's ID.
|
2455
2963
|
# @return [String]
|
2456
2964
|
#
|
2457
2965
|
# @!attribute [rw] name
|
2966
|
+
# A SIP rule's name.
|
2458
2967
|
# @return [String]
|
2459
2968
|
#
|
2460
2969
|
# @!attribute [rw] disabled
|
2970
|
+
# Indicates whether the SIP rule is enabled or disabled. You must
|
2971
|
+
# disable a rule before you can delete it.
|
2461
2972
|
# @return [Boolean]
|
2462
2973
|
#
|
2463
2974
|
# @!attribute [rw] trigger_type
|
2975
|
+
# The type of trigger set for a SIP rule, either a phone number or a
|
2976
|
+
# URI request host name.
|
2464
2977
|
# @return [String]
|
2465
2978
|
#
|
2466
2979
|
# @!attribute [rw] trigger_value
|
2980
|
+
# The value set for a SIP rule's trigger type. Either a phone number
|
2981
|
+
# or a URI hostname.
|
2467
2982
|
# @return [String]
|
2468
2983
|
#
|
2469
2984
|
# @!attribute [rw] target_applications
|
2985
|
+
# The target SIP media application and other details, such as priority
|
2986
|
+
# and AWS Region, to be specified in the SIP rule. Only one SIP rule
|
2987
|
+
# per AWS Region can be provided.
|
2470
2988
|
# @return [Array<Types::SipRuleTargetApplication>]
|
2471
2989
|
#
|
2472
2990
|
# @!attribute [rw] created_timestamp
|
2991
|
+
# The time at which the SIP rule was created, in ISO 8601 format.
|
2473
2992
|
# @return [Time]
|
2474
2993
|
#
|
2475
2994
|
# @!attribute [rw] updated_timestamp
|
2995
|
+
# The time at which the SIP rule was updated, in ISO 8601 format.
|
2476
2996
|
# @return [Time]
|
2477
2997
|
#
|
2478
2998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipRule AWS API Documentation
|
@@ -2490,13 +3010,20 @@ module Aws::ChimeSDKVoice
|
|
2490
3010
|
include Aws::Structure
|
2491
3011
|
end
|
2492
3012
|
|
3013
|
+
# A target SIP media application and other details, such as priority and
|
3014
|
+
# AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS
|
3015
|
+
# Region can be provided.
|
3016
|
+
#
|
2493
3017
|
# @!attribute [rw] sip_media_application_id
|
3018
|
+
# The ID of a rule's target SIP media application.
|
2494
3019
|
# @return [String]
|
2495
3020
|
#
|
2496
3021
|
# @!attribute [rw] priority
|
3022
|
+
# The priority setting of a rule's target SIP media application.
|
2497
3023
|
# @return [Integer]
|
2498
3024
|
#
|
2499
3025
|
# @!attribute [rw] aws_region
|
3026
|
+
# The AWS Region of a rule's target SIP media application.
|
2500
3027
|
# @return [String]
|
2501
3028
|
#
|
2502
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipRuleTargetApplication AWS API Documentation
|
@@ -2509,10 +3036,15 @@ module Aws::ChimeSDKVoice
|
|
2509
3036
|
include Aws::Structure
|
2510
3037
|
end
|
2511
3038
|
|
3039
|
+
# The details of a speaker search task.
|
3040
|
+
#
|
2512
3041
|
# @!attribute [rw] results
|
3042
|
+
# The result value in the speaker search details.
|
2513
3043
|
# @return [Array<Types::SpeakerSearchResult>]
|
2514
3044
|
#
|
2515
3045
|
# @!attribute [rw] voiceprint_generation_status
|
3046
|
+
# The status of a voice print generation operation,
|
3047
|
+
# `VoiceprintGenerationSuccess` or `VoiceprintGenerationFailure`..
|
2516
3048
|
# @return [String]
|
2517
3049
|
#
|
2518
3050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchDetails AWS API Documentation
|
@@ -2524,10 +3056,14 @@ module Aws::ChimeSDKVoice
|
|
2524
3056
|
include Aws::Structure
|
2525
3057
|
end
|
2526
3058
|
|
3059
|
+
# The result of a speaker search analysis.
|
3060
|
+
#
|
2527
3061
|
# @!attribute [rw] confidence_score
|
3062
|
+
# The confidence score in the speaker search analysis.
|
2528
3063
|
# @return [Float]
|
2529
3064
|
#
|
2530
3065
|
# @!attribute [rw] voice_profile_id
|
3066
|
+
# The voice profile ID.
|
2531
3067
|
# @return [String]
|
2532
3068
|
#
|
2533
3069
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchResult AWS API Documentation
|
@@ -2539,28 +3075,40 @@ module Aws::ChimeSDKVoice
|
|
2539
3075
|
include Aws::Structure
|
2540
3076
|
end
|
2541
3077
|
|
3078
|
+
# A representation of an asynchronous request to perform speaker search
|
3079
|
+
# analysis on a Voice Connector call.
|
3080
|
+
#
|
2542
3081
|
# @!attribute [rw] speaker_search_task_id
|
3082
|
+
# The speaker search task ID.
|
2543
3083
|
# @return [String]
|
2544
3084
|
#
|
2545
3085
|
# @!attribute [rw] speaker_search_task_status
|
3086
|
+
# The status of the speaker search task, `IN_QUEUE`, `IN_PROGRESS`,
|
3087
|
+
# `PARTIAL_SUCCESS`, `SUCCEEDED`, `FAILED`, or `STOPPED`.
|
2546
3088
|
# @return [String]
|
2547
3089
|
#
|
2548
3090
|
# @!attribute [rw] call_details
|
3091
|
+
# The call details of a speaker search task.
|
2549
3092
|
# @return [Types::CallDetails]
|
2550
3093
|
#
|
2551
3094
|
# @!attribute [rw] speaker_search_details
|
3095
|
+
# The details of a speaker search task.
|
2552
3096
|
# @return [Types::SpeakerSearchDetails]
|
2553
3097
|
#
|
2554
3098
|
# @!attribute [rw] created_timestamp
|
3099
|
+
# The time at which a speaker search task was created.
|
2555
3100
|
# @return [Time]
|
2556
3101
|
#
|
2557
3102
|
# @!attribute [rw] updated_timestamp
|
3103
|
+
# The time at which a speaker search task was updated.
|
2558
3104
|
# @return [Time]
|
2559
3105
|
#
|
2560
3106
|
# @!attribute [rw] started_timestamp
|
3107
|
+
# The time at which the speaker search task began.
|
2561
3108
|
# @return [Time]
|
2562
3109
|
#
|
2563
3110
|
# @!attribute [rw] status_message
|
3111
|
+
# A detailed message about the status of a speaker search.
|
2564
3112
|
# @return [String]
|
2565
3113
|
#
|
2566
3114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchTask AWS API Documentation
|
@@ -2579,15 +3127,21 @@ module Aws::ChimeSDKVoice
|
|
2579
3127
|
end
|
2580
3128
|
|
2581
3129
|
# @!attribute [rw] voice_connector_id
|
3130
|
+
# The Voice Connector ID.
|
2582
3131
|
# @return [String]
|
2583
3132
|
#
|
2584
3133
|
# @!attribute [rw] transaction_id
|
3134
|
+
# The transaction ID of the call being analyzed.
|
2585
3135
|
# @return [String]
|
2586
3136
|
#
|
2587
3137
|
# @!attribute [rw] voice_profile_domain_id
|
3138
|
+
# The ID of the voice profile domain that will store the voice
|
3139
|
+
# profile.
|
2588
3140
|
# @return [String]
|
2589
3141
|
#
|
2590
3142
|
# @!attribute [rw] client_request_token
|
3143
|
+
# The unique identifier for the client request. Use a different token
|
3144
|
+
# for different speaker search tasks.
|
2591
3145
|
# @return [String]
|
2592
3146
|
#
|
2593
3147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTaskRequest AWS API Documentation
|
@@ -2602,6 +3156,7 @@ module Aws::ChimeSDKVoice
|
|
2602
3156
|
end
|
2603
3157
|
|
2604
3158
|
# @!attribute [rw] speaker_search_task
|
3159
|
+
# The details of the speaker search task.
|
2605
3160
|
# @return [Types::SpeakerSearchTask]
|
2606
3161
|
#
|
2607
3162
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTaskResponse AWS API Documentation
|
@@ -2613,15 +3168,20 @@ module Aws::ChimeSDKVoice
|
|
2613
3168
|
end
|
2614
3169
|
|
2615
3170
|
# @!attribute [rw] voice_connector_id
|
3171
|
+
# The Voice Connector ID.
|
2616
3172
|
# @return [String]
|
2617
3173
|
#
|
2618
3174
|
# @!attribute [rw] transaction_id
|
3175
|
+
# The transaction ID.
|
2619
3176
|
# @return [String]
|
2620
3177
|
#
|
2621
3178
|
# @!attribute [rw] language_code
|
3179
|
+
# The language code.
|
2622
3180
|
# @return [String]
|
2623
3181
|
#
|
2624
3182
|
# @!attribute [rw] client_request_token
|
3183
|
+
# The unique identifier for the client request. Use a different token
|
3184
|
+
# for different voice tone analysis tasks.
|
2625
3185
|
# @return [String]
|
2626
3186
|
#
|
2627
3187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTaskRequest AWS API Documentation
|
@@ -2636,6 +3196,7 @@ module Aws::ChimeSDKVoice
|
|
2636
3196
|
end
|
2637
3197
|
|
2638
3198
|
# @!attribute [rw] voice_tone_analysis_task
|
3199
|
+
# The details of the voice tone analysis task.
|
2639
3200
|
# @return [Types::VoiceToneAnalysisTask]
|
2640
3201
|
#
|
2641
3202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTaskResponse AWS API Documentation
|
@@ -2647,9 +3208,11 @@ module Aws::ChimeSDKVoice
|
|
2647
3208
|
end
|
2648
3209
|
|
2649
3210
|
# @!attribute [rw] voice_connector_id
|
3211
|
+
# The Voice Connector ID.
|
2650
3212
|
# @return [String]
|
2651
3213
|
#
|
2652
3214
|
# @!attribute [rw] speaker_search_task_id
|
3215
|
+
# The speaker search task ID.
|
2653
3216
|
# @return [String]
|
2654
3217
|
#
|
2655
3218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopSpeakerSearchTaskRequest AWS API Documentation
|
@@ -2662,9 +3225,11 @@ module Aws::ChimeSDKVoice
|
|
2662
3225
|
end
|
2663
3226
|
|
2664
3227
|
# @!attribute [rw] voice_connector_id
|
3228
|
+
# The Voice Connector ID.
|
2665
3229
|
# @return [String]
|
2666
3230
|
#
|
2667
3231
|
# @!attribute [rw] voice_tone_analysis_task_id
|
3232
|
+
# The ID of the voice tone analysis task.
|
2668
3233
|
# @return [String]
|
2669
3234
|
#
|
2670
3235
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTaskRequest AWS API Documentation
|
@@ -2676,16 +3241,25 @@ module Aws::ChimeSDKVoice
|
|
2676
3241
|
include Aws::Structure
|
2677
3242
|
end
|
2678
3243
|
|
3244
|
+
# The streaming configuration associated with an Amazon Chime SDK Voice
|
3245
|
+
# Connector. Specifies whether media streaming is enabled for sending to
|
3246
|
+
# Amazon Kinesis, and shows the retention period for the Amazon Kinesis
|
3247
|
+
# data, in hours.
|
3248
|
+
#
|
2679
3249
|
# @!attribute [rw] data_retention_in_hours
|
3250
|
+
# The amount of time, in hours, to the Kinesis data.
|
2680
3251
|
# @return [Integer]
|
2681
3252
|
#
|
2682
3253
|
# @!attribute [rw] disabled
|
3254
|
+
# When true, streaming to Kinesis is off.
|
2683
3255
|
# @return [Boolean]
|
2684
3256
|
#
|
2685
3257
|
# @!attribute [rw] streaming_notification_targets
|
3258
|
+
# The streaming notification targets.
|
2686
3259
|
# @return [Array<Types::StreamingNotificationTarget>]
|
2687
3260
|
#
|
2688
3261
|
# @!attribute [rw] media_insights_configuration
|
3262
|
+
# The call analytics configuration.
|
2689
3263
|
# @return [Types::MediaInsightsConfiguration]
|
2690
3264
|
#
|
2691
3265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StreamingConfiguration AWS API Documentation
|
@@ -2699,7 +3273,10 @@ module Aws::ChimeSDKVoice
|
|
2699
3273
|
include Aws::Structure
|
2700
3274
|
end
|
2701
3275
|
|
3276
|
+
# The target recipient for a streaming configuration notification.
|
3277
|
+
#
|
2702
3278
|
# @!attribute [rw] notification_target
|
3279
|
+
# The streaming notification target.
|
2703
3280
|
# @return [String]
|
2704
3281
|
#
|
2705
3282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StreamingNotificationTarget AWS API Documentation
|
@@ -2710,10 +3287,14 @@ module Aws::ChimeSDKVoice
|
|
2710
3287
|
include Aws::Structure
|
2711
3288
|
end
|
2712
3289
|
|
3290
|
+
# Describes a tag applied to a resource.
|
3291
|
+
#
|
2713
3292
|
# @!attribute [rw] key
|
3293
|
+
# The tag's key.
|
2714
3294
|
# @return [String]
|
2715
3295
|
#
|
2716
3296
|
# @!attribute [rw] value
|
3297
|
+
# The tag's value.
|
2717
3298
|
# @return [String]
|
2718
3299
|
#
|
2719
3300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Tag AWS API Documentation
|
@@ -2726,9 +3307,11 @@ module Aws::ChimeSDKVoice
|
|
2726
3307
|
end
|
2727
3308
|
|
2728
3309
|
# @!attribute [rw] resource_arn
|
3310
|
+
# The ARN of the resource being tagged.
|
2729
3311
|
# @return [String]
|
2730
3312
|
#
|
2731
3313
|
# @!attribute [rw] tags
|
3314
|
+
# A list of the tags being added to the resource.
|
2732
3315
|
# @return [Array<Types::Tag>]
|
2733
3316
|
#
|
2734
3317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TagResourceRequest AWS API Documentation
|
@@ -2740,19 +3323,29 @@ module Aws::ChimeSDKVoice
|
|
2740
3323
|
include Aws::Structure
|
2741
3324
|
end
|
2742
3325
|
|
3326
|
+
# Termination settings enable SIP hosts to make outbound calls using an
|
3327
|
+
# Amazon Chime SDK Voice Connector.
|
3328
|
+
#
|
2743
3329
|
# @!attribute [rw] cps_limit
|
3330
|
+
# The limit on calls per second. Max value based on account service
|
3331
|
+
# quota. Default value of 1.
|
2744
3332
|
# @return [Integer]
|
2745
3333
|
#
|
2746
3334
|
# @!attribute [rw] default_phone_number
|
3335
|
+
# The default outbound calling number.
|
2747
3336
|
# @return [String]
|
2748
3337
|
#
|
2749
3338
|
# @!attribute [rw] calling_regions
|
3339
|
+
# The countries to which calls are allowed, in ISO 3166-1 alpha-2
|
3340
|
+
# format. Required.
|
2750
3341
|
# @return [Array<String>]
|
2751
3342
|
#
|
2752
3343
|
# @!attribute [rw] cidr_allowed_list
|
3344
|
+
# The IP addresses allowed to make calls, in CIDR format.
|
2753
3345
|
# @return [Array<String>]
|
2754
3346
|
#
|
2755
3347
|
# @!attribute [rw] disabled
|
3348
|
+
# When termination is disabled, outbound calls cannot be made.
|
2756
3349
|
# @return [Boolean]
|
2757
3350
|
#
|
2758
3351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Termination AWS API Documentation
|
@@ -2767,10 +3360,16 @@ module Aws::ChimeSDKVoice
|
|
2767
3360
|
include Aws::Structure
|
2768
3361
|
end
|
2769
3362
|
|
3363
|
+
# The termination health details, including the source IP address and
|
3364
|
+
# timestamp of the last successful `SIP OPTIONS` message from your SIP
|
3365
|
+
# infrastructure.
|
3366
|
+
#
|
2770
3367
|
# @!attribute [rw] timestamp
|
3368
|
+
# The timestamp, in ISO 8601 format.
|
2771
3369
|
# @return [Time]
|
2772
3370
|
#
|
2773
3371
|
# @!attribute [rw] source
|
3372
|
+
# The source IP address.
|
2774
3373
|
# @return [String]
|
2775
3374
|
#
|
2776
3375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TerminationHealth AWS API Documentation
|
@@ -2782,22 +3381,30 @@ module Aws::ChimeSDKVoice
|
|
2782
3381
|
include Aws::Structure
|
2783
3382
|
end
|
2784
3383
|
|
3384
|
+
# The number of customer requests exceeds the request rate limit.
|
3385
|
+
#
|
2785
3386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ThrottledClientException AWS API Documentation
|
2786
3387
|
#
|
2787
3388
|
class ThrottledClientException < Aws::EmptyStructure; end
|
2788
3389
|
|
3390
|
+
# The client isn't authorized to request a resource.
|
3391
|
+
#
|
2789
3392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UnauthorizedClientException AWS API Documentation
|
2790
3393
|
#
|
2791
3394
|
class UnauthorizedClientException < Aws::EmptyStructure; end
|
2792
3395
|
|
3396
|
+
# A well-formed request couldn't be followed due to semantic errors.
|
3397
|
+
#
|
2793
3398
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UnprocessableEntityException AWS API Documentation
|
2794
3399
|
#
|
2795
3400
|
class UnprocessableEntityException < Aws::EmptyStructure; end
|
2796
3401
|
|
2797
3402
|
# @!attribute [rw] resource_arn
|
3403
|
+
# The ARN of the resource having its tags removed.
|
2798
3404
|
# @return [String]
|
2799
3405
|
#
|
2800
3406
|
# @!attribute [rw] tag_keys
|
3407
|
+
# The keys of the tags being removed from the resource.
|
2801
3408
|
# @return [Array<String>]
|
2802
3409
|
#
|
2803
3410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UntagResourceRequest AWS API Documentation
|
@@ -2810,6 +3417,7 @@ module Aws::ChimeSDKVoice
|
|
2810
3417
|
end
|
2811
3418
|
|
2812
3419
|
# @!attribute [rw] voice_connector
|
3420
|
+
# The Voice Connector settings.
|
2813
3421
|
# @return [Types::VoiceConnectorSettings]
|
2814
3422
|
#
|
2815
3423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateGlobalSettingsRequest AWS API Documentation
|
@@ -2821,12 +3429,15 @@ module Aws::ChimeSDKVoice
|
|
2821
3429
|
end
|
2822
3430
|
|
2823
3431
|
# @!attribute [rw] phone_number_id
|
3432
|
+
# The phone number ID.
|
2824
3433
|
# @return [String]
|
2825
3434
|
#
|
2826
3435
|
# @!attribute [rw] product_type
|
3436
|
+
# The product type.
|
2827
3437
|
# @return [String]
|
2828
3438
|
#
|
2829
3439
|
# @!attribute [rw] calling_name
|
3440
|
+
# The outbound calling name associated with the phone number.
|
2830
3441
|
# @return [String]
|
2831
3442
|
#
|
2832
3443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberRequest AWS API Documentation
|
@@ -2839,13 +3450,19 @@ module Aws::ChimeSDKVoice
|
|
2839
3450
|
include Aws::Structure
|
2840
3451
|
end
|
2841
3452
|
|
3453
|
+
# The phone number ID, product type, or calling name fields to update,
|
3454
|
+
# used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
|
3455
|
+
#
|
2842
3456
|
# @!attribute [rw] phone_number_id
|
3457
|
+
# The phone number ID to update.
|
2843
3458
|
# @return [String]
|
2844
3459
|
#
|
2845
3460
|
# @!attribute [rw] product_type
|
3461
|
+
# The product type to update.
|
2846
3462
|
# @return [String]
|
2847
3463
|
#
|
2848
3464
|
# @!attribute [rw] calling_name
|
3465
|
+
# The outbound calling name to update.
|
2849
3466
|
# @return [String]
|
2850
3467
|
#
|
2851
3468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberRequestItem AWS API Documentation
|
@@ -2859,6 +3476,7 @@ module Aws::ChimeSDKVoice
|
|
2859
3476
|
end
|
2860
3477
|
|
2861
3478
|
# @!attribute [rw] phone_number
|
3479
|
+
# The updated phone number details.
|
2862
3480
|
# @return [Types::PhoneNumber]
|
2863
3481
|
#
|
2864
3482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberResponse AWS API Documentation
|
@@ -2870,6 +3488,7 @@ module Aws::ChimeSDKVoice
|
|
2870
3488
|
end
|
2871
3489
|
|
2872
3490
|
# @!attribute [rw] calling_name
|
3491
|
+
# The default outbound calling name for the account.
|
2873
3492
|
# @return [String]
|
2874
3493
|
#
|
2875
3494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettingsRequest AWS API Documentation
|
@@ -2881,15 +3500,19 @@ module Aws::ChimeSDKVoice
|
|
2881
3500
|
end
|
2882
3501
|
|
2883
3502
|
# @!attribute [rw] voice_connector_id
|
3503
|
+
# The Voice Connector ID.
|
2884
3504
|
# @return [String]
|
2885
3505
|
#
|
2886
3506
|
# @!attribute [rw] proxy_session_id
|
3507
|
+
# The proxy session ID.
|
2887
3508
|
# @return [String]
|
2888
3509
|
#
|
2889
3510
|
# @!attribute [rw] capabilities
|
3511
|
+
# The proxy session capabilities.
|
2890
3512
|
# @return [Array<String>]
|
2891
3513
|
#
|
2892
3514
|
# @!attribute [rw] expiry_minutes
|
3515
|
+
# The number of minutes allowed for the proxy session.
|
2893
3516
|
# @return [Integer]
|
2894
3517
|
#
|
2895
3518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySessionRequest AWS API Documentation
|
@@ -2904,6 +3527,7 @@ module Aws::ChimeSDKVoice
|
|
2904
3527
|
end
|
2905
3528
|
|
2906
3529
|
# @!attribute [rw] proxy_session
|
3530
|
+
# The updated proxy session details.
|
2907
3531
|
# @return [Types::ProxySession]
|
2908
3532
|
#
|
2909
3533
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySessionResponse AWS API Documentation
|
@@ -2915,12 +3539,16 @@ module Aws::ChimeSDKVoice
|
|
2915
3539
|
end
|
2916
3540
|
|
2917
3541
|
# @!attribute [rw] sip_media_application_id
|
3542
|
+
# The ID of the SIP media application handling the call.
|
2918
3543
|
# @return [String]
|
2919
3544
|
#
|
2920
3545
|
# @!attribute [rw] transaction_id
|
3546
|
+
# The ID of the call transaction.
|
2921
3547
|
# @return [String]
|
2922
3548
|
#
|
2923
3549
|
# @!attribute [rw] arguments
|
3550
|
+
# Arguments made available to the Lambda function as part of the
|
3551
|
+
# `CALL_UPDATE_REQUESTED` event. Can contain 0-20 key-value pairs.
|
2924
3552
|
# @return [Hash<String,String>]
|
2925
3553
|
#
|
2926
3554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCallRequest AWS API Documentation
|
@@ -2934,6 +3562,7 @@ module Aws::ChimeSDKVoice
|
|
2934
3562
|
end
|
2935
3563
|
|
2936
3564
|
# @!attribute [rw] sip_media_application_call
|
3565
|
+
# A `Call` instance for a SIP media application.
|
2937
3566
|
# @return [Types::SipMediaApplicationCall]
|
2938
3567
|
#
|
2939
3568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCallResponse AWS API Documentation
|
@@ -2945,12 +3574,15 @@ module Aws::ChimeSDKVoice
|
|
2945
3574
|
end
|
2946
3575
|
|
2947
3576
|
# @!attribute [rw] sip_media_application_id
|
3577
|
+
# The SIP media application ID.
|
2948
3578
|
# @return [String]
|
2949
3579
|
#
|
2950
3580
|
# @!attribute [rw] name
|
3581
|
+
# The new name for the specified SIP media application.
|
2951
3582
|
# @return [String]
|
2952
3583
|
#
|
2953
3584
|
# @!attribute [rw] endpoints
|
3585
|
+
# The new set of endpoints for the specified SIP media application.
|
2954
3586
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
2955
3587
|
#
|
2956
3588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationRequest AWS API Documentation
|
@@ -2964,6 +3596,7 @@ module Aws::ChimeSDKVoice
|
|
2964
3596
|
end
|
2965
3597
|
|
2966
3598
|
# @!attribute [rw] sip_media_application
|
3599
|
+
# The updated SIP media application’s details.
|
2967
3600
|
# @return [Types::SipMediaApplication]
|
2968
3601
|
#
|
2969
3602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationResponse AWS API Documentation
|
@@ -2975,15 +3608,19 @@ module Aws::ChimeSDKVoice
|
|
2975
3608
|
end
|
2976
3609
|
|
2977
3610
|
# @!attribute [rw] sip_rule_id
|
3611
|
+
# The SIP rule ID.
|
2978
3612
|
# @return [String]
|
2979
3613
|
#
|
2980
3614
|
# @!attribute [rw] name
|
3615
|
+
# The new name for the specified SIP rule.
|
2981
3616
|
# @return [String]
|
2982
3617
|
#
|
2983
3618
|
# @!attribute [rw] disabled
|
3619
|
+
# The new value that indicates whether the rule is disabled.
|
2984
3620
|
# @return [Boolean]
|
2985
3621
|
#
|
2986
3622
|
# @!attribute [rw] target_applications
|
3623
|
+
# The new list of target applications.
|
2987
3624
|
# @return [Array<Types::SipRuleTargetApplication>]
|
2988
3625
|
#
|
2989
3626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRuleRequest AWS API Documentation
|
@@ -2998,6 +3635,7 @@ module Aws::ChimeSDKVoice
|
|
2998
3635
|
end
|
2999
3636
|
|
3000
3637
|
# @!attribute [rw] sip_rule
|
3638
|
+
# The updated SIP rule details.
|
3001
3639
|
# @return [Types::SipRule]
|
3002
3640
|
#
|
3003
3641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRuleResponse AWS API Documentation
|
@@ -3009,12 +3647,16 @@ module Aws::ChimeSDKVoice
|
|
3009
3647
|
end
|
3010
3648
|
|
3011
3649
|
# @!attribute [rw] voice_connector_group_id
|
3650
|
+
# The Voice Connector ID.
|
3012
3651
|
# @return [String]
|
3013
3652
|
#
|
3014
3653
|
# @!attribute [rw] name
|
3654
|
+
# The name of the Voice Connector group.
|
3015
3655
|
# @return [String]
|
3016
3656
|
#
|
3017
3657
|
# @!attribute [rw] voice_connector_items
|
3658
|
+
# The `VoiceConnectorItems` to associate with the Voice Connector
|
3659
|
+
# group.
|
3018
3660
|
# @return [Array<Types::VoiceConnectorItem>]
|
3019
3661
|
#
|
3020
3662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroupRequest AWS API Documentation
|
@@ -3028,6 +3670,7 @@ module Aws::ChimeSDKVoice
|
|
3028
3670
|
end
|
3029
3671
|
|
3030
3672
|
# @!attribute [rw] voice_connector_group
|
3673
|
+
# The updated Voice Connector group.
|
3031
3674
|
# @return [Types::VoiceConnectorGroup]
|
3032
3675
|
#
|
3033
3676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroupResponse AWS API Documentation
|
@@ -3039,12 +3682,15 @@ module Aws::ChimeSDKVoice
|
|
3039
3682
|
end
|
3040
3683
|
|
3041
3684
|
# @!attribute [rw] voice_connector_id
|
3685
|
+
# The Voice Connector ID.
|
3042
3686
|
# @return [String]
|
3043
3687
|
#
|
3044
3688
|
# @!attribute [rw] name
|
3689
|
+
# The name of the Voice Connector.
|
3045
3690
|
# @return [String]
|
3046
3691
|
#
|
3047
3692
|
# @!attribute [rw] require_encryption
|
3693
|
+
# When enabled, requires encryption for the Voice Connector.
|
3048
3694
|
# @return [Boolean]
|
3049
3695
|
#
|
3050
3696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorRequest AWS API Documentation
|
@@ -3058,6 +3704,7 @@ module Aws::ChimeSDKVoice
|
|
3058
3704
|
end
|
3059
3705
|
|
3060
3706
|
# @!attribute [rw] voice_connector
|
3707
|
+
# The updated Voice Connector details.
|
3061
3708
|
# @return [Types::VoiceConnector]
|
3062
3709
|
#
|
3063
3710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorResponse AWS API Documentation
|
@@ -3069,12 +3716,15 @@ module Aws::ChimeSDKVoice
|
|
3069
3716
|
end
|
3070
3717
|
|
3071
3718
|
# @!attribute [rw] voice_profile_domain_id
|
3719
|
+
# The domain ID.
|
3072
3720
|
# @return [String]
|
3073
3721
|
#
|
3074
3722
|
# @!attribute [rw] name
|
3723
|
+
# The name of the voice profile domain.
|
3075
3724
|
# @return [String]
|
3076
3725
|
#
|
3077
3726
|
# @!attribute [rw] description
|
3727
|
+
# The description of the voice profile domain.
|
3078
3728
|
# @return [String]
|
3079
3729
|
#
|
3080
3730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomainRequest AWS API Documentation
|
@@ -3088,6 +3738,7 @@ module Aws::ChimeSDKVoice
|
|
3088
3738
|
end
|
3089
3739
|
|
3090
3740
|
# @!attribute [rw] voice_profile_domain
|
3741
|
+
# The updated details of the voice profile domain.
|
3091
3742
|
# @return [Types::VoiceProfileDomain]
|
3092
3743
|
#
|
3093
3744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomainResponse AWS API Documentation
|
@@ -3099,9 +3750,11 @@ module Aws::ChimeSDKVoice
|
|
3099
3750
|
end
|
3100
3751
|
|
3101
3752
|
# @!attribute [rw] voice_profile_id
|
3753
|
+
# The profile ID.
|
3102
3754
|
# @return [String]
|
3103
3755
|
#
|
3104
3756
|
# @!attribute [rw] speaker_search_task_id
|
3757
|
+
# The ID of the speaker search task.
|
3105
3758
|
# @return [String]
|
3106
3759
|
#
|
3107
3760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileRequest AWS API Documentation
|
@@ -3114,6 +3767,7 @@ module Aws::ChimeSDKVoice
|
|
3114
3767
|
end
|
3115
3768
|
|
3116
3769
|
# @!attribute [rw] voice_profile
|
3770
|
+
# The updated voice profile settings.
|
3117
3771
|
# @return [Types::VoiceProfile]
|
3118
3772
|
#
|
3119
3773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileResponse AWS API Documentation
|
@@ -3125,24 +3779,31 @@ module Aws::ChimeSDKVoice
|
|
3125
3779
|
end
|
3126
3780
|
|
3127
3781
|
# @!attribute [rw] aws_account_id
|
3782
|
+
# The AWS account ID.
|
3128
3783
|
# @return [String]
|
3129
3784
|
#
|
3130
3785
|
# @!attribute [rw] street_number
|
3786
|
+
# The address street number, such as `200` or `2121`.
|
3131
3787
|
# @return [String]
|
3132
3788
|
#
|
3133
3789
|
# @!attribute [rw] street_info
|
3790
|
+
# The address street information, such as `8th Avenue`.
|
3134
3791
|
# @return [String]
|
3135
3792
|
#
|
3136
3793
|
# @!attribute [rw] city
|
3794
|
+
# The address city, such as `Portland`.
|
3137
3795
|
# @return [String]
|
3138
3796
|
#
|
3139
3797
|
# @!attribute [rw] state
|
3798
|
+
# The address state, such as `ME`.
|
3140
3799
|
# @return [String]
|
3141
3800
|
#
|
3142
3801
|
# @!attribute [rw] country
|
3802
|
+
# The country in the address being validated.
|
3143
3803
|
# @return [String]
|
3144
3804
|
#
|
3145
3805
|
# @!attribute [rw] postal_code
|
3806
|
+
# The dress postal code, such `04352`.
|
3146
3807
|
# @return [String]
|
3147
3808
|
#
|
3148
3809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911AddressRequest AWS API Documentation
|
@@ -3160,15 +3821,22 @@ module Aws::ChimeSDKVoice
|
|
3160
3821
|
end
|
3161
3822
|
|
3162
3823
|
# @!attribute [rw] validation_result
|
3824
|
+
# Number indicating the result of address validation. `0` means the
|
3825
|
+
# address was perfect as-is and successfully validated. `1` means the
|
3826
|
+
# address was corrected. `2` means the address sent was not close
|
3827
|
+
# enough and was not validated.
|
3163
3828
|
# @return [Integer]
|
3164
3829
|
#
|
3165
3830
|
# @!attribute [rw] address_external_id
|
3831
|
+
# The ID that represents the address.
|
3166
3832
|
# @return [String]
|
3167
3833
|
#
|
3168
3834
|
# @!attribute [rw] address
|
3835
|
+
# The validated address.
|
3169
3836
|
# @return [Types::Address]
|
3170
3837
|
#
|
3171
3838
|
# @!attribute [rw] candidate_address_list
|
3839
|
+
# The list of address suggestions..
|
3172
3840
|
# @return [Array<Types::CandidateAddress>]
|
3173
3841
|
#
|
3174
3842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911AddressResponse AWS API Documentation
|
@@ -3182,28 +3850,40 @@ module Aws::ChimeSDKVoice
|
|
3182
3850
|
include Aws::Structure
|
3183
3851
|
end
|
3184
3852
|
|
3853
|
+
# The Amazon Chime SDK Voice Connector configuration, including outbound
|
3854
|
+
# host name and encryption settings.
|
3855
|
+
#
|
3185
3856
|
# @!attribute [rw] voice_connector_id
|
3857
|
+
# The Voice Connector's ID.
|
3186
3858
|
# @return [String]
|
3187
3859
|
#
|
3188
3860
|
# @!attribute [rw] aws_region
|
3861
|
+
# The AWS Region in which the Voice Connector is created. Default:
|
3862
|
+
# us-east-1.
|
3189
3863
|
# @return [String]
|
3190
3864
|
#
|
3191
3865
|
# @!attribute [rw] name
|
3866
|
+
# The Voice Connector's name.
|
3192
3867
|
# @return [String]
|
3193
3868
|
#
|
3194
3869
|
# @!attribute [rw] outbound_host_name
|
3870
|
+
# The outbound host name for the Voice Connector.
|
3195
3871
|
# @return [String]
|
3196
3872
|
#
|
3197
3873
|
# @!attribute [rw] require_encryption
|
3874
|
+
# Enables or disables encryption for the Voice Connector.
|
3198
3875
|
# @return [Boolean]
|
3199
3876
|
#
|
3200
3877
|
# @!attribute [rw] created_timestamp
|
3878
|
+
# The Voice Connector's creation timestamp, in ISO 8601 format.
|
3201
3879
|
# @return [Time]
|
3202
3880
|
#
|
3203
3881
|
# @!attribute [rw] updated_timestamp
|
3882
|
+
# The Voice Connector's updated timestamp, in ISO 8601 format.
|
3204
3883
|
# @return [Time]
|
3205
3884
|
#
|
3206
3885
|
# @!attribute [rw] voice_connector_arn
|
3886
|
+
# The ARN of the Voice Connector.
|
3207
3887
|
# @return [String]
|
3208
3888
|
#
|
3209
3889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnector AWS API Documentation
|
@@ -3221,22 +3901,35 @@ module Aws::ChimeSDKVoice
|
|
3221
3901
|
include Aws::Structure
|
3222
3902
|
end
|
3223
3903
|
|
3904
|
+
# The Amazon Chime SDK Voice Connector group configuration, including
|
3905
|
+
# associated Voice Connectors. You can include Voice Connectors from
|
3906
|
+
# different AWS Regions in a group. This creates a fault tolerant
|
3907
|
+
# mechanism for fallback in case of availability events.
|
3908
|
+
#
|
3224
3909
|
# @!attribute [rw] voice_connector_group_id
|
3910
|
+
# The ID of a Voice Connector group.
|
3225
3911
|
# @return [String]
|
3226
3912
|
#
|
3227
3913
|
# @!attribute [rw] name
|
3914
|
+
# The name of a Voice Connector group.
|
3228
3915
|
# @return [String]
|
3229
3916
|
#
|
3230
3917
|
# @!attribute [rw] voice_connector_items
|
3918
|
+
# The Voice Connectors to which you route inbound calls.
|
3231
3919
|
# @return [Array<Types::VoiceConnectorItem>]
|
3232
3920
|
#
|
3233
3921
|
# @!attribute [rw] created_timestamp
|
3922
|
+
# The Voice Connector group's creation time stamp, in ISO 8601
|
3923
|
+
# format.
|
3234
3924
|
# @return [Time]
|
3235
3925
|
#
|
3236
3926
|
# @!attribute [rw] updated_timestamp
|
3927
|
+
# The Voice Connector group's creation time stamp, in ISO 8601
|
3928
|
+
# format.
|
3237
3929
|
# @return [Time]
|
3238
3930
|
#
|
3239
3931
|
# @!attribute [rw] voice_connector_group_arn
|
3932
|
+
# The ARN of the Voice Connector group.
|
3240
3933
|
# @return [String]
|
3241
3934
|
#
|
3242
3935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorGroup AWS API Documentation
|
@@ -3252,10 +3945,20 @@ module Aws::ChimeSDKVoice
|
|
3252
3945
|
include Aws::Structure
|
3253
3946
|
end
|
3254
3947
|
|
3948
|
+
# For Amazon Chime SDK Voice Connector groups, the Amazon Chime SDK
|
3949
|
+
# Voice Connectors to which you route inbound calls. Includes priority
|
3950
|
+
# configuration settings. Limit: 3 VoiceConnectorItems per Voice
|
3951
|
+
# Connector group.
|
3952
|
+
#
|
3255
3953
|
# @!attribute [rw] voice_connector_id
|
3954
|
+
# The Voice Connector ID.
|
3256
3955
|
# @return [String]
|
3257
3956
|
#
|
3258
3957
|
# @!attribute [rw] priority
|
3958
|
+
# The priority setting of a Voice Connector item. Calls are routed to
|
3959
|
+
# hosts in priority order, with 1 as the highest priority. When hosts
|
3960
|
+
# have equal priority, the system distributes calls among them based
|
3961
|
+
# on their relative weight.
|
3259
3962
|
# @return [Integer]
|
3260
3963
|
#
|
3261
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorItem AWS API Documentation
|
@@ -3267,7 +3970,12 @@ module Aws::ChimeSDKVoice
|
|
3267
3970
|
include Aws::Structure
|
3268
3971
|
end
|
3269
3972
|
|
3973
|
+
# The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3
|
3974
|
+
# buckets designated for storing call detail records.
|
3975
|
+
#
|
3270
3976
|
# @!attribute [rw] cdr_bucket
|
3977
|
+
# The S3 bucket that stores the Voice Connector's call detail
|
3978
|
+
# records.
|
3271
3979
|
# @return [String]
|
3272
3980
|
#
|
3273
3981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorSettings AWS API Documentation
|
@@ -3278,22 +3986,31 @@ module Aws::ChimeSDKVoice
|
|
3278
3986
|
include Aws::Structure
|
3279
3987
|
end
|
3280
3988
|
|
3989
|
+
# The combination of a voice print and caller ID.
|
3990
|
+
#
|
3281
3991
|
# @!attribute [rw] voice_profile_id
|
3992
|
+
# The ID of the voice profile.
|
3282
3993
|
# @return [String]
|
3283
3994
|
#
|
3284
3995
|
# @!attribute [rw] voice_profile_arn
|
3996
|
+
# The ARN of the voice profile.
|
3285
3997
|
# @return [String]
|
3286
3998
|
#
|
3287
3999
|
# @!attribute [rw] voice_profile_domain_id
|
4000
|
+
# The ID of the domain that contains the voice profile.
|
3288
4001
|
# @return [String]
|
3289
4002
|
#
|
3290
4003
|
# @!attribute [rw] created_timestamp
|
4004
|
+
# The time at which the voice profile was created and enrolled.
|
3291
4005
|
# @return [Time]
|
3292
4006
|
#
|
3293
4007
|
# @!attribute [rw] updated_timestamp
|
4008
|
+
# The time at which the voice profile was last updated.
|
3294
4009
|
# @return [Time]
|
3295
4010
|
#
|
3296
4011
|
# @!attribute [rw] expiration_timestamp
|
4012
|
+
# The time at which a voice profile expires unless you re-enroll the
|
4013
|
+
# caller via the `UpdateVoiceProfile` API.
|
3297
4014
|
# @return [Time]
|
3298
4015
|
#
|
3299
4016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfile AWS API Documentation
|
@@ -3309,25 +4026,35 @@ module Aws::ChimeSDKVoice
|
|
3309
4026
|
include Aws::Structure
|
3310
4027
|
end
|
3311
4028
|
|
4029
|
+
# A collection of voice profiles.
|
4030
|
+
#
|
3312
4031
|
# @!attribute [rw] voice_profile_domain_id
|
4032
|
+
# The ID of the voice profile domain.
|
3313
4033
|
# @return [String]
|
3314
4034
|
#
|
3315
4035
|
# @!attribute [rw] voice_profile_domain_arn
|
4036
|
+
# The voice profile domain's Amazon Resource Number (ARN).
|
3316
4037
|
# @return [String]
|
3317
4038
|
#
|
3318
4039
|
# @!attribute [rw] name
|
4040
|
+
# The name of the voice profile domain.
|
3319
4041
|
# @return [String]
|
3320
4042
|
#
|
3321
4043
|
# @!attribute [rw] description
|
4044
|
+
# The description of the voice profile domain.
|
3322
4045
|
# @return [String]
|
3323
4046
|
#
|
3324
4047
|
# @!attribute [rw] server_side_encryption_configuration
|
4048
|
+
# A structure that contains the configuration settings for server-side
|
4049
|
+
# encryption.
|
3325
4050
|
# @return [Types::ServerSideEncryptionConfiguration]
|
3326
4051
|
#
|
3327
4052
|
# @!attribute [rw] created_timestamp
|
4053
|
+
# The time at which the voice profile domain was created.
|
3328
4054
|
# @return [Time]
|
3329
4055
|
#
|
3330
4056
|
# @!attribute [rw] updated_timestamp
|
4057
|
+
# The time at which the voice profile was last updated.
|
3331
4058
|
# @return [Time]
|
3332
4059
|
#
|
3333
4060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileDomain AWS API Documentation
|
@@ -3344,22 +4071,30 @@ module Aws::ChimeSDKVoice
|
|
3344
4071
|
include Aws::Structure
|
3345
4072
|
end
|
3346
4073
|
|
4074
|
+
# A high-level overview of a voice profile domain.
|
4075
|
+
#
|
3347
4076
|
# @!attribute [rw] voice_profile_domain_id
|
4077
|
+
# The ID of the voice profile domain summary.
|
3348
4078
|
# @return [String]
|
3349
4079
|
#
|
3350
4080
|
# @!attribute [rw] voice_profile_domain_arn
|
4081
|
+
# The ARN of a voice profile in a voice profile domain summary.
|
3351
4082
|
# @return [String]
|
3352
4083
|
#
|
3353
4084
|
# @!attribute [rw] name
|
4085
|
+
# The name of the voice profile domain summary.
|
3354
4086
|
# @return [String]
|
3355
4087
|
#
|
3356
4088
|
# @!attribute [rw] description
|
4089
|
+
# Describes the voice profile domain summary.
|
3357
4090
|
# @return [String]
|
3358
4091
|
#
|
3359
4092
|
# @!attribute [rw] created_timestamp
|
4093
|
+
# The time at which the voice profile domain summary was created.
|
3360
4094
|
# @return [Time]
|
3361
4095
|
#
|
3362
4096
|
# @!attribute [rw] updated_timestamp
|
4097
|
+
# The time at which the voice profile domain summary was last updated.
|
3363
4098
|
# @return [Time]
|
3364
4099
|
#
|
3365
4100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileDomainSummary AWS API Documentation
|
@@ -3375,22 +4110,32 @@ module Aws::ChimeSDKVoice
|
|
3375
4110
|
include Aws::Structure
|
3376
4111
|
end
|
3377
4112
|
|
4113
|
+
# A high-level summary of a voice profile.
|
4114
|
+
#
|
3378
4115
|
# @!attribute [rw] voice_profile_id
|
4116
|
+
# The ID of the voice profile in a voice profile summary.
|
3379
4117
|
# @return [String]
|
3380
4118
|
#
|
3381
4119
|
# @!attribute [rw] voice_profile_arn
|
4120
|
+
# The ARN of the voice profile in a voice profile summary.
|
3382
4121
|
# @return [String]
|
3383
4122
|
#
|
3384
4123
|
# @!attribute [rw] voice_profile_domain_id
|
4124
|
+
# The ID of the voice profile domain in a voice profile summary.
|
3385
4125
|
# @return [String]
|
3386
4126
|
#
|
3387
4127
|
# @!attribute [rw] created_timestamp
|
4128
|
+
# The time at which a voice profile summary was created.
|
3388
4129
|
# @return [Time]
|
3389
4130
|
#
|
3390
4131
|
# @!attribute [rw] updated_timestamp
|
4132
|
+
# The time at which a voice profile summary was last updated.
|
3391
4133
|
# @return [Time]
|
3392
4134
|
#
|
3393
4135
|
# @!attribute [rw] expiration_timestamp
|
4136
|
+
# Extends the life of the voice profile. You can use
|
4137
|
+
# `UpdateVoiceProfile` to refresh an existing voice profile's voice
|
4138
|
+
# print and extend the life of the summary.
|
3394
4139
|
# @return [Time]
|
3395
4140
|
#
|
3396
4141
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileSummary AWS API Documentation
|
@@ -3406,25 +4151,36 @@ module Aws::ChimeSDKVoice
|
|
3406
4151
|
include Aws::Structure
|
3407
4152
|
end
|
3408
4153
|
|
4154
|
+
# A representation of an asynchronous request to perform voice tone
|
4155
|
+
# analysis on a Voice Connector call.
|
4156
|
+
#
|
3409
4157
|
# @!attribute [rw] voice_tone_analysis_task_id
|
4158
|
+
# The ID of the voice tone analysis task.
|
3410
4159
|
# @return [String]
|
3411
4160
|
#
|
3412
4161
|
# @!attribute [rw] voice_tone_analysis_task_status
|
4162
|
+
# The status of a voice tone analysis task, `IN_QUEUE`, `IN_PROGRESS`,
|
4163
|
+
# `PARTIAL_SUCCESS`, `SUCCEEDED`, `FAILED`, or `STOPPED`.
|
3413
4164
|
# @return [String]
|
3414
4165
|
#
|
3415
4166
|
# @!attribute [rw] call_details
|
4167
|
+
# The call details of a voice tone analysis task.
|
3416
4168
|
# @return [Types::CallDetails]
|
3417
4169
|
#
|
3418
4170
|
# @!attribute [rw] created_timestamp
|
4171
|
+
# The time at which a voice tone analysis task was created.
|
3419
4172
|
# @return [Time]
|
3420
4173
|
#
|
3421
4174
|
# @!attribute [rw] updated_timestamp
|
4175
|
+
# The time at which a voice tone analysis task was updated.
|
3422
4176
|
# @return [Time]
|
3423
4177
|
#
|
3424
4178
|
# @!attribute [rw] started_timestamp
|
4179
|
+
# The time at which a voice tone analysis task started.
|
3425
4180
|
# @return [Time]
|
3426
4181
|
#
|
3427
4182
|
# @!attribute [rw] status_message
|
4183
|
+
# The status of a voice tone analysis task.
|
3428
4184
|
# @return [String]
|
3429
4185
|
#
|
3430
4186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceToneAnalysisTask AWS API Documentation
|