aws-sdk-chimesdkvoice 1.2.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkvoice/client.rb +1233 -1
- data/lib/aws-sdk-chimesdkvoice/client_api.rb +603 -0
- data/lib/aws-sdk-chimesdkvoice/endpoints.rb +266 -0
- data/lib/aws-sdk-chimesdkvoice/errors.rb +22 -0
- data/lib/aws-sdk-chimesdkvoice/plugins/endpoints.rb +38 -0
- data/lib/aws-sdk-chimesdkvoice/types.rb +1521 -9
- 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,25 +210,58 @@ 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
|
+
#
|
215
|
+
# @!attribute [rw] voice_connector_id
|
216
|
+
# The Voice Connector ID.
|
217
|
+
# @return [String]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] transaction_id
|
220
|
+
# The transaction ID of a Voice Connector call.
|
221
|
+
# @return [String]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] is_caller
|
224
|
+
# Identifies a person as the caller or the callee.
|
225
|
+
# @return [Boolean]
|
226
|
+
#
|
227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CallDetails AWS API Documentation
|
228
|
+
#
|
229
|
+
class CallDetails < Struct.new(
|
230
|
+
:voice_connector_id,
|
231
|
+
:transaction_id,
|
232
|
+
:is_caller)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# A suggested address.
|
238
|
+
#
|
172
239
|
# @!attribute [rw] street_info
|
240
|
+
# The street information of the candidate address.
|
173
241
|
# @return [String]
|
174
242
|
#
|
175
243
|
# @!attribute [rw] street_number
|
244
|
+
# The numeric portion of the candidate address.
|
176
245
|
# @return [String]
|
177
246
|
#
|
178
247
|
# @!attribute [rw] city
|
248
|
+
# The city of the candidate address.
|
179
249
|
# @return [String]
|
180
250
|
#
|
181
251
|
# @!attribute [rw] state
|
252
|
+
# The state of the candidate address.
|
182
253
|
# @return [String]
|
183
254
|
#
|
184
255
|
# @!attribute [rw] postal_code
|
256
|
+
# The postal code of the candidate address.
|
185
257
|
# @return [String]
|
186
258
|
#
|
187
259
|
# @!attribute [rw] postal_code_plus_4
|
260
|
+
# The zip + 4 or postal code +4 of the candidate address.
|
188
261
|
# @return [String]
|
189
262
|
#
|
190
263
|
# @!attribute [rw] country
|
264
|
+
# The country of the candidate address.
|
191
265
|
# @return [String]
|
192
266
|
#
|
193
267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CandidateAddress AWS API Documentation
|
@@ -204,14 +278,18 @@ module Aws::ChimeSDKVoice
|
|
204
278
|
include Aws::Structure
|
205
279
|
end
|
206
280
|
|
281
|
+
# Multiple instances of the same request were made simultaneously.
|
282
|
+
#
|
207
283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ConflictException AWS API Documentation
|
208
284
|
#
|
209
285
|
class ConflictException < Aws::EmptyStructure; end
|
210
286
|
|
211
287
|
# @!attribute [rw] product_type
|
288
|
+
# The phone number product type.
|
212
289
|
# @return [String]
|
213
290
|
#
|
214
291
|
# @!attribute [rw] e164_phone_numbers
|
292
|
+
# List of phone numbers, in E.164 format.
|
215
293
|
# @return [Array<String>]
|
216
294
|
#
|
217
295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrderRequest AWS API Documentation
|
@@ -224,6 +302,7 @@ module Aws::ChimeSDKVoice
|
|
224
302
|
end
|
225
303
|
|
226
304
|
# @!attribute [rw] phone_number_order
|
305
|
+
# The phone number order details.
|
227
306
|
# @return [Types::PhoneNumberOrder]
|
228
307
|
#
|
229
308
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrderResponse AWS API Documentation
|
@@ -235,27 +314,37 @@ module Aws::ChimeSDKVoice
|
|
235
314
|
end
|
236
315
|
|
237
316
|
# @!attribute [rw] voice_connector_id
|
317
|
+
# The Voice Connector ID.
|
238
318
|
# @return [String]
|
239
319
|
#
|
240
320
|
# @!attribute [rw] participant_phone_numbers
|
321
|
+
# The participant phone numbers.
|
241
322
|
# @return [Array<String>]
|
242
323
|
#
|
243
324
|
# @!attribute [rw] name
|
325
|
+
# The name of the proxy session.
|
244
326
|
# @return [String]
|
245
327
|
#
|
246
328
|
# @!attribute [rw] expiry_minutes
|
329
|
+
# The number of minutes allowed for the proxy session.
|
247
330
|
# @return [Integer]
|
248
331
|
#
|
249
332
|
# @!attribute [rw] capabilities
|
333
|
+
# The proxy session's capabilities.
|
250
334
|
# @return [Array<String>]
|
251
335
|
#
|
252
336
|
# @!attribute [rw] number_selection_behavior
|
337
|
+
# The preference for proxy phone number reuse, or stickiness, between
|
338
|
+
# the same participants across sessions.
|
253
339
|
# @return [String]
|
254
340
|
#
|
255
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.
|
256
344
|
# @return [String]
|
257
345
|
#
|
258
346
|
# @!attribute [rw] geo_match_params
|
347
|
+
# The country and area code for the proxy phone number.
|
259
348
|
# @return [Types::GeoMatchParams]
|
260
349
|
#
|
261
350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySessionRequest AWS API Documentation
|
@@ -274,6 +363,7 @@ module Aws::ChimeSDKVoice
|
|
274
363
|
end
|
275
364
|
|
276
365
|
# @!attribute [rw] proxy_session
|
366
|
+
# The proxy session details.
|
277
367
|
# @return [Types::ProxySession]
|
278
368
|
#
|
279
369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySessionResponse AWS API Documentation
|
@@ -285,18 +375,26 @@ module Aws::ChimeSDKVoice
|
|
285
375
|
end
|
286
376
|
|
287
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.
|
288
380
|
# @return [String]
|
289
381
|
#
|
290
382
|
# @!attribute [rw] to_phone_number
|
383
|
+
# The phone number that the service should call.
|
291
384
|
# @return [String]
|
292
385
|
#
|
293
386
|
# @!attribute [rw] sip_media_application_id
|
387
|
+
# The ID of the SIP media application.
|
294
388
|
# @return [String]
|
295
389
|
#
|
296
390
|
# @!attribute [rw] sip_headers
|
391
|
+
# The SIP headers added to an outbound call leg.
|
297
392
|
# @return [Hash<String,String>]
|
298
393
|
#
|
299
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"`
|
300
398
|
# @return [Hash<String,String>]
|
301
399
|
#
|
302
400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCallRequest AWS API Documentation
|
@@ -312,6 +410,7 @@ module Aws::ChimeSDKVoice
|
|
312
410
|
end
|
313
411
|
|
314
412
|
# @!attribute [rw] sip_media_application_call
|
413
|
+
# The actual call.
|
315
414
|
# @return [Types::SipMediaApplicationCall]
|
316
415
|
#
|
317
416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCallResponse AWS API Documentation
|
@@ -323,12 +422,16 @@ module Aws::ChimeSDKVoice
|
|
323
422
|
end
|
324
423
|
|
325
424
|
# @!attribute [rw] aws_region
|
425
|
+
# The AWS Region assigned to the SIP media application.
|
326
426
|
# @return [String]
|
327
427
|
#
|
328
428
|
# @!attribute [rw] name
|
429
|
+
# The SIP media application's name.
|
329
430
|
# @return [String]
|
330
431
|
#
|
331
432
|
# @!attribute [rw] endpoints
|
433
|
+
# List of endpoints (Lambda ARNs) specified for the SIP media
|
434
|
+
# application.
|
332
435
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
333
436
|
#
|
334
437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationRequest AWS API Documentation
|
@@ -342,6 +445,7 @@ module Aws::ChimeSDKVoice
|
|
342
445
|
end
|
343
446
|
|
344
447
|
# @!attribute [rw] sip_media_application
|
448
|
+
# The SIP media application details.
|
345
449
|
# @return [Types::SipMediaApplication]
|
346
450
|
#
|
347
451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationResponse AWS API Documentation
|
@@ -353,18 +457,32 @@ module Aws::ChimeSDKVoice
|
|
353
457
|
end
|
354
458
|
|
355
459
|
# @!attribute [rw] name
|
460
|
+
# The name of the SIP rule.
|
356
461
|
# @return [String]
|
357
462
|
#
|
358
463
|
# @!attribute [rw] trigger_type
|
464
|
+
# The type of trigger assigned to the SIP rule in `TriggerValue`,
|
465
|
+
# currently `RequestUriHostname` or `ToPhoneNumber`.
|
359
466
|
# @return [String]
|
360
467
|
#
|
361
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.
|
362
476
|
# @return [String]
|
363
477
|
#
|
364
478
|
# @!attribute [rw] disabled
|
479
|
+
# Disables or enables a SIP rule. You must disable SIP rules before
|
480
|
+
# you can delete them.
|
365
481
|
# @return [Boolean]
|
366
482
|
#
|
367
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.
|
368
486
|
# @return [Array<Types::SipRuleTargetApplication>]
|
369
487
|
#
|
370
488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRuleRequest AWS API Documentation
|
@@ -380,6 +498,8 @@ module Aws::ChimeSDKVoice
|
|
380
498
|
end
|
381
499
|
|
382
500
|
# @!attribute [rw] sip_rule
|
501
|
+
# The SIP rule information, including the rule ID, triggers, and
|
502
|
+
# target applications.
|
383
503
|
# @return [Types::SipRule]
|
384
504
|
#
|
385
505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRuleResponse AWS API Documentation
|
@@ -391,9 +511,11 @@ module Aws::ChimeSDKVoice
|
|
391
511
|
end
|
392
512
|
|
393
513
|
# @!attribute [rw] name
|
514
|
+
# The name of the Voice Connector group.
|
394
515
|
# @return [String]
|
395
516
|
#
|
396
517
|
# @!attribute [rw] voice_connector_items
|
518
|
+
# Lists the Voice Connectors that inbound calls are routed to.
|
397
519
|
# @return [Array<Types::VoiceConnectorItem>]
|
398
520
|
#
|
399
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroupRequest AWS API Documentation
|
@@ -406,6 +528,7 @@ module Aws::ChimeSDKVoice
|
|
406
528
|
end
|
407
529
|
|
408
530
|
# @!attribute [rw] voice_connector_group
|
531
|
+
# The details of the Voice Connector group.
|
409
532
|
# @return [Types::VoiceConnectorGroup]
|
410
533
|
#
|
411
534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroupResponse AWS API Documentation
|
@@ -417,12 +540,16 @@ module Aws::ChimeSDKVoice
|
|
417
540
|
end
|
418
541
|
|
419
542
|
# @!attribute [rw] name
|
543
|
+
# The name of the Voice Connector.
|
420
544
|
# @return [String]
|
421
545
|
#
|
422
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` .
|
423
549
|
# @return [String]
|
424
550
|
#
|
425
551
|
# @!attribute [rw] require_encryption
|
552
|
+
# Enables or disables encryption for the Voice Connector.
|
426
553
|
# @return [Boolean]
|
427
554
|
#
|
428
555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorRequest AWS API Documentation
|
@@ -436,6 +563,7 @@ module Aws::ChimeSDKVoice
|
|
436
563
|
end
|
437
564
|
|
438
565
|
# @!attribute [rw] voice_connector
|
566
|
+
# The details of the Voice Connector.
|
439
567
|
# @return [Types::VoiceConnector]
|
440
568
|
#
|
441
569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorResponse AWS API Documentation
|
@@ -446,10 +574,86 @@ module Aws::ChimeSDKVoice
|
|
446
574
|
include Aws::Structure
|
447
575
|
end
|
448
576
|
|
577
|
+
# @!attribute [rw] name
|
578
|
+
# The name of the voice profile domain.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @!attribute [rw] description
|
582
|
+
# A description of the voice profile domain.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] server_side_encryption_configuration
|
586
|
+
# The server-side encryption configuration for the request.
|
587
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] client_request_token
|
590
|
+
# The unique identifier for the client request. Use a different token
|
591
|
+
# for different domain creation requests.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] tags
|
595
|
+
# The tags assigned to the domain.
|
596
|
+
# @return [Array<Types::Tag>]
|
597
|
+
#
|
598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomainRequest AWS API Documentation
|
599
|
+
#
|
600
|
+
class CreateVoiceProfileDomainRequest < Struct.new(
|
601
|
+
:name,
|
602
|
+
:description,
|
603
|
+
:server_side_encryption_configuration,
|
604
|
+
:client_request_token,
|
605
|
+
:tags)
|
606
|
+
SENSITIVE = []
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
609
|
+
|
610
|
+
# @!attribute [rw] voice_profile_domain
|
611
|
+
# The requested voice profile domain.
|
612
|
+
# @return [Types::VoiceProfileDomain]
|
613
|
+
#
|
614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomainResponse AWS API Documentation
|
615
|
+
#
|
616
|
+
class CreateVoiceProfileDomainResponse < Struct.new(
|
617
|
+
:voice_profile_domain)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
622
|
+
# @!attribute [rw] speaker_search_task_id
|
623
|
+
# The ID of the speaker search task.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileRequest AWS API Documentation
|
627
|
+
#
|
628
|
+
class CreateVoiceProfileRequest < Struct.new(
|
629
|
+
:speaker_search_task_id)
|
630
|
+
SENSITIVE = []
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
633
|
+
|
634
|
+
# @!attribute [rw] voice_profile
|
635
|
+
# The requested voice profile.
|
636
|
+
# @return [Types::VoiceProfile]
|
637
|
+
#
|
638
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileResponse AWS API Documentation
|
639
|
+
#
|
640
|
+
class CreateVoiceProfileResponse < Struct.new(
|
641
|
+
:voice_profile)
|
642
|
+
SENSITIVE = []
|
643
|
+
include Aws::Structure
|
644
|
+
end
|
645
|
+
|
646
|
+
# The SIP credentials used to authenticate requests to an Amazon Chime
|
647
|
+
# SDK Voice Connector.
|
648
|
+
#
|
449
649
|
# @!attribute [rw] username
|
650
|
+
# The RFC2617 compliant user name associated with the SIP credentials,
|
651
|
+
# in US-ASCII format.
|
450
652
|
# @return [String]
|
451
653
|
#
|
452
654
|
# @!attribute [rw] password
|
655
|
+
# The RFC2617 compliant password associated with the SIP credentials,
|
656
|
+
# in US-ASCII format.
|
453
657
|
# @return [String]
|
454
658
|
#
|
455
659
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Credential AWS API Documentation
|
@@ -461,13 +665,23 @@ module Aws::ChimeSDKVoice
|
|
461
665
|
include Aws::Structure
|
462
666
|
end
|
463
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
|
+
#
|
464
672
|
# @!attribute [rw] emergency_phone_number
|
673
|
+
# The DNIS phone number that you route emergency calls to, in E.164
|
674
|
+
# format.
|
465
675
|
# @return [String]
|
466
676
|
#
|
467
677
|
# @!attribute [rw] test_phone_number
|
678
|
+
# The DNIS phone number for routing test emergency calls to, in E.164
|
679
|
+
# format.
|
468
680
|
# @return [String]
|
469
681
|
#
|
470
682
|
# @!attribute [rw] calling_country
|
683
|
+
# The country from which emergency calls are allowed, in ISO 3166-1
|
684
|
+
# alpha-2 format.
|
471
685
|
# @return [String]
|
472
686
|
#
|
473
687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DNISEmergencyCallingConfiguration AWS API Documentation
|
@@ -481,6 +695,7 @@ module Aws::ChimeSDKVoice
|
|
481
695
|
end
|
482
696
|
|
483
697
|
# @!attribute [rw] phone_number_id
|
698
|
+
# The phone number ID.
|
484
699
|
# @return [String]
|
485
700
|
#
|
486
701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeletePhoneNumberRequest AWS API Documentation
|
@@ -492,9 +707,11 @@ module Aws::ChimeSDKVoice
|
|
492
707
|
end
|
493
708
|
|
494
709
|
# @!attribute [rw] voice_connector_id
|
710
|
+
# The Voice Connector ID.
|
495
711
|
# @return [String]
|
496
712
|
#
|
497
713
|
# @!attribute [rw] proxy_session_id
|
714
|
+
# The proxy session ID.
|
498
715
|
# @return [String]
|
499
716
|
#
|
500
717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteProxySessionRequest AWS API Documentation
|
@@ -507,6 +724,7 @@ module Aws::ChimeSDKVoice
|
|
507
724
|
end
|
508
725
|
|
509
726
|
# @!attribute [rw] sip_media_application_id
|
727
|
+
# The SIP media application ID.
|
510
728
|
# @return [String]
|
511
729
|
#
|
512
730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipMediaApplicationRequest AWS API Documentation
|
@@ -518,6 +736,7 @@ module Aws::ChimeSDKVoice
|
|
518
736
|
end
|
519
737
|
|
520
738
|
# @!attribute [rw] sip_rule_id
|
739
|
+
# The SIP rule ID.
|
521
740
|
# @return [String]
|
522
741
|
#
|
523
742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipRuleRequest AWS API Documentation
|
@@ -529,6 +748,7 @@ module Aws::ChimeSDKVoice
|
|
529
748
|
end
|
530
749
|
|
531
750
|
# @!attribute [rw] voice_connector_id
|
751
|
+
# The Voice Connector ID.
|
532
752
|
# @return [String]
|
533
753
|
#
|
534
754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -540,6 +760,7 @@ module Aws::ChimeSDKVoice
|
|
540
760
|
end
|
541
761
|
|
542
762
|
# @!attribute [rw] voice_connector_group_id
|
763
|
+
# The Voice Connector Group ID.
|
543
764
|
# @return [String]
|
544
765
|
#
|
545
766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroupRequest AWS API Documentation
|
@@ -551,6 +772,7 @@ module Aws::ChimeSDKVoice
|
|
551
772
|
end
|
552
773
|
|
553
774
|
# @!attribute [rw] voice_connector_id
|
775
|
+
# The Voice Connector ID.
|
554
776
|
# @return [String]
|
555
777
|
#
|
556
778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -562,6 +784,7 @@ module Aws::ChimeSDKVoice
|
|
562
784
|
end
|
563
785
|
|
564
786
|
# @!attribute [rw] voice_connector_id
|
787
|
+
# The Voice Connector ID.
|
565
788
|
# @return [String]
|
566
789
|
#
|
567
790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxyRequest AWS API Documentation
|
@@ -573,6 +796,7 @@ module Aws::ChimeSDKVoice
|
|
573
796
|
end
|
574
797
|
|
575
798
|
# @!attribute [rw] voice_connector_id
|
799
|
+
# The Voice Connector ID.
|
576
800
|
# @return [String]
|
577
801
|
#
|
578
802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorRequest AWS API Documentation
|
@@ -584,6 +808,7 @@ module Aws::ChimeSDKVoice
|
|
584
808
|
end
|
585
809
|
|
586
810
|
# @!attribute [rw] voice_connector_id
|
811
|
+
# The Voice Connector ID.
|
587
812
|
# @return [String]
|
588
813
|
#
|
589
814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -595,9 +820,12 @@ module Aws::ChimeSDKVoice
|
|
595
820
|
end
|
596
821
|
|
597
822
|
# @!attribute [rw] voice_connector_id
|
823
|
+
# The Voice Connector ID.
|
598
824
|
# @return [String]
|
599
825
|
#
|
600
826
|
# @!attribute [rw] usernames
|
827
|
+
# The RFC2617 compliant username associated with the SIP credentials,
|
828
|
+
# in US-ASCII format.
|
601
829
|
# @return [Array<String>]
|
602
830
|
#
|
603
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -610,6 +838,7 @@ module Aws::ChimeSDKVoice
|
|
610
838
|
end
|
611
839
|
|
612
840
|
# @!attribute [rw] voice_connector_id
|
841
|
+
# The Voice Connector ID.
|
613
842
|
# @return [String]
|
614
843
|
#
|
615
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -620,10 +849,36 @@ module Aws::ChimeSDKVoice
|
|
620
849
|
include Aws::Structure
|
621
850
|
end
|
622
851
|
|
852
|
+
# @!attribute [rw] voice_profile_domain_id
|
853
|
+
# The voice profile domain ID.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomainRequest AWS API Documentation
|
857
|
+
#
|
858
|
+
class DeleteVoiceProfileDomainRequest < Struct.new(
|
859
|
+
:voice_profile_domain_id)
|
860
|
+
SENSITIVE = []
|
861
|
+
include Aws::Structure
|
862
|
+
end
|
863
|
+
|
864
|
+
# @!attribute [rw] voice_profile_id
|
865
|
+
# The voice profile ID.
|
866
|
+
# @return [String]
|
867
|
+
#
|
868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileRequest AWS API Documentation
|
869
|
+
#
|
870
|
+
class DeleteVoiceProfileRequest < Struct.new(
|
871
|
+
:voice_profile_id)
|
872
|
+
SENSITIVE = []
|
873
|
+
include Aws::Structure
|
874
|
+
end
|
875
|
+
|
623
876
|
# @!attribute [rw] voice_connector_group_id
|
877
|
+
# The Voice Connector group ID.
|
624
878
|
# @return [String]
|
625
879
|
#
|
626
880
|
# @!attribute [rw] e164_phone_numbers
|
881
|
+
# The list of phone numbers, in E.164 format.
|
627
882
|
# @return [Array<String>]
|
628
883
|
#
|
629
884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroupRequest AWS API Documentation
|
@@ -636,6 +891,9 @@ module Aws::ChimeSDKVoice
|
|
636
891
|
end
|
637
892
|
|
638
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.
|
639
897
|
# @return [Array<Types::PhoneNumberError>]
|
640
898
|
#
|
641
899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroupResponse AWS API Documentation
|
@@ -647,9 +905,11 @@ module Aws::ChimeSDKVoice
|
|
647
905
|
end
|
648
906
|
|
649
907
|
# @!attribute [rw] voice_connector_id
|
908
|
+
# The Voice Connector ID.
|
650
909
|
# @return [String]
|
651
910
|
#
|
652
911
|
# @!attribute [rw] e164_phone_numbers
|
912
|
+
# List of phone numbers, in E.164 format.
|
653
913
|
# @return [Array<String>]
|
654
914
|
#
|
655
915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorRequest AWS API Documentation
|
@@ -662,6 +922,9 @@ module Aws::ChimeSDKVoice
|
|
662
922
|
end
|
663
923
|
|
664
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.
|
665
928
|
# @return [Array<Types::PhoneNumberError>]
|
666
929
|
#
|
667
930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorResponse AWS API Documentation
|
@@ -672,7 +935,12 @@ module Aws::ChimeSDKVoice
|
|
672
935
|
include Aws::Structure
|
673
936
|
end
|
674
937
|
|
938
|
+
# The emergency calling configuration details associated with an Amazon
|
939
|
+
# Chime SDK Voice Connector.
|
940
|
+
#
|
675
941
|
# @!attribute [rw] dnis
|
942
|
+
# The Dialed Number Identification Service (DNIS) emergency calling
|
943
|
+
# configuration details.
|
676
944
|
# @return [Array<Types::DNISEmergencyCallingConfiguration>]
|
677
945
|
#
|
678
946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/EmergencyCallingConfiguration AWS API Documentation
|
@@ -683,14 +951,21 @@ module Aws::ChimeSDKVoice
|
|
683
951
|
include Aws::Structure
|
684
952
|
end
|
685
953
|
|
954
|
+
# The client is permanently forbidden from making the request.
|
955
|
+
#
|
686
956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ForbiddenException AWS API Documentation
|
687
957
|
#
|
688
958
|
class ForbiddenException < Aws::EmptyStructure; end
|
689
959
|
|
960
|
+
# The country and area code for a proxy phone number in a proxy phone
|
961
|
+
# session.
|
962
|
+
#
|
690
963
|
# @!attribute [rw] country
|
964
|
+
# The country.
|
691
965
|
# @return [String]
|
692
966
|
#
|
693
967
|
# @!attribute [rw] area_code
|
968
|
+
# The area code.
|
694
969
|
# @return [String]
|
695
970
|
#
|
696
971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GeoMatchParams AWS API Documentation
|
@@ -703,6 +978,7 @@ module Aws::ChimeSDKVoice
|
|
703
978
|
end
|
704
979
|
|
705
980
|
# @!attribute [rw] voice_connector
|
981
|
+
# The Voice Connector settings.
|
706
982
|
# @return [Types::VoiceConnectorSettings]
|
707
983
|
#
|
708
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetGlobalSettingsResponse AWS API Documentation
|
@@ -714,6 +990,7 @@ module Aws::ChimeSDKVoice
|
|
714
990
|
end
|
715
991
|
|
716
992
|
# @!attribute [rw] phone_number_order_id
|
993
|
+
# The ID of the phone number order .
|
717
994
|
# @return [String]
|
718
995
|
#
|
719
996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrderRequest AWS API Documentation
|
@@ -725,6 +1002,7 @@ module Aws::ChimeSDKVoice
|
|
725
1002
|
end
|
726
1003
|
|
727
1004
|
# @!attribute [rw] phone_number_order
|
1005
|
+
# The phone number order details.
|
728
1006
|
# @return [Types::PhoneNumberOrder]
|
729
1007
|
#
|
730
1008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrderResponse AWS API Documentation
|
@@ -736,6 +1014,7 @@ module Aws::ChimeSDKVoice
|
|
736
1014
|
end
|
737
1015
|
|
738
1016
|
# @!attribute [rw] phone_number_id
|
1017
|
+
# The phone number ID.
|
739
1018
|
# @return [String]
|
740
1019
|
#
|
741
1020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberRequest AWS API Documentation
|
@@ -747,6 +1026,7 @@ module Aws::ChimeSDKVoice
|
|
747
1026
|
end
|
748
1027
|
|
749
1028
|
# @!attribute [rw] phone_number
|
1029
|
+
# The phone number details.
|
750
1030
|
# @return [Types::PhoneNumber]
|
751
1031
|
#
|
752
1032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberResponse AWS API Documentation
|
@@ -758,9 +1038,11 @@ module Aws::ChimeSDKVoice
|
|
758
1038
|
end
|
759
1039
|
|
760
1040
|
# @!attribute [rw] calling_name
|
1041
|
+
# The default outbound calling name for the account.
|
761
1042
|
# @return [String]
|
762
1043
|
#
|
763
1044
|
# @!attribute [rw] calling_name_updated_timestamp
|
1045
|
+
# The updated outbound calling name timestamp, in ISO 8601 format.
|
764
1046
|
# @return [Time]
|
765
1047
|
#
|
766
1048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberSettingsResponse AWS API Documentation
|
@@ -773,9 +1055,11 @@ module Aws::ChimeSDKVoice
|
|
773
1055
|
end
|
774
1056
|
|
775
1057
|
# @!attribute [rw] voice_connector_id
|
1058
|
+
# The Voice Connector ID.
|
776
1059
|
# @return [String]
|
777
1060
|
#
|
778
1061
|
# @!attribute [rw] proxy_session_id
|
1062
|
+
# The proxy session ID.
|
779
1063
|
# @return [String]
|
780
1064
|
#
|
781
1065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySessionRequest AWS API Documentation
|
@@ -788,6 +1072,7 @@ module Aws::ChimeSDKVoice
|
|
788
1072
|
end
|
789
1073
|
|
790
1074
|
# @!attribute [rw] proxy_session
|
1075
|
+
# The proxy session details.
|
791
1076
|
# @return [Types::ProxySession]
|
792
1077
|
#
|
793
1078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySessionResponse AWS API Documentation
|
@@ -799,6 +1084,7 @@ module Aws::ChimeSDKVoice
|
|
799
1084
|
end
|
800
1085
|
|
801
1086
|
# @!attribute [rw] sip_media_application_id
|
1087
|
+
# The SIP media application ID.
|
802
1088
|
# @return [String]
|
803
1089
|
#
|
804
1090
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfigurationRequest AWS API Documentation
|
@@ -810,6 +1096,7 @@ module Aws::ChimeSDKVoice
|
|
810
1096
|
end
|
811
1097
|
|
812
1098
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
1099
|
+
# Returns the Alexa Skill configuration.
|
813
1100
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
814
1101
|
#
|
815
1102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfigurationResponse AWS API Documentation
|
@@ -821,6 +1108,7 @@ module Aws::ChimeSDKVoice
|
|
821
1108
|
end
|
822
1109
|
|
823
1110
|
# @!attribute [rw] sip_media_application_id
|
1111
|
+
# The SIP media application ID.
|
824
1112
|
# @return [String]
|
825
1113
|
#
|
826
1114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
|
@@ -832,6 +1120,7 @@ module Aws::ChimeSDKVoice
|
|
832
1120
|
end
|
833
1121
|
|
834
1122
|
# @!attribute [rw] sip_media_application_logging_configuration
|
1123
|
+
# The actual logging configuration.
|
835
1124
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
836
1125
|
#
|
837
1126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
|
@@ -843,6 +1132,7 @@ module Aws::ChimeSDKVoice
|
|
843
1132
|
end
|
844
1133
|
|
845
1134
|
# @!attribute [rw] sip_media_application_id
|
1135
|
+
# The SIP media application ID .
|
846
1136
|
# @return [String]
|
847
1137
|
#
|
848
1138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationRequest AWS API Documentation
|
@@ -854,6 +1144,7 @@ module Aws::ChimeSDKVoice
|
|
854
1144
|
end
|
855
1145
|
|
856
1146
|
# @!attribute [rw] sip_media_application
|
1147
|
+
# The details of the SIP media application.
|
857
1148
|
# @return [Types::SipMediaApplication]
|
858
1149
|
#
|
859
1150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationResponse AWS API Documentation
|
@@ -865,6 +1156,7 @@ module Aws::ChimeSDKVoice
|
|
865
1156
|
end
|
866
1157
|
|
867
1158
|
# @!attribute [rw] sip_rule_id
|
1159
|
+
# The SIP rule ID.
|
868
1160
|
# @return [String]
|
869
1161
|
#
|
870
1162
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRuleRequest AWS API Documentation
|
@@ -876,6 +1168,7 @@ module Aws::ChimeSDKVoice
|
|
876
1168
|
end
|
877
1169
|
|
878
1170
|
# @!attribute [rw] sip_rule
|
1171
|
+
# The SIP rule details.
|
879
1172
|
# @return [Types::SipRule]
|
880
1173
|
#
|
881
1174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRuleResponse AWS API Documentation
|
@@ -887,6 +1180,36 @@ module Aws::ChimeSDKVoice
|
|
887
1180
|
end
|
888
1181
|
|
889
1182
|
# @!attribute [rw] voice_connector_id
|
1183
|
+
# The Voice Connector ID.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] speaker_search_task_id
|
1187
|
+
# The ID of the speaker search task.
|
1188
|
+
# @return [String]
|
1189
|
+
#
|
1190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTaskRequest AWS API Documentation
|
1191
|
+
#
|
1192
|
+
class GetSpeakerSearchTaskRequest < Struct.new(
|
1193
|
+
:voice_connector_id,
|
1194
|
+
:speaker_search_task_id)
|
1195
|
+
SENSITIVE = []
|
1196
|
+
include Aws::Structure
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# @!attribute [rw] speaker_search_task
|
1200
|
+
# The details of the speaker search task.
|
1201
|
+
# @return [Types::SpeakerSearchTask]
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTaskResponse AWS API Documentation
|
1204
|
+
#
|
1205
|
+
class GetSpeakerSearchTaskResponse < Struct.new(
|
1206
|
+
:speaker_search_task)
|
1207
|
+
SENSITIVE = []
|
1208
|
+
include Aws::Structure
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# @!attribute [rw] voice_connector_id
|
1212
|
+
# The Voice Connector ID.
|
890
1213
|
# @return [String]
|
891
1214
|
#
|
892
1215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -898,6 +1221,7 @@ module Aws::ChimeSDKVoice
|
|
898
1221
|
end
|
899
1222
|
|
900
1223
|
# @!attribute [rw] emergency_calling_configuration
|
1224
|
+
# The details of the emergency calling configuration.
|
901
1225
|
# @return [Types::EmergencyCallingConfiguration]
|
902
1226
|
#
|
903
1227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfigurationResponse AWS API Documentation
|
@@ -909,6 +1233,7 @@ module Aws::ChimeSDKVoice
|
|
909
1233
|
end
|
910
1234
|
|
911
1235
|
# @!attribute [rw] voice_connector_group_id
|
1236
|
+
# The Voice Connector group ID.
|
912
1237
|
# @return [String]
|
913
1238
|
#
|
914
1239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroupRequest AWS API Documentation
|
@@ -920,6 +1245,7 @@ module Aws::ChimeSDKVoice
|
|
920
1245
|
end
|
921
1246
|
|
922
1247
|
# @!attribute [rw] voice_connector_group
|
1248
|
+
# The details of the Voice Connector group.
|
923
1249
|
# @return [Types::VoiceConnectorGroup]
|
924
1250
|
#
|
925
1251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroupResponse AWS API Documentation
|
@@ -931,6 +1257,7 @@ module Aws::ChimeSDKVoice
|
|
931
1257
|
end
|
932
1258
|
|
933
1259
|
# @!attribute [rw] voice_connector_id
|
1260
|
+
# The Voice Connector ID.
|
934
1261
|
# @return [String]
|
935
1262
|
#
|
936
1263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfigurationRequest AWS API Documentation
|
@@ -942,6 +1269,7 @@ module Aws::ChimeSDKVoice
|
|
942
1269
|
end
|
943
1270
|
|
944
1271
|
# @!attribute [rw] logging_configuration
|
1272
|
+
# The logging configuration details .
|
945
1273
|
# @return [Types::LoggingConfiguration]
|
946
1274
|
#
|
947
1275
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfigurationResponse AWS API Documentation
|
@@ -953,6 +1281,7 @@ module Aws::ChimeSDKVoice
|
|
953
1281
|
end
|
954
1282
|
|
955
1283
|
# @!attribute [rw] voice_connector_id
|
1284
|
+
# The Voice Connector ID.
|
956
1285
|
# @return [String]
|
957
1286
|
#
|
958
1287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -964,6 +1293,7 @@ module Aws::ChimeSDKVoice
|
|
964
1293
|
end
|
965
1294
|
|
966
1295
|
# @!attribute [rw] origination
|
1296
|
+
# The origination setting details.
|
967
1297
|
# @return [Types::Origination]
|
968
1298
|
#
|
969
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOriginationResponse AWS API Documentation
|
@@ -975,6 +1305,7 @@ module Aws::ChimeSDKVoice
|
|
975
1305
|
end
|
976
1306
|
|
977
1307
|
# @!attribute [rw] voice_connector_id
|
1308
|
+
# The Voice Connector ID.
|
978
1309
|
# @return [String]
|
979
1310
|
#
|
980
1311
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxyRequest AWS API Documentation
|
@@ -986,6 +1317,7 @@ module Aws::ChimeSDKVoice
|
|
986
1317
|
end
|
987
1318
|
|
988
1319
|
# @!attribute [rw] proxy
|
1320
|
+
# The proxy configuration details.
|
989
1321
|
# @return [Types::Proxy]
|
990
1322
|
#
|
991
1323
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxyResponse AWS API Documentation
|
@@ -997,6 +1329,7 @@ module Aws::ChimeSDKVoice
|
|
997
1329
|
end
|
998
1330
|
|
999
1331
|
# @!attribute [rw] voice_connector_id
|
1332
|
+
# The Voice Connector ID.
|
1000
1333
|
# @return [String]
|
1001
1334
|
#
|
1002
1335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorRequest AWS API Documentation
|
@@ -1008,6 +1341,7 @@ module Aws::ChimeSDKVoice
|
|
1008
1341
|
end
|
1009
1342
|
|
1010
1343
|
# @!attribute [rw] voice_connector
|
1344
|
+
# The Voice Connector details.
|
1011
1345
|
# @return [Types::VoiceConnector]
|
1012
1346
|
#
|
1013
1347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorResponse AWS API Documentation
|
@@ -1019,6 +1353,7 @@ module Aws::ChimeSDKVoice
|
|
1019
1353
|
end
|
1020
1354
|
|
1021
1355
|
# @!attribute [rw] voice_connector_id
|
1356
|
+
# The Voice Connector ID.
|
1022
1357
|
# @return [String]
|
1023
1358
|
#
|
1024
1359
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -1030,6 +1365,7 @@ module Aws::ChimeSDKVoice
|
|
1030
1365
|
end
|
1031
1366
|
|
1032
1367
|
# @!attribute [rw] streaming_configuration
|
1368
|
+
# The details of the streaming configuration.
|
1033
1369
|
# @return [Types::StreamingConfiguration]
|
1034
1370
|
#
|
1035
1371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfigurationResponse AWS API Documentation
|
@@ -1041,6 +1377,7 @@ module Aws::ChimeSDKVoice
|
|
1041
1377
|
end
|
1042
1378
|
|
1043
1379
|
# @!attribute [rw] voice_connector_id
|
1380
|
+
# The Voice Connector ID.
|
1044
1381
|
# @return [String]
|
1045
1382
|
#
|
1046
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealthRequest AWS API Documentation
|
@@ -1052,6 +1389,7 @@ module Aws::ChimeSDKVoice
|
|
1052
1389
|
end
|
1053
1390
|
|
1054
1391
|
# @!attribute [rw] termination_health
|
1392
|
+
# The termination health details.
|
1055
1393
|
# @return [Types::TerminationHealth]
|
1056
1394
|
#
|
1057
1395
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealthResponse AWS API Documentation
|
@@ -1063,6 +1401,7 @@ module Aws::ChimeSDKVoice
|
|
1063
1401
|
end
|
1064
1402
|
|
1065
1403
|
# @!attribute [rw] voice_connector_id
|
1404
|
+
# The Voice Connector ID.
|
1066
1405
|
# @return [String]
|
1067
1406
|
#
|
1068
1407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -1074,6 +1413,7 @@ module Aws::ChimeSDKVoice
|
|
1074
1413
|
end
|
1075
1414
|
|
1076
1415
|
# @!attribute [rw] termination
|
1416
|
+
# The termination setting details.
|
1077
1417
|
# @return [Types::Termination]
|
1078
1418
|
#
|
1079
1419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationResponse AWS API Documentation
|
@@ -1084,7 +1424,98 @@ module Aws::ChimeSDKVoice
|
|
1084
1424
|
include Aws::Structure
|
1085
1425
|
end
|
1086
1426
|
|
1427
|
+
# @!attribute [rw] voice_profile_domain_id
|
1428
|
+
# The voice profile domain ID.
|
1429
|
+
# @return [String]
|
1430
|
+
#
|
1431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomainRequest AWS API Documentation
|
1432
|
+
#
|
1433
|
+
class GetVoiceProfileDomainRequest < Struct.new(
|
1434
|
+
:voice_profile_domain_id)
|
1435
|
+
SENSITIVE = []
|
1436
|
+
include Aws::Structure
|
1437
|
+
end
|
1438
|
+
|
1439
|
+
# @!attribute [rw] voice_profile_domain
|
1440
|
+
# The details of the voice profile domain.
|
1441
|
+
# @return [Types::VoiceProfileDomain]
|
1442
|
+
#
|
1443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomainResponse AWS API Documentation
|
1444
|
+
#
|
1445
|
+
class GetVoiceProfileDomainResponse < Struct.new(
|
1446
|
+
:voice_profile_domain)
|
1447
|
+
SENSITIVE = []
|
1448
|
+
include Aws::Structure
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
# @!attribute [rw] voice_profile_id
|
1452
|
+
# The voice profile ID.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileRequest AWS API Documentation
|
1456
|
+
#
|
1457
|
+
class GetVoiceProfileRequest < Struct.new(
|
1458
|
+
:voice_profile_id)
|
1459
|
+
SENSITIVE = []
|
1460
|
+
include Aws::Structure
|
1461
|
+
end
|
1462
|
+
|
1463
|
+
# @!attribute [rw] voice_profile
|
1464
|
+
# The voice profile details.
|
1465
|
+
# @return [Types::VoiceProfile]
|
1466
|
+
#
|
1467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileResponse AWS API Documentation
|
1468
|
+
#
|
1469
|
+
class GetVoiceProfileResponse < Struct.new(
|
1470
|
+
:voice_profile)
|
1471
|
+
SENSITIVE = []
|
1472
|
+
include Aws::Structure
|
1473
|
+
end
|
1474
|
+
|
1475
|
+
# @!attribute [rw] voice_connector_id
|
1476
|
+
# The Voice Connector ID.
|
1477
|
+
# @return [String]
|
1478
|
+
#
|
1479
|
+
# @!attribute [rw] voice_tone_analysis_task_id
|
1480
|
+
# The ID of the voice tone anlysis task.
|
1481
|
+
# @return [String]
|
1482
|
+
#
|
1483
|
+
# @!attribute [rw] is_caller
|
1484
|
+
# Specifies whether the voice being analyzed is the caller
|
1485
|
+
# (originator) or the callee (responder).
|
1486
|
+
# @return [Boolean]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTaskRequest AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class GetVoiceToneAnalysisTaskRequest < Struct.new(
|
1491
|
+
:voice_connector_id,
|
1492
|
+
:voice_tone_analysis_task_id,
|
1493
|
+
:is_caller)
|
1494
|
+
SENSITIVE = []
|
1495
|
+
include Aws::Structure
|
1496
|
+
end
|
1497
|
+
|
1498
|
+
# @!attribute [rw] voice_tone_analysis_task
|
1499
|
+
# The details of the voice tone analysis task.
|
1500
|
+
# @return [Types::VoiceToneAnalysisTask]
|
1501
|
+
#
|
1502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTaskResponse AWS API Documentation
|
1503
|
+
#
|
1504
|
+
class GetVoiceToneAnalysisTaskResponse < Struct.new(
|
1505
|
+
:voice_tone_analysis_task)
|
1506
|
+
SENSITIVE = []
|
1507
|
+
include Aws::Structure
|
1508
|
+
end
|
1509
|
+
|
1510
|
+
# Access to the target resource is no longer available at the origin
|
1511
|
+
# server. This condition is likely to be permanent.
|
1512
|
+
#
|
1513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GoneException AWS API Documentation
|
1514
|
+
#
|
1515
|
+
class GoneException < Aws::EmptyStructure; end
|
1516
|
+
|
1087
1517
|
# @!attribute [rw] voice_connector_regions
|
1518
|
+
# The list of AWS Regions.
|
1088
1519
|
# @return [Array<String>]
|
1089
1520
|
#
|
1090
1521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegionsResponse AWS API Documentation
|
@@ -1096,9 +1527,11 @@ module Aws::ChimeSDKVoice
|
|
1096
1527
|
end
|
1097
1528
|
|
1098
1529
|
# @!attribute [rw] next_token
|
1530
|
+
# The token used to retrieve the next page of results.
|
1099
1531
|
# @return [String]
|
1100
1532
|
#
|
1101
1533
|
# @!attribute [rw] max_results
|
1534
|
+
# The maximum number of results to return in a single call.
|
1102
1535
|
# @return [Integer]
|
1103
1536
|
#
|
1104
1537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrdersRequest AWS API Documentation
|
@@ -1111,9 +1544,11 @@ module Aws::ChimeSDKVoice
|
|
1111
1544
|
end
|
1112
1545
|
|
1113
1546
|
# @!attribute [rw] phone_number_orders
|
1547
|
+
# The phone number order details.
|
1114
1548
|
# @return [Array<Types::PhoneNumberOrder>]
|
1115
1549
|
#
|
1116
1550
|
# @!attribute [rw] next_token
|
1551
|
+
# The token used to retrieve the next page of results.
|
1117
1552
|
# @return [String]
|
1118
1553
|
#
|
1119
1554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrdersResponse AWS API Documentation
|
@@ -1126,21 +1561,27 @@ module Aws::ChimeSDKVoice
|
|
1126
1561
|
end
|
1127
1562
|
|
1128
1563
|
# @!attribute [rw] status
|
1564
|
+
# The status of your organization's phone numbers.
|
1129
1565
|
# @return [String]
|
1130
1566
|
#
|
1131
1567
|
# @!attribute [rw] product_type
|
1568
|
+
# The phone number product types.
|
1132
1569
|
# @return [String]
|
1133
1570
|
#
|
1134
1571
|
# @!attribute [rw] filter_name
|
1572
|
+
# The filter to limit the number of results.
|
1135
1573
|
# @return [String]
|
1136
1574
|
#
|
1137
1575
|
# @!attribute [rw] filter_value
|
1576
|
+
# The filter value.
|
1138
1577
|
# @return [String]
|
1139
1578
|
#
|
1140
1579
|
# @!attribute [rw] max_results
|
1580
|
+
# The maximum number of results to return in a single call.
|
1141
1581
|
# @return [Integer]
|
1142
1582
|
#
|
1143
1583
|
# @!attribute [rw] next_token
|
1584
|
+
# The token used to return the next page of results.
|
1144
1585
|
# @return [String]
|
1145
1586
|
#
|
1146
1587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbersRequest AWS API Documentation
|
@@ -1157,9 +1598,11 @@ module Aws::ChimeSDKVoice
|
|
1157
1598
|
end
|
1158
1599
|
|
1159
1600
|
# @!attribute [rw] phone_numbers
|
1601
|
+
# The phone number details.
|
1160
1602
|
# @return [Array<Types::PhoneNumber>]
|
1161
1603
|
#
|
1162
1604
|
# @!attribute [rw] next_token
|
1605
|
+
# The token used to return the next page of results.
|
1163
1606
|
# @return [String]
|
1164
1607
|
#
|
1165
1608
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbersResponse AWS API Documentation
|
@@ -1172,15 +1615,19 @@ module Aws::ChimeSDKVoice
|
|
1172
1615
|
end
|
1173
1616
|
|
1174
1617
|
# @!attribute [rw] voice_connector_id
|
1618
|
+
# The Voice Connector ID.
|
1175
1619
|
# @return [String]
|
1176
1620
|
#
|
1177
1621
|
# @!attribute [rw] status
|
1622
|
+
# The proxy session status.
|
1178
1623
|
# @return [String]
|
1179
1624
|
#
|
1180
1625
|
# @!attribute [rw] next_token
|
1626
|
+
# The token used to retrieve the next page of results.
|
1181
1627
|
# @return [String]
|
1182
1628
|
#
|
1183
1629
|
# @!attribute [rw] max_results
|
1630
|
+
# The maximum number of results to return in a single call.
|
1184
1631
|
# @return [Integer]
|
1185
1632
|
#
|
1186
1633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessionsRequest AWS API Documentation
|
@@ -1195,9 +1642,11 @@ module Aws::ChimeSDKVoice
|
|
1195
1642
|
end
|
1196
1643
|
|
1197
1644
|
# @!attribute [rw] proxy_sessions
|
1645
|
+
# The proxy sessions' details.
|
1198
1646
|
# @return [Array<Types::ProxySession>]
|
1199
1647
|
#
|
1200
1648
|
# @!attribute [rw] next_token
|
1649
|
+
# The token used to retrieve the next page of results.
|
1201
1650
|
# @return [String]
|
1202
1651
|
#
|
1203
1652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessionsResponse AWS API Documentation
|
@@ -1210,9 +1659,12 @@ module Aws::ChimeSDKVoice
|
|
1210
1659
|
end
|
1211
1660
|
|
1212
1661
|
# @!attribute [rw] max_results
|
1662
|
+
# The maximum number of results to return in a single call. Defaults
|
1663
|
+
# to 100.
|
1213
1664
|
# @return [Integer]
|
1214
1665
|
#
|
1215
1666
|
# @!attribute [rw] next_token
|
1667
|
+
# The token used to return the next page of results.
|
1216
1668
|
# @return [String]
|
1217
1669
|
#
|
1218
1670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplicationsRequest AWS API Documentation
|
@@ -1225,9 +1677,11 @@ module Aws::ChimeSDKVoice
|
|
1225
1677
|
end
|
1226
1678
|
|
1227
1679
|
# @!attribute [rw] sip_media_applications
|
1680
|
+
# The list of SIP media applications and application details.
|
1228
1681
|
# @return [Array<Types::SipMediaApplication>]
|
1229
1682
|
#
|
1230
1683
|
# @!attribute [rw] next_token
|
1684
|
+
# The token used to return the next page of results.
|
1231
1685
|
# @return [String]
|
1232
1686
|
#
|
1233
1687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplicationsResponse AWS API Documentation
|
@@ -1240,12 +1694,16 @@ module Aws::ChimeSDKVoice
|
|
1240
1694
|
end
|
1241
1695
|
|
1242
1696
|
# @!attribute [rw] sip_media_application_id
|
1697
|
+
# The SIP media application ID.
|
1243
1698
|
# @return [String]
|
1244
1699
|
#
|
1245
1700
|
# @!attribute [rw] max_results
|
1701
|
+
# The maximum number of results to return in a single call. Defaults
|
1702
|
+
# to 100.
|
1246
1703
|
# @return [Integer]
|
1247
1704
|
#
|
1248
1705
|
# @!attribute [rw] next_token
|
1706
|
+
# The token used to return the next page of results.
|
1249
1707
|
# @return [String]
|
1250
1708
|
#
|
1251
1709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRulesRequest AWS API Documentation
|
@@ -1259,9 +1717,11 @@ module Aws::ChimeSDKVoice
|
|
1259
1717
|
end
|
1260
1718
|
|
1261
1719
|
# @!attribute [rw] sip_rules
|
1720
|
+
# The list of SIP rules and details.
|
1262
1721
|
# @return [Array<Types::SipRule>]
|
1263
1722
|
#
|
1264
1723
|
# @!attribute [rw] next_token
|
1724
|
+
# The token used to return the next page of results.
|
1265
1725
|
# @return [String]
|
1266
1726
|
#
|
1267
1727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRulesResponse AWS API Documentation
|
@@ -1274,6 +1734,7 @@ module Aws::ChimeSDKVoice
|
|
1274
1734
|
end
|
1275
1735
|
|
1276
1736
|
# @!attribute [rw] product_type
|
1737
|
+
# The phone number product type.
|
1277
1738
|
# @return [String]
|
1278
1739
|
#
|
1279
1740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountriesRequest AWS API Documentation
|
@@ -1285,6 +1746,7 @@ module Aws::ChimeSDKVoice
|
|
1285
1746
|
end
|
1286
1747
|
|
1287
1748
|
# @!attribute [rw] phone_number_countries
|
1749
|
+
# The supported phone number countries.
|
1288
1750
|
# @return [Array<Types::PhoneNumberCountry>]
|
1289
1751
|
#
|
1290
1752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountriesResponse AWS API Documentation
|
@@ -1295,10 +1757,36 @@ module Aws::ChimeSDKVoice
|
|
1295
1757
|
include Aws::Structure
|
1296
1758
|
end
|
1297
1759
|
|
1760
|
+
# @!attribute [rw] resource_arn
|
1761
|
+
# The resource ARN.
|
1762
|
+
# @return [String]
|
1763
|
+
#
|
1764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResourceRequest AWS API Documentation
|
1765
|
+
#
|
1766
|
+
class ListTagsForResourceRequest < Struct.new(
|
1767
|
+
:resource_arn)
|
1768
|
+
SENSITIVE = [:resource_arn]
|
1769
|
+
include Aws::Structure
|
1770
|
+
end
|
1771
|
+
|
1772
|
+
# @!attribute [rw] tags
|
1773
|
+
# The tags in the list.
|
1774
|
+
# @return [Array<Types::Tag>]
|
1775
|
+
#
|
1776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResourceResponse AWS API Documentation
|
1777
|
+
#
|
1778
|
+
class ListTagsForResourceResponse < Struct.new(
|
1779
|
+
:tags)
|
1780
|
+
SENSITIVE = []
|
1781
|
+
include Aws::Structure
|
1782
|
+
end
|
1783
|
+
|
1298
1784
|
# @!attribute [rw] next_token
|
1785
|
+
# The token used to return the next page of results.
|
1299
1786
|
# @return [String]
|
1300
1787
|
#
|
1301
1788
|
# @!attribute [rw] max_results
|
1789
|
+
# The maximum number of results to return in a single call.
|
1302
1790
|
# @return [Integer]
|
1303
1791
|
#
|
1304
1792
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroupsRequest AWS API Documentation
|
@@ -1311,9 +1799,11 @@ module Aws::ChimeSDKVoice
|
|
1311
1799
|
end
|
1312
1800
|
|
1313
1801
|
# @!attribute [rw] voice_connector_groups
|
1802
|
+
# The details of the Voice Connector groups.
|
1314
1803
|
# @return [Array<Types::VoiceConnectorGroup>]
|
1315
1804
|
#
|
1316
1805
|
# @!attribute [rw] next_token
|
1806
|
+
# The token used to return the next page of results.
|
1317
1807
|
# @return [String]
|
1318
1808
|
#
|
1319
1809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroupsResponse AWS API Documentation
|
@@ -1326,6 +1816,7 @@ module Aws::ChimeSDKVoice
|
|
1326
1816
|
end
|
1327
1817
|
|
1328
1818
|
# @!attribute [rw] voice_connector_id
|
1819
|
+
# The Voice Connector ID.
|
1329
1820
|
# @return [String]
|
1330
1821
|
#
|
1331
1822
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -1337,6 +1828,7 @@ module Aws::ChimeSDKVoice
|
|
1337
1828
|
end
|
1338
1829
|
|
1339
1830
|
# @!attribute [rw] usernames
|
1831
|
+
# A list of user names.
|
1340
1832
|
# @return [Array<String>]
|
1341
1833
|
#
|
1342
1834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentialsResponse AWS API Documentation
|
@@ -1348,9 +1840,11 @@ module Aws::ChimeSDKVoice
|
|
1348
1840
|
end
|
1349
1841
|
|
1350
1842
|
# @!attribute [rw] next_token
|
1843
|
+
# The token used to return the next page of results.
|
1351
1844
|
# @return [String]
|
1352
1845
|
#
|
1353
1846
|
# @!attribute [rw] max_results
|
1847
|
+
# The maximum number of results to return in a single call.
|
1354
1848
|
# @return [Integer]
|
1355
1849
|
#
|
1356
1850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorsRequest AWS API Documentation
|
@@ -1363,9 +1857,11 @@ module Aws::ChimeSDKVoice
|
|
1363
1857
|
end
|
1364
1858
|
|
1365
1859
|
# @!attribute [rw] voice_connectors
|
1860
|
+
# The details of the Voice Connectors.
|
1366
1861
|
# @return [Array<Types::VoiceConnector>]
|
1367
1862
|
#
|
1368
1863
|
# @!attribute [rw] next_token
|
1864
|
+
# The token used to return the next page of results.
|
1369
1865
|
# @return [String]
|
1370
1866
|
#
|
1371
1867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorsResponse AWS API Documentation
|
@@ -1377,10 +1873,90 @@ module Aws::ChimeSDKVoice
|
|
1377
1873
|
include Aws::Structure
|
1378
1874
|
end
|
1379
1875
|
|
1876
|
+
# @!attribute [rw] next_token
|
1877
|
+
# The token used to return the next page of results.
|
1878
|
+
# @return [String]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] max_results
|
1881
|
+
# The maximum number of results to return in a single call.
|
1882
|
+
# @return [Integer]
|
1883
|
+
#
|
1884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomainsRequest AWS API Documentation
|
1885
|
+
#
|
1886
|
+
class ListVoiceProfileDomainsRequest < Struct.new(
|
1887
|
+
:next_token,
|
1888
|
+
:max_results)
|
1889
|
+
SENSITIVE = []
|
1890
|
+
include Aws::Structure
|
1891
|
+
end
|
1892
|
+
|
1893
|
+
# @!attribute [rw] voice_profile_domains
|
1894
|
+
# The list of voice profile domains.
|
1895
|
+
# @return [Array<Types::VoiceProfileDomainSummary>]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] next_token
|
1898
|
+
# The token used to return the next page of results.
|
1899
|
+
# @return [String]
|
1900
|
+
#
|
1901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomainsResponse AWS API Documentation
|
1902
|
+
#
|
1903
|
+
class ListVoiceProfileDomainsResponse < Struct.new(
|
1904
|
+
:voice_profile_domains,
|
1905
|
+
:next_token)
|
1906
|
+
SENSITIVE = []
|
1907
|
+
include Aws::Structure
|
1908
|
+
end
|
1909
|
+
|
1910
|
+
# @!attribute [rw] voice_profile_domain_id
|
1911
|
+
# The ID of the voice profile domain.
|
1912
|
+
# @return [String]
|
1913
|
+
#
|
1914
|
+
# @!attribute [rw] next_token
|
1915
|
+
# The token used to retrieve the next page of results.
|
1916
|
+
# @return [String]
|
1917
|
+
#
|
1918
|
+
# @!attribute [rw] max_results
|
1919
|
+
# The maximum number of results in the request.
|
1920
|
+
# @return [Integer]
|
1921
|
+
#
|
1922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfilesRequest AWS API Documentation
|
1923
|
+
#
|
1924
|
+
class ListVoiceProfilesRequest < Struct.new(
|
1925
|
+
:voice_profile_domain_id,
|
1926
|
+
:next_token,
|
1927
|
+
:max_results)
|
1928
|
+
SENSITIVE = []
|
1929
|
+
include Aws::Structure
|
1930
|
+
end
|
1931
|
+
|
1932
|
+
# @!attribute [rw] voice_profiles
|
1933
|
+
# The list of voice profiles.
|
1934
|
+
# @return [Array<Types::VoiceProfileSummary>]
|
1935
|
+
#
|
1936
|
+
# @!attribute [rw] next_token
|
1937
|
+
# The token used to retrieve the next page of results.
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfilesResponse AWS API Documentation
|
1941
|
+
#
|
1942
|
+
class ListVoiceProfilesResponse < Struct.new(
|
1943
|
+
:voice_profiles,
|
1944
|
+
:next_token)
|
1945
|
+
SENSITIVE = []
|
1946
|
+
include Aws::Structure
|
1947
|
+
end
|
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
|
+
#
|
1380
1953
|
# @!attribute [rw] enable_sip_logs
|
1954
|
+
# Boolean that enables sending SIP message logs to Amazon CloudWatch
|
1955
|
+
# logs.
|
1381
1956
|
# @return [Boolean]
|
1382
1957
|
#
|
1383
1958
|
# @!attribute [rw] enable_media_metric_logs
|
1959
|
+
# Enables or disables media metrics logging.
|
1384
1960
|
# @return [Boolean]
|
1385
1961
|
#
|
1386
1962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/LoggingConfiguration AWS API Documentation
|
@@ -1392,14 +1968,39 @@ module Aws::ChimeSDKVoice
|
|
1392
1968
|
include Aws::Structure
|
1393
1969
|
end
|
1394
1970
|
|
1971
|
+
# The configuration for a call analytics task.
|
1972
|
+
#
|
1973
|
+
# @!attribute [rw] disabled
|
1974
|
+
# Denotes the configration as enabled or disabled.
|
1975
|
+
# @return [Boolean]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] configuration_arn
|
1978
|
+
# The configuration's ARN.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/MediaInsightsConfiguration AWS API Documentation
|
1982
|
+
#
|
1983
|
+
class MediaInsightsConfiguration < Struct.new(
|
1984
|
+
:disabled,
|
1985
|
+
:configuration_arn)
|
1986
|
+
SENSITIVE = [:configuration_arn]
|
1987
|
+
include Aws::Structure
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# The requested resource couldn't be found.
|
1991
|
+
#
|
1395
1992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/NotFoundException AWS API Documentation
|
1396
1993
|
#
|
1397
1994
|
class NotFoundException < Aws::EmptyStructure; end
|
1398
1995
|
|
1996
|
+
# A phone number for which an order has been placed.
|
1997
|
+
#
|
1399
1998
|
# @!attribute [rw] e164_phone_number
|
1999
|
+
# The phone number, in E.164 format.
|
1400
2000
|
# @return [String]
|
1401
2001
|
#
|
1402
2002
|
# @!attribute [rw] status
|
2003
|
+
# The phone number status.
|
1403
2004
|
# @return [String]
|
1404
2005
|
#
|
1405
2006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/OrderedPhoneNumber AWS API Documentation
|
@@ -1411,10 +2012,24 @@ module Aws::ChimeSDKVoice
|
|
1411
2012
|
include Aws::Structure
|
1412
2013
|
end
|
1413
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
|
+
#
|
1414
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`.
|
1415
2027
|
# @return [Array<Types::OriginationRoute>]
|
1416
2028
|
#
|
1417
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`.
|
1418
2033
|
# @return [Boolean]
|
1419
2034
|
#
|
1420
2035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Origination AWS API Documentation
|
@@ -1426,19 +2041,37 @@ module Aws::ChimeSDKVoice
|
|
1426
2041
|
include Aws::Structure
|
1427
2042
|
end
|
1428
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
|
+
#
|
1429
2053
|
# @!attribute [rw] host
|
2054
|
+
# The FQDN or IP address to contact for origination traffic.
|
1430
2055
|
# @return [String]
|
1431
2056
|
#
|
1432
2057
|
# @!attribute [rw] port
|
2058
|
+
# The designated origination route port. Defaults to 5060.
|
1433
2059
|
# @return [Integer]
|
1434
2060
|
#
|
1435
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.
|
1436
2064
|
# @return [String]
|
1437
2065
|
#
|
1438
2066
|
# @!attribute [rw] priority
|
2067
|
+
# The priority associated with the host, with 1 being the highest
|
2068
|
+
# priority. Higher priority hosts are attempted first.
|
1439
2069
|
# @return [Integer]
|
1440
2070
|
#
|
1441
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.
|
1442
2075
|
# @return [Integer]
|
1443
2076
|
#
|
1444
2077
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/OriginationRoute AWS API Documentation
|
@@ -1453,10 +2086,15 @@ module Aws::ChimeSDKVoice
|
|
1453
2086
|
include Aws::Structure
|
1454
2087
|
end
|
1455
2088
|
|
2089
|
+
# The phone number and proxy phone number for a participant in an Amazon
|
2090
|
+
# Chime SDK Voice Connector proxy session.
|
2091
|
+
#
|
1456
2092
|
# @!attribute [rw] phone_number
|
2093
|
+
# The participant's phone number.
|
1457
2094
|
# @return [String]
|
1458
2095
|
#
|
1459
2096
|
# @!attribute [rw] proxy_phone_number
|
2097
|
+
# The participant's proxy phone number.
|
1460
2098
|
# @return [String]
|
1461
2099
|
#
|
1462
2100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Participant AWS API Documentation
|
@@ -1468,46 +2106,62 @@ module Aws::ChimeSDKVoice
|
|
1468
2106
|
include Aws::Structure
|
1469
2107
|
end
|
1470
2108
|
|
2109
|
+
# A phone number used to call an Amazon Chime SDK Voice Connector.
|
2110
|
+
#
|
1471
2111
|
# @!attribute [rw] phone_number_id
|
2112
|
+
# The phone number's ID.
|
1472
2113
|
# @return [String]
|
1473
2114
|
#
|
1474
2115
|
# @!attribute [rw] e164_phone_number
|
2116
|
+
# The phone number, in E.164 format.
|
1475
2117
|
# @return [String]
|
1476
2118
|
#
|
1477
2119
|
# @!attribute [rw] country
|
2120
|
+
# The phone number's country. Format: ISO 3166-1 alpha-2.
|
1478
2121
|
# @return [String]
|
1479
2122
|
#
|
1480
2123
|
# @!attribute [rw] type
|
2124
|
+
# The phone number's type.
|
1481
2125
|
# @return [String]
|
1482
2126
|
#
|
1483
2127
|
# @!attribute [rw] product_type
|
2128
|
+
# The phone number's product type.
|
1484
2129
|
# @return [String]
|
1485
2130
|
#
|
1486
2131
|
# @!attribute [rw] status
|
2132
|
+
# The phone number's status.
|
1487
2133
|
# @return [String]
|
1488
2134
|
#
|
1489
2135
|
# @!attribute [rw] capabilities
|
2136
|
+
# The phone number's capabilities.
|
1490
2137
|
# @return [Types::PhoneNumberCapabilities]
|
1491
2138
|
#
|
1492
2139
|
# @!attribute [rw] associations
|
2140
|
+
# The phone number's associations.
|
1493
2141
|
# @return [Array<Types::PhoneNumberAssociation>]
|
1494
2142
|
#
|
1495
2143
|
# @!attribute [rw] calling_name
|
2144
|
+
# The outbound calling name associated with the phone number.
|
1496
2145
|
# @return [String]
|
1497
2146
|
#
|
1498
2147
|
# @!attribute [rw] calling_name_status
|
2148
|
+
# The outbound calling name status.
|
1499
2149
|
# @return [String]
|
1500
2150
|
#
|
1501
2151
|
# @!attribute [rw] created_timestamp
|
2152
|
+
# The phone number creation timestamp, in ISO 8601 format.
|
1502
2153
|
# @return [Time]
|
1503
2154
|
#
|
1504
2155
|
# @!attribute [rw] updated_timestamp
|
2156
|
+
# The updated phone number timestamp, in ISO 8601 format.
|
1505
2157
|
# @return [Time]
|
1506
2158
|
#
|
1507
2159
|
# @!attribute [rw] deletion_timestamp
|
2160
|
+
# The deleted phone number timestamp, in ISO 8601 format.
|
1508
2161
|
# @return [Time]
|
1509
2162
|
#
|
1510
2163
|
# @!attribute [rw] order_id
|
2164
|
+
# The phone number's order ID.
|
1511
2165
|
# @return [String]
|
1512
2166
|
#
|
1513
2167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumber AWS API Documentation
|
@@ -1531,13 +2185,20 @@ module Aws::ChimeSDKVoice
|
|
1531
2185
|
include Aws::Structure
|
1532
2186
|
end
|
1533
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
|
+
#
|
1534
2191
|
# @!attribute [rw] value
|
2192
|
+
# Contains the ID for the entity specified in Name.
|
1535
2193
|
# @return [String]
|
1536
2194
|
#
|
1537
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.
|
1538
2198
|
# @return [String]
|
1539
2199
|
#
|
1540
2200
|
# @!attribute [rw] associated_timestamp
|
2201
|
+
# The timestamp of the phone number association, in ISO 8601 format.
|
1541
2202
|
# @return [Time]
|
1542
2203
|
#
|
1543
2204
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberAssociation AWS API Documentation
|
@@ -1550,22 +2211,35 @@ module Aws::ChimeSDKVoice
|
|
1550
2211
|
include Aws::Structure
|
1551
2212
|
end
|
1552
2213
|
|
2214
|
+
# The phone number capabilities for Amazon Chime SDK phone numbers, such
|
2215
|
+
# as enabled inbound and outbound calling, and text messaging.
|
2216
|
+
#
|
1553
2217
|
# @!attribute [rw] inbound_call
|
2218
|
+
# Allows or denies inbound calling for the specified phone number.
|
1554
2219
|
# @return [Boolean]
|
1555
2220
|
#
|
1556
2221
|
# @!attribute [rw] outbound_call
|
2222
|
+
# Allows or denies outbound calling for the specified phone number.
|
1557
2223
|
# @return [Boolean]
|
1558
2224
|
#
|
1559
2225
|
# @!attribute [rw] inbound_sms
|
2226
|
+
# Allows or denies inbound SMS messaging for the specified phone
|
2227
|
+
# number.
|
1560
2228
|
# @return [Boolean]
|
1561
2229
|
#
|
1562
2230
|
# @!attribute [rw] outbound_sms
|
2231
|
+
# Allows or denies outbound SMS messaging for the specified phone
|
2232
|
+
# number.
|
1563
2233
|
# @return [Boolean]
|
1564
2234
|
#
|
1565
2235
|
# @!attribute [rw] inbound_mms
|
2236
|
+
# Allows or denies inbound MMS messaging for the specified phone
|
2237
|
+
# number.
|
1566
2238
|
# @return [Boolean]
|
1567
2239
|
#
|
1568
2240
|
# @!attribute [rw] outbound_mms
|
2241
|
+
# Allows or denies inbound MMS messaging for the specified phone
|
2242
|
+
# number.
|
1569
2243
|
# @return [Boolean]
|
1570
2244
|
#
|
1571
2245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberCapabilities AWS API Documentation
|
@@ -1581,10 +2255,14 @@ module Aws::ChimeSDKVoice
|
|
1581
2255
|
include Aws::Structure
|
1582
2256
|
end
|
1583
2257
|
|
2258
|
+
# The phone number's country.
|
2259
|
+
#
|
1584
2260
|
# @!attribute [rw] country_code
|
2261
|
+
# The phone number country code. Format: ISO 3166-1 alpha-2.
|
1585
2262
|
# @return [String]
|
1586
2263
|
#
|
1587
2264
|
# @!attribute [rw] supported_phone_number_types
|
2265
|
+
# The supported phone number types.
|
1588
2266
|
# @return [Array<String>]
|
1589
2267
|
#
|
1590
2268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberCountry AWS API Documentation
|
@@ -1596,13 +2274,20 @@ module Aws::ChimeSDKVoice
|
|
1596
2274
|
include Aws::Structure
|
1597
2275
|
end
|
1598
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
|
+
#
|
1599
2281
|
# @!attribute [rw] phone_number_id
|
2282
|
+
# The phone number ID for which the action failed.
|
1600
2283
|
# @return [String]
|
1601
2284
|
#
|
1602
2285
|
# @!attribute [rw] error_code
|
2286
|
+
# The error code.
|
1603
2287
|
# @return [String]
|
1604
2288
|
#
|
1605
2289
|
# @!attribute [rw] error_message
|
2290
|
+
# The error message.
|
1606
2291
|
# @return [String]
|
1607
2292
|
#
|
1608
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberError AWS API Documentation
|
@@ -1615,25 +2300,35 @@ module Aws::ChimeSDKVoice
|
|
1615
2300
|
include Aws::Structure
|
1616
2301
|
end
|
1617
2302
|
|
2303
|
+
# The details of an Amazon Chime SDK phone number order.
|
2304
|
+
#
|
1618
2305
|
# @!attribute [rw] phone_number_order_id
|
2306
|
+
# The ID of the phone order.
|
1619
2307
|
# @return [String]
|
1620
2308
|
#
|
1621
2309
|
# @!attribute [rw] product_type
|
2310
|
+
# The phone number order product type.
|
1622
2311
|
# @return [String]
|
1623
2312
|
#
|
1624
2313
|
# @!attribute [rw] status
|
2314
|
+
# The status of the phone number order.
|
1625
2315
|
# @return [String]
|
1626
2316
|
#
|
1627
2317
|
# @!attribute [rw] order_type
|
2318
|
+
# The type of phone number being ordered, local or toll-free.
|
1628
2319
|
# @return [String]
|
1629
2320
|
#
|
1630
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.
|
1631
2324
|
# @return [Array<Types::OrderedPhoneNumber>]
|
1632
2325
|
#
|
1633
2326
|
# @!attribute [rw] created_timestamp
|
2327
|
+
# The phone number order creation time stamp, in ISO 8601 format.
|
1634
2328
|
# @return [Time]
|
1635
2329
|
#
|
1636
2330
|
# @!attribute [rw] updated_timestamp
|
2331
|
+
# The updated phone number order time stamp, in ISO 8601 format.
|
1637
2332
|
# @return [Time]
|
1638
2333
|
#
|
1639
2334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PhoneNumberOrder AWS API Documentation
|
@@ -1650,16 +2345,23 @@ module Aws::ChimeSDKVoice
|
|
1650
2345
|
include Aws::Structure
|
1651
2346
|
end
|
1652
2347
|
|
2348
|
+
# The proxy configuration for an Amazon Chime SDK Voice Connector.
|
2349
|
+
#
|
1653
2350
|
# @!attribute [rw] default_session_expiry_minutes
|
2351
|
+
# The default number of minutes allowed for proxy sessions.
|
1654
2352
|
# @return [Integer]
|
1655
2353
|
#
|
1656
2354
|
# @!attribute [rw] disabled
|
2355
|
+
# When true, stops proxy sessions from being created on the specified
|
2356
|
+
# Amazon Chime SDK Voice Connector.
|
1657
2357
|
# @return [Boolean]
|
1658
2358
|
#
|
1659
2359
|
# @!attribute [rw] fall_back_phone_number
|
2360
|
+
# The phone number to route calls to after a proxy session expires.
|
1660
2361
|
# @return [String]
|
1661
2362
|
#
|
1662
2363
|
# @!attribute [rw] phone_number_countries
|
2364
|
+
# The countries for proxy phone numbers to be selected from.
|
1663
2365
|
# @return [Array<String>]
|
1664
2366
|
#
|
1665
2367
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Proxy AWS API Documentation
|
@@ -1673,43 +2375,60 @@ module Aws::ChimeSDKVoice
|
|
1673
2375
|
include Aws::Structure
|
1674
2376
|
end
|
1675
2377
|
|
2378
|
+
# The proxy session for an Amazon Chime SDK Voice Connector.
|
2379
|
+
#
|
1676
2380
|
# @!attribute [rw] voice_connector_id
|
2381
|
+
# The Voice Connector ID.
|
1677
2382
|
# @return [String]
|
1678
2383
|
#
|
1679
2384
|
# @!attribute [rw] proxy_session_id
|
2385
|
+
# The proxy session ID.
|
1680
2386
|
# @return [String]
|
1681
2387
|
#
|
1682
2388
|
# @!attribute [rw] name
|
2389
|
+
# The proxy session name.
|
1683
2390
|
# @return [String]
|
1684
2391
|
#
|
1685
2392
|
# @!attribute [rw] status
|
2393
|
+
# The proxy session status.
|
1686
2394
|
# @return [String]
|
1687
2395
|
#
|
1688
2396
|
# @!attribute [rw] expiry_minutes
|
2397
|
+
# The number of minutes allowed for the proxy session.
|
1689
2398
|
# @return [Integer]
|
1690
2399
|
#
|
1691
2400
|
# @!attribute [rw] capabilities
|
2401
|
+
# The proxy session capabilities.
|
1692
2402
|
# @return [Array<String>]
|
1693
2403
|
#
|
1694
2404
|
# @!attribute [rw] created_timestamp
|
2405
|
+
# The created time stamp, in ISO 8601 format.
|
1695
2406
|
# @return [Time]
|
1696
2407
|
#
|
1697
2408
|
# @!attribute [rw] updated_timestamp
|
2409
|
+
# The updated time stamp, in ISO 8601 format.
|
1698
2410
|
# @return [Time]
|
1699
2411
|
#
|
1700
2412
|
# @!attribute [rw] ended_timestamp
|
2413
|
+
# The ended time stamp, in ISO 8601 format.
|
1701
2414
|
# @return [Time]
|
1702
2415
|
#
|
1703
2416
|
# @!attribute [rw] participants
|
2417
|
+
# The proxy session participants.
|
1704
2418
|
# @return [Array<Types::Participant>]
|
1705
2419
|
#
|
1706
2420
|
# @!attribute [rw] number_selection_behavior
|
2421
|
+
# The preference for proxy phone number reuse, or stickiness, between
|
2422
|
+
# the same participants across sessions.
|
1707
2423
|
# @return [String]
|
1708
2424
|
#
|
1709
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.
|
1710
2428
|
# @return [String]
|
1711
2429
|
#
|
1712
2430
|
# @!attribute [rw] geo_match_params
|
2431
|
+
# The country and area code for the proxy phone number.
|
1713
2432
|
# @return [Types::GeoMatchParams]
|
1714
2433
|
#
|
1715
2434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ProxySession AWS API Documentation
|
@@ -1733,9 +2452,11 @@ module Aws::ChimeSDKVoice
|
|
1733
2452
|
end
|
1734
2453
|
|
1735
2454
|
# @!attribute [rw] sip_media_application_id
|
2455
|
+
# The SIP media application ID.
|
1736
2456
|
# @return [String]
|
1737
2457
|
#
|
1738
2458
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
2459
|
+
# The Alexa Skill configuration.
|
1739
2460
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
1740
2461
|
#
|
1741
2462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfigurationRequest AWS API Documentation
|
@@ -1748,6 +2469,7 @@ module Aws::ChimeSDKVoice
|
|
1748
2469
|
end
|
1749
2470
|
|
1750
2471
|
# @!attribute [rw] sip_media_application_alexa_skill_configuration
|
2472
|
+
# Returns the Alexa Skill configuration.
|
1751
2473
|
# @return [Types::SipMediaApplicationAlexaSkillConfiguration]
|
1752
2474
|
#
|
1753
2475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfigurationResponse AWS API Documentation
|
@@ -1759,9 +2481,11 @@ module Aws::ChimeSDKVoice
|
|
1759
2481
|
end
|
1760
2482
|
|
1761
2483
|
# @!attribute [rw] sip_media_application_id
|
2484
|
+
# The SIP media application ID.
|
1762
2485
|
# @return [String]
|
1763
2486
|
#
|
1764
2487
|
# @!attribute [rw] sip_media_application_logging_configuration
|
2488
|
+
# The logging configuration for the specified SIP media application.
|
1765
2489
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
1766
2490
|
#
|
1767
2491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfigurationRequest AWS API Documentation
|
@@ -1774,6 +2498,8 @@ module Aws::ChimeSDKVoice
|
|
1774
2498
|
end
|
1775
2499
|
|
1776
2500
|
# @!attribute [rw] sip_media_application_logging_configuration
|
2501
|
+
# The updated logging configuration for the specified SIP media
|
2502
|
+
# application.
|
1777
2503
|
# @return [Types::SipMediaApplicationLoggingConfiguration]
|
1778
2504
|
#
|
1779
2505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfigurationResponse AWS API Documentation
|
@@ -1785,9 +2511,11 @@ module Aws::ChimeSDKVoice
|
|
1785
2511
|
end
|
1786
2512
|
|
1787
2513
|
# @!attribute [rw] voice_connector_id
|
2514
|
+
# The Voice Connector ID.
|
1788
2515
|
# @return [String]
|
1789
2516
|
#
|
1790
2517
|
# @!attribute [rw] emergency_calling_configuration
|
2518
|
+
# The configuration being updated.
|
1791
2519
|
# @return [Types::EmergencyCallingConfiguration]
|
1792
2520
|
#
|
1793
2521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfigurationRequest AWS API Documentation
|
@@ -1800,6 +2528,7 @@ module Aws::ChimeSDKVoice
|
|
1800
2528
|
end
|
1801
2529
|
|
1802
2530
|
# @!attribute [rw] emergency_calling_configuration
|
2531
|
+
# The updated configuration.
|
1803
2532
|
# @return [Types::EmergencyCallingConfiguration]
|
1804
2533
|
#
|
1805
2534
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfigurationResponse AWS API Documentation
|
@@ -1811,9 +2540,11 @@ module Aws::ChimeSDKVoice
|
|
1811
2540
|
end
|
1812
2541
|
|
1813
2542
|
# @!attribute [rw] voice_connector_id
|
2543
|
+
# The Voice Connector ID.
|
1814
2544
|
# @return [String]
|
1815
2545
|
#
|
1816
2546
|
# @!attribute [rw] logging_configuration
|
2547
|
+
# The logging configuration being updated.
|
1817
2548
|
# @return [Types::LoggingConfiguration]
|
1818
2549
|
#
|
1819
2550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfigurationRequest AWS API Documentation
|
@@ -1826,6 +2557,7 @@ module Aws::ChimeSDKVoice
|
|
1826
2557
|
end
|
1827
2558
|
|
1828
2559
|
# @!attribute [rw] logging_configuration
|
2560
|
+
# The updated logging configuration.
|
1829
2561
|
# @return [Types::LoggingConfiguration]
|
1830
2562
|
#
|
1831
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfigurationResponse AWS API Documentation
|
@@ -1837,9 +2569,11 @@ module Aws::ChimeSDKVoice
|
|
1837
2569
|
end
|
1838
2570
|
|
1839
2571
|
# @!attribute [rw] voice_connector_id
|
2572
|
+
# The Voice Connector ID.
|
1840
2573
|
# @return [String]
|
1841
2574
|
#
|
1842
2575
|
# @!attribute [rw] origination
|
2576
|
+
# The origination settings being updated.
|
1843
2577
|
# @return [Types::Origination]
|
1844
2578
|
#
|
1845
2579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOriginationRequest AWS API Documentation
|
@@ -1852,6 +2586,7 @@ module Aws::ChimeSDKVoice
|
|
1852
2586
|
end
|
1853
2587
|
|
1854
2588
|
# @!attribute [rw] origination
|
2589
|
+
# The updated origination settings.
|
1855
2590
|
# @return [Types::Origination]
|
1856
2591
|
#
|
1857
2592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOriginationResponse AWS API Documentation
|
@@ -1863,18 +2598,24 @@ module Aws::ChimeSDKVoice
|
|
1863
2598
|
end
|
1864
2599
|
|
1865
2600
|
# @!attribute [rw] voice_connector_id
|
2601
|
+
# The Voice Connector ID.
|
1866
2602
|
# @return [String]
|
1867
2603
|
#
|
1868
2604
|
# @!attribute [rw] default_session_expiry_minutes
|
2605
|
+
# The default number of minutes allowed for proxy session.
|
1869
2606
|
# @return [Integer]
|
1870
2607
|
#
|
1871
2608
|
# @!attribute [rw] phone_number_pool_countries
|
2609
|
+
# The countries for proxy phone numbers to be selected from.
|
1872
2610
|
# @return [Array<String>]
|
1873
2611
|
#
|
1874
2612
|
# @!attribute [rw] fall_back_phone_number
|
2613
|
+
# The phone number to route calls to after a proxy session expires.
|
1875
2614
|
# @return [String]
|
1876
2615
|
#
|
1877
2616
|
# @!attribute [rw] disabled
|
2617
|
+
# When true, stops proxy sessions from being created on the specified
|
2618
|
+
# Amazon Chime SDK Voice Connector.
|
1878
2619
|
# @return [Boolean]
|
1879
2620
|
#
|
1880
2621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxyRequest AWS API Documentation
|
@@ -1890,6 +2631,7 @@ module Aws::ChimeSDKVoice
|
|
1890
2631
|
end
|
1891
2632
|
|
1892
2633
|
# @!attribute [rw] proxy
|
2634
|
+
# The proxy configuration details.
|
1893
2635
|
# @return [Types::Proxy]
|
1894
2636
|
#
|
1895
2637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxyResponse AWS API Documentation
|
@@ -1901,9 +2643,11 @@ module Aws::ChimeSDKVoice
|
|
1901
2643
|
end
|
1902
2644
|
|
1903
2645
|
# @!attribute [rw] voice_connector_id
|
2646
|
+
# The Voice Connector ID.
|
1904
2647
|
# @return [String]
|
1905
2648
|
#
|
1906
2649
|
# @!attribute [rw] streaming_configuration
|
2650
|
+
# The streaming settings being updated.
|
1907
2651
|
# @return [Types::StreamingConfiguration]
|
1908
2652
|
#
|
1909
2653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfigurationRequest AWS API Documentation
|
@@ -1916,6 +2660,7 @@ module Aws::ChimeSDKVoice
|
|
1916
2660
|
end
|
1917
2661
|
|
1918
2662
|
# @!attribute [rw] streaming_configuration
|
2663
|
+
# The updated streaming settings.
|
1919
2664
|
# @return [Types::StreamingConfiguration]
|
1920
2665
|
#
|
1921
2666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfigurationResponse AWS API Documentation
|
@@ -1927,9 +2672,11 @@ module Aws::ChimeSDKVoice
|
|
1927
2672
|
end
|
1928
2673
|
|
1929
2674
|
# @!attribute [rw] voice_connector_id
|
2675
|
+
# The Voice Connector ID.
|
1930
2676
|
# @return [String]
|
1931
2677
|
#
|
1932
2678
|
# @!attribute [rw] credentials
|
2679
|
+
# The termination credentials being updated.
|
1933
2680
|
# @return [Array<Types::Credential>]
|
1934
2681
|
#
|
1935
2682
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
@@ -1942,9 +2689,11 @@ module Aws::ChimeSDKVoice
|
|
1942
2689
|
end
|
1943
2690
|
|
1944
2691
|
# @!attribute [rw] voice_connector_id
|
2692
|
+
# The Voice Connector ID.
|
1945
2693
|
# @return [String]
|
1946
2694
|
#
|
1947
2695
|
# @!attribute [rw] termination
|
2696
|
+
# The termination settings to be updated.
|
1948
2697
|
# @return [Types::Termination]
|
1949
2698
|
#
|
1950
2699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationRequest AWS API Documentation
|
@@ -1957,6 +2706,7 @@ module Aws::ChimeSDKVoice
|
|
1957
2706
|
end
|
1958
2707
|
|
1959
2708
|
# @!attribute [rw] termination
|
2709
|
+
# The updated termination settings.
|
1960
2710
|
# @return [Types::Termination]
|
1961
2711
|
#
|
1962
2712
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationResponse AWS API Documentation
|
@@ -1967,11 +2717,14 @@ module Aws::ChimeSDKVoice
|
|
1967
2717
|
include Aws::Structure
|
1968
2718
|
end
|
1969
2719
|
|
2720
|
+
# The request exceeds the resource limit.
|
2721
|
+
#
|
1970
2722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ResourceLimitExceededException AWS API Documentation
|
1971
2723
|
#
|
1972
2724
|
class ResourceLimitExceededException < Aws::EmptyStructure; end
|
1973
2725
|
|
1974
2726
|
# @!attribute [rw] phone_number_id
|
2727
|
+
# The ID of the phone number being restored.
|
1975
2728
|
# @return [String]
|
1976
2729
|
#
|
1977
2730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumberRequest AWS API Documentation
|
@@ -1983,6 +2736,7 @@ module Aws::ChimeSDKVoice
|
|
1983
2736
|
end
|
1984
2737
|
|
1985
2738
|
# @!attribute [rw] phone_number
|
2739
|
+
# The restored phone number.
|
1986
2740
|
# @return [Types::PhoneNumber]
|
1987
2741
|
#
|
1988
2742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumberResponse AWS API Documentation
|
@@ -1994,27 +2748,41 @@ module Aws::ChimeSDKVoice
|
|
1994
2748
|
end
|
1995
2749
|
|
1996
2750
|
# @!attribute [rw] area_code
|
2751
|
+
# Confines a search to just the phone numbers associated with the
|
2752
|
+
# specified area code.
|
1997
2753
|
# @return [String]
|
1998
2754
|
#
|
1999
2755
|
# @!attribute [rw] city
|
2756
|
+
# Confines a search to just the phone numbers associated with the
|
2757
|
+
# specified city.
|
2000
2758
|
# @return [String]
|
2001
2759
|
#
|
2002
2760
|
# @!attribute [rw] country
|
2761
|
+
# Confines a search to just the phone numbers associated with the
|
2762
|
+
# specified country.
|
2003
2763
|
# @return [String]
|
2004
2764
|
#
|
2005
2765
|
# @!attribute [rw] state
|
2766
|
+
# Confines a search to just the phone numbers associated with the
|
2767
|
+
# specified state.
|
2006
2768
|
# @return [String]
|
2007
2769
|
#
|
2008
2770
|
# @!attribute [rw] toll_free_prefix
|
2771
|
+
# Confines a search to just the phone numbers associated with the
|
2772
|
+
# specified toll-free prefix.
|
2009
2773
|
# @return [String]
|
2010
2774
|
#
|
2011
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**.
|
2012
2778
|
# @return [String]
|
2013
2779
|
#
|
2014
2780
|
# @!attribute [rw] max_results
|
2781
|
+
# The maximum number of results to return.
|
2015
2782
|
# @return [Integer]
|
2016
2783
|
#
|
2017
2784
|
# @!attribute [rw] next_token
|
2785
|
+
# The token used to return the next page of results.
|
2018
2786
|
# @return [String]
|
2019
2787
|
#
|
2020
2788
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbersRequest AWS API Documentation
|
@@ -2033,9 +2801,11 @@ module Aws::ChimeSDKVoice
|
|
2033
2801
|
end
|
2034
2802
|
|
2035
2803
|
# @!attribute [rw] e164_phone_numbers
|
2804
|
+
# Confines a search to just the phone numbers in the E.164 format.
|
2036
2805
|
# @return [Array<String>]
|
2037
2806
|
#
|
2038
2807
|
# @!attribute [rw] next_token
|
2808
|
+
# The token used to return the next page of results.
|
2039
2809
|
# @return [String]
|
2040
2810
|
#
|
2041
2811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbersResponse AWS API Documentation
|
@@ -2047,30 +2817,66 @@ module Aws::ChimeSDKVoice
|
|
2047
2817
|
include Aws::Structure
|
2048
2818
|
end
|
2049
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
|
+
#
|
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.
|
2832
|
+
# @return [String]
|
2833
|
+
#
|
2834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServerSideEncryptionConfiguration AWS API Documentation
|
2835
|
+
#
|
2836
|
+
class ServerSideEncryptionConfiguration < Struct.new(
|
2837
|
+
:kms_key_arn)
|
2838
|
+
SENSITIVE = [:kms_key_arn]
|
2839
|
+
include Aws::Structure
|
2840
|
+
end
|
2841
|
+
|
2842
|
+
# The service encountered an unexpected error.
|
2843
|
+
#
|
2050
2844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServiceFailureException AWS API Documentation
|
2051
2845
|
#
|
2052
2846
|
class ServiceFailureException < Aws::EmptyStructure; end
|
2053
2847
|
|
2848
|
+
# The service is currently unavailable.
|
2849
|
+
#
|
2054
2850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ServiceUnavailableException AWS API Documentation
|
2055
2851
|
#
|
2056
2852
|
class ServiceUnavailableException < Aws::EmptyStructure; end
|
2057
2853
|
|
2854
|
+
# The details of the SIP media application, including name and
|
2855
|
+
# endpoints. An AWS account can have multiple SIP media applications.
|
2856
|
+
#
|
2058
2857
|
# @!attribute [rw] sip_media_application_id
|
2858
|
+
# A SIP media application's ID.
|
2059
2859
|
# @return [String]
|
2060
2860
|
#
|
2061
2861
|
# @!attribute [rw] aws_region
|
2862
|
+
# The AWS Region in which the SIP media application is created.
|
2062
2863
|
# @return [String]
|
2063
2864
|
#
|
2064
2865
|
# @!attribute [rw] name
|
2866
|
+
# The SIP media application's name.
|
2065
2867
|
# @return [String]
|
2066
2868
|
#
|
2067
2869
|
# @!attribute [rw] endpoints
|
2870
|
+
# List of endpoints for SIP media application. Currently, only one
|
2871
|
+
# endpoint per SIP media application is permitted.
|
2068
2872
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
2069
2873
|
#
|
2070
2874
|
# @!attribute [rw] created_timestamp
|
2875
|
+
# The SIP media application creation timestamp, in ISO 8601 format.
|
2071
2876
|
# @return [Time]
|
2072
2877
|
#
|
2073
2878
|
# @!attribute [rw] updated_timestamp
|
2879
|
+
# The time at which the SIP media application was updated.
|
2074
2880
|
# @return [Time]
|
2075
2881
|
#
|
2076
2882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplication AWS API Documentation
|
@@ -2086,10 +2892,14 @@ module Aws::ChimeSDKVoice
|
|
2086
2892
|
include Aws::Structure
|
2087
2893
|
end
|
2088
2894
|
|
2895
|
+
# The Alexa Skill configuration of a SIP media application.
|
2896
|
+
#
|
2089
2897
|
# @!attribute [rw] alexa_skill_status
|
2898
|
+
# The status of the Alexa Skill configuration.
|
2090
2899
|
# @return [String]
|
2091
2900
|
#
|
2092
2901
|
# @!attribute [rw] alexa_skill_ids
|
2902
|
+
# The ID of the Alexa Skill configuration.
|
2093
2903
|
# @return [Array<String>]
|
2094
2904
|
#
|
2095
2905
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationAlexaSkillConfiguration AWS API Documentation
|
@@ -2101,7 +2911,10 @@ module Aws::ChimeSDKVoice
|
|
2101
2911
|
include Aws::Structure
|
2102
2912
|
end
|
2103
2913
|
|
2914
|
+
# A `Call` instance for a SIP media application.
|
2915
|
+
#
|
2104
2916
|
# @!attribute [rw] transaction_id
|
2917
|
+
# The call's transaction ID.
|
2105
2918
|
# @return [String]
|
2106
2919
|
#
|
2107
2920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationCall AWS API Documentation
|
@@ -2112,7 +2925,12 @@ module Aws::ChimeSDKVoice
|
|
2112
2925
|
include Aws::Structure
|
2113
2926
|
end
|
2114
2927
|
|
2928
|
+
# The endpoint assigned to a SIP media application.
|
2929
|
+
#
|
2115
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.
|
2116
2934
|
# @return [String]
|
2117
2935
|
#
|
2118
2936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationEndpoint AWS API Documentation
|
@@ -2123,7 +2941,10 @@ module Aws::ChimeSDKVoice
|
|
2123
2941
|
include Aws::Structure
|
2124
2942
|
end
|
2125
2943
|
|
2944
|
+
# The logging configuration of a SIP media application.
|
2945
|
+
#
|
2126
2946
|
# @!attribute [rw] enable_sip_media_application_message_logs
|
2947
|
+
# Enables message logging for the specified SIP media application.
|
2127
2948
|
# @return [Boolean]
|
2128
2949
|
#
|
2129
2950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipMediaApplicationLoggingConfiguration AWS API Documentation
|
@@ -2134,28 +2955,44 @@ module Aws::ChimeSDKVoice
|
|
2134
2955
|
include Aws::Structure
|
2135
2956
|
end
|
2136
2957
|
|
2958
|
+
# The details of a SIP rule, including name, triggers, and target
|
2959
|
+
# applications. An AWS account can have multiple SIP rules.
|
2960
|
+
#
|
2137
2961
|
# @!attribute [rw] sip_rule_id
|
2962
|
+
# A SIP rule's ID.
|
2138
2963
|
# @return [String]
|
2139
2964
|
#
|
2140
2965
|
# @!attribute [rw] name
|
2966
|
+
# A SIP rule's name.
|
2141
2967
|
# @return [String]
|
2142
2968
|
#
|
2143
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.
|
2144
2972
|
# @return [Boolean]
|
2145
2973
|
#
|
2146
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.
|
2147
2977
|
# @return [String]
|
2148
2978
|
#
|
2149
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.
|
2150
2982
|
# @return [String]
|
2151
2983
|
#
|
2152
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.
|
2153
2988
|
# @return [Array<Types::SipRuleTargetApplication>]
|
2154
2989
|
#
|
2155
2990
|
# @!attribute [rw] created_timestamp
|
2991
|
+
# The time at which the SIP rule was created, in ISO 8601 format.
|
2156
2992
|
# @return [Time]
|
2157
2993
|
#
|
2158
2994
|
# @!attribute [rw] updated_timestamp
|
2995
|
+
# The time at which the SIP rule was updated, in ISO 8601 format.
|
2159
2996
|
# @return [Time]
|
2160
2997
|
#
|
2161
2998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipRule AWS API Documentation
|
@@ -2173,13 +3010,20 @@ module Aws::ChimeSDKVoice
|
|
2173
3010
|
include Aws::Structure
|
2174
3011
|
end
|
2175
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
|
+
#
|
2176
3017
|
# @!attribute [rw] sip_media_application_id
|
3018
|
+
# The ID of a rule's target SIP media application.
|
2177
3019
|
# @return [String]
|
2178
3020
|
#
|
2179
3021
|
# @!attribute [rw] priority
|
3022
|
+
# The priority setting of a rule's target SIP media application.
|
2180
3023
|
# @return [Integer]
|
2181
3024
|
#
|
2182
3025
|
# @!attribute [rw] aws_region
|
3026
|
+
# The AWS Region of a rule's target SIP media application.
|
2183
3027
|
# @return [String]
|
2184
3028
|
#
|
2185
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SipRuleTargetApplication AWS API Documentation
|
@@ -2192,26 +3036,247 @@ module Aws::ChimeSDKVoice
|
|
2192
3036
|
include Aws::Structure
|
2193
3037
|
end
|
2194
3038
|
|
2195
|
-
#
|
2196
|
-
# @return [Integer]
|
3039
|
+
# The details of a speaker search task.
|
2197
3040
|
#
|
2198
|
-
# @!attribute [rw]
|
2199
|
-
#
|
3041
|
+
# @!attribute [rw] results
|
3042
|
+
# The result value in the speaker search details.
|
3043
|
+
# @return [Array<Types::SpeakerSearchResult>]
|
2200
3044
|
#
|
2201
|
-
# @!attribute [rw]
|
2202
|
-
#
|
3045
|
+
# @!attribute [rw] voiceprint_generation_status
|
3046
|
+
# The status of a voice print generation operation,
|
3047
|
+
# `VoiceprintGenerationSuccess` or `VoiceprintGenerationFailure`..
|
3048
|
+
# @return [String]
|
2203
3049
|
#
|
2204
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/
|
3050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchDetails AWS API Documentation
|
2205
3051
|
#
|
2206
|
-
class
|
3052
|
+
class SpeakerSearchDetails < Struct.new(
|
3053
|
+
:results,
|
3054
|
+
:voiceprint_generation_status)
|
3055
|
+
SENSITIVE = []
|
3056
|
+
include Aws::Structure
|
3057
|
+
end
|
3058
|
+
|
3059
|
+
# The result of a speaker search analysis.
|
3060
|
+
#
|
3061
|
+
# @!attribute [rw] confidence_score
|
3062
|
+
# The confidence score in the speaker search analysis.
|
3063
|
+
# @return [Float]
|
3064
|
+
#
|
3065
|
+
# @!attribute [rw] voice_profile_id
|
3066
|
+
# The voice profile ID.
|
3067
|
+
# @return [String]
|
3068
|
+
#
|
3069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchResult AWS API Documentation
|
3070
|
+
#
|
3071
|
+
class SpeakerSearchResult < Struct.new(
|
3072
|
+
:confidence_score,
|
3073
|
+
:voice_profile_id)
|
3074
|
+
SENSITIVE = []
|
3075
|
+
include Aws::Structure
|
3076
|
+
end
|
3077
|
+
|
3078
|
+
# A representation of an asynchronous request to perform speaker search
|
3079
|
+
# analysis on a Voice Connector call.
|
3080
|
+
#
|
3081
|
+
# @!attribute [rw] speaker_search_task_id
|
3082
|
+
# The speaker search task ID.
|
3083
|
+
# @return [String]
|
3084
|
+
#
|
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`.
|
3088
|
+
# @return [String]
|
3089
|
+
#
|
3090
|
+
# @!attribute [rw] call_details
|
3091
|
+
# The call details of a speaker search task.
|
3092
|
+
# @return [Types::CallDetails]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] speaker_search_details
|
3095
|
+
# The details of a speaker search task.
|
3096
|
+
# @return [Types::SpeakerSearchDetails]
|
3097
|
+
#
|
3098
|
+
# @!attribute [rw] created_timestamp
|
3099
|
+
# The time at which a speaker search task was created.
|
3100
|
+
# @return [Time]
|
3101
|
+
#
|
3102
|
+
# @!attribute [rw] updated_timestamp
|
3103
|
+
# The time at which a speaker search task was updated.
|
3104
|
+
# @return [Time]
|
3105
|
+
#
|
3106
|
+
# @!attribute [rw] started_timestamp
|
3107
|
+
# The time at which the speaker search task began.
|
3108
|
+
# @return [Time]
|
3109
|
+
#
|
3110
|
+
# @!attribute [rw] status_message
|
3111
|
+
# A detailed message about the status of a speaker search.
|
3112
|
+
# @return [String]
|
3113
|
+
#
|
3114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SpeakerSearchTask AWS API Documentation
|
3115
|
+
#
|
3116
|
+
class SpeakerSearchTask < Struct.new(
|
3117
|
+
:speaker_search_task_id,
|
3118
|
+
:speaker_search_task_status,
|
3119
|
+
:call_details,
|
3120
|
+
:speaker_search_details,
|
3121
|
+
:created_timestamp,
|
3122
|
+
:updated_timestamp,
|
3123
|
+
:started_timestamp,
|
3124
|
+
:status_message)
|
3125
|
+
SENSITIVE = []
|
3126
|
+
include Aws::Structure
|
3127
|
+
end
|
3128
|
+
|
3129
|
+
# @!attribute [rw] voice_connector_id
|
3130
|
+
# The Voice Connector ID.
|
3131
|
+
# @return [String]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] transaction_id
|
3134
|
+
# The transaction ID of the call being analyzed.
|
3135
|
+
# @return [String]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] voice_profile_domain_id
|
3138
|
+
# The ID of the voice profile domain that will store the voice
|
3139
|
+
# profile.
|
3140
|
+
# @return [String]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] client_request_token
|
3143
|
+
# The unique identifier for the client request. Use a different token
|
3144
|
+
# for different speaker search tasks.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTaskRequest AWS API Documentation
|
3148
|
+
#
|
3149
|
+
class StartSpeakerSearchTaskRequest < Struct.new(
|
3150
|
+
:voice_connector_id,
|
3151
|
+
:transaction_id,
|
3152
|
+
:voice_profile_domain_id,
|
3153
|
+
:client_request_token)
|
3154
|
+
SENSITIVE = []
|
3155
|
+
include Aws::Structure
|
3156
|
+
end
|
3157
|
+
|
3158
|
+
# @!attribute [rw] speaker_search_task
|
3159
|
+
# The details of the speaker search task.
|
3160
|
+
# @return [Types::SpeakerSearchTask]
|
3161
|
+
#
|
3162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTaskResponse AWS API Documentation
|
3163
|
+
#
|
3164
|
+
class StartSpeakerSearchTaskResponse < Struct.new(
|
3165
|
+
:speaker_search_task)
|
3166
|
+
SENSITIVE = []
|
3167
|
+
include Aws::Structure
|
3168
|
+
end
|
3169
|
+
|
3170
|
+
# @!attribute [rw] voice_connector_id
|
3171
|
+
# The Voice Connector ID.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] transaction_id
|
3175
|
+
# The transaction ID.
|
3176
|
+
# @return [String]
|
3177
|
+
#
|
3178
|
+
# @!attribute [rw] language_code
|
3179
|
+
# The language code.
|
3180
|
+
# @return [String]
|
3181
|
+
#
|
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.
|
3185
|
+
# @return [String]
|
3186
|
+
#
|
3187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTaskRequest AWS API Documentation
|
3188
|
+
#
|
3189
|
+
class StartVoiceToneAnalysisTaskRequest < Struct.new(
|
3190
|
+
:voice_connector_id,
|
3191
|
+
:transaction_id,
|
3192
|
+
:language_code,
|
3193
|
+
:client_request_token)
|
3194
|
+
SENSITIVE = []
|
3195
|
+
include Aws::Structure
|
3196
|
+
end
|
3197
|
+
|
3198
|
+
# @!attribute [rw] voice_tone_analysis_task
|
3199
|
+
# The details of the voice tone analysis task.
|
3200
|
+
# @return [Types::VoiceToneAnalysisTask]
|
3201
|
+
#
|
3202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTaskResponse AWS API Documentation
|
3203
|
+
#
|
3204
|
+
class StartVoiceToneAnalysisTaskResponse < Struct.new(
|
3205
|
+
:voice_tone_analysis_task)
|
3206
|
+
SENSITIVE = []
|
3207
|
+
include Aws::Structure
|
3208
|
+
end
|
3209
|
+
|
3210
|
+
# @!attribute [rw] voice_connector_id
|
3211
|
+
# The Voice Connector ID.
|
3212
|
+
# @return [String]
|
3213
|
+
#
|
3214
|
+
# @!attribute [rw] speaker_search_task_id
|
3215
|
+
# The speaker search task ID.
|
3216
|
+
# @return [String]
|
3217
|
+
#
|
3218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopSpeakerSearchTaskRequest AWS API Documentation
|
3219
|
+
#
|
3220
|
+
class StopSpeakerSearchTaskRequest < Struct.new(
|
3221
|
+
:voice_connector_id,
|
3222
|
+
:speaker_search_task_id)
|
3223
|
+
SENSITIVE = []
|
3224
|
+
include Aws::Structure
|
3225
|
+
end
|
3226
|
+
|
3227
|
+
# @!attribute [rw] voice_connector_id
|
3228
|
+
# The Voice Connector ID.
|
3229
|
+
# @return [String]
|
3230
|
+
#
|
3231
|
+
# @!attribute [rw] voice_tone_analysis_task_id
|
3232
|
+
# The ID of the voice tone analysis task.
|
3233
|
+
# @return [String]
|
3234
|
+
#
|
3235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTaskRequest AWS API Documentation
|
3236
|
+
#
|
3237
|
+
class StopVoiceToneAnalysisTaskRequest < Struct.new(
|
3238
|
+
:voice_connector_id,
|
3239
|
+
:voice_tone_analysis_task_id)
|
3240
|
+
SENSITIVE = []
|
3241
|
+
include Aws::Structure
|
3242
|
+
end
|
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
|
+
#
|
3249
|
+
# @!attribute [rw] data_retention_in_hours
|
3250
|
+
# The amount of time, in hours, to the Kinesis data.
|
3251
|
+
# @return [Integer]
|
3252
|
+
#
|
3253
|
+
# @!attribute [rw] disabled
|
3254
|
+
# When true, streaming to Kinesis is off.
|
3255
|
+
# @return [Boolean]
|
3256
|
+
#
|
3257
|
+
# @!attribute [rw] streaming_notification_targets
|
3258
|
+
# The streaming notification targets.
|
3259
|
+
# @return [Array<Types::StreamingNotificationTarget>]
|
3260
|
+
#
|
3261
|
+
# @!attribute [rw] media_insights_configuration
|
3262
|
+
# The call analytics configuration.
|
3263
|
+
# @return [Types::MediaInsightsConfiguration]
|
3264
|
+
#
|
3265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StreamingConfiguration AWS API Documentation
|
3266
|
+
#
|
3267
|
+
class StreamingConfiguration < Struct.new(
|
2207
3268
|
:data_retention_in_hours,
|
2208
3269
|
:disabled,
|
2209
|
-
:streaming_notification_targets
|
3270
|
+
:streaming_notification_targets,
|
3271
|
+
:media_insights_configuration)
|
2210
3272
|
SENSITIVE = []
|
2211
3273
|
include Aws::Structure
|
2212
3274
|
end
|
2213
3275
|
|
3276
|
+
# The target recipient for a streaming configuration notification.
|
3277
|
+
#
|
2214
3278
|
# @!attribute [rw] notification_target
|
3279
|
+
# The streaming notification target.
|
2215
3280
|
# @return [String]
|
2216
3281
|
#
|
2217
3282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StreamingNotificationTarget AWS API Documentation
|
@@ -2222,19 +3287,65 @@ module Aws::ChimeSDKVoice
|
|
2222
3287
|
include Aws::Structure
|
2223
3288
|
end
|
2224
3289
|
|
3290
|
+
# Describes a tag applied to a resource.
|
3291
|
+
#
|
3292
|
+
# @!attribute [rw] key
|
3293
|
+
# The tag's key.
|
3294
|
+
# @return [String]
|
3295
|
+
#
|
3296
|
+
# @!attribute [rw] value
|
3297
|
+
# The tag's value.
|
3298
|
+
# @return [String]
|
3299
|
+
#
|
3300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Tag AWS API Documentation
|
3301
|
+
#
|
3302
|
+
class Tag < Struct.new(
|
3303
|
+
:key,
|
3304
|
+
:value)
|
3305
|
+
SENSITIVE = [:key, :value]
|
3306
|
+
include Aws::Structure
|
3307
|
+
end
|
3308
|
+
|
3309
|
+
# @!attribute [rw] resource_arn
|
3310
|
+
# The ARN of the resource being tagged.
|
3311
|
+
# @return [String]
|
3312
|
+
#
|
3313
|
+
# @!attribute [rw] tags
|
3314
|
+
# A list of the tags being added to the resource.
|
3315
|
+
# @return [Array<Types::Tag>]
|
3316
|
+
#
|
3317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TagResourceRequest AWS API Documentation
|
3318
|
+
#
|
3319
|
+
class TagResourceRequest < Struct.new(
|
3320
|
+
:resource_arn,
|
3321
|
+
:tags)
|
3322
|
+
SENSITIVE = [:resource_arn]
|
3323
|
+
include Aws::Structure
|
3324
|
+
end
|
3325
|
+
|
3326
|
+
# Termination settings enable SIP hosts to make outbound calls using an
|
3327
|
+
# Amazon Chime SDK Voice Connector.
|
3328
|
+
#
|
2225
3329
|
# @!attribute [rw] cps_limit
|
3330
|
+
# The limit on calls per second. Max value based on account service
|
3331
|
+
# quota. Default value of 1.
|
2226
3332
|
# @return [Integer]
|
2227
3333
|
#
|
2228
3334
|
# @!attribute [rw] default_phone_number
|
3335
|
+
# The default outbound calling number.
|
2229
3336
|
# @return [String]
|
2230
3337
|
#
|
2231
3338
|
# @!attribute [rw] calling_regions
|
3339
|
+
# The countries to which calls are allowed, in ISO 3166-1 alpha-2
|
3340
|
+
# format. Required.
|
2232
3341
|
# @return [Array<String>]
|
2233
3342
|
#
|
2234
3343
|
# @!attribute [rw] cidr_allowed_list
|
3344
|
+
# The IP addresses allowed to make calls, in CIDR format.
|
2235
3345
|
# @return [Array<String>]
|
2236
3346
|
#
|
2237
3347
|
# @!attribute [rw] disabled
|
3348
|
+
# When termination is disabled, outbound calls cannot be made.
|
2238
3349
|
# @return [Boolean]
|
2239
3350
|
#
|
2240
3351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/Termination AWS API Documentation
|
@@ -2249,10 +3360,16 @@ module Aws::ChimeSDKVoice
|
|
2249
3360
|
include Aws::Structure
|
2250
3361
|
end
|
2251
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
|
+
#
|
2252
3367
|
# @!attribute [rw] timestamp
|
3368
|
+
# The timestamp, in ISO 8601 format.
|
2253
3369
|
# @return [Time]
|
2254
3370
|
#
|
2255
3371
|
# @!attribute [rw] source
|
3372
|
+
# The source IP address.
|
2256
3373
|
# @return [String]
|
2257
3374
|
#
|
2258
3375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TerminationHealth AWS API Documentation
|
@@ -2264,15 +3381,43 @@ module Aws::ChimeSDKVoice
|
|
2264
3381
|
include Aws::Structure
|
2265
3382
|
end
|
2266
3383
|
|
3384
|
+
# The number of customer requests exceeds the request rate limit.
|
3385
|
+
#
|
2267
3386
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ThrottledClientException AWS API Documentation
|
2268
3387
|
#
|
2269
3388
|
class ThrottledClientException < Aws::EmptyStructure; end
|
2270
3389
|
|
3390
|
+
# The client isn't authorized to request a resource.
|
3391
|
+
#
|
2271
3392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UnauthorizedClientException AWS API Documentation
|
2272
3393
|
#
|
2273
3394
|
class UnauthorizedClientException < Aws::EmptyStructure; end
|
2274
3395
|
|
3396
|
+
# A well-formed request couldn't be followed due to semantic errors.
|
3397
|
+
#
|
3398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UnprocessableEntityException AWS API Documentation
|
3399
|
+
#
|
3400
|
+
class UnprocessableEntityException < Aws::EmptyStructure; end
|
3401
|
+
|
3402
|
+
# @!attribute [rw] resource_arn
|
3403
|
+
# The ARN of the resource having its tags removed.
|
3404
|
+
# @return [String]
|
3405
|
+
#
|
3406
|
+
# @!attribute [rw] tag_keys
|
3407
|
+
# The keys of the tags being removed from the resource.
|
3408
|
+
# @return [Array<String>]
|
3409
|
+
#
|
3410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UntagResourceRequest AWS API Documentation
|
3411
|
+
#
|
3412
|
+
class UntagResourceRequest < Struct.new(
|
3413
|
+
:resource_arn,
|
3414
|
+
:tag_keys)
|
3415
|
+
SENSITIVE = [:resource_arn]
|
3416
|
+
include Aws::Structure
|
3417
|
+
end
|
3418
|
+
|
2275
3419
|
# @!attribute [rw] voice_connector
|
3420
|
+
# The Voice Connector settings.
|
2276
3421
|
# @return [Types::VoiceConnectorSettings]
|
2277
3422
|
#
|
2278
3423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateGlobalSettingsRequest AWS API Documentation
|
@@ -2284,12 +3429,15 @@ module Aws::ChimeSDKVoice
|
|
2284
3429
|
end
|
2285
3430
|
|
2286
3431
|
# @!attribute [rw] phone_number_id
|
3432
|
+
# The phone number ID.
|
2287
3433
|
# @return [String]
|
2288
3434
|
#
|
2289
3435
|
# @!attribute [rw] product_type
|
3436
|
+
# The product type.
|
2290
3437
|
# @return [String]
|
2291
3438
|
#
|
2292
3439
|
# @!attribute [rw] calling_name
|
3440
|
+
# The outbound calling name associated with the phone number.
|
2293
3441
|
# @return [String]
|
2294
3442
|
#
|
2295
3443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberRequest AWS API Documentation
|
@@ -2302,13 +3450,19 @@ module Aws::ChimeSDKVoice
|
|
2302
3450
|
include Aws::Structure
|
2303
3451
|
end
|
2304
3452
|
|
3453
|
+
# The phone number ID, product type, or calling name fields to update,
|
3454
|
+
# used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
|
3455
|
+
#
|
2305
3456
|
# @!attribute [rw] phone_number_id
|
3457
|
+
# The phone number ID to update.
|
2306
3458
|
# @return [String]
|
2307
3459
|
#
|
2308
3460
|
# @!attribute [rw] product_type
|
3461
|
+
# The product type to update.
|
2309
3462
|
# @return [String]
|
2310
3463
|
#
|
2311
3464
|
# @!attribute [rw] calling_name
|
3465
|
+
# The outbound calling name to update.
|
2312
3466
|
# @return [String]
|
2313
3467
|
#
|
2314
3468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberRequestItem AWS API Documentation
|
@@ -2322,6 +3476,7 @@ module Aws::ChimeSDKVoice
|
|
2322
3476
|
end
|
2323
3477
|
|
2324
3478
|
# @!attribute [rw] phone_number
|
3479
|
+
# The updated phone number details.
|
2325
3480
|
# @return [Types::PhoneNumber]
|
2326
3481
|
#
|
2327
3482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberResponse AWS API Documentation
|
@@ -2333,6 +3488,7 @@ module Aws::ChimeSDKVoice
|
|
2333
3488
|
end
|
2334
3489
|
|
2335
3490
|
# @!attribute [rw] calling_name
|
3491
|
+
# The default outbound calling name for the account.
|
2336
3492
|
# @return [String]
|
2337
3493
|
#
|
2338
3494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettingsRequest AWS API Documentation
|
@@ -2344,15 +3500,19 @@ module Aws::ChimeSDKVoice
|
|
2344
3500
|
end
|
2345
3501
|
|
2346
3502
|
# @!attribute [rw] voice_connector_id
|
3503
|
+
# The Voice Connector ID.
|
2347
3504
|
# @return [String]
|
2348
3505
|
#
|
2349
3506
|
# @!attribute [rw] proxy_session_id
|
3507
|
+
# The proxy session ID.
|
2350
3508
|
# @return [String]
|
2351
3509
|
#
|
2352
3510
|
# @!attribute [rw] capabilities
|
3511
|
+
# The proxy session capabilities.
|
2353
3512
|
# @return [Array<String>]
|
2354
3513
|
#
|
2355
3514
|
# @!attribute [rw] expiry_minutes
|
3515
|
+
# The number of minutes allowed for the proxy session.
|
2356
3516
|
# @return [Integer]
|
2357
3517
|
#
|
2358
3518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySessionRequest AWS API Documentation
|
@@ -2367,6 +3527,7 @@ module Aws::ChimeSDKVoice
|
|
2367
3527
|
end
|
2368
3528
|
|
2369
3529
|
# @!attribute [rw] proxy_session
|
3530
|
+
# The updated proxy session details.
|
2370
3531
|
# @return [Types::ProxySession]
|
2371
3532
|
#
|
2372
3533
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySessionResponse AWS API Documentation
|
@@ -2378,12 +3539,16 @@ module Aws::ChimeSDKVoice
|
|
2378
3539
|
end
|
2379
3540
|
|
2380
3541
|
# @!attribute [rw] sip_media_application_id
|
3542
|
+
# The ID of the SIP media application handling the call.
|
2381
3543
|
# @return [String]
|
2382
3544
|
#
|
2383
3545
|
# @!attribute [rw] transaction_id
|
3546
|
+
# The ID of the call transaction.
|
2384
3547
|
# @return [String]
|
2385
3548
|
#
|
2386
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.
|
2387
3552
|
# @return [Hash<String,String>]
|
2388
3553
|
#
|
2389
3554
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCallRequest AWS API Documentation
|
@@ -2397,6 +3562,7 @@ module Aws::ChimeSDKVoice
|
|
2397
3562
|
end
|
2398
3563
|
|
2399
3564
|
# @!attribute [rw] sip_media_application_call
|
3565
|
+
# A `Call` instance for a SIP media application.
|
2400
3566
|
# @return [Types::SipMediaApplicationCall]
|
2401
3567
|
#
|
2402
3568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCallResponse AWS API Documentation
|
@@ -2408,12 +3574,15 @@ module Aws::ChimeSDKVoice
|
|
2408
3574
|
end
|
2409
3575
|
|
2410
3576
|
# @!attribute [rw] sip_media_application_id
|
3577
|
+
# The SIP media application ID.
|
2411
3578
|
# @return [String]
|
2412
3579
|
#
|
2413
3580
|
# @!attribute [rw] name
|
3581
|
+
# The new name for the specified SIP media application.
|
2414
3582
|
# @return [String]
|
2415
3583
|
#
|
2416
3584
|
# @!attribute [rw] endpoints
|
3585
|
+
# The new set of endpoints for the specified SIP media application.
|
2417
3586
|
# @return [Array<Types::SipMediaApplicationEndpoint>]
|
2418
3587
|
#
|
2419
3588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationRequest AWS API Documentation
|
@@ -2427,6 +3596,7 @@ module Aws::ChimeSDKVoice
|
|
2427
3596
|
end
|
2428
3597
|
|
2429
3598
|
# @!attribute [rw] sip_media_application
|
3599
|
+
# The updated SIP media application’s details.
|
2430
3600
|
# @return [Types::SipMediaApplication]
|
2431
3601
|
#
|
2432
3602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationResponse AWS API Documentation
|
@@ -2438,15 +3608,19 @@ module Aws::ChimeSDKVoice
|
|
2438
3608
|
end
|
2439
3609
|
|
2440
3610
|
# @!attribute [rw] sip_rule_id
|
3611
|
+
# The SIP rule ID.
|
2441
3612
|
# @return [String]
|
2442
3613
|
#
|
2443
3614
|
# @!attribute [rw] name
|
3615
|
+
# The new name for the specified SIP rule.
|
2444
3616
|
# @return [String]
|
2445
3617
|
#
|
2446
3618
|
# @!attribute [rw] disabled
|
3619
|
+
# The new value that indicates whether the rule is disabled.
|
2447
3620
|
# @return [Boolean]
|
2448
3621
|
#
|
2449
3622
|
# @!attribute [rw] target_applications
|
3623
|
+
# The new list of target applications.
|
2450
3624
|
# @return [Array<Types::SipRuleTargetApplication>]
|
2451
3625
|
#
|
2452
3626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRuleRequest AWS API Documentation
|
@@ -2461,6 +3635,7 @@ module Aws::ChimeSDKVoice
|
|
2461
3635
|
end
|
2462
3636
|
|
2463
3637
|
# @!attribute [rw] sip_rule
|
3638
|
+
# The updated SIP rule details.
|
2464
3639
|
# @return [Types::SipRule]
|
2465
3640
|
#
|
2466
3641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRuleResponse AWS API Documentation
|
@@ -2472,12 +3647,16 @@ module Aws::ChimeSDKVoice
|
|
2472
3647
|
end
|
2473
3648
|
|
2474
3649
|
# @!attribute [rw] voice_connector_group_id
|
3650
|
+
# The Voice Connector ID.
|
2475
3651
|
# @return [String]
|
2476
3652
|
#
|
2477
3653
|
# @!attribute [rw] name
|
3654
|
+
# The name of the Voice Connector group.
|
2478
3655
|
# @return [String]
|
2479
3656
|
#
|
2480
3657
|
# @!attribute [rw] voice_connector_items
|
3658
|
+
# The `VoiceConnectorItems` to associate with the Voice Connector
|
3659
|
+
# group.
|
2481
3660
|
# @return [Array<Types::VoiceConnectorItem>]
|
2482
3661
|
#
|
2483
3662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroupRequest AWS API Documentation
|
@@ -2491,6 +3670,7 @@ module Aws::ChimeSDKVoice
|
|
2491
3670
|
end
|
2492
3671
|
|
2493
3672
|
# @!attribute [rw] voice_connector_group
|
3673
|
+
# The updated Voice Connector group.
|
2494
3674
|
# @return [Types::VoiceConnectorGroup]
|
2495
3675
|
#
|
2496
3676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroupResponse AWS API Documentation
|
@@ -2502,12 +3682,15 @@ module Aws::ChimeSDKVoice
|
|
2502
3682
|
end
|
2503
3683
|
|
2504
3684
|
# @!attribute [rw] voice_connector_id
|
3685
|
+
# The Voice Connector ID.
|
2505
3686
|
# @return [String]
|
2506
3687
|
#
|
2507
3688
|
# @!attribute [rw] name
|
3689
|
+
# The name of the Voice Connector.
|
2508
3690
|
# @return [String]
|
2509
3691
|
#
|
2510
3692
|
# @!attribute [rw] require_encryption
|
3693
|
+
# When enabled, requires encryption for the Voice Connector.
|
2511
3694
|
# @return [Boolean]
|
2512
3695
|
#
|
2513
3696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorRequest AWS API Documentation
|
@@ -2521,6 +3704,7 @@ module Aws::ChimeSDKVoice
|
|
2521
3704
|
end
|
2522
3705
|
|
2523
3706
|
# @!attribute [rw] voice_connector
|
3707
|
+
# The updated Voice Connector details.
|
2524
3708
|
# @return [Types::VoiceConnector]
|
2525
3709
|
#
|
2526
3710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorResponse AWS API Documentation
|
@@ -2531,25 +3715,95 @@ module Aws::ChimeSDKVoice
|
|
2531
3715
|
include Aws::Structure
|
2532
3716
|
end
|
2533
3717
|
|
3718
|
+
# @!attribute [rw] voice_profile_domain_id
|
3719
|
+
# The domain ID.
|
3720
|
+
# @return [String]
|
3721
|
+
#
|
3722
|
+
# @!attribute [rw] name
|
3723
|
+
# The name of the voice profile domain.
|
3724
|
+
# @return [String]
|
3725
|
+
#
|
3726
|
+
# @!attribute [rw] description
|
3727
|
+
# The description of the voice profile domain.
|
3728
|
+
# @return [String]
|
3729
|
+
#
|
3730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomainRequest AWS API Documentation
|
3731
|
+
#
|
3732
|
+
class UpdateVoiceProfileDomainRequest < Struct.new(
|
3733
|
+
:voice_profile_domain_id,
|
3734
|
+
:name,
|
3735
|
+
:description)
|
3736
|
+
SENSITIVE = []
|
3737
|
+
include Aws::Structure
|
3738
|
+
end
|
3739
|
+
|
3740
|
+
# @!attribute [rw] voice_profile_domain
|
3741
|
+
# The updated details of the voice profile domain.
|
3742
|
+
# @return [Types::VoiceProfileDomain]
|
3743
|
+
#
|
3744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomainResponse AWS API Documentation
|
3745
|
+
#
|
3746
|
+
class UpdateVoiceProfileDomainResponse < Struct.new(
|
3747
|
+
:voice_profile_domain)
|
3748
|
+
SENSITIVE = []
|
3749
|
+
include Aws::Structure
|
3750
|
+
end
|
3751
|
+
|
3752
|
+
# @!attribute [rw] voice_profile_id
|
3753
|
+
# The profile ID.
|
3754
|
+
# @return [String]
|
3755
|
+
#
|
3756
|
+
# @!attribute [rw] speaker_search_task_id
|
3757
|
+
# The ID of the speaker search task.
|
3758
|
+
# @return [String]
|
3759
|
+
#
|
3760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileRequest AWS API Documentation
|
3761
|
+
#
|
3762
|
+
class UpdateVoiceProfileRequest < Struct.new(
|
3763
|
+
:voice_profile_id,
|
3764
|
+
:speaker_search_task_id)
|
3765
|
+
SENSITIVE = []
|
3766
|
+
include Aws::Structure
|
3767
|
+
end
|
3768
|
+
|
3769
|
+
# @!attribute [rw] voice_profile
|
3770
|
+
# The updated voice profile settings.
|
3771
|
+
# @return [Types::VoiceProfile]
|
3772
|
+
#
|
3773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileResponse AWS API Documentation
|
3774
|
+
#
|
3775
|
+
class UpdateVoiceProfileResponse < Struct.new(
|
3776
|
+
:voice_profile)
|
3777
|
+
SENSITIVE = []
|
3778
|
+
include Aws::Structure
|
3779
|
+
end
|
3780
|
+
|
2534
3781
|
# @!attribute [rw] aws_account_id
|
3782
|
+
# The AWS account ID.
|
2535
3783
|
# @return [String]
|
2536
3784
|
#
|
2537
3785
|
# @!attribute [rw] street_number
|
3786
|
+
# The address street number, such as `200` or `2121`.
|
2538
3787
|
# @return [String]
|
2539
3788
|
#
|
2540
3789
|
# @!attribute [rw] street_info
|
3790
|
+
# The address street information, such as `8th Avenue`.
|
2541
3791
|
# @return [String]
|
2542
3792
|
#
|
2543
3793
|
# @!attribute [rw] city
|
3794
|
+
# The address city, such as `Portland`.
|
2544
3795
|
# @return [String]
|
2545
3796
|
#
|
2546
3797
|
# @!attribute [rw] state
|
3798
|
+
# The address state, such as `ME`.
|
2547
3799
|
# @return [String]
|
2548
3800
|
#
|
2549
3801
|
# @!attribute [rw] country
|
3802
|
+
# The country in the address being validated.
|
2550
3803
|
# @return [String]
|
2551
3804
|
#
|
2552
3805
|
# @!attribute [rw] postal_code
|
3806
|
+
# The dress postal code, such `04352`.
|
2553
3807
|
# @return [String]
|
2554
3808
|
#
|
2555
3809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911AddressRequest AWS API Documentation
|
@@ -2567,15 +3821,22 @@ module Aws::ChimeSDKVoice
|
|
2567
3821
|
end
|
2568
3822
|
|
2569
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.
|
2570
3828
|
# @return [Integer]
|
2571
3829
|
#
|
2572
3830
|
# @!attribute [rw] address_external_id
|
3831
|
+
# The ID that represents the address.
|
2573
3832
|
# @return [String]
|
2574
3833
|
#
|
2575
3834
|
# @!attribute [rw] address
|
3835
|
+
# The validated address.
|
2576
3836
|
# @return [Types::Address]
|
2577
3837
|
#
|
2578
3838
|
# @!attribute [rw] candidate_address_list
|
3839
|
+
# The list of address suggestions..
|
2579
3840
|
# @return [Array<Types::CandidateAddress>]
|
2580
3841
|
#
|
2581
3842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911AddressResponse AWS API Documentation
|
@@ -2589,28 +3850,40 @@ module Aws::ChimeSDKVoice
|
|
2589
3850
|
include Aws::Structure
|
2590
3851
|
end
|
2591
3852
|
|
3853
|
+
# The Amazon Chime SDK Voice Connector configuration, including outbound
|
3854
|
+
# host name and encryption settings.
|
3855
|
+
#
|
2592
3856
|
# @!attribute [rw] voice_connector_id
|
3857
|
+
# The Voice Connector's ID.
|
2593
3858
|
# @return [String]
|
2594
3859
|
#
|
2595
3860
|
# @!attribute [rw] aws_region
|
3861
|
+
# The AWS Region in which the Voice Connector is created. Default:
|
3862
|
+
# us-east-1.
|
2596
3863
|
# @return [String]
|
2597
3864
|
#
|
2598
3865
|
# @!attribute [rw] name
|
3866
|
+
# The Voice Connector's name.
|
2599
3867
|
# @return [String]
|
2600
3868
|
#
|
2601
3869
|
# @!attribute [rw] outbound_host_name
|
3870
|
+
# The outbound host name for the Voice Connector.
|
2602
3871
|
# @return [String]
|
2603
3872
|
#
|
2604
3873
|
# @!attribute [rw] require_encryption
|
3874
|
+
# Enables or disables encryption for the Voice Connector.
|
2605
3875
|
# @return [Boolean]
|
2606
3876
|
#
|
2607
3877
|
# @!attribute [rw] created_timestamp
|
3878
|
+
# The Voice Connector's creation timestamp, in ISO 8601 format.
|
2608
3879
|
# @return [Time]
|
2609
3880
|
#
|
2610
3881
|
# @!attribute [rw] updated_timestamp
|
3882
|
+
# The Voice Connector's updated timestamp, in ISO 8601 format.
|
2611
3883
|
# @return [Time]
|
2612
3884
|
#
|
2613
3885
|
# @!attribute [rw] voice_connector_arn
|
3886
|
+
# The ARN of the Voice Connector.
|
2614
3887
|
# @return [String]
|
2615
3888
|
#
|
2616
3889
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnector AWS API Documentation
|
@@ -2628,22 +3901,35 @@ module Aws::ChimeSDKVoice
|
|
2628
3901
|
include Aws::Structure
|
2629
3902
|
end
|
2630
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
|
+
#
|
2631
3909
|
# @!attribute [rw] voice_connector_group_id
|
3910
|
+
# The ID of a Voice Connector group.
|
2632
3911
|
# @return [String]
|
2633
3912
|
#
|
2634
3913
|
# @!attribute [rw] name
|
3914
|
+
# The name of a Voice Connector group.
|
2635
3915
|
# @return [String]
|
2636
3916
|
#
|
2637
3917
|
# @!attribute [rw] voice_connector_items
|
3918
|
+
# The Voice Connectors to which you route inbound calls.
|
2638
3919
|
# @return [Array<Types::VoiceConnectorItem>]
|
2639
3920
|
#
|
2640
3921
|
# @!attribute [rw] created_timestamp
|
3922
|
+
# The Voice Connector group's creation time stamp, in ISO 8601
|
3923
|
+
# format.
|
2641
3924
|
# @return [Time]
|
2642
3925
|
#
|
2643
3926
|
# @!attribute [rw] updated_timestamp
|
3927
|
+
# The Voice Connector group's creation time stamp, in ISO 8601
|
3928
|
+
# format.
|
2644
3929
|
# @return [Time]
|
2645
3930
|
#
|
2646
3931
|
# @!attribute [rw] voice_connector_group_arn
|
3932
|
+
# The ARN of the Voice Connector group.
|
2647
3933
|
# @return [String]
|
2648
3934
|
#
|
2649
3935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorGroup AWS API Documentation
|
@@ -2659,10 +3945,20 @@ module Aws::ChimeSDKVoice
|
|
2659
3945
|
include Aws::Structure
|
2660
3946
|
end
|
2661
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
|
+
#
|
2662
3953
|
# @!attribute [rw] voice_connector_id
|
3954
|
+
# The Voice Connector ID.
|
2663
3955
|
# @return [String]
|
2664
3956
|
#
|
2665
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.
|
2666
3962
|
# @return [Integer]
|
2667
3963
|
#
|
2668
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorItem AWS API Documentation
|
@@ -2674,7 +3970,12 @@ module Aws::ChimeSDKVoice
|
|
2674
3970
|
include Aws::Structure
|
2675
3971
|
end
|
2676
3972
|
|
3973
|
+
# The Amazon Chime SDK Voice Connector settings. Includes any Amazon S3
|
3974
|
+
# buckets designated for storing call detail records.
|
3975
|
+
#
|
2677
3976
|
# @!attribute [rw] cdr_bucket
|
3977
|
+
# The S3 bucket that stores the Voice Connector's call detail
|
3978
|
+
# records.
|
2678
3979
|
# @return [String]
|
2679
3980
|
#
|
2680
3981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceConnectorSettings AWS API Documentation
|
@@ -2685,5 +3986,216 @@ module Aws::ChimeSDKVoice
|
|
2685
3986
|
include Aws::Structure
|
2686
3987
|
end
|
2687
3988
|
|
3989
|
+
# The combination of a voice print and caller ID.
|
3990
|
+
#
|
3991
|
+
# @!attribute [rw] voice_profile_id
|
3992
|
+
# The ID of the voice profile.
|
3993
|
+
# @return [String]
|
3994
|
+
#
|
3995
|
+
# @!attribute [rw] voice_profile_arn
|
3996
|
+
# The ARN of the voice profile.
|
3997
|
+
# @return [String]
|
3998
|
+
#
|
3999
|
+
# @!attribute [rw] voice_profile_domain_id
|
4000
|
+
# The ID of the domain that contains the voice profile.
|
4001
|
+
# @return [String]
|
4002
|
+
#
|
4003
|
+
# @!attribute [rw] created_timestamp
|
4004
|
+
# The time at which the voice profile was created and enrolled.
|
4005
|
+
# @return [Time]
|
4006
|
+
#
|
4007
|
+
# @!attribute [rw] updated_timestamp
|
4008
|
+
# The time at which the voice profile was last updated.
|
4009
|
+
# @return [Time]
|
4010
|
+
#
|
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.
|
4014
|
+
# @return [Time]
|
4015
|
+
#
|
4016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfile AWS API Documentation
|
4017
|
+
#
|
4018
|
+
class VoiceProfile < Struct.new(
|
4019
|
+
:voice_profile_id,
|
4020
|
+
:voice_profile_arn,
|
4021
|
+
:voice_profile_domain_id,
|
4022
|
+
:created_timestamp,
|
4023
|
+
:updated_timestamp,
|
4024
|
+
:expiration_timestamp)
|
4025
|
+
SENSITIVE = [:voice_profile_arn]
|
4026
|
+
include Aws::Structure
|
4027
|
+
end
|
4028
|
+
|
4029
|
+
# A collection of voice profiles.
|
4030
|
+
#
|
4031
|
+
# @!attribute [rw] voice_profile_domain_id
|
4032
|
+
# The ID of the voice profile domain.
|
4033
|
+
# @return [String]
|
4034
|
+
#
|
4035
|
+
# @!attribute [rw] voice_profile_domain_arn
|
4036
|
+
# The voice profile domain's Amazon Resource Number (ARN).
|
4037
|
+
# @return [String]
|
4038
|
+
#
|
4039
|
+
# @!attribute [rw] name
|
4040
|
+
# The name of the voice profile domain.
|
4041
|
+
# @return [String]
|
4042
|
+
#
|
4043
|
+
# @!attribute [rw] description
|
4044
|
+
# The description of the voice profile domain.
|
4045
|
+
# @return [String]
|
4046
|
+
#
|
4047
|
+
# @!attribute [rw] server_side_encryption_configuration
|
4048
|
+
# A structure that contains the configuration settings for server-side
|
4049
|
+
# encryption.
|
4050
|
+
# @return [Types::ServerSideEncryptionConfiguration]
|
4051
|
+
#
|
4052
|
+
# @!attribute [rw] created_timestamp
|
4053
|
+
# The time at which the voice profile domain was created.
|
4054
|
+
# @return [Time]
|
4055
|
+
#
|
4056
|
+
# @!attribute [rw] updated_timestamp
|
4057
|
+
# The time at which the voice profile was last updated.
|
4058
|
+
# @return [Time]
|
4059
|
+
#
|
4060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileDomain AWS API Documentation
|
4061
|
+
#
|
4062
|
+
class VoiceProfileDomain < Struct.new(
|
4063
|
+
:voice_profile_domain_id,
|
4064
|
+
:voice_profile_domain_arn,
|
4065
|
+
:name,
|
4066
|
+
:description,
|
4067
|
+
:server_side_encryption_configuration,
|
4068
|
+
:created_timestamp,
|
4069
|
+
:updated_timestamp)
|
4070
|
+
SENSITIVE = [:voice_profile_domain_arn]
|
4071
|
+
include Aws::Structure
|
4072
|
+
end
|
4073
|
+
|
4074
|
+
# A high-level overview of a voice profile domain.
|
4075
|
+
#
|
4076
|
+
# @!attribute [rw] voice_profile_domain_id
|
4077
|
+
# The ID of the voice profile domain summary.
|
4078
|
+
# @return [String]
|
4079
|
+
#
|
4080
|
+
# @!attribute [rw] voice_profile_domain_arn
|
4081
|
+
# The ARN of a voice profile in a voice profile domain summary.
|
4082
|
+
# @return [String]
|
4083
|
+
#
|
4084
|
+
# @!attribute [rw] name
|
4085
|
+
# The name of the voice profile domain summary.
|
4086
|
+
# @return [String]
|
4087
|
+
#
|
4088
|
+
# @!attribute [rw] description
|
4089
|
+
# Describes the voice profile domain summary.
|
4090
|
+
# @return [String]
|
4091
|
+
#
|
4092
|
+
# @!attribute [rw] created_timestamp
|
4093
|
+
# The time at which the voice profile domain summary was created.
|
4094
|
+
# @return [Time]
|
4095
|
+
#
|
4096
|
+
# @!attribute [rw] updated_timestamp
|
4097
|
+
# The time at which the voice profile domain summary was last updated.
|
4098
|
+
# @return [Time]
|
4099
|
+
#
|
4100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileDomainSummary AWS API Documentation
|
4101
|
+
#
|
4102
|
+
class VoiceProfileDomainSummary < Struct.new(
|
4103
|
+
:voice_profile_domain_id,
|
4104
|
+
:voice_profile_domain_arn,
|
4105
|
+
:name,
|
4106
|
+
:description,
|
4107
|
+
:created_timestamp,
|
4108
|
+
:updated_timestamp)
|
4109
|
+
SENSITIVE = [:voice_profile_domain_arn]
|
4110
|
+
include Aws::Structure
|
4111
|
+
end
|
4112
|
+
|
4113
|
+
# A high-level summary of a voice profile.
|
4114
|
+
#
|
4115
|
+
# @!attribute [rw] voice_profile_id
|
4116
|
+
# The ID of the voice profile in a voice profile summary.
|
4117
|
+
# @return [String]
|
4118
|
+
#
|
4119
|
+
# @!attribute [rw] voice_profile_arn
|
4120
|
+
# The ARN of the voice profile in a voice profile summary.
|
4121
|
+
# @return [String]
|
4122
|
+
#
|
4123
|
+
# @!attribute [rw] voice_profile_domain_id
|
4124
|
+
# The ID of the voice profile domain in a voice profile summary.
|
4125
|
+
# @return [String]
|
4126
|
+
#
|
4127
|
+
# @!attribute [rw] created_timestamp
|
4128
|
+
# The time at which a voice profile summary was created.
|
4129
|
+
# @return [Time]
|
4130
|
+
#
|
4131
|
+
# @!attribute [rw] updated_timestamp
|
4132
|
+
# The time at which a voice profile summary was last updated.
|
4133
|
+
# @return [Time]
|
4134
|
+
#
|
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.
|
4139
|
+
# @return [Time]
|
4140
|
+
#
|
4141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceProfileSummary AWS API Documentation
|
4142
|
+
#
|
4143
|
+
class VoiceProfileSummary < Struct.new(
|
4144
|
+
:voice_profile_id,
|
4145
|
+
:voice_profile_arn,
|
4146
|
+
:voice_profile_domain_id,
|
4147
|
+
:created_timestamp,
|
4148
|
+
:updated_timestamp,
|
4149
|
+
:expiration_timestamp)
|
4150
|
+
SENSITIVE = [:voice_profile_arn]
|
4151
|
+
include Aws::Structure
|
4152
|
+
end
|
4153
|
+
|
4154
|
+
# A representation of an asynchronous request to perform voice tone
|
4155
|
+
# analysis on a Voice Connector call.
|
4156
|
+
#
|
4157
|
+
# @!attribute [rw] voice_tone_analysis_task_id
|
4158
|
+
# The ID of the voice tone analysis task.
|
4159
|
+
# @return [String]
|
4160
|
+
#
|
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`.
|
4164
|
+
# @return [String]
|
4165
|
+
#
|
4166
|
+
# @!attribute [rw] call_details
|
4167
|
+
# The call details of a voice tone analysis task.
|
4168
|
+
# @return [Types::CallDetails]
|
4169
|
+
#
|
4170
|
+
# @!attribute [rw] created_timestamp
|
4171
|
+
# The time at which a voice tone analysis task was created.
|
4172
|
+
# @return [Time]
|
4173
|
+
#
|
4174
|
+
# @!attribute [rw] updated_timestamp
|
4175
|
+
# The time at which a voice tone analysis task was updated.
|
4176
|
+
# @return [Time]
|
4177
|
+
#
|
4178
|
+
# @!attribute [rw] started_timestamp
|
4179
|
+
# The time at which a voice tone analysis task started.
|
4180
|
+
# @return [Time]
|
4181
|
+
#
|
4182
|
+
# @!attribute [rw] status_message
|
4183
|
+
# The status of a voice tone analysis task.
|
4184
|
+
# @return [String]
|
4185
|
+
#
|
4186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/VoiceToneAnalysisTask AWS API Documentation
|
4187
|
+
#
|
4188
|
+
class VoiceToneAnalysisTask < Struct.new(
|
4189
|
+
:voice_tone_analysis_task_id,
|
4190
|
+
:voice_tone_analysis_task_status,
|
4191
|
+
:call_details,
|
4192
|
+
:created_timestamp,
|
4193
|
+
:updated_timestamp,
|
4194
|
+
:started_timestamp,
|
4195
|
+
:status_message)
|
4196
|
+
SENSITIVE = []
|
4197
|
+
include Aws::Structure
|
4198
|
+
end
|
4199
|
+
|
2688
4200
|
end
|
2689
4201
|
end
|