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