aws-sdk-chime 1.4.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-chime.rb +1 -1
- data/lib/aws-sdk-chime/client.rb +1258 -5
- data/lib/aws-sdk-chime/client_api.rb +974 -16
- data/lib/aws-sdk-chime/types.rb +1847 -170
- metadata +4 -4
data/lib/aws-sdk-chime/types.rb
CHANGED
@@ -99,6 +99,108 @@ module Aws::Chime
|
|
99
99
|
include Aws::Structure
|
100
100
|
end
|
101
101
|
|
102
|
+
# @note When making an API call, you may pass AssociatePhoneNumberWithUserRequest
|
103
|
+
# data as a hash:
|
104
|
+
#
|
105
|
+
# {
|
106
|
+
# account_id: "String", # required
|
107
|
+
# user_id: "String", # required
|
108
|
+
# e164_phone_number: "E164PhoneNumber", # required
|
109
|
+
# }
|
110
|
+
#
|
111
|
+
# @!attribute [rw] account_id
|
112
|
+
# The Amazon Chime account ID.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] user_id
|
116
|
+
# The user ID.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] e164_phone_number
|
120
|
+
# The phone number, in E.164 format.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumberWithUserRequest AWS API Documentation
|
124
|
+
#
|
125
|
+
class AssociatePhoneNumberWithUserRequest < Struct.new(
|
126
|
+
:account_id,
|
127
|
+
:user_id,
|
128
|
+
:e164_phone_number)
|
129
|
+
include Aws::Structure
|
130
|
+
end
|
131
|
+
|
132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumberWithUserResponse AWS API Documentation
|
133
|
+
#
|
134
|
+
class AssociatePhoneNumberWithUserResponse < Aws::EmptyStructure; end
|
135
|
+
|
136
|
+
# @note When making an API call, you may pass AssociatePhoneNumbersWithVoiceConnectorRequest
|
137
|
+
# data as a hash:
|
138
|
+
#
|
139
|
+
# {
|
140
|
+
# voice_connector_id: "NonEmptyString", # required
|
141
|
+
# e164_phone_numbers: ["E164PhoneNumber"],
|
142
|
+
# }
|
143
|
+
#
|
144
|
+
# @!attribute [rw] voice_connector_id
|
145
|
+
# The Amazon Chime Voice Connector ID.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] e164_phone_numbers
|
149
|
+
# List of phone numbers, in E.164 format.
|
150
|
+
# @return [Array<String>]
|
151
|
+
#
|
152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumbersWithVoiceConnectorRequest AWS API Documentation
|
153
|
+
#
|
154
|
+
class AssociatePhoneNumbersWithVoiceConnectorRequest < Struct.new(
|
155
|
+
:voice_connector_id,
|
156
|
+
:e164_phone_numbers)
|
157
|
+
include Aws::Structure
|
158
|
+
end
|
159
|
+
|
160
|
+
# @!attribute [rw] phone_number_errors
|
161
|
+
# If the action fails for one or more of the phone numbers in the
|
162
|
+
# request, a list of the phone numbers is returned, along with error
|
163
|
+
# codes and error messages.
|
164
|
+
# @return [Array<Types::PhoneNumberError>]
|
165
|
+
#
|
166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumbersWithVoiceConnectorResponse AWS API Documentation
|
167
|
+
#
|
168
|
+
class AssociatePhoneNumbersWithVoiceConnectorResponse < Struct.new(
|
169
|
+
:phone_number_errors)
|
170
|
+
include Aws::Structure
|
171
|
+
end
|
172
|
+
|
173
|
+
# @note When making an API call, you may pass BatchDeletePhoneNumberRequest
|
174
|
+
# data as a hash:
|
175
|
+
#
|
176
|
+
# {
|
177
|
+
# phone_number_ids: ["String"], # required
|
178
|
+
# }
|
179
|
+
#
|
180
|
+
# @!attribute [rw] phone_number_ids
|
181
|
+
# List of phone number IDs.
|
182
|
+
# @return [Array<String>]
|
183
|
+
#
|
184
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchDeletePhoneNumberRequest AWS API Documentation
|
185
|
+
#
|
186
|
+
class BatchDeletePhoneNumberRequest < Struct.new(
|
187
|
+
:phone_number_ids)
|
188
|
+
include Aws::Structure
|
189
|
+
end
|
190
|
+
|
191
|
+
# @!attribute [rw] phone_number_errors
|
192
|
+
# If the action fails for one or more of the phone numbers in the
|
193
|
+
# request, a list of the phone numbers is returned, along with error
|
194
|
+
# codes and error messages.
|
195
|
+
# @return [Array<Types::PhoneNumberError>]
|
196
|
+
#
|
197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchDeletePhoneNumberResponse AWS API Documentation
|
198
|
+
#
|
199
|
+
class BatchDeletePhoneNumberResponse < Struct.new(
|
200
|
+
:phone_number_errors)
|
201
|
+
include Aws::Structure
|
202
|
+
end
|
203
|
+
|
102
204
|
# @note When making an API call, you may pass BatchSuspendUserRequest
|
103
205
|
# data as a hash:
|
104
206
|
#
|
@@ -173,6 +275,43 @@ module Aws::Chime
|
|
173
275
|
include Aws::Structure
|
174
276
|
end
|
175
277
|
|
278
|
+
# @note When making an API call, you may pass BatchUpdatePhoneNumberRequest
|
279
|
+
# data as a hash:
|
280
|
+
#
|
281
|
+
# {
|
282
|
+
# update_phone_number_request_items: [ # required
|
283
|
+
# {
|
284
|
+
# phone_number_id: "NonEmptyString", # required
|
285
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
286
|
+
# },
|
287
|
+
# ],
|
288
|
+
# }
|
289
|
+
#
|
290
|
+
# @!attribute [rw] update_phone_number_request_items
|
291
|
+
# The request containing the phone number IDs and product types to
|
292
|
+
# update.
|
293
|
+
# @return [Array<Types::UpdatePhoneNumberRequestItem>]
|
294
|
+
#
|
295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdatePhoneNumberRequest AWS API Documentation
|
296
|
+
#
|
297
|
+
class BatchUpdatePhoneNumberRequest < Struct.new(
|
298
|
+
:update_phone_number_request_items)
|
299
|
+
include Aws::Structure
|
300
|
+
end
|
301
|
+
|
302
|
+
# @!attribute [rw] phone_number_errors
|
303
|
+
# If the action fails for one or more of the phone numbers in the
|
304
|
+
# request, a list of the phone numbers is returned, along with error
|
305
|
+
# codes and error messages.
|
306
|
+
# @return [Array<Types::PhoneNumberError>]
|
307
|
+
#
|
308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdatePhoneNumberResponse AWS API Documentation
|
309
|
+
#
|
310
|
+
class BatchUpdatePhoneNumberResponse < Struct.new(
|
311
|
+
:phone_number_errors)
|
312
|
+
include Aws::Structure
|
313
|
+
end
|
314
|
+
|
176
315
|
# @note When making an API call, you may pass BatchUpdateUserRequest
|
177
316
|
# data as a hash:
|
178
317
|
#
|
@@ -215,6 +354,28 @@ module Aws::Chime
|
|
215
354
|
include Aws::Structure
|
216
355
|
end
|
217
356
|
|
357
|
+
# The Amazon Chime Business Calling settings for the administrator's
|
358
|
+
# AWS account. Includes any Amazon S3 buckets designated for storing
|
359
|
+
# call detail records.
|
360
|
+
#
|
361
|
+
# @note When making an API call, you may pass BusinessCallingSettings
|
362
|
+
# data as a hash:
|
363
|
+
#
|
364
|
+
# {
|
365
|
+
# cdr_bucket: "String",
|
366
|
+
# }
|
367
|
+
#
|
368
|
+
# @!attribute [rw] cdr_bucket
|
369
|
+
# The Amazon S3 bucket designated for call detail record storage.
|
370
|
+
# @return [String]
|
371
|
+
#
|
372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BusinessCallingSettings AWS API Documentation
|
373
|
+
#
|
374
|
+
class BusinessCallingSettings < Struct.new(
|
375
|
+
:cdr_bucket)
|
376
|
+
include Aws::Structure
|
377
|
+
end
|
378
|
+
|
218
379
|
# @note When making an API call, you may pass CreateAccountRequest
|
219
380
|
# data as a hash:
|
220
381
|
#
|
@@ -244,6 +405,106 @@ module Aws::Chime
|
|
244
405
|
include Aws::Structure
|
245
406
|
end
|
246
407
|
|
408
|
+
# @note When making an API call, you may pass CreatePhoneNumberOrderRequest
|
409
|
+
# data as a hash:
|
410
|
+
#
|
411
|
+
# {
|
412
|
+
# product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector
|
413
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
414
|
+
# }
|
415
|
+
#
|
416
|
+
# @!attribute [rw] product_type
|
417
|
+
# The phone number product type.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] e164_phone_numbers
|
421
|
+
# List of phone numbers, in E.164 format.
|
422
|
+
# @return [Array<String>]
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreatePhoneNumberOrderRequest AWS API Documentation
|
425
|
+
#
|
426
|
+
class CreatePhoneNumberOrderRequest < Struct.new(
|
427
|
+
:product_type,
|
428
|
+
:e164_phone_numbers)
|
429
|
+
include Aws::Structure
|
430
|
+
end
|
431
|
+
|
432
|
+
# @!attribute [rw] phone_number_order
|
433
|
+
# The phone number order details.
|
434
|
+
# @return [Types::PhoneNumberOrder]
|
435
|
+
#
|
436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreatePhoneNumberOrderResponse AWS API Documentation
|
437
|
+
#
|
438
|
+
class CreatePhoneNumberOrderResponse < Struct.new(
|
439
|
+
:phone_number_order)
|
440
|
+
include Aws::Structure
|
441
|
+
end
|
442
|
+
|
443
|
+
# @note When making an API call, you may pass CreateVoiceConnectorRequest
|
444
|
+
# data as a hash:
|
445
|
+
#
|
446
|
+
# {
|
447
|
+
# name: "VoiceConnectorName", # required
|
448
|
+
# require_encryption: false, # required
|
449
|
+
# }
|
450
|
+
#
|
451
|
+
# @!attribute [rw] name
|
452
|
+
# The name of the Amazon Chime Voice Connector.
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] require_encryption
|
456
|
+
# When enabled, requires encryption for the Amazon Chime Voice
|
457
|
+
# Connector.
|
458
|
+
# @return [Boolean]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateVoiceConnectorRequest AWS API Documentation
|
461
|
+
#
|
462
|
+
class CreateVoiceConnectorRequest < Struct.new(
|
463
|
+
:name,
|
464
|
+
:require_encryption)
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# @!attribute [rw] voice_connector
|
469
|
+
# The Amazon Chime Voice Connector details.
|
470
|
+
# @return [Types::VoiceConnector]
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateVoiceConnectorResponse AWS API Documentation
|
473
|
+
#
|
474
|
+
class CreateVoiceConnectorResponse < Struct.new(
|
475
|
+
:voice_connector)
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
479
|
+
# The SIP credentials used to authenticate requests to your Amazon Chime
|
480
|
+
# Voice Connector.
|
481
|
+
#
|
482
|
+
# @note When making an API call, you may pass Credential
|
483
|
+
# data as a hash:
|
484
|
+
#
|
485
|
+
# {
|
486
|
+
# username: "SensitiveString",
|
487
|
+
# password: "SensitiveString",
|
488
|
+
# }
|
489
|
+
#
|
490
|
+
# @!attribute [rw] username
|
491
|
+
# The RFC2617 compliant user name associated with the SIP credentials,
|
492
|
+
# in US-ASCII format.
|
493
|
+
# @return [String]
|
494
|
+
#
|
495
|
+
# @!attribute [rw] password
|
496
|
+
# The RFC2617 compliant password associated with the SIP credentials,
|
497
|
+
# in US-ASCII format.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Credential AWS API Documentation
|
501
|
+
#
|
502
|
+
class Credential < Struct.new(
|
503
|
+
:username,
|
504
|
+
:password)
|
505
|
+
include Aws::Structure
|
506
|
+
end
|
507
|
+
|
247
508
|
# @note When making an API call, you may pass DeleteAccountRequest
|
248
509
|
# data as a hash:
|
249
510
|
#
|
@@ -266,70 +527,109 @@ module Aws::Chime
|
|
266
527
|
#
|
267
528
|
class DeleteAccountResponse < Aws::EmptyStructure; end
|
268
529
|
|
269
|
-
# @note When making an API call, you may pass
|
530
|
+
# @note When making an API call, you may pass DeletePhoneNumberRequest
|
270
531
|
# data as a hash:
|
271
532
|
#
|
272
533
|
# {
|
273
|
-
#
|
534
|
+
# phone_number_id: "String", # required
|
274
535
|
# }
|
275
536
|
#
|
276
|
-
# @!attribute [rw]
|
277
|
-
# The
|
537
|
+
# @!attribute [rw] phone_number_id
|
538
|
+
# The phone number ID.
|
278
539
|
# @return [String]
|
279
540
|
#
|
280
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeletePhoneNumberRequest AWS API Documentation
|
281
542
|
#
|
282
|
-
class
|
283
|
-
:
|
543
|
+
class DeletePhoneNumberRequest < Struct.new(
|
544
|
+
:phone_number_id)
|
284
545
|
include Aws::Structure
|
285
546
|
end
|
286
547
|
|
287
|
-
#
|
288
|
-
#
|
289
|
-
# @return [Types::Account]
|
548
|
+
# @note When making an API call, you may pass DeleteVoiceConnectorOriginationRequest
|
549
|
+
# data as a hash:
|
290
550
|
#
|
291
|
-
#
|
551
|
+
# {
|
552
|
+
# voice_connector_id: "NonEmptyString", # required
|
553
|
+
# }
|
292
554
|
#
|
293
|
-
|
294
|
-
|
555
|
+
# @!attribute [rw] voice_connector_id
|
556
|
+
# The Amazon Chime Voice Connector ID.
|
557
|
+
# @return [String]
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorOriginationRequest AWS API Documentation
|
560
|
+
#
|
561
|
+
class DeleteVoiceConnectorOriginationRequest < Struct.new(
|
562
|
+
:voice_connector_id)
|
295
563
|
include Aws::Structure
|
296
564
|
end
|
297
565
|
|
298
|
-
# @note When making an API call, you may pass
|
566
|
+
# @note When making an API call, you may pass DeleteVoiceConnectorRequest
|
299
567
|
# data as a hash:
|
300
568
|
#
|
301
569
|
# {
|
302
|
-
#
|
570
|
+
# voice_connector_id: "NonEmptyString", # required
|
303
571
|
# }
|
304
572
|
#
|
305
|
-
# @!attribute [rw]
|
306
|
-
# The Amazon Chime
|
573
|
+
# @!attribute [rw] voice_connector_id
|
574
|
+
# The Amazon Chime Voice Connector ID.
|
307
575
|
# @return [String]
|
308
576
|
#
|
309
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorRequest AWS API Documentation
|
310
578
|
#
|
311
|
-
class
|
312
|
-
:
|
579
|
+
class DeleteVoiceConnectorRequest < Struct.new(
|
580
|
+
:voice_connector_id)
|
313
581
|
include Aws::Structure
|
314
582
|
end
|
315
583
|
|
316
|
-
#
|
317
|
-
#
|
318
|
-
# @return [Types::AccountSettings]
|
584
|
+
# @note When making an API call, you may pass DeleteVoiceConnectorTerminationCredentialsRequest
|
585
|
+
# data as a hash:
|
319
586
|
#
|
320
|
-
#
|
587
|
+
# {
|
588
|
+
# voice_connector_id: "NonEmptyString", # required
|
589
|
+
# usernames: ["SensitiveString"],
|
590
|
+
# }
|
321
591
|
#
|
322
|
-
|
323
|
-
|
592
|
+
# @!attribute [rw] voice_connector_id
|
593
|
+
# The Amazon Chime Voice Connector ID.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] usernames
|
597
|
+
# The RFC2617 compliant username associated with the SIP credentials,
|
598
|
+
# in US-ASCII format.
|
599
|
+
# @return [Array<String>]
|
600
|
+
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
602
|
+
#
|
603
|
+
class DeleteVoiceConnectorTerminationCredentialsRequest < Struct.new(
|
604
|
+
:voice_connector_id,
|
605
|
+
:usernames)
|
324
606
|
include Aws::Structure
|
325
607
|
end
|
326
608
|
|
327
|
-
# @note When making an API call, you may pass
|
609
|
+
# @note When making an API call, you may pass DeleteVoiceConnectorTerminationRequest
|
328
610
|
# data as a hash:
|
329
611
|
#
|
330
612
|
# {
|
331
|
-
#
|
332
|
-
#
|
613
|
+
# voice_connector_id: "NonEmptyString", # required
|
614
|
+
# }
|
615
|
+
#
|
616
|
+
# @!attribute [rw] voice_connector_id
|
617
|
+
# The Amazon Chime Voice Connector ID.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorTerminationRequest AWS API Documentation
|
621
|
+
#
|
622
|
+
class DeleteVoiceConnectorTerminationRequest < Struct.new(
|
623
|
+
:voice_connector_id)
|
624
|
+
include Aws::Structure
|
625
|
+
end
|
626
|
+
|
627
|
+
# @note When making an API call, you may pass DisassociatePhoneNumberFromUserRequest
|
628
|
+
# data as a hash:
|
629
|
+
#
|
630
|
+
# {
|
631
|
+
# account_id: "String", # required
|
632
|
+
# user_id: "String", # required
|
333
633
|
# }
|
334
634
|
#
|
335
635
|
# @!attribute [rw] account_id
|
@@ -340,255 +640,1371 @@ module Aws::Chime
|
|
340
640
|
# The user ID.
|
341
641
|
# @return [String]
|
342
642
|
#
|
343
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumberFromUserRequest AWS API Documentation
|
344
644
|
#
|
345
|
-
class
|
645
|
+
class DisassociatePhoneNumberFromUserRequest < Struct.new(
|
346
646
|
:account_id,
|
347
647
|
:user_id)
|
348
648
|
include Aws::Structure
|
349
649
|
end
|
350
650
|
|
351
|
-
#
|
352
|
-
# The user details.
|
353
|
-
# @return [Types::User]
|
354
|
-
#
|
355
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserResponse AWS API Documentation
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumberFromUserResponse AWS API Documentation
|
356
652
|
#
|
357
|
-
class
|
358
|
-
:user)
|
359
|
-
include Aws::Structure
|
360
|
-
end
|
653
|
+
class DisassociatePhoneNumberFromUserResponse < Aws::EmptyStructure; end
|
361
654
|
|
362
|
-
#
|
363
|
-
#
|
655
|
+
# @note When making an API call, you may pass DisassociatePhoneNumbersFromVoiceConnectorRequest
|
656
|
+
# data as a hash:
|
364
657
|
#
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
658
|
+
# {
|
659
|
+
# voice_connector_id: "NonEmptyString", # required
|
660
|
+
# e164_phone_numbers: ["E164PhoneNumber"],
|
661
|
+
# }
|
368
662
|
#
|
369
|
-
# @!attribute [rw]
|
370
|
-
# The
|
663
|
+
# @!attribute [rw] voice_connector_id
|
664
|
+
# The Amazon Chime Voice Connector ID.
|
371
665
|
# @return [String]
|
372
666
|
#
|
373
|
-
# @!attribute [rw]
|
374
|
-
#
|
375
|
-
# @return [String]
|
667
|
+
# @!attribute [rw] e164_phone_numbers
|
668
|
+
# List of phone numbers, in E.164 format.
|
669
|
+
# @return [Array<String>]
|
376
670
|
#
|
377
|
-
#
|
378
|
-
# The status of the invite email.
|
379
|
-
# @return [String]
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumbersFromVoiceConnectorRequest AWS API Documentation
|
380
672
|
#
|
381
|
-
|
673
|
+
class DisassociatePhoneNumbersFromVoiceConnectorRequest < Struct.new(
|
674
|
+
:voice_connector_id,
|
675
|
+
:e164_phone_numbers)
|
676
|
+
include Aws::Structure
|
677
|
+
end
|
678
|
+
|
679
|
+
# @!attribute [rw] phone_number_errors
|
680
|
+
# If the action fails for one or more of the phone numbers in the
|
681
|
+
# request, a list of the phone numbers is returned, along with error
|
682
|
+
# codes and error messages.
|
683
|
+
# @return [Array<Types::PhoneNumberError>]
|
382
684
|
#
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
:
|
387
|
-
:email_status)
|
685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumbersFromVoiceConnectorResponse AWS API Documentation
|
686
|
+
#
|
687
|
+
class DisassociatePhoneNumbersFromVoiceConnectorResponse < Struct.new(
|
688
|
+
:phone_number_errors)
|
388
689
|
include Aws::Structure
|
389
690
|
end
|
390
691
|
|
391
|
-
# @note When making an API call, you may pass
|
692
|
+
# @note When making an API call, you may pass GetAccountRequest
|
392
693
|
# data as a hash:
|
393
694
|
#
|
394
695
|
# {
|
395
696
|
# account_id: "NonEmptyString", # required
|
396
|
-
# user_email_list: ["EmailAddress"], # required
|
397
697
|
# }
|
398
698
|
#
|
399
699
|
# @!attribute [rw] account_id
|
400
700
|
# The Amazon Chime account ID.
|
401
701
|
# @return [String]
|
402
702
|
#
|
403
|
-
#
|
404
|
-
# The user email addresses to which to send the invite.
|
405
|
-
# @return [Array<String>]
|
406
|
-
#
|
407
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersRequest AWS API Documentation
|
703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountRequest AWS API Documentation
|
408
704
|
#
|
409
|
-
class
|
410
|
-
:account_id
|
411
|
-
:user_email_list)
|
705
|
+
class GetAccountRequest < Struct.new(
|
706
|
+
:account_id)
|
412
707
|
include Aws::Structure
|
413
708
|
end
|
414
709
|
|
415
|
-
# @!attribute [rw]
|
416
|
-
# The
|
417
|
-
# @return [
|
710
|
+
# @!attribute [rw] account
|
711
|
+
# The Amazon Chime account details.
|
712
|
+
# @return [Types::Account]
|
418
713
|
#
|
419
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountResponse AWS API Documentation
|
715
|
+
#
|
716
|
+
class GetAccountResponse < Struct.new(
|
717
|
+
:account)
|
718
|
+
include Aws::Structure
|
719
|
+
end
|
720
|
+
|
721
|
+
# @note When making an API call, you may pass GetAccountSettingsRequest
|
722
|
+
# data as a hash:
|
723
|
+
#
|
724
|
+
# {
|
725
|
+
# account_id: "NonEmptyString", # required
|
726
|
+
# }
|
727
|
+
#
|
728
|
+
# @!attribute [rw] account_id
|
729
|
+
# The Amazon Chime account ID.
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsRequest AWS API Documentation
|
733
|
+
#
|
734
|
+
class GetAccountSettingsRequest < Struct.new(
|
735
|
+
:account_id)
|
736
|
+
include Aws::Structure
|
737
|
+
end
|
738
|
+
|
739
|
+
# @!attribute [rw] account_settings
|
740
|
+
# The Amazon Chime account settings.
|
741
|
+
# @return [Types::AccountSettings]
|
742
|
+
#
|
743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAccountSettingsResponse AWS API Documentation
|
744
|
+
#
|
745
|
+
class GetAccountSettingsResponse < Struct.new(
|
746
|
+
:account_settings)
|
747
|
+
include Aws::Structure
|
748
|
+
end
|
749
|
+
|
750
|
+
# @!attribute [rw] business_calling
|
751
|
+
# The Amazon Chime Business Calling settings.
|
752
|
+
# @return [Types::BusinessCallingSettings]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] voice_connector
|
755
|
+
# The Amazon Chime Voice Connector settings.
|
756
|
+
# @return [Types::VoiceConnectorSettings]
|
757
|
+
#
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetGlobalSettingsResponse AWS API Documentation
|
759
|
+
#
|
760
|
+
class GetGlobalSettingsResponse < Struct.new(
|
761
|
+
:business_calling,
|
762
|
+
:voice_connector)
|
763
|
+
include Aws::Structure
|
764
|
+
end
|
765
|
+
|
766
|
+
# @note When making an API call, you may pass GetPhoneNumberOrderRequest
|
767
|
+
# data as a hash:
|
768
|
+
#
|
769
|
+
# {
|
770
|
+
# phone_number_order_id: "GuidString", # required
|
771
|
+
# }
|
772
|
+
#
|
773
|
+
# @!attribute [rw] phone_number_order_id
|
774
|
+
# The ID for the phone number order.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumberOrderRequest AWS API Documentation
|
778
|
+
#
|
779
|
+
class GetPhoneNumberOrderRequest < Struct.new(
|
780
|
+
:phone_number_order_id)
|
781
|
+
include Aws::Structure
|
782
|
+
end
|
783
|
+
|
784
|
+
# @!attribute [rw] phone_number_order
|
785
|
+
# The phone number order details.
|
786
|
+
# @return [Types::PhoneNumberOrder]
|
787
|
+
#
|
788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumberOrderResponse AWS API Documentation
|
789
|
+
#
|
790
|
+
class GetPhoneNumberOrderResponse < Struct.new(
|
791
|
+
:phone_number_order)
|
792
|
+
include Aws::Structure
|
793
|
+
end
|
794
|
+
|
795
|
+
# @note When making an API call, you may pass GetPhoneNumberRequest
|
796
|
+
# data as a hash:
|
797
|
+
#
|
798
|
+
# {
|
799
|
+
# phone_number_id: "String", # required
|
800
|
+
# }
|
801
|
+
#
|
802
|
+
# @!attribute [rw] phone_number_id
|
803
|
+
# The phone number ID.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumberRequest AWS API Documentation
|
807
|
+
#
|
808
|
+
class GetPhoneNumberRequest < Struct.new(
|
809
|
+
:phone_number_id)
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
813
|
+
# @!attribute [rw] phone_number
|
814
|
+
# The phone number details.
|
815
|
+
# @return [Types::PhoneNumber]
|
816
|
+
#
|
817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumberResponse AWS API Documentation
|
818
|
+
#
|
819
|
+
class GetPhoneNumberResponse < Struct.new(
|
820
|
+
:phone_number)
|
821
|
+
include Aws::Structure
|
822
|
+
end
|
823
|
+
|
824
|
+
# @note When making an API call, you may pass GetUserRequest
|
825
|
+
# data as a hash:
|
826
|
+
#
|
827
|
+
# {
|
828
|
+
# account_id: "NonEmptyString", # required
|
829
|
+
# user_id: "NonEmptyString", # required
|
830
|
+
# }
|
831
|
+
#
|
832
|
+
# @!attribute [rw] account_id
|
833
|
+
# The Amazon Chime account ID.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] user_id
|
837
|
+
# The user ID.
|
838
|
+
# @return [String]
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserRequest AWS API Documentation
|
841
|
+
#
|
842
|
+
class GetUserRequest < Struct.new(
|
843
|
+
:account_id,
|
844
|
+
:user_id)
|
845
|
+
include Aws::Structure
|
846
|
+
end
|
847
|
+
|
848
|
+
# @!attribute [rw] user
|
849
|
+
# The user details.
|
850
|
+
# @return [Types::User]
|
851
|
+
#
|
852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserResponse AWS API Documentation
|
853
|
+
#
|
854
|
+
class GetUserResponse < Struct.new(
|
855
|
+
:user)
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# @note When making an API call, you may pass GetUserSettingsRequest
|
860
|
+
# data as a hash:
|
861
|
+
#
|
862
|
+
# {
|
863
|
+
# account_id: "String", # required
|
864
|
+
# user_id: "String", # required
|
865
|
+
# }
|
866
|
+
#
|
867
|
+
# @!attribute [rw] account_id
|
868
|
+
# The Amazon Chime account ID.
|
869
|
+
# @return [String]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] user_id
|
872
|
+
# The user ID.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserSettingsRequest AWS API Documentation
|
876
|
+
#
|
877
|
+
class GetUserSettingsRequest < Struct.new(
|
878
|
+
:account_id,
|
879
|
+
:user_id)
|
880
|
+
include Aws::Structure
|
881
|
+
end
|
882
|
+
|
883
|
+
# @!attribute [rw] user_settings
|
884
|
+
# The user settings.
|
885
|
+
# @return [Types::UserSettings]
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserSettingsResponse AWS API Documentation
|
888
|
+
#
|
889
|
+
class GetUserSettingsResponse < Struct.new(
|
890
|
+
:user_settings)
|
891
|
+
include Aws::Structure
|
892
|
+
end
|
893
|
+
|
894
|
+
# @note When making an API call, you may pass GetVoiceConnectorOriginationRequest
|
895
|
+
# data as a hash:
|
896
|
+
#
|
897
|
+
# {
|
898
|
+
# voice_connector_id: "NonEmptyString", # required
|
899
|
+
# }
|
900
|
+
#
|
901
|
+
# @!attribute [rw] voice_connector_id
|
902
|
+
# The Amazon Chime Voice Connector ID.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorOriginationRequest AWS API Documentation
|
906
|
+
#
|
907
|
+
class GetVoiceConnectorOriginationRequest < Struct.new(
|
908
|
+
:voice_connector_id)
|
909
|
+
include Aws::Structure
|
910
|
+
end
|
911
|
+
|
912
|
+
# @!attribute [rw] origination
|
913
|
+
# The origination setting details.
|
914
|
+
# @return [Types::Origination]
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorOriginationResponse AWS API Documentation
|
917
|
+
#
|
918
|
+
class GetVoiceConnectorOriginationResponse < Struct.new(
|
919
|
+
:origination)
|
920
|
+
include Aws::Structure
|
921
|
+
end
|
922
|
+
|
923
|
+
# @note When making an API call, you may pass GetVoiceConnectorRequest
|
924
|
+
# data as a hash:
|
925
|
+
#
|
926
|
+
# {
|
927
|
+
# voice_connector_id: "NonEmptyString", # required
|
928
|
+
# }
|
929
|
+
#
|
930
|
+
# @!attribute [rw] voice_connector_id
|
931
|
+
# The Amazon Chime Voice Connector ID.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorRequest AWS API Documentation
|
935
|
+
#
|
936
|
+
class GetVoiceConnectorRequest < Struct.new(
|
937
|
+
:voice_connector_id)
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# @!attribute [rw] voice_connector
|
942
|
+
# The Amazon Chime Voice Connector details.
|
943
|
+
# @return [Types::VoiceConnector]
|
944
|
+
#
|
945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorResponse AWS API Documentation
|
946
|
+
#
|
947
|
+
class GetVoiceConnectorResponse < Struct.new(
|
948
|
+
:voice_connector)
|
949
|
+
include Aws::Structure
|
950
|
+
end
|
951
|
+
|
952
|
+
# @note When making an API call, you may pass GetVoiceConnectorTerminationHealthRequest
|
953
|
+
# data as a hash:
|
954
|
+
#
|
955
|
+
# {
|
956
|
+
# voice_connector_id: "NonEmptyString", # required
|
957
|
+
# }
|
958
|
+
#
|
959
|
+
# @!attribute [rw] voice_connector_id
|
960
|
+
# The Amazon Chime Voice Connector ID.
|
961
|
+
# @return [String]
|
962
|
+
#
|
963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTerminationHealthRequest AWS API Documentation
|
964
|
+
#
|
965
|
+
class GetVoiceConnectorTerminationHealthRequest < Struct.new(
|
966
|
+
:voice_connector_id)
|
967
|
+
include Aws::Structure
|
968
|
+
end
|
969
|
+
|
970
|
+
# @!attribute [rw] termination_health
|
971
|
+
# The termination health details.
|
972
|
+
# @return [Types::TerminationHealth]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTerminationHealthResponse AWS API Documentation
|
975
|
+
#
|
976
|
+
class GetVoiceConnectorTerminationHealthResponse < Struct.new(
|
977
|
+
:termination_health)
|
978
|
+
include Aws::Structure
|
979
|
+
end
|
980
|
+
|
981
|
+
# @note When making an API call, you may pass GetVoiceConnectorTerminationRequest
|
982
|
+
# data as a hash:
|
983
|
+
#
|
984
|
+
# {
|
985
|
+
# voice_connector_id: "NonEmptyString", # required
|
986
|
+
# }
|
987
|
+
#
|
988
|
+
# @!attribute [rw] voice_connector_id
|
989
|
+
# The Amazon Chime Voice Connector ID.
|
990
|
+
# @return [String]
|
991
|
+
#
|
992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTerminationRequest AWS API Documentation
|
993
|
+
#
|
994
|
+
class GetVoiceConnectorTerminationRequest < Struct.new(
|
995
|
+
:voice_connector_id)
|
996
|
+
include Aws::Structure
|
997
|
+
end
|
998
|
+
|
999
|
+
# @!attribute [rw] termination
|
1000
|
+
# The termination setting details.
|
1001
|
+
# @return [Types::Termination]
|
1002
|
+
#
|
1003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTerminationResponse AWS API Documentation
|
1004
|
+
#
|
1005
|
+
class GetVoiceConnectorTerminationResponse < Struct.new(
|
1006
|
+
:termination)
|
1007
|
+
include Aws::Structure
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# Invitation object returned after emailing users to invite them to join
|
1011
|
+
# the Amazon Chime `Team` account.
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] invite_id
|
1014
|
+
# The invite ID.
|
1015
|
+
# @return [String]
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] status
|
1018
|
+
# The status of the invite.
|
1019
|
+
# @return [String]
|
1020
|
+
#
|
1021
|
+
# @!attribute [rw] email_address
|
1022
|
+
# The email address to which the invite is sent.
|
1023
|
+
# @return [String]
|
1024
|
+
#
|
1025
|
+
# @!attribute [rw] email_status
|
1026
|
+
# The status of the invite email.
|
1027
|
+
# @return [String]
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Invite AWS API Documentation
|
1030
|
+
#
|
1031
|
+
class Invite < Struct.new(
|
1032
|
+
:invite_id,
|
1033
|
+
:status,
|
1034
|
+
:email_address,
|
1035
|
+
:email_status)
|
1036
|
+
include Aws::Structure
|
1037
|
+
end
|
1038
|
+
|
1039
|
+
# @note When making an API call, you may pass InviteUsersRequest
|
1040
|
+
# data as a hash:
|
1041
|
+
#
|
1042
|
+
# {
|
1043
|
+
# account_id: "NonEmptyString", # required
|
1044
|
+
# user_email_list: ["EmailAddress"], # required
|
1045
|
+
# }
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] account_id
|
1048
|
+
# The Amazon Chime account ID.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] user_email_list
|
1052
|
+
# The user email addresses to which to send the invite.
|
1053
|
+
# @return [Array<String>]
|
1054
|
+
#
|
1055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersRequest AWS API Documentation
|
1056
|
+
#
|
1057
|
+
class InviteUsersRequest < Struct.new(
|
1058
|
+
:account_id,
|
1059
|
+
:user_email_list)
|
1060
|
+
include Aws::Structure
|
1061
|
+
end
|
1062
|
+
|
1063
|
+
# @!attribute [rw] invites
|
1064
|
+
# The invite details.
|
1065
|
+
# @return [Array<Types::Invite>]
|
1066
|
+
#
|
1067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/InviteUsersResponse AWS API Documentation
|
1068
|
+
#
|
1069
|
+
class InviteUsersResponse < Struct.new(
|
1070
|
+
:invites)
|
1071
|
+
include Aws::Structure
|
1072
|
+
end
|
1073
|
+
|
1074
|
+
# @note When making an API call, you may pass ListAccountsRequest
|
1075
|
+
# data as a hash:
|
1076
|
+
#
|
1077
|
+
# {
|
1078
|
+
# name: "AccountName",
|
1079
|
+
# user_email: "EmailAddress",
|
1080
|
+
# next_token: "String",
|
1081
|
+
# max_results: 1,
|
1082
|
+
# }
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] name
|
1085
|
+
# Amazon Chime account name prefix with which to filter results.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] user_email
|
1089
|
+
# User email address with which to filter results.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] next_token
|
1093
|
+
# The token to use to retrieve the next page of results.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] max_results
|
1097
|
+
# The maximum number of results to return in a single call. Defaults
|
1098
|
+
# to 100.
|
1099
|
+
# @return [Integer]
|
1100
|
+
#
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsRequest AWS API Documentation
|
1102
|
+
#
|
1103
|
+
class ListAccountsRequest < Struct.new(
|
1104
|
+
:name,
|
1105
|
+
:user_email,
|
1106
|
+
:next_token,
|
1107
|
+
:max_results)
|
1108
|
+
include Aws::Structure
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# @!attribute [rw] accounts
|
1112
|
+
# List of Amazon Chime accounts and account details.
|
1113
|
+
# @return [Array<Types::Account>]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] next_token
|
1116
|
+
# The token to use to retrieve the next page of results.
|
1117
|
+
# @return [String]
|
1118
|
+
#
|
1119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsResponse AWS API Documentation
|
1120
|
+
#
|
1121
|
+
class ListAccountsResponse < Struct.new(
|
1122
|
+
:accounts,
|
1123
|
+
:next_token)
|
1124
|
+
include Aws::Structure
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# @note When making an API call, you may pass ListPhoneNumberOrdersRequest
|
1128
|
+
# data as a hash:
|
1129
|
+
#
|
1130
|
+
# {
|
1131
|
+
# next_token: "String",
|
1132
|
+
# max_results: 1,
|
1133
|
+
# }
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] next_token
|
1136
|
+
# The token to use to retrieve the next page of results.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] max_results
|
1140
|
+
# The maximum number of results to return in a single call.
|
1141
|
+
# @return [Integer]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumberOrdersRequest AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class ListPhoneNumberOrdersRequest < Struct.new(
|
1146
|
+
:next_token,
|
1147
|
+
:max_results)
|
1148
|
+
include Aws::Structure
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# @!attribute [rw] phone_number_orders
|
1152
|
+
# The phone number order details.
|
1153
|
+
# @return [Array<Types::PhoneNumberOrder>]
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] next_token
|
1156
|
+
# The token to use to retrieve the next page of results.
|
1157
|
+
# @return [String]
|
1158
|
+
#
|
1159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumberOrdersResponse AWS API Documentation
|
1160
|
+
#
|
1161
|
+
class ListPhoneNumberOrdersResponse < Struct.new(
|
1162
|
+
:phone_number_orders,
|
1163
|
+
:next_token)
|
1164
|
+
include Aws::Structure
|
1165
|
+
end
|
1166
|
+
|
1167
|
+
# @note When making an API call, you may pass ListPhoneNumbersRequest
|
1168
|
+
# data as a hash:
|
1169
|
+
#
|
1170
|
+
# {
|
1171
|
+
# status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
|
1172
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
1173
|
+
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId
|
1174
|
+
# filter_value: "String",
|
1175
|
+
# max_results: 1,
|
1176
|
+
# next_token: "String",
|
1177
|
+
# }
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] status
|
1180
|
+
# The phone number status.
|
1181
|
+
# @return [String]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] product_type
|
1184
|
+
# The phone number product type.
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] filter_name
|
1188
|
+
# The filter to use to limit the number of results.
|
1189
|
+
# @return [String]
|
1190
|
+
#
|
1191
|
+
# @!attribute [rw] filter_value
|
1192
|
+
# The value to use for the filter.
|
1193
|
+
# @return [String]
|
1194
|
+
#
|
1195
|
+
# @!attribute [rw] max_results
|
1196
|
+
# The maximum number of results to return in a single call.
|
1197
|
+
# @return [Integer]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] next_token
|
1200
|
+
# The token to use to retrieve the next page of results.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumbersRequest AWS API Documentation
|
1204
|
+
#
|
1205
|
+
class ListPhoneNumbersRequest < Struct.new(
|
1206
|
+
:status,
|
1207
|
+
:product_type,
|
1208
|
+
:filter_name,
|
1209
|
+
:filter_value,
|
1210
|
+
:max_results,
|
1211
|
+
:next_token)
|
1212
|
+
include Aws::Structure
|
1213
|
+
end
|
1214
|
+
|
1215
|
+
# @!attribute [rw] phone_numbers
|
1216
|
+
# The phone number details.
|
1217
|
+
# @return [Array<Types::PhoneNumber>]
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] next_token
|
1220
|
+
# The token to use to retrieve the next page of results.
|
1221
|
+
# @return [String]
|
1222
|
+
#
|
1223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumbersResponse AWS API Documentation
|
1224
|
+
#
|
1225
|
+
class ListPhoneNumbersResponse < Struct.new(
|
1226
|
+
:phone_numbers,
|
1227
|
+
:next_token)
|
1228
|
+
include Aws::Structure
|
1229
|
+
end
|
1230
|
+
|
1231
|
+
# @note When making an API call, you may pass ListUsersRequest
|
1232
|
+
# data as a hash:
|
1233
|
+
#
|
1234
|
+
# {
|
1235
|
+
# account_id: "NonEmptyString", # required
|
1236
|
+
# user_email: "EmailAddress",
|
1237
|
+
# max_results: 1,
|
1238
|
+
# next_token: "String",
|
1239
|
+
# }
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] account_id
|
1242
|
+
# The Amazon Chime account ID.
|
1243
|
+
# @return [String]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] user_email
|
1246
|
+
# Optional. The user email address used to filter results. Maximum 1.
|
1247
|
+
# @return [String]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] max_results
|
1250
|
+
# The maximum number of results to return in a single call. Defaults
|
1251
|
+
# to 100.
|
1252
|
+
# @return [Integer]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] next_token
|
1255
|
+
# The token to use to retrieve the next page of results.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersRequest AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class ListUsersRequest < Struct.new(
|
1261
|
+
:account_id,
|
1262
|
+
:user_email,
|
1263
|
+
:max_results,
|
1264
|
+
:next_token)
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# @!attribute [rw] users
|
1269
|
+
# List of users and user details.
|
1270
|
+
# @return [Array<Types::User>]
|
1271
|
+
#
|
1272
|
+
# @!attribute [rw] next_token
|
1273
|
+
# The token to use to retrieve the next page of results.
|
1274
|
+
# @return [String]
|
1275
|
+
#
|
1276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListUsersResponse AWS API Documentation
|
1277
|
+
#
|
1278
|
+
class ListUsersResponse < Struct.new(
|
1279
|
+
:users,
|
1280
|
+
:next_token)
|
1281
|
+
include Aws::Structure
|
1282
|
+
end
|
1283
|
+
|
1284
|
+
# @note When making an API call, you may pass ListVoiceConnectorTerminationCredentialsRequest
|
1285
|
+
# data as a hash:
|
1286
|
+
#
|
1287
|
+
# {
|
1288
|
+
# voice_connector_id: "NonEmptyString", # required
|
1289
|
+
# }
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] voice_connector_id
|
1292
|
+
# The Amazon Chime Voice Connector ID.
|
1293
|
+
# @return [String]
|
1294
|
+
#
|
1295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
1296
|
+
#
|
1297
|
+
class ListVoiceConnectorTerminationCredentialsRequest < Struct.new(
|
1298
|
+
:voice_connector_id)
|
1299
|
+
include Aws::Structure
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
# @!attribute [rw] usernames
|
1303
|
+
# A list of user names.
|
1304
|
+
# @return [Array<String>]
|
1305
|
+
#
|
1306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectorTerminationCredentialsResponse AWS API Documentation
|
1307
|
+
#
|
1308
|
+
class ListVoiceConnectorTerminationCredentialsResponse < Struct.new(
|
1309
|
+
:usernames)
|
1310
|
+
include Aws::Structure
|
1311
|
+
end
|
1312
|
+
|
1313
|
+
# @note When making an API call, you may pass ListVoiceConnectorsRequest
|
1314
|
+
# data as a hash:
|
1315
|
+
#
|
1316
|
+
# {
|
1317
|
+
# next_token: "String",
|
1318
|
+
# max_results: 1,
|
1319
|
+
# }
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] next_token
|
1322
|
+
# The token to use to retrieve the next page of results.
|
1323
|
+
# @return [String]
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] max_results
|
1326
|
+
# The maximum number of results to return in a single call.
|
1327
|
+
# @return [Integer]
|
1328
|
+
#
|
1329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectorsRequest AWS API Documentation
|
1330
|
+
#
|
1331
|
+
class ListVoiceConnectorsRequest < Struct.new(
|
1332
|
+
:next_token,
|
1333
|
+
:max_results)
|
1334
|
+
include Aws::Structure
|
1335
|
+
end
|
1336
|
+
|
1337
|
+
# @!attribute [rw] voice_connectors
|
1338
|
+
# The details of the Amazon Chime Voice Connectors.
|
1339
|
+
# @return [Array<Types::VoiceConnector>]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] next_token
|
1342
|
+
# The token to use to retrieve the next page of results.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectorsResponse AWS API Documentation
|
1346
|
+
#
|
1347
|
+
class ListVoiceConnectorsResponse < Struct.new(
|
1348
|
+
:voice_connectors,
|
1349
|
+
:next_token)
|
1350
|
+
include Aws::Structure
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
# @note When making an API call, you may pass LogoutUserRequest
|
1354
|
+
# data as a hash:
|
1355
|
+
#
|
1356
|
+
# {
|
1357
|
+
# account_id: "NonEmptyString", # required
|
1358
|
+
# user_id: "NonEmptyString", # required
|
1359
|
+
# }
|
1360
|
+
#
|
1361
|
+
# @!attribute [rw] account_id
|
1362
|
+
# The Amazon Chime account ID.
|
1363
|
+
# @return [String]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] user_id
|
1366
|
+
# The user ID.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserRequest AWS API Documentation
|
1370
|
+
#
|
1371
|
+
class LogoutUserRequest < Struct.new(
|
1372
|
+
:account_id,
|
1373
|
+
:user_id)
|
1374
|
+
include Aws::Structure
|
1375
|
+
end
|
1376
|
+
|
1377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/LogoutUserResponse AWS API Documentation
|
1378
|
+
#
|
1379
|
+
class LogoutUserResponse < Aws::EmptyStructure; end
|
1380
|
+
|
1381
|
+
# A phone number for which an order has been placed.
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] e164_phone_number
|
1384
|
+
# The phone number, in E.164 format.
|
1385
|
+
# @return [String]
|
1386
|
+
#
|
1387
|
+
# @!attribute [rw] status
|
1388
|
+
# The phone number status.
|
1389
|
+
# @return [String]
|
1390
|
+
#
|
1391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/OrderedPhoneNumber AWS API Documentation
|
1392
|
+
#
|
1393
|
+
class OrderedPhoneNumber < Struct.new(
|
1394
|
+
:e164_phone_number,
|
1395
|
+
:status)
|
1396
|
+
include Aws::Structure
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# Origination settings enable your SIP hosts to receive inbound calls
|
1400
|
+
# using your Amazon Chime Voice Connector.
|
1401
|
+
#
|
1402
|
+
# @note When making an API call, you may pass Origination
|
1403
|
+
# data as a hash:
|
1404
|
+
#
|
1405
|
+
# {
|
1406
|
+
# routes: [
|
1407
|
+
# {
|
1408
|
+
# host: "String",
|
1409
|
+
# port: 1,
|
1410
|
+
# protocol: "TCP", # accepts TCP, UDP
|
1411
|
+
# priority: 1,
|
1412
|
+
# weight: 1,
|
1413
|
+
# },
|
1414
|
+
# ],
|
1415
|
+
# disabled: false,
|
1416
|
+
# }
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] routes
|
1419
|
+
# The call distribution properties defined for your SIP hosts. Valid
|
1420
|
+
# range: Minimum value of 1. Maximum value of 20.
|
1421
|
+
# @return [Array<Types::OriginationRoute>]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] disabled
|
1424
|
+
# When origination settings are disabled, inbound calls are not
|
1425
|
+
# enabled for your Amazon Chime Voice Connector.
|
1426
|
+
# @return [Boolean]
|
1427
|
+
#
|
1428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Origination AWS API Documentation
|
1429
|
+
#
|
1430
|
+
class Origination < Struct.new(
|
1431
|
+
:routes,
|
1432
|
+
:disabled)
|
1433
|
+
include Aws::Structure
|
1434
|
+
end
|
1435
|
+
|
1436
|
+
# Origination routes define call distribution properties for your SIP
|
1437
|
+
# hosts to receive inbound calls using your Amazon Chime Voice
|
1438
|
+
# Connector. Limit: 10 origination routes per Amazon Chime Voice
|
1439
|
+
# Connector.
|
1440
|
+
#
|
1441
|
+
# @note When making an API call, you may pass OriginationRoute
|
1442
|
+
# data as a hash:
|
1443
|
+
#
|
1444
|
+
# {
|
1445
|
+
# host: "String",
|
1446
|
+
# port: 1,
|
1447
|
+
# protocol: "TCP", # accepts TCP, UDP
|
1448
|
+
# priority: 1,
|
1449
|
+
# weight: 1,
|
1450
|
+
# }
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] host
|
1453
|
+
# The FODN or IP address to contact for origination traffic.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] port
|
1457
|
+
# The designated origination route port. Defaults to 5060.
|
1458
|
+
# @return [Integer]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] protocol
|
1461
|
+
# The protocol to use for the origination route. Encryption-enabled
|
1462
|
+
# Amazon Chime Voice Connectors use TCP protocol by default.
|
1463
|
+
# @return [String]
|
1464
|
+
#
|
1465
|
+
# @!attribute [rw] priority
|
1466
|
+
# The priority associated with the host, with 1 being the highest
|
1467
|
+
# priority. Higher priority hosts are attempted first.
|
1468
|
+
# @return [Integer]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] weight
|
1471
|
+
# The weight associated with the host. If hosts are equal in priority,
|
1472
|
+
# calls are distributed among them based on their relative weight.
|
1473
|
+
# @return [Integer]
|
1474
|
+
#
|
1475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/OriginationRoute AWS API Documentation
|
1476
|
+
#
|
1477
|
+
class OriginationRoute < Struct.new(
|
1478
|
+
:host,
|
1479
|
+
:port,
|
1480
|
+
:protocol,
|
1481
|
+
:priority,
|
1482
|
+
:weight)
|
1483
|
+
include Aws::Structure
|
1484
|
+
end
|
1485
|
+
|
1486
|
+
# A phone number used for Amazon Chime Business Calling or an Amazon
|
1487
|
+
# Chime Voice Connector.
|
1488
|
+
#
|
1489
|
+
# @!attribute [rw] phone_number_id
|
1490
|
+
# The phone number ID.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] e164_phone_number
|
1494
|
+
# The phone number, in E.164 format.
|
1495
|
+
# @return [String]
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] product_type
|
1498
|
+
# The phone number product type.
|
1499
|
+
# @return [String]
|
1500
|
+
#
|
1501
|
+
# @!attribute [rw] status
|
1502
|
+
# The phone number status.
|
1503
|
+
# @return [String]
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] capabilities
|
1506
|
+
# The phone number capabilities.
|
1507
|
+
# @return [Types::PhoneNumberCapabilities]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] associations
|
1510
|
+
# The phone number associations.
|
1511
|
+
# @return [Array<Types::PhoneNumberAssociation>]
|
1512
|
+
#
|
1513
|
+
# @!attribute [rw] created_timestamp
|
1514
|
+
# The phone number creation timestamp, in ISO 8601 format.
|
1515
|
+
# @return [Time]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] updated_timestamp
|
1518
|
+
# The updated phone number timestamp, in ISO 8601 format.
|
1519
|
+
# @return [Time]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] deletion_timestamp
|
1522
|
+
# The deleted phone number timestamp, in ISO 8601 format.
|
1523
|
+
# @return [Time]
|
1524
|
+
#
|
1525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PhoneNumber AWS API Documentation
|
1526
|
+
#
|
1527
|
+
class PhoneNumber < Struct.new(
|
1528
|
+
:phone_number_id,
|
1529
|
+
:e164_phone_number,
|
1530
|
+
:product_type,
|
1531
|
+
:status,
|
1532
|
+
:capabilities,
|
1533
|
+
:associations,
|
1534
|
+
:created_timestamp,
|
1535
|
+
:updated_timestamp,
|
1536
|
+
:deletion_timestamp)
|
1537
|
+
include Aws::Structure
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
# The phone number associations, such as Amazon Chime account ID, Amazon
|
1541
|
+
# Chime user ID, or Amazon Chime Voice Connector ID.
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] value
|
1544
|
+
# Contains the ID for the entity specified in Name.
|
1545
|
+
# @return [String]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] name
|
1548
|
+
# Defines the association with an Amazon Chime account ID, user ID, or
|
1549
|
+
# Amazon Chime Voice Connector ID.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @!attribute [rw] associated_timestamp
|
1553
|
+
# The timestamp of the phone number association, in ISO 8601 format.
|
1554
|
+
# @return [Time]
|
1555
|
+
#
|
1556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PhoneNumberAssociation AWS API Documentation
|
1557
|
+
#
|
1558
|
+
class PhoneNumberAssociation < Struct.new(
|
1559
|
+
:value,
|
1560
|
+
:name,
|
1561
|
+
:associated_timestamp)
|
1562
|
+
include Aws::Structure
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# The phone number capabilities, such as enabled inbound and outbound
|
1566
|
+
# calling and text messaging.
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] inbound_call
|
1569
|
+
# Allows or denies inbound calling for the specified phone number.
|
1570
|
+
# @return [Boolean]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] outbound_call
|
1573
|
+
# Allows or denies outbound calling for the specified phone number.
|
1574
|
+
# @return [Boolean]
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] inbound_sms
|
1577
|
+
# Allows or denies inbound SMS messaging for the specified phone
|
1578
|
+
# number.
|
1579
|
+
# @return [Boolean]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] outbound_sms
|
1582
|
+
# Allows or denies outbound SMS messaging for the specified phone
|
1583
|
+
# number.
|
1584
|
+
# @return [Boolean]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] inbound_mms
|
1587
|
+
# Allows or denies inbound MMS messaging for the specified phone
|
1588
|
+
# number.
|
1589
|
+
# @return [Boolean]
|
1590
|
+
#
|
1591
|
+
# @!attribute [rw] outbound_mms
|
1592
|
+
# Allows or denies outbound MMS messaging for the specified phone
|
1593
|
+
# number.
|
1594
|
+
# @return [Boolean]
|
1595
|
+
#
|
1596
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PhoneNumberCapabilities AWS API Documentation
|
1597
|
+
#
|
1598
|
+
class PhoneNumberCapabilities < Struct.new(
|
1599
|
+
:inbound_call,
|
1600
|
+
:outbound_call,
|
1601
|
+
:inbound_sms,
|
1602
|
+
:outbound_sms,
|
1603
|
+
:inbound_mms,
|
1604
|
+
:outbound_mms)
|
1605
|
+
include Aws::Structure
|
1606
|
+
end
|
1607
|
+
|
1608
|
+
# If the phone number action fails for one or more of the phone numbers
|
1609
|
+
# in the request, a list of the phone numbers is returned, along with
|
1610
|
+
# error codes and error messages.
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] phone_number_id
|
1613
|
+
# The phone number ID for which the action failed.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] error_code
|
1617
|
+
# The error code.
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] error_message
|
1621
|
+
# The error message.
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PhoneNumberError AWS API Documentation
|
1625
|
+
#
|
1626
|
+
class PhoneNumberError < Struct.new(
|
1627
|
+
:phone_number_id,
|
1628
|
+
:error_code,
|
1629
|
+
:error_message)
|
1630
|
+
include Aws::Structure
|
1631
|
+
end
|
1632
|
+
|
1633
|
+
# The details of a phone number order created for Amazon Chime.
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] phone_number_order_id
|
1636
|
+
# The phone number order ID.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] product_type
|
1640
|
+
# The phone number order product type.
|
1641
|
+
# @return [String]
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] status
|
1644
|
+
# The status of the phone number order.
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] ordered_phone_numbers
|
1648
|
+
# The ordered phone number details, such as the phone number in E.164
|
1649
|
+
# format and the phone number status.
|
1650
|
+
# @return [Array<Types::OrderedPhoneNumber>]
|
1651
|
+
#
|
1652
|
+
# @!attribute [rw] created_timestamp
|
1653
|
+
# The phone number order creation timestamp, in ISO 8601 format.
|
1654
|
+
# @return [Time]
|
1655
|
+
#
|
1656
|
+
# @!attribute [rw] updated_timestamp
|
1657
|
+
# The updated phone number order timestamp, in ISO 8601 format.
|
1658
|
+
# @return [Time]
|
1659
|
+
#
|
1660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PhoneNumberOrder AWS API Documentation
|
1661
|
+
#
|
1662
|
+
class PhoneNumberOrder < Struct.new(
|
1663
|
+
:phone_number_order_id,
|
1664
|
+
:product_type,
|
1665
|
+
:status,
|
1666
|
+
:ordered_phone_numbers,
|
1667
|
+
:created_timestamp,
|
1668
|
+
:updated_timestamp)
|
1669
|
+
include Aws::Structure
|
1670
|
+
end
|
1671
|
+
|
1672
|
+
# @note When making an API call, you may pass PutVoiceConnectorOriginationRequest
|
1673
|
+
# data as a hash:
|
1674
|
+
#
|
1675
|
+
# {
|
1676
|
+
# voice_connector_id: "NonEmptyString", # required
|
1677
|
+
# origination: { # required
|
1678
|
+
# routes: [
|
1679
|
+
# {
|
1680
|
+
# host: "String",
|
1681
|
+
# port: 1,
|
1682
|
+
# protocol: "TCP", # accepts TCP, UDP
|
1683
|
+
# priority: 1,
|
1684
|
+
# weight: 1,
|
1685
|
+
# },
|
1686
|
+
# ],
|
1687
|
+
# disabled: false,
|
1688
|
+
# },
|
1689
|
+
# }
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] voice_connector_id
|
1692
|
+
# The Amazon Chime Voice Connector ID.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] origination
|
1696
|
+
# The origination setting details to add.
|
1697
|
+
# @return [Types::Origination]
|
1698
|
+
#
|
1699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorOriginationRequest AWS API Documentation
|
1700
|
+
#
|
1701
|
+
class PutVoiceConnectorOriginationRequest < Struct.new(
|
1702
|
+
:voice_connector_id,
|
1703
|
+
:origination)
|
1704
|
+
include Aws::Structure
|
1705
|
+
end
|
1706
|
+
|
1707
|
+
# @!attribute [rw] origination
|
1708
|
+
# The updated origination setting details.
|
1709
|
+
# @return [Types::Origination]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorOriginationResponse AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class PutVoiceConnectorOriginationResponse < Struct.new(
|
1714
|
+
:origination)
|
1715
|
+
include Aws::Structure
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
# @note When making an API call, you may pass PutVoiceConnectorTerminationCredentialsRequest
|
1719
|
+
# data as a hash:
|
1720
|
+
#
|
1721
|
+
# {
|
1722
|
+
# voice_connector_id: "NonEmptyString", # required
|
1723
|
+
# credentials: [
|
1724
|
+
# {
|
1725
|
+
# username: "SensitiveString",
|
1726
|
+
# password: "SensitiveString",
|
1727
|
+
# },
|
1728
|
+
# ],
|
1729
|
+
# }
|
1730
|
+
#
|
1731
|
+
# @!attribute [rw] voice_connector_id
|
1732
|
+
# The Amazon Chime Voice Connector ID.
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] credentials
|
1736
|
+
# The termination SIP credentials.
|
1737
|
+
# @return [Array<Types::Credential>]
|
1738
|
+
#
|
1739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorTerminationCredentialsRequest AWS API Documentation
|
1740
|
+
#
|
1741
|
+
class PutVoiceConnectorTerminationCredentialsRequest < Struct.new(
|
1742
|
+
:voice_connector_id,
|
1743
|
+
:credentials)
|
1744
|
+
include Aws::Structure
|
1745
|
+
end
|
1746
|
+
|
1747
|
+
# @note When making an API call, you may pass PutVoiceConnectorTerminationRequest
|
1748
|
+
# data as a hash:
|
1749
|
+
#
|
1750
|
+
# {
|
1751
|
+
# voice_connector_id: "NonEmptyString", # required
|
1752
|
+
# termination: { # required
|
1753
|
+
# cps_limit: 1,
|
1754
|
+
# default_phone_number: "E164PhoneNumber",
|
1755
|
+
# calling_regions: ["CallingRegion"],
|
1756
|
+
# cidr_allowed_list: ["String"],
|
1757
|
+
# disabled: false,
|
1758
|
+
# },
|
1759
|
+
# }
|
1760
|
+
#
|
1761
|
+
# @!attribute [rw] voice_connector_id
|
1762
|
+
# The Amazon Chime Voice Connector ID.
|
1763
|
+
# @return [String]
|
1764
|
+
#
|
1765
|
+
# @!attribute [rw] termination
|
1766
|
+
# The termination setting details to add.
|
1767
|
+
# @return [Types::Termination]
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorTerminationRequest AWS API Documentation
|
1770
|
+
#
|
1771
|
+
class PutVoiceConnectorTerminationRequest < Struct.new(
|
1772
|
+
:voice_connector_id,
|
1773
|
+
:termination)
|
1774
|
+
include Aws::Structure
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# @!attribute [rw] termination
|
1778
|
+
# The updated termination setting details.
|
1779
|
+
# @return [Types::Termination]
|
1780
|
+
#
|
1781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorTerminationResponse AWS API Documentation
|
1782
|
+
#
|
1783
|
+
class PutVoiceConnectorTerminationResponse < Struct.new(
|
1784
|
+
:termination)
|
1785
|
+
include Aws::Structure
|
1786
|
+
end
|
1787
|
+
|
1788
|
+
# @note When making an API call, you may pass ResetPersonalPINRequest
|
1789
|
+
# data as a hash:
|
1790
|
+
#
|
1791
|
+
# {
|
1792
|
+
# account_id: "NonEmptyString", # required
|
1793
|
+
# user_id: "NonEmptyString", # required
|
1794
|
+
# }
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] account_id
|
1797
|
+
# The Amazon Chime account ID.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] user_id
|
1801
|
+
# The user ID.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINRequest AWS API Documentation
|
1805
|
+
#
|
1806
|
+
class ResetPersonalPINRequest < Struct.new(
|
1807
|
+
:account_id,
|
1808
|
+
:user_id)
|
1809
|
+
include Aws::Structure
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
# @!attribute [rw] user
|
1813
|
+
# The user details and new personal meeting PIN.
|
1814
|
+
# @return [Types::User]
|
1815
|
+
#
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ResetPersonalPINResponse AWS API Documentation
|
420
1817
|
#
|
421
|
-
class
|
422
|
-
:
|
1818
|
+
class ResetPersonalPINResponse < Struct.new(
|
1819
|
+
:user)
|
423
1820
|
include Aws::Structure
|
424
1821
|
end
|
425
1822
|
|
426
|
-
# @note When making an API call, you may pass
|
1823
|
+
# @note When making an API call, you may pass RestorePhoneNumberRequest
|
427
1824
|
# data as a hash:
|
428
1825
|
#
|
429
1826
|
# {
|
430
|
-
#
|
431
|
-
# user_email: "EmailAddress",
|
432
|
-
# next_token: "String",
|
433
|
-
# max_results: 1,
|
1827
|
+
# phone_number_id: "NonEmptyString", # required
|
434
1828
|
# }
|
435
1829
|
#
|
436
|
-
# @!attribute [rw]
|
437
|
-
#
|
438
|
-
# @return [String]
|
439
|
-
#
|
440
|
-
# @!attribute [rw] user_email
|
441
|
-
# User email address with which to filter results.
|
442
|
-
# @return [String]
|
443
|
-
#
|
444
|
-
# @!attribute [rw] next_token
|
445
|
-
# The token to use to retrieve the next page of results.
|
1830
|
+
# @!attribute [rw] phone_number_id
|
1831
|
+
# The phone number.
|
446
1832
|
# @return [String]
|
447
1833
|
#
|
448
|
-
#
|
449
|
-
# The maximum number of results to return in a single call. Defaults
|
450
|
-
# to 100.
|
451
|
-
# @return [Integer]
|
452
|
-
#
|
453
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAccountsRequest AWS API Documentation
|
1834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RestorePhoneNumberRequest AWS API Documentation
|
454
1835
|
#
|
455
|
-
class
|
456
|
-
:
|
457
|
-
:user_email,
|
458
|
-
:next_token,
|
459
|
-
:max_results)
|
1836
|
+
class RestorePhoneNumberRequest < Struct.new(
|
1837
|
+
:phone_number_id)
|
460
1838
|
include Aws::Structure
|
461
1839
|
end
|
462
1840
|
|
463
|
-
# @!attribute [rw]
|
464
|
-
#
|
465
|
-
# @return [
|
466
|
-
#
|
467
|
-
# @!attribute [rw] next_token
|
468
|
-
# The token to use to retrieve the next page of results.
|
469
|
-
# @return [String]
|
1841
|
+
# @!attribute [rw] phone_number
|
1842
|
+
# The phone number details.
|
1843
|
+
# @return [Types::PhoneNumber]
|
470
1844
|
#
|
471
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
1845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RestorePhoneNumberResponse AWS API Documentation
|
472
1846
|
#
|
473
|
-
class
|
474
|
-
:
|
475
|
-
:next_token)
|
1847
|
+
class RestorePhoneNumberResponse < Struct.new(
|
1848
|
+
:phone_number)
|
476
1849
|
include Aws::Structure
|
477
1850
|
end
|
478
1851
|
|
479
|
-
# @note When making an API call, you may pass
|
1852
|
+
# @note When making an API call, you may pass SearchAvailablePhoneNumbersRequest
|
480
1853
|
# data as a hash:
|
481
1854
|
#
|
482
1855
|
# {
|
483
|
-
#
|
484
|
-
#
|
1856
|
+
# area_code: "String",
|
1857
|
+
# city: "String",
|
1858
|
+
# country: "String",
|
1859
|
+
# state: "String",
|
485
1860
|
# max_results: 1,
|
486
1861
|
# next_token: "String",
|
487
1862
|
# }
|
488
1863
|
#
|
489
|
-
# @!attribute [rw]
|
490
|
-
# The
|
1864
|
+
# @!attribute [rw] area_code
|
1865
|
+
# The area code used to filter results.
|
491
1866
|
# @return [String]
|
492
1867
|
#
|
493
|
-
# @!attribute [rw]
|
494
|
-
#
|
1868
|
+
# @!attribute [rw] city
|
1869
|
+
# The city used to filter results.
|
1870
|
+
# @return [String]
|
1871
|
+
#
|
1872
|
+
# @!attribute [rw] country
|
1873
|
+
# The country used to filter results.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] state
|
1877
|
+
# The state used to filter results.
|
495
1878
|
# @return [String]
|
496
1879
|
#
|
497
1880
|
# @!attribute [rw] max_results
|
498
|
-
# The maximum number of results to return in a single call.
|
499
|
-
# to 100.
|
1881
|
+
# The maximum number of results to return in a single call.
|
500
1882
|
# @return [Integer]
|
501
1883
|
#
|
502
1884
|
# @!attribute [rw] next_token
|
503
1885
|
# The token to use to retrieve the next page of results.
|
504
1886
|
# @return [String]
|
505
1887
|
#
|
506
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
1888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SearchAvailablePhoneNumbersRequest AWS API Documentation
|
507
1889
|
#
|
508
|
-
class
|
509
|
-
:
|
510
|
-
:
|
1890
|
+
class SearchAvailablePhoneNumbersRequest < Struct.new(
|
1891
|
+
:area_code,
|
1892
|
+
:city,
|
1893
|
+
:country,
|
1894
|
+
:state,
|
511
1895
|
:max_results,
|
512
1896
|
:next_token)
|
513
1897
|
include Aws::Structure
|
514
1898
|
end
|
515
1899
|
|
516
|
-
# @!attribute [rw]
|
517
|
-
# List of
|
518
|
-
# @return [Array<
|
519
|
-
#
|
520
|
-
# @!attribute [rw] next_token
|
521
|
-
# The token to use to retrieve the next page of results.
|
522
|
-
# @return [String]
|
1900
|
+
# @!attribute [rw] e164_phone_numbers
|
1901
|
+
# List of phone numbers, in E.164 format.
|
1902
|
+
# @return [Array<String>]
|
523
1903
|
#
|
524
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
1904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SearchAvailablePhoneNumbersResponse AWS API Documentation
|
525
1905
|
#
|
526
|
-
class
|
527
|
-
:
|
528
|
-
:next_token)
|
1906
|
+
class SearchAvailablePhoneNumbersResponse < Struct.new(
|
1907
|
+
:e164_phone_numbers)
|
529
1908
|
include Aws::Structure
|
530
1909
|
end
|
531
1910
|
|
532
|
-
#
|
1911
|
+
# Settings that allow management of telephony permissions for an Amazon
|
1912
|
+
# Chime user, such as inbound and outbound calling and text messaging.
|
1913
|
+
#
|
1914
|
+
# @note When making an API call, you may pass TelephonySettings
|
533
1915
|
# data as a hash:
|
534
1916
|
#
|
535
1917
|
# {
|
536
|
-
#
|
537
|
-
#
|
1918
|
+
# inbound_calling: false, # required
|
1919
|
+
# outbound_calling: false, # required
|
1920
|
+
# sms: false, # required
|
538
1921
|
# }
|
539
1922
|
#
|
540
|
-
# @!attribute [rw]
|
541
|
-
#
|
542
|
-
# @return [
|
1923
|
+
# @!attribute [rw] inbound_calling
|
1924
|
+
# Allows or denies inbound calling.
|
1925
|
+
# @return [Boolean]
|
543
1926
|
#
|
544
|
-
# @!attribute [rw]
|
545
|
-
#
|
546
|
-
# @return [
|
1927
|
+
# @!attribute [rw] outbound_calling
|
1928
|
+
# Allows or denies outbound calling.
|
1929
|
+
# @return [Boolean]
|
547
1930
|
#
|
548
|
-
#
|
1931
|
+
# @!attribute [rw] sms
|
1932
|
+
# Allows or denies SMS messaging.
|
1933
|
+
# @return [Boolean]
|
549
1934
|
#
|
550
|
-
|
551
|
-
|
552
|
-
|
1935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/TelephonySettings AWS API Documentation
|
1936
|
+
#
|
1937
|
+
class TelephonySettings < Struct.new(
|
1938
|
+
:inbound_calling,
|
1939
|
+
:outbound_calling,
|
1940
|
+
:sms)
|
553
1941
|
include Aws::Structure
|
554
1942
|
end
|
555
1943
|
|
556
|
-
#
|
1944
|
+
# Termination settings enable your SIP hosts to make outbound calls
|
1945
|
+
# using your Amazon Chime Voice Connector.
|
557
1946
|
#
|
558
|
-
|
559
|
-
|
560
|
-
# @note When making an API call, you may pass ResetPersonalPINRequest
|
1947
|
+
# @note When making an API call, you may pass Termination
|
561
1948
|
# data as a hash:
|
562
1949
|
#
|
563
1950
|
# {
|
564
|
-
#
|
565
|
-
#
|
1951
|
+
# cps_limit: 1,
|
1952
|
+
# default_phone_number: "E164PhoneNumber",
|
1953
|
+
# calling_regions: ["CallingRegion"],
|
1954
|
+
# cidr_allowed_list: ["String"],
|
1955
|
+
# disabled: false,
|
566
1956
|
# }
|
567
1957
|
#
|
568
|
-
# @!attribute [rw]
|
569
|
-
# The
|
570
|
-
#
|
1958
|
+
# @!attribute [rw] cps_limit
|
1959
|
+
# The limit on calls per second. Max value based on account service
|
1960
|
+
# limit. Default value of 1.
|
1961
|
+
# @return [Integer]
|
571
1962
|
#
|
572
|
-
# @!attribute [rw]
|
573
|
-
# The
|
1963
|
+
# @!attribute [rw] default_phone_number
|
1964
|
+
# The default caller ID phone number.
|
574
1965
|
# @return [String]
|
575
1966
|
#
|
576
|
-
#
|
1967
|
+
# @!attribute [rw] calling_regions
|
1968
|
+
# The countries to which calls are allowed.
|
1969
|
+
# @return [Array<String>]
|
577
1970
|
#
|
578
|
-
|
579
|
-
|
580
|
-
|
1971
|
+
# @!attribute [rw] cidr_allowed_list
|
1972
|
+
# The IP addresses allowed to make calls, in CIDR format.
|
1973
|
+
# @return [Array<String>]
|
1974
|
+
#
|
1975
|
+
# @!attribute [rw] disabled
|
1976
|
+
# When termination settings are disabled, outbound calls can not be
|
1977
|
+
# made.
|
1978
|
+
# @return [Boolean]
|
1979
|
+
#
|
1980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/Termination AWS API Documentation
|
1981
|
+
#
|
1982
|
+
class Termination < Struct.new(
|
1983
|
+
:cps_limit,
|
1984
|
+
:default_phone_number,
|
1985
|
+
:calling_regions,
|
1986
|
+
:cidr_allowed_list,
|
1987
|
+
:disabled)
|
581
1988
|
include Aws::Structure
|
582
1989
|
end
|
583
1990
|
|
584
|
-
#
|
585
|
-
#
|
586
|
-
#
|
1991
|
+
# The termination health details, including the source IP address and
|
1992
|
+
# timestamp of the last successful SIP `OPTIONS` message from your SIP
|
1993
|
+
# infrastructure.
|
587
1994
|
#
|
588
|
-
#
|
1995
|
+
# @!attribute [rw] timestamp
|
1996
|
+
# The timestamp, in ISO 8601 format.
|
1997
|
+
# @return [Time]
|
589
1998
|
#
|
590
|
-
|
591
|
-
|
1999
|
+
# @!attribute [rw] source
|
2000
|
+
# The source IP address.
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/TerminationHealth AWS API Documentation
|
2004
|
+
#
|
2005
|
+
class TerminationHealth < Struct.new(
|
2006
|
+
:timestamp,
|
2007
|
+
:source)
|
592
2008
|
include Aws::Structure
|
593
2009
|
end
|
594
2010
|
|
@@ -658,6 +2074,96 @@ module Aws::Chime
|
|
658
2074
|
#
|
659
2075
|
class UpdateAccountSettingsResponse < Aws::EmptyStructure; end
|
660
2076
|
|
2077
|
+
# @note When making an API call, you may pass UpdateGlobalSettingsRequest
|
2078
|
+
# data as a hash:
|
2079
|
+
#
|
2080
|
+
# {
|
2081
|
+
# business_calling: { # required
|
2082
|
+
# cdr_bucket: "String",
|
2083
|
+
# },
|
2084
|
+
# voice_connector: { # required
|
2085
|
+
# cdr_bucket: "String",
|
2086
|
+
# },
|
2087
|
+
# }
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] business_calling
|
2090
|
+
# The Amazon Chime Business Calling settings.
|
2091
|
+
# @return [Types::BusinessCallingSettings]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] voice_connector
|
2094
|
+
# The Amazon Chime Voice Connector settings.
|
2095
|
+
# @return [Types::VoiceConnectorSettings]
|
2096
|
+
#
|
2097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateGlobalSettingsRequest AWS API Documentation
|
2098
|
+
#
|
2099
|
+
class UpdateGlobalSettingsRequest < Struct.new(
|
2100
|
+
:business_calling,
|
2101
|
+
:voice_connector)
|
2102
|
+
include Aws::Structure
|
2103
|
+
end
|
2104
|
+
|
2105
|
+
# @note When making an API call, you may pass UpdatePhoneNumberRequest
|
2106
|
+
# data as a hash:
|
2107
|
+
#
|
2108
|
+
# {
|
2109
|
+
# phone_number_id: "String", # required
|
2110
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
2111
|
+
# }
|
2112
|
+
#
|
2113
|
+
# @!attribute [rw] phone_number_id
|
2114
|
+
# The phone number ID.
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] product_type
|
2118
|
+
# The product type.
|
2119
|
+
# @return [String]
|
2120
|
+
#
|
2121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdatePhoneNumberRequest AWS API Documentation
|
2122
|
+
#
|
2123
|
+
class UpdatePhoneNumberRequest < Struct.new(
|
2124
|
+
:phone_number_id,
|
2125
|
+
:product_type)
|
2126
|
+
include Aws::Structure
|
2127
|
+
end
|
2128
|
+
|
2129
|
+
# The phone number ID and product type fields to update, used with the
|
2130
|
+
# BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
|
2131
|
+
#
|
2132
|
+
# @note When making an API call, you may pass UpdatePhoneNumberRequestItem
|
2133
|
+
# data as a hash:
|
2134
|
+
#
|
2135
|
+
# {
|
2136
|
+
# phone_number_id: "NonEmptyString", # required
|
2137
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
2138
|
+
# }
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] phone_number_id
|
2141
|
+
# The phone number ID to update.
|
2142
|
+
# @return [String]
|
2143
|
+
#
|
2144
|
+
# @!attribute [rw] product_type
|
2145
|
+
# The product type to update.
|
2146
|
+
# @return [String]
|
2147
|
+
#
|
2148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdatePhoneNumberRequestItem AWS API Documentation
|
2149
|
+
#
|
2150
|
+
class UpdatePhoneNumberRequestItem < Struct.new(
|
2151
|
+
:phone_number_id,
|
2152
|
+
:product_type)
|
2153
|
+
include Aws::Structure
|
2154
|
+
end
|
2155
|
+
|
2156
|
+
# @!attribute [rw] phone_number
|
2157
|
+
# The updated phone number details.
|
2158
|
+
# @return [Types::PhoneNumber]
|
2159
|
+
#
|
2160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdatePhoneNumberResponse AWS API Documentation
|
2161
|
+
#
|
2162
|
+
class UpdatePhoneNumberResponse < Struct.new(
|
2163
|
+
:phone_number)
|
2164
|
+
include Aws::Structure
|
2165
|
+
end
|
2166
|
+
|
661
2167
|
# @note When making an API call, you may pass UpdateUserRequest
|
662
2168
|
# data as a hash:
|
663
2169
|
#
|
@@ -727,6 +2233,84 @@ module Aws::Chime
|
|
727
2233
|
include Aws::Structure
|
728
2234
|
end
|
729
2235
|
|
2236
|
+
# @note When making an API call, you may pass UpdateUserSettingsRequest
|
2237
|
+
# data as a hash:
|
2238
|
+
#
|
2239
|
+
# {
|
2240
|
+
# account_id: "String", # required
|
2241
|
+
# user_id: "String", # required
|
2242
|
+
# user_settings: { # required
|
2243
|
+
# telephony: { # required
|
2244
|
+
# inbound_calling: false, # required
|
2245
|
+
# outbound_calling: false, # required
|
2246
|
+
# sms: false, # required
|
2247
|
+
# },
|
2248
|
+
# },
|
2249
|
+
# }
|
2250
|
+
#
|
2251
|
+
# @!attribute [rw] account_id
|
2252
|
+
# The Amazon Chime account ID.
|
2253
|
+
# @return [String]
|
2254
|
+
#
|
2255
|
+
# @!attribute [rw] user_id
|
2256
|
+
# The user ID.
|
2257
|
+
# @return [String]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] user_settings
|
2260
|
+
# The user settings to update.
|
2261
|
+
# @return [Types::UserSettings]
|
2262
|
+
#
|
2263
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserSettingsRequest AWS API Documentation
|
2264
|
+
#
|
2265
|
+
class UpdateUserSettingsRequest < Struct.new(
|
2266
|
+
:account_id,
|
2267
|
+
:user_id,
|
2268
|
+
:user_settings)
|
2269
|
+
include Aws::Structure
|
2270
|
+
end
|
2271
|
+
|
2272
|
+
# @note When making an API call, you may pass UpdateVoiceConnectorRequest
|
2273
|
+
# data as a hash:
|
2274
|
+
#
|
2275
|
+
# {
|
2276
|
+
# voice_connector_id: "NonEmptyString", # required
|
2277
|
+
# name: "VoiceConnectorName", # required
|
2278
|
+
# require_encryption: false, # required
|
2279
|
+
# }
|
2280
|
+
#
|
2281
|
+
# @!attribute [rw] voice_connector_id
|
2282
|
+
# The Amazon Chime Voice Connector ID.
|
2283
|
+
# @return [String]
|
2284
|
+
#
|
2285
|
+
# @!attribute [rw] name
|
2286
|
+
# The name of the Amazon Chime Voice Connector.
|
2287
|
+
# @return [String]
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] require_encryption
|
2290
|
+
# When enabled, requires encryption for the Amazon Chime Voice
|
2291
|
+
# Connector.
|
2292
|
+
# @return [Boolean]
|
2293
|
+
#
|
2294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateVoiceConnectorRequest AWS API Documentation
|
2295
|
+
#
|
2296
|
+
class UpdateVoiceConnectorRequest < Struct.new(
|
2297
|
+
:voice_connector_id,
|
2298
|
+
:name,
|
2299
|
+
:require_encryption)
|
2300
|
+
include Aws::Structure
|
2301
|
+
end
|
2302
|
+
|
2303
|
+
# @!attribute [rw] voice_connector
|
2304
|
+
# The Amazon Chime Voice Connector details.
|
2305
|
+
# @return [Types::VoiceConnector]
|
2306
|
+
#
|
2307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateVoiceConnectorResponse AWS API Documentation
|
2308
|
+
#
|
2309
|
+
class UpdateVoiceConnectorResponse < Struct.new(
|
2310
|
+
:voice_connector)
|
2311
|
+
include Aws::Structure
|
2312
|
+
end
|
2313
|
+
|
730
2314
|
# The user on the Amazon Chime account.
|
731
2315
|
#
|
732
2316
|
# @!attribute [rw] user_id
|
@@ -741,6 +2325,10 @@ module Aws::Chime
|
|
741
2325
|
# The primary email address of the user.
|
742
2326
|
# @return [String]
|
743
2327
|
#
|
2328
|
+
# @!attribute [rw] primary_provisioned_number
|
2329
|
+
# The primary phone number associated with the user.
|
2330
|
+
# @return [String]
|
2331
|
+
#
|
744
2332
|
# @!attribute [rw] display_name
|
745
2333
|
# The display name of the user.
|
746
2334
|
# @return [String]
|
@@ -776,6 +2364,7 @@ module Aws::Chime
|
|
776
2364
|
:user_id,
|
777
2365
|
:account_id,
|
778
2366
|
:primary_email,
|
2367
|
+
:primary_provisioned_number,
|
779
2368
|
:display_name,
|
780
2369
|
:license_type,
|
781
2370
|
:user_registration_status,
|
@@ -811,5 +2400,93 @@ module Aws::Chime
|
|
811
2400
|
include Aws::Structure
|
812
2401
|
end
|
813
2402
|
|
2403
|
+
# Settings associated with an Amazon Chime user, including inbound and
|
2404
|
+
# outbound calling and text messaging.
|
2405
|
+
#
|
2406
|
+
# @note When making an API call, you may pass UserSettings
|
2407
|
+
# data as a hash:
|
2408
|
+
#
|
2409
|
+
# {
|
2410
|
+
# telephony: { # required
|
2411
|
+
# inbound_calling: false, # required
|
2412
|
+
# outbound_calling: false, # required
|
2413
|
+
# sms: false, # required
|
2414
|
+
# },
|
2415
|
+
# }
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] telephony
|
2418
|
+
# The telephony settings associated with the user.
|
2419
|
+
# @return [Types::TelephonySettings]
|
2420
|
+
#
|
2421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UserSettings AWS API Documentation
|
2422
|
+
#
|
2423
|
+
class UserSettings < Struct.new(
|
2424
|
+
:telephony)
|
2425
|
+
include Aws::Structure
|
2426
|
+
end
|
2427
|
+
|
2428
|
+
# The Amazon Chime Voice Connector configuration, including outbound
|
2429
|
+
# host name and encryption settings.
|
2430
|
+
#
|
2431
|
+
# @!attribute [rw] voice_connector_id
|
2432
|
+
# The Amazon Chime Voice Connector ID.
|
2433
|
+
# @return [String]
|
2434
|
+
#
|
2435
|
+
# @!attribute [rw] name
|
2436
|
+
# The name of the Amazon Chime Voice Connector.
|
2437
|
+
# @return [String]
|
2438
|
+
#
|
2439
|
+
# @!attribute [rw] outbound_host_name
|
2440
|
+
# The outbound host name for the Amazon Chime Voice Connector.
|
2441
|
+
# @return [String]
|
2442
|
+
#
|
2443
|
+
# @!attribute [rw] require_encryption
|
2444
|
+
# Designates whether encryption is required for the Amazon Chime Voice
|
2445
|
+
# Connector.
|
2446
|
+
# @return [Boolean]
|
2447
|
+
#
|
2448
|
+
# @!attribute [rw] created_timestamp
|
2449
|
+
# The Amazon Chime Voice Connector creation timestamp, in ISO 8601
|
2450
|
+
# format.
|
2451
|
+
# @return [Time]
|
2452
|
+
#
|
2453
|
+
# @!attribute [rw] updated_timestamp
|
2454
|
+
# The updated Amazon Chime Voice Connector timestamp, in ISO 8601
|
2455
|
+
# format.
|
2456
|
+
# @return [Time]
|
2457
|
+
#
|
2458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/VoiceConnector AWS API Documentation
|
2459
|
+
#
|
2460
|
+
class VoiceConnector < Struct.new(
|
2461
|
+
:voice_connector_id,
|
2462
|
+
:name,
|
2463
|
+
:outbound_host_name,
|
2464
|
+
:require_encryption,
|
2465
|
+
:created_timestamp,
|
2466
|
+
:updated_timestamp)
|
2467
|
+
include Aws::Structure
|
2468
|
+
end
|
2469
|
+
|
2470
|
+
# The Amazon Chime Voice Connector settings. Includes any Amazon S3
|
2471
|
+
# buckets designated for storing call detail records.
|
2472
|
+
#
|
2473
|
+
# @note When making an API call, you may pass VoiceConnectorSettings
|
2474
|
+
# data as a hash:
|
2475
|
+
#
|
2476
|
+
# {
|
2477
|
+
# cdr_bucket: "String",
|
2478
|
+
# }
|
2479
|
+
#
|
2480
|
+
# @!attribute [rw] cdr_bucket
|
2481
|
+
# The Amazon S3 bucket designated for call detail record storage.
|
2482
|
+
# @return [String]
|
2483
|
+
#
|
2484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/VoiceConnectorSettings AWS API Documentation
|
2485
|
+
#
|
2486
|
+
class VoiceConnectorSettings < Struct.new(
|
2487
|
+
:cdr_bucket)
|
2488
|
+
include Aws::Structure
|
2489
|
+
end
|
2490
|
+
|
814
2491
|
end
|
815
2492
|
end
|