aws-sdk-chime 1.4.0 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0403b25932ddcfb977a831d01ebe18b353242890
|
4
|
+
data.tar.gz: f50cfede88990e4fd723b1500266a546139ffcee
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d5456a5687a2432732b8886f5aab40988ff16d9736f1f1170c1824d51556e6c9e347772631acf198152baadce473361dc0bdf5e9d9364bf6953fdbdcdd93d72d
|
7
|
+
data.tar.gz: 266d4a7b028345268f49f7abe0412ac8f1041f996a2940b45366ebd770770208b42698c9623cf328eb8d754b57b4fa5886d3122be29aaa9230c92d8cc09c2a90
|
data/lib/aws-sdk-chime.rb
CHANGED
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -205,6 +205,108 @@ module Aws::Chime
|
|
205
205
|
|
206
206
|
# @!group API Operations
|
207
207
|
|
208
|
+
# Associates a phone number with the specified Amazon Chime user.
|
209
|
+
#
|
210
|
+
# @option params [required, String] :account_id
|
211
|
+
# The Amazon Chime account ID.
|
212
|
+
#
|
213
|
+
# @option params [required, String] :user_id
|
214
|
+
# The user ID.
|
215
|
+
#
|
216
|
+
# @option params [required, String] :e164_phone_number
|
217
|
+
# The phone number, in E.164 format.
|
218
|
+
#
|
219
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
220
|
+
#
|
221
|
+
# @example Request syntax with placeholder values
|
222
|
+
#
|
223
|
+
# resp = client.associate_phone_number_with_user({
|
224
|
+
# account_id: "String", # required
|
225
|
+
# user_id: "String", # required
|
226
|
+
# e164_phone_number: "E164PhoneNumber", # required
|
227
|
+
# })
|
228
|
+
#
|
229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumberWithUser AWS API Documentation
|
230
|
+
#
|
231
|
+
# @overload associate_phone_number_with_user(params = {})
|
232
|
+
# @param [Hash] params ({})
|
233
|
+
def associate_phone_number_with_user(params = {}, options = {})
|
234
|
+
req = build_request(:associate_phone_number_with_user, params)
|
235
|
+
req.send_request(options)
|
236
|
+
end
|
237
|
+
|
238
|
+
# Associates a phone number with the specified Amazon Chime Voice
|
239
|
+
# Connector.
|
240
|
+
#
|
241
|
+
# @option params [required, String] :voice_connector_id
|
242
|
+
# The Amazon Chime Voice Connector ID.
|
243
|
+
#
|
244
|
+
# @option params [Array<String>] :e164_phone_numbers
|
245
|
+
# List of phone numbers, in E.164 format.
|
246
|
+
#
|
247
|
+
# @return [Types::AssociatePhoneNumbersWithVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
248
|
+
#
|
249
|
+
# * {Types::AssociatePhoneNumbersWithVoiceConnectorResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
250
|
+
#
|
251
|
+
# @example Request syntax with placeholder values
|
252
|
+
#
|
253
|
+
# resp = client.associate_phone_numbers_with_voice_connector({
|
254
|
+
# voice_connector_id: "NonEmptyString", # required
|
255
|
+
# e164_phone_numbers: ["E164PhoneNumber"],
|
256
|
+
# })
|
257
|
+
#
|
258
|
+
# @example Response structure
|
259
|
+
#
|
260
|
+
# resp.phone_number_errors #=> Array
|
261
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
262
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
263
|
+
# resp.phone_number_errors[0].error_message #=> String
|
264
|
+
#
|
265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/AssociatePhoneNumbersWithVoiceConnector AWS API Documentation
|
266
|
+
#
|
267
|
+
# @overload associate_phone_numbers_with_voice_connector(params = {})
|
268
|
+
# @param [Hash] params ({})
|
269
|
+
def associate_phone_numbers_with_voice_connector(params = {}, options = {})
|
270
|
+
req = build_request(:associate_phone_numbers_with_voice_connector, params)
|
271
|
+
req.send_request(options)
|
272
|
+
end
|
273
|
+
|
274
|
+
# Moves phone numbers into the **Deletion queue**. Phone numbers must be
|
275
|
+
# disassociated from any users or Amazon Chime Voice Connectors before
|
276
|
+
# they can be deleted.
|
277
|
+
#
|
278
|
+
# Phone numbers remain in the **Deletion queue** for 7 days before they
|
279
|
+
# are deleted permanently.
|
280
|
+
#
|
281
|
+
# @option params [required, Array<String>] :phone_number_ids
|
282
|
+
# List of phone number IDs.
|
283
|
+
#
|
284
|
+
# @return [Types::BatchDeletePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
285
|
+
#
|
286
|
+
# * {Types::BatchDeletePhoneNumberResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
287
|
+
#
|
288
|
+
# @example Request syntax with placeholder values
|
289
|
+
#
|
290
|
+
# resp = client.batch_delete_phone_number({
|
291
|
+
# phone_number_ids: ["String"], # required
|
292
|
+
# })
|
293
|
+
#
|
294
|
+
# @example Response structure
|
295
|
+
#
|
296
|
+
# resp.phone_number_errors #=> Array
|
297
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
298
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
299
|
+
# resp.phone_number_errors[0].error_message #=> String
|
300
|
+
#
|
301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchDeletePhoneNumber AWS API Documentation
|
302
|
+
#
|
303
|
+
# @overload batch_delete_phone_number(params = {})
|
304
|
+
# @param [Hash] params ({})
|
305
|
+
def batch_delete_phone_number(params = {}, options = {})
|
306
|
+
req = build_request(:batch_delete_phone_number, params)
|
307
|
+
req.send_request(options)
|
308
|
+
end
|
309
|
+
|
208
310
|
# Suspends up to 50 users from a `Team` or `EnterpriseLWA` Amazon Chime
|
209
311
|
# account. For more information about different account types, see
|
210
312
|
# [Managing Your Amazon Chime Accounts][1] in the *Amazon Chime
|
@@ -217,7 +319,7 @@ module Aws::Chime
|
|
217
319
|
# so.
|
218
320
|
#
|
219
321
|
# Users suspended from an `EnterpriseLWA` account are immediately signed
|
220
|
-
# out of Amazon Chime and
|
322
|
+
# out of Amazon Chime and can no longer sign in. To remove the
|
221
323
|
# suspension from suspended `EnterpriseLWA` account users, use the
|
222
324
|
# BatchUnsuspendUser action.
|
223
325
|
#
|
@@ -307,6 +409,44 @@ module Aws::Chime
|
|
307
409
|
req.send_request(options)
|
308
410
|
end
|
309
411
|
|
412
|
+
# Updates phone number product types. Choose from Amazon Chime Business
|
413
|
+
# Calling and Amazon Chime Voice Connector product types.
|
414
|
+
#
|
415
|
+
# @option params [required, Array<Types::UpdatePhoneNumberRequestItem>] :update_phone_number_request_items
|
416
|
+
# The request containing the phone number IDs and product types to
|
417
|
+
# update.
|
418
|
+
#
|
419
|
+
# @return [Types::BatchUpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
420
|
+
#
|
421
|
+
# * {Types::BatchUpdatePhoneNumberResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
422
|
+
#
|
423
|
+
# @example Request syntax with placeholder values
|
424
|
+
#
|
425
|
+
# resp = client.batch_update_phone_number({
|
426
|
+
# update_phone_number_request_items: [ # required
|
427
|
+
# {
|
428
|
+
# phone_number_id: "NonEmptyString", # required
|
429
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
430
|
+
# },
|
431
|
+
# ],
|
432
|
+
# })
|
433
|
+
#
|
434
|
+
# @example Response structure
|
435
|
+
#
|
436
|
+
# resp.phone_number_errors #=> Array
|
437
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
438
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
439
|
+
# resp.phone_number_errors[0].error_message #=> String
|
440
|
+
#
|
441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/BatchUpdatePhoneNumber AWS API Documentation
|
442
|
+
#
|
443
|
+
# @overload batch_update_phone_number(params = {})
|
444
|
+
# @param [Hash] params ({})
|
445
|
+
def batch_update_phone_number(params = {}, options = {})
|
446
|
+
req = build_request(:batch_update_phone_number, params)
|
447
|
+
req.send_request(options)
|
448
|
+
end
|
449
|
+
|
310
450
|
# Updates user details within the UpdateUserRequestItem object for up to
|
311
451
|
# 20 users for the specified Amazon Chime account. Currently, only
|
312
452
|
# `LicenseType` updates are supported for this action.
|
@@ -392,6 +532,89 @@ module Aws::Chime
|
|
392
532
|
req.send_request(options)
|
393
533
|
end
|
394
534
|
|
535
|
+
# Creates an order for phone numbers to be provisioned. Choose from
|
536
|
+
# Amazon Chime Business Calling and Amazon Chime Voice Connector product
|
537
|
+
# types.
|
538
|
+
#
|
539
|
+
# @option params [required, String] :product_type
|
540
|
+
# The phone number product type.
|
541
|
+
#
|
542
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
543
|
+
# List of phone numbers, in E.164 format.
|
544
|
+
#
|
545
|
+
# @return [Types::CreatePhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
546
|
+
#
|
547
|
+
# * {Types::CreatePhoneNumberOrderResponse#phone_number_order #phone_number_order} => Types::PhoneNumberOrder
|
548
|
+
#
|
549
|
+
# @example Request syntax with placeholder values
|
550
|
+
#
|
551
|
+
# resp = client.create_phone_number_order({
|
552
|
+
# product_type: "BusinessCalling", # required, accepts BusinessCalling, VoiceConnector
|
553
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
554
|
+
# })
|
555
|
+
#
|
556
|
+
# @example Response structure
|
557
|
+
#
|
558
|
+
# resp.phone_number_order.phone_number_order_id #=> String
|
559
|
+
# resp.phone_number_order.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
560
|
+
# resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial"
|
561
|
+
# resp.phone_number_order.ordered_phone_numbers #=> Array
|
562
|
+
# resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
|
563
|
+
# resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
564
|
+
# resp.phone_number_order.created_timestamp #=> Time
|
565
|
+
# resp.phone_number_order.updated_timestamp #=> Time
|
566
|
+
#
|
567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreatePhoneNumberOrder AWS API Documentation
|
568
|
+
#
|
569
|
+
# @overload create_phone_number_order(params = {})
|
570
|
+
# @param [Hash] params ({})
|
571
|
+
def create_phone_number_order(params = {}, options = {})
|
572
|
+
req = build_request(:create_phone_number_order, params)
|
573
|
+
req.send_request(options)
|
574
|
+
end
|
575
|
+
|
576
|
+
# Creates an Amazon Chime Voice Connector under the administrator's AWS
|
577
|
+
# account. Enabling CreateVoiceConnectorRequest$RequireEncryption
|
578
|
+
# configures your Amazon Chime Voice Connector to use TLS transport for
|
579
|
+
# SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS
|
580
|
+
# transport, and unencrypted outbound calls are blocked.
|
581
|
+
#
|
582
|
+
# @option params [required, String] :name
|
583
|
+
# The name of the Amazon Chime Voice Connector.
|
584
|
+
#
|
585
|
+
# @option params [required, Boolean] :require_encryption
|
586
|
+
# When enabled, requires encryption for the Amazon Chime Voice
|
587
|
+
# Connector.
|
588
|
+
#
|
589
|
+
# @return [Types::CreateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
590
|
+
#
|
591
|
+
# * {Types::CreateVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
592
|
+
#
|
593
|
+
# @example Request syntax with placeholder values
|
594
|
+
#
|
595
|
+
# resp = client.create_voice_connector({
|
596
|
+
# name: "VoiceConnectorName", # required
|
597
|
+
# require_encryption: false, # required
|
598
|
+
# })
|
599
|
+
#
|
600
|
+
# @example Response structure
|
601
|
+
#
|
602
|
+
# resp.voice_connector.voice_connector_id #=> String
|
603
|
+
# resp.voice_connector.name #=> String
|
604
|
+
# resp.voice_connector.outbound_host_name #=> String
|
605
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
606
|
+
# resp.voice_connector.created_timestamp #=> Time
|
607
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
608
|
+
#
|
609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateVoiceConnector AWS API Documentation
|
610
|
+
#
|
611
|
+
# @overload create_voice_connector(params = {})
|
612
|
+
# @param [Hash] params ({})
|
613
|
+
def create_voice_connector(params = {}, options = {})
|
614
|
+
req = build_request(:create_voice_connector, params)
|
615
|
+
req.send_request(options)
|
616
|
+
end
|
617
|
+
|
395
618
|
# Deletes the specified Amazon Chime account. You must suspend all users
|
396
619
|
# before deleting a `Team` account. You can use the BatchSuspendUser
|
397
620
|
# action to do so.
|
@@ -427,6 +650,194 @@ module Aws::Chime
|
|
427
650
|
req.send_request(options)
|
428
651
|
end
|
429
652
|
|
653
|
+
# Moves the specified phone number into the **Deletion queue**. A phone
|
654
|
+
# number must be disassociated from any users or Amazon Chime Voice
|
655
|
+
# Connectors before it can be deleted.
|
656
|
+
#
|
657
|
+
# Deleted phone numbers remain in the **Deletion queue** for 7 days
|
658
|
+
# before they are deleted permanently.
|
659
|
+
#
|
660
|
+
# @option params [required, String] :phone_number_id
|
661
|
+
# The phone number ID.
|
662
|
+
#
|
663
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
664
|
+
#
|
665
|
+
# @example Request syntax with placeholder values
|
666
|
+
#
|
667
|
+
# resp = client.delete_phone_number({
|
668
|
+
# phone_number_id: "String", # required
|
669
|
+
# })
|
670
|
+
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeletePhoneNumber AWS API Documentation
|
672
|
+
#
|
673
|
+
# @overload delete_phone_number(params = {})
|
674
|
+
# @param [Hash] params ({})
|
675
|
+
def delete_phone_number(params = {}, options = {})
|
676
|
+
req = build_request(:delete_phone_number, params)
|
677
|
+
req.send_request(options)
|
678
|
+
end
|
679
|
+
|
680
|
+
# Deletes the specified Amazon Chime Voice Connector. Any phone numbers
|
681
|
+
# assigned to the Amazon Chime Voice Connector must be unassigned from
|
682
|
+
# it before it can be deleted.
|
683
|
+
#
|
684
|
+
# @option params [required, String] :voice_connector_id
|
685
|
+
# The Amazon Chime Voice Connector ID.
|
686
|
+
#
|
687
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
688
|
+
#
|
689
|
+
# @example Request syntax with placeholder values
|
690
|
+
#
|
691
|
+
# resp = client.delete_voice_connector({
|
692
|
+
# voice_connector_id: "NonEmptyString", # required
|
693
|
+
# })
|
694
|
+
#
|
695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnector AWS API Documentation
|
696
|
+
#
|
697
|
+
# @overload delete_voice_connector(params = {})
|
698
|
+
# @param [Hash] params ({})
|
699
|
+
def delete_voice_connector(params = {}, options = {})
|
700
|
+
req = build_request(:delete_voice_connector, params)
|
701
|
+
req.send_request(options)
|
702
|
+
end
|
703
|
+
|
704
|
+
# Deletes the origination settings for the specified Amazon Chime Voice
|
705
|
+
# Connector.
|
706
|
+
#
|
707
|
+
# @option params [required, String] :voice_connector_id
|
708
|
+
# The Amazon Chime Voice Connector ID.
|
709
|
+
#
|
710
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
711
|
+
#
|
712
|
+
# @example Request syntax with placeholder values
|
713
|
+
#
|
714
|
+
# resp = client.delete_voice_connector_origination({
|
715
|
+
# voice_connector_id: "NonEmptyString", # required
|
716
|
+
# })
|
717
|
+
#
|
718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorOrigination AWS API Documentation
|
719
|
+
#
|
720
|
+
# @overload delete_voice_connector_origination(params = {})
|
721
|
+
# @param [Hash] params ({})
|
722
|
+
def delete_voice_connector_origination(params = {}, options = {})
|
723
|
+
req = build_request(:delete_voice_connector_origination, params)
|
724
|
+
req.send_request(options)
|
725
|
+
end
|
726
|
+
|
727
|
+
# Deletes the termination settings for the specified Amazon Chime Voice
|
728
|
+
# Connector.
|
729
|
+
#
|
730
|
+
# @option params [required, String] :voice_connector_id
|
731
|
+
# The Amazon Chime Voice Connector ID.
|
732
|
+
#
|
733
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
734
|
+
#
|
735
|
+
# @example Request syntax with placeholder values
|
736
|
+
#
|
737
|
+
# resp = client.delete_voice_connector_termination({
|
738
|
+
# voice_connector_id: "NonEmptyString", # required
|
739
|
+
# })
|
740
|
+
#
|
741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorTermination AWS API Documentation
|
742
|
+
#
|
743
|
+
# @overload delete_voice_connector_termination(params = {})
|
744
|
+
# @param [Hash] params ({})
|
745
|
+
def delete_voice_connector_termination(params = {}, options = {})
|
746
|
+
req = build_request(:delete_voice_connector_termination, params)
|
747
|
+
req.send_request(options)
|
748
|
+
end
|
749
|
+
|
750
|
+
# Deletes the specified SIP credentials used by your equipment to
|
751
|
+
# authenticate during call termination.
|
752
|
+
#
|
753
|
+
# @option params [required, String] :voice_connector_id
|
754
|
+
# The Amazon Chime Voice Connector ID.
|
755
|
+
#
|
756
|
+
# @option params [Array<String>] :usernames
|
757
|
+
# The RFC2617 compliant username associated with the SIP credentials, in
|
758
|
+
# US-ASCII format.
|
759
|
+
#
|
760
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
761
|
+
#
|
762
|
+
# @example Request syntax with placeholder values
|
763
|
+
#
|
764
|
+
# resp = client.delete_voice_connector_termination_credentials({
|
765
|
+
# voice_connector_id: "NonEmptyString", # required
|
766
|
+
# usernames: ["SensitiveString"],
|
767
|
+
# })
|
768
|
+
#
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteVoiceConnectorTerminationCredentials AWS API Documentation
|
770
|
+
#
|
771
|
+
# @overload delete_voice_connector_termination_credentials(params = {})
|
772
|
+
# @param [Hash] params ({})
|
773
|
+
def delete_voice_connector_termination_credentials(params = {}, options = {})
|
774
|
+
req = build_request(:delete_voice_connector_termination_credentials, params)
|
775
|
+
req.send_request(options)
|
776
|
+
end
|
777
|
+
|
778
|
+
# Disassociates the primary provisioned phone number from the specified
|
779
|
+
# Amazon Chime user.
|
780
|
+
#
|
781
|
+
# @option params [required, String] :account_id
|
782
|
+
# The Amazon Chime account ID.
|
783
|
+
#
|
784
|
+
# @option params [required, String] :user_id
|
785
|
+
# The user ID.
|
786
|
+
#
|
787
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
788
|
+
#
|
789
|
+
# @example Request syntax with placeholder values
|
790
|
+
#
|
791
|
+
# resp = client.disassociate_phone_number_from_user({
|
792
|
+
# account_id: "String", # required
|
793
|
+
# user_id: "String", # required
|
794
|
+
# })
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumberFromUser AWS API Documentation
|
797
|
+
#
|
798
|
+
# @overload disassociate_phone_number_from_user(params = {})
|
799
|
+
# @param [Hash] params ({})
|
800
|
+
def disassociate_phone_number_from_user(params = {}, options = {})
|
801
|
+
req = build_request(:disassociate_phone_number_from_user, params)
|
802
|
+
req.send_request(options)
|
803
|
+
end
|
804
|
+
|
805
|
+
# Disassociates the specified phone number from the specified Amazon
|
806
|
+
# Chime Voice Connector.
|
807
|
+
#
|
808
|
+
# @option params [required, String] :voice_connector_id
|
809
|
+
# The Amazon Chime Voice Connector ID.
|
810
|
+
#
|
811
|
+
# @option params [Array<String>] :e164_phone_numbers
|
812
|
+
# List of phone numbers, in E.164 format.
|
813
|
+
#
|
814
|
+
# @return [Types::DisassociatePhoneNumbersFromVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
|
+
#
|
816
|
+
# * {Types::DisassociatePhoneNumbersFromVoiceConnectorResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
817
|
+
#
|
818
|
+
# @example Request syntax with placeholder values
|
819
|
+
#
|
820
|
+
# resp = client.disassociate_phone_numbers_from_voice_connector({
|
821
|
+
# voice_connector_id: "NonEmptyString", # required
|
822
|
+
# e164_phone_numbers: ["E164PhoneNumber"],
|
823
|
+
# })
|
824
|
+
#
|
825
|
+
# @example Response structure
|
826
|
+
#
|
827
|
+
# resp.phone_number_errors #=> Array
|
828
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
829
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "Unauthorized", "Forbidden", "NotFound", "BadRequest", "Conflict", "ServiceFailure", "ServiceUnavailable", "Unprocessable", "Throttled", "PreconditionFailed"
|
830
|
+
# resp.phone_number_errors[0].error_message #=> String
|
831
|
+
#
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DisassociatePhoneNumbersFromVoiceConnector AWS API Documentation
|
833
|
+
#
|
834
|
+
# @overload disassociate_phone_numbers_from_voice_connector(params = {})
|
835
|
+
# @param [Hash] params ({})
|
836
|
+
def disassociate_phone_numbers_from_voice_connector(params = {}, options = {})
|
837
|
+
req = build_request(:disassociate_phone_numbers_from_voice_connector, params)
|
838
|
+
req.send_request(options)
|
839
|
+
end
|
840
|
+
|
430
841
|
# Retrieves details for the specified Amazon Chime account, such as
|
431
842
|
# account type and supported licenses.
|
432
843
|
#
|
@@ -499,6 +910,111 @@ module Aws::Chime
|
|
499
910
|
req.send_request(options)
|
500
911
|
end
|
501
912
|
|
913
|
+
# Retrieves global settings for the administrator's AWS account, such
|
914
|
+
# as Amazon Chime Business Calling and Amazon Chime Voice Connector
|
915
|
+
# settings.
|
916
|
+
#
|
917
|
+
# @return [Types::GetGlobalSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
918
|
+
#
|
919
|
+
# * {Types::GetGlobalSettingsResponse#business_calling #business_calling} => Types::BusinessCallingSettings
|
920
|
+
# * {Types::GetGlobalSettingsResponse#voice_connector #voice_connector} => Types::VoiceConnectorSettings
|
921
|
+
#
|
922
|
+
# @example Response structure
|
923
|
+
#
|
924
|
+
# resp.business_calling.cdr_bucket #=> String
|
925
|
+
# resp.voice_connector.cdr_bucket #=> String
|
926
|
+
#
|
927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetGlobalSettings AWS API Documentation
|
928
|
+
#
|
929
|
+
# @overload get_global_settings(params = {})
|
930
|
+
# @param [Hash] params ({})
|
931
|
+
def get_global_settings(params = {}, options = {})
|
932
|
+
req = build_request(:get_global_settings, params)
|
933
|
+
req.send_request(options)
|
934
|
+
end
|
935
|
+
|
936
|
+
# Retrieves details for the specified phone number ID, such as
|
937
|
+
# associations, capabilities, and product type.
|
938
|
+
#
|
939
|
+
# @option params [required, String] :phone_number_id
|
940
|
+
# The phone number ID.
|
941
|
+
#
|
942
|
+
# @return [Types::GetPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
943
|
+
#
|
944
|
+
# * {Types::GetPhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
945
|
+
#
|
946
|
+
# @example Request syntax with placeholder values
|
947
|
+
#
|
948
|
+
# resp = client.get_phone_number({
|
949
|
+
# phone_number_id: "String", # required
|
950
|
+
# })
|
951
|
+
#
|
952
|
+
# @example Response structure
|
953
|
+
#
|
954
|
+
# resp.phone_number.phone_number_id #=> String
|
955
|
+
# resp.phone_number.e164_phone_number #=> String
|
956
|
+
# resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
957
|
+
# resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
958
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
959
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
960
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
961
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
962
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
963
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
964
|
+
# resp.phone_number.associations #=> Array
|
965
|
+
# resp.phone_number.associations[0].value #=> String
|
966
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId"
|
967
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
968
|
+
# resp.phone_number.created_timestamp #=> Time
|
969
|
+
# resp.phone_number.updated_timestamp #=> Time
|
970
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
971
|
+
#
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumber AWS API Documentation
|
973
|
+
#
|
974
|
+
# @overload get_phone_number(params = {})
|
975
|
+
# @param [Hash] params ({})
|
976
|
+
def get_phone_number(params = {}, options = {})
|
977
|
+
req = build_request(:get_phone_number, params)
|
978
|
+
req.send_request(options)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Retrieves details for the specified phone number order, such as order
|
982
|
+
# creation timestamp, phone numbers in E.164 format, product type, and
|
983
|
+
# order status.
|
984
|
+
#
|
985
|
+
# @option params [required, String] :phone_number_order_id
|
986
|
+
# The ID for the phone number order.
|
987
|
+
#
|
988
|
+
# @return [Types::GetPhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
989
|
+
#
|
990
|
+
# * {Types::GetPhoneNumberOrderResponse#phone_number_order #phone_number_order} => Types::PhoneNumberOrder
|
991
|
+
#
|
992
|
+
# @example Request syntax with placeholder values
|
993
|
+
#
|
994
|
+
# resp = client.get_phone_number_order({
|
995
|
+
# phone_number_order_id: "GuidString", # required
|
996
|
+
# })
|
997
|
+
#
|
998
|
+
# @example Response structure
|
999
|
+
#
|
1000
|
+
# resp.phone_number_order.phone_number_order_id #=> String
|
1001
|
+
# resp.phone_number_order.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
1002
|
+
# resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial"
|
1003
|
+
# resp.phone_number_order.ordered_phone_numbers #=> Array
|
1004
|
+
# resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
|
1005
|
+
# resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
1006
|
+
# resp.phone_number_order.created_timestamp #=> Time
|
1007
|
+
# resp.phone_number_order.updated_timestamp #=> Time
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetPhoneNumberOrder AWS API Documentation
|
1010
|
+
#
|
1011
|
+
# @overload get_phone_number_order(params = {})
|
1012
|
+
# @param [Hash] params ({})
|
1013
|
+
def get_phone_number_order(params = {}, options = {})
|
1014
|
+
req = build_request(:get_phone_number_order, params)
|
1015
|
+
req.send_request(options)
|
1016
|
+
end
|
1017
|
+
|
502
1018
|
# Retrieves details for the specified user ID, such as primary email
|
503
1019
|
# address, license type, and personal meeting PIN.
|
504
1020
|
#
|
@@ -527,6 +1043,7 @@ module Aws::Chime
|
|
527
1043
|
# resp.user.user_id #=> String
|
528
1044
|
# resp.user.account_id #=> String
|
529
1045
|
# resp.user.primary_email #=> String
|
1046
|
+
# resp.user.primary_provisioned_number #=> String
|
530
1047
|
# resp.user.display_name #=> String
|
531
1048
|
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
532
1049
|
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
@@ -537,10 +1054,180 @@ module Aws::Chime
|
|
537
1054
|
#
|
538
1055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUser AWS API Documentation
|
539
1056
|
#
|
540
|
-
# @overload get_user(params = {})
|
1057
|
+
# @overload get_user(params = {})
|
1058
|
+
# @param [Hash] params ({})
|
1059
|
+
def get_user(params = {}, options = {})
|
1060
|
+
req = build_request(:get_user, params)
|
1061
|
+
req.send_request(options)
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Retrieves settings for the specified user ID, such as any associated
|
1065
|
+
# phone number settings.
|
1066
|
+
#
|
1067
|
+
# @option params [required, String] :account_id
|
1068
|
+
# The Amazon Chime account ID.
|
1069
|
+
#
|
1070
|
+
# @option params [required, String] :user_id
|
1071
|
+
# The user ID.
|
1072
|
+
#
|
1073
|
+
# @return [Types::GetUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1074
|
+
#
|
1075
|
+
# * {Types::GetUserSettingsResponse#user_settings #user_settings} => Types::UserSettings
|
1076
|
+
#
|
1077
|
+
# @example Request syntax with placeholder values
|
1078
|
+
#
|
1079
|
+
# resp = client.get_user_settings({
|
1080
|
+
# account_id: "String", # required
|
1081
|
+
# user_id: "String", # required
|
1082
|
+
# })
|
1083
|
+
#
|
1084
|
+
# @example Response structure
|
1085
|
+
#
|
1086
|
+
# resp.user_settings.telephony.inbound_calling #=> Boolean
|
1087
|
+
# resp.user_settings.telephony.outbound_calling #=> Boolean
|
1088
|
+
# resp.user_settings.telephony.sms #=> Boolean
|
1089
|
+
#
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetUserSettings AWS API Documentation
|
1091
|
+
#
|
1092
|
+
# @overload get_user_settings(params = {})
|
1093
|
+
# @param [Hash] params ({})
|
1094
|
+
def get_user_settings(params = {}, options = {})
|
1095
|
+
req = build_request(:get_user_settings, params)
|
1096
|
+
req.send_request(options)
|
1097
|
+
end
|
1098
|
+
|
1099
|
+
# Retrieves details for the specified Amazon Chime Voice Connector, such
|
1100
|
+
# as timestamps, name, outbound host, and encryption requirements.
|
1101
|
+
#
|
1102
|
+
# @option params [required, String] :voice_connector_id
|
1103
|
+
# The Amazon Chime Voice Connector ID.
|
1104
|
+
#
|
1105
|
+
# @return [Types::GetVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1106
|
+
#
|
1107
|
+
# * {Types::GetVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
1108
|
+
#
|
1109
|
+
# @example Request syntax with placeholder values
|
1110
|
+
#
|
1111
|
+
# resp = client.get_voice_connector({
|
1112
|
+
# voice_connector_id: "NonEmptyString", # required
|
1113
|
+
# })
|
1114
|
+
#
|
1115
|
+
# @example Response structure
|
1116
|
+
#
|
1117
|
+
# resp.voice_connector.voice_connector_id #=> String
|
1118
|
+
# resp.voice_connector.name #=> String
|
1119
|
+
# resp.voice_connector.outbound_host_name #=> String
|
1120
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
1121
|
+
# resp.voice_connector.created_timestamp #=> Time
|
1122
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
1123
|
+
#
|
1124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnector AWS API Documentation
|
1125
|
+
#
|
1126
|
+
# @overload get_voice_connector(params = {})
|
1127
|
+
# @param [Hash] params ({})
|
1128
|
+
def get_voice_connector(params = {}, options = {})
|
1129
|
+
req = build_request(:get_voice_connector, params)
|
1130
|
+
req.send_request(options)
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# Retrieves origination setting details for the specified Amazon Chime
|
1134
|
+
# Voice Connector.
|
1135
|
+
#
|
1136
|
+
# @option params [required, String] :voice_connector_id
|
1137
|
+
# The Amazon Chime Voice Connector ID.
|
1138
|
+
#
|
1139
|
+
# @return [Types::GetVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1140
|
+
#
|
1141
|
+
# * {Types::GetVoiceConnectorOriginationResponse#origination #origination} => Types::Origination
|
1142
|
+
#
|
1143
|
+
# @example Request syntax with placeholder values
|
1144
|
+
#
|
1145
|
+
# resp = client.get_voice_connector_origination({
|
1146
|
+
# voice_connector_id: "NonEmptyString", # required
|
1147
|
+
# })
|
1148
|
+
#
|
1149
|
+
# @example Response structure
|
1150
|
+
#
|
1151
|
+
# resp.origination.routes #=> Array
|
1152
|
+
# resp.origination.routes[0].host #=> String
|
1153
|
+
# resp.origination.routes[0].port #=> Integer
|
1154
|
+
# resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
|
1155
|
+
# resp.origination.routes[0].priority #=> Integer
|
1156
|
+
# resp.origination.routes[0].weight #=> Integer
|
1157
|
+
# resp.origination.disabled #=> Boolean
|
1158
|
+
#
|
1159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorOrigination AWS API Documentation
|
1160
|
+
#
|
1161
|
+
# @overload get_voice_connector_origination(params = {})
|
1162
|
+
# @param [Hash] params ({})
|
1163
|
+
def get_voice_connector_origination(params = {}, options = {})
|
1164
|
+
req = build_request(:get_voice_connector_origination, params)
|
1165
|
+
req.send_request(options)
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
# Retrieves termination setting details for the specified Amazon Chime
|
1169
|
+
# Voice Connector.
|
1170
|
+
#
|
1171
|
+
# @option params [required, String] :voice_connector_id
|
1172
|
+
# The Amazon Chime Voice Connector ID.
|
1173
|
+
#
|
1174
|
+
# @return [Types::GetVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1175
|
+
#
|
1176
|
+
# * {Types::GetVoiceConnectorTerminationResponse#termination #termination} => Types::Termination
|
1177
|
+
#
|
1178
|
+
# @example Request syntax with placeholder values
|
1179
|
+
#
|
1180
|
+
# resp = client.get_voice_connector_termination({
|
1181
|
+
# voice_connector_id: "NonEmptyString", # required
|
1182
|
+
# })
|
1183
|
+
#
|
1184
|
+
# @example Response structure
|
1185
|
+
#
|
1186
|
+
# resp.termination.cps_limit #=> Integer
|
1187
|
+
# resp.termination.default_phone_number #=> String
|
1188
|
+
# resp.termination.calling_regions #=> Array
|
1189
|
+
# resp.termination.calling_regions[0] #=> String
|
1190
|
+
# resp.termination.cidr_allowed_list #=> Array
|
1191
|
+
# resp.termination.cidr_allowed_list[0] #=> String
|
1192
|
+
# resp.termination.disabled #=> Boolean
|
1193
|
+
#
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTermination AWS API Documentation
|
1195
|
+
#
|
1196
|
+
# @overload get_voice_connector_termination(params = {})
|
1197
|
+
# @param [Hash] params ({})
|
1198
|
+
def get_voice_connector_termination(params = {}, options = {})
|
1199
|
+
req = build_request(:get_voice_connector_termination, params)
|
1200
|
+
req.send_request(options)
|
1201
|
+
end
|
1202
|
+
|
1203
|
+
# Retrieves information about the last time a SIP `OPTIONS` ping was
|
1204
|
+
# received from your SIP infrastructure for the specified Amazon Chime
|
1205
|
+
# Voice Connector.
|
1206
|
+
#
|
1207
|
+
# @option params [required, String] :voice_connector_id
|
1208
|
+
# The Amazon Chime Voice Connector ID.
|
1209
|
+
#
|
1210
|
+
# @return [Types::GetVoiceConnectorTerminationHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1211
|
+
#
|
1212
|
+
# * {Types::GetVoiceConnectorTerminationHealthResponse#termination_health #termination_health} => Types::TerminationHealth
|
1213
|
+
#
|
1214
|
+
# @example Request syntax with placeholder values
|
1215
|
+
#
|
1216
|
+
# resp = client.get_voice_connector_termination_health({
|
1217
|
+
# voice_connector_id: "NonEmptyString", # required
|
1218
|
+
# })
|
1219
|
+
#
|
1220
|
+
# @example Response structure
|
1221
|
+
#
|
1222
|
+
# resp.termination_health.timestamp #=> Time
|
1223
|
+
# resp.termination_health.source #=> String
|
1224
|
+
#
|
1225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetVoiceConnectorTerminationHealth AWS API Documentation
|
1226
|
+
#
|
1227
|
+
# @overload get_voice_connector_termination_health(params = {})
|
541
1228
|
# @param [Hash] params ({})
|
542
|
-
def
|
543
|
-
req = build_request(:
|
1229
|
+
def get_voice_connector_termination_health(params = {}, options = {})
|
1230
|
+
req = build_request(:get_voice_connector_termination_health, params)
|
544
1231
|
req.send_request(options)
|
545
1232
|
end
|
546
1233
|
|
@@ -636,6 +1323,117 @@ module Aws::Chime
|
|
636
1323
|
req.send_request(options)
|
637
1324
|
end
|
638
1325
|
|
1326
|
+
# Lists the phone number orders for the administrator's Amazon Chime
|
1327
|
+
# account.
|
1328
|
+
#
|
1329
|
+
# @option params [String] :next_token
|
1330
|
+
# The token to use to retrieve the next page of results.
|
1331
|
+
#
|
1332
|
+
# @option params [Integer] :max_results
|
1333
|
+
# The maximum number of results to return in a single call.
|
1334
|
+
#
|
1335
|
+
# @return [Types::ListPhoneNumberOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1336
|
+
#
|
1337
|
+
# * {Types::ListPhoneNumberOrdersResponse#phone_number_orders #phone_number_orders} => Array<Types::PhoneNumberOrder>
|
1338
|
+
# * {Types::ListPhoneNumberOrdersResponse#next_token #next_token} => String
|
1339
|
+
#
|
1340
|
+
# @example Request syntax with placeholder values
|
1341
|
+
#
|
1342
|
+
# resp = client.list_phone_number_orders({
|
1343
|
+
# next_token: "String",
|
1344
|
+
# max_results: 1,
|
1345
|
+
# })
|
1346
|
+
#
|
1347
|
+
# @example Response structure
|
1348
|
+
#
|
1349
|
+
# resp.phone_number_orders #=> Array
|
1350
|
+
# resp.phone_number_orders[0].phone_number_order_id #=> String
|
1351
|
+
# resp.phone_number_orders[0].product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
1352
|
+
# resp.phone_number_orders[0].status #=> String, one of "Processing", "Successful", "Failed", "Partial"
|
1353
|
+
# resp.phone_number_orders[0].ordered_phone_numbers #=> Array
|
1354
|
+
# resp.phone_number_orders[0].ordered_phone_numbers[0].e164_phone_number #=> String
|
1355
|
+
# resp.phone_number_orders[0].ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
1356
|
+
# resp.phone_number_orders[0].created_timestamp #=> Time
|
1357
|
+
# resp.phone_number_orders[0].updated_timestamp #=> Time
|
1358
|
+
# resp.next_token #=> String
|
1359
|
+
#
|
1360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumberOrders AWS API Documentation
|
1361
|
+
#
|
1362
|
+
# @overload list_phone_number_orders(params = {})
|
1363
|
+
# @param [Hash] params ({})
|
1364
|
+
def list_phone_number_orders(params = {}, options = {})
|
1365
|
+
req = build_request(:list_phone_number_orders, params)
|
1366
|
+
req.send_request(options)
|
1367
|
+
end
|
1368
|
+
|
1369
|
+
# Lists the phone numbers for the specified Amazon Chime account, Amazon
|
1370
|
+
# Chime user, or Amazon Chime Voice Connector.
|
1371
|
+
#
|
1372
|
+
# @option params [String] :status
|
1373
|
+
# The phone number status.
|
1374
|
+
#
|
1375
|
+
# @option params [String] :product_type
|
1376
|
+
# The phone number product type.
|
1377
|
+
#
|
1378
|
+
# @option params [String] :filter_name
|
1379
|
+
# The filter to use to limit the number of results.
|
1380
|
+
#
|
1381
|
+
# @option params [String] :filter_value
|
1382
|
+
# The value to use for the filter.
|
1383
|
+
#
|
1384
|
+
# @option params [Integer] :max_results
|
1385
|
+
# The maximum number of results to return in a single call.
|
1386
|
+
#
|
1387
|
+
# @option params [String] :next_token
|
1388
|
+
# The token to use to retrieve the next page of results.
|
1389
|
+
#
|
1390
|
+
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
|
+
#
|
1392
|
+
# * {Types::ListPhoneNumbersResponse#phone_numbers #phone_numbers} => Array<Types::PhoneNumber>
|
1393
|
+
# * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
|
1394
|
+
#
|
1395
|
+
# @example Request syntax with placeholder values
|
1396
|
+
#
|
1397
|
+
# resp = client.list_phone_numbers({
|
1398
|
+
# status: "AcquireInProgress", # accepts AcquireInProgress, AcquireFailed, Unassigned, Assigned, ReleaseInProgress, DeleteInProgress, ReleaseFailed, DeleteFailed
|
1399
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
1400
|
+
# filter_name: "AccountId", # accepts AccountId, UserId, VoiceConnectorId
|
1401
|
+
# filter_value: "String",
|
1402
|
+
# max_results: 1,
|
1403
|
+
# next_token: "String",
|
1404
|
+
# })
|
1405
|
+
#
|
1406
|
+
# @example Response structure
|
1407
|
+
#
|
1408
|
+
# resp.phone_numbers #=> Array
|
1409
|
+
# resp.phone_numbers[0].phone_number_id #=> String
|
1410
|
+
# resp.phone_numbers[0].e164_phone_number #=> String
|
1411
|
+
# resp.phone_numbers[0].product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
1412
|
+
# resp.phone_numbers[0].status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
1413
|
+
# resp.phone_numbers[0].capabilities.inbound_call #=> Boolean
|
1414
|
+
# resp.phone_numbers[0].capabilities.outbound_call #=> Boolean
|
1415
|
+
# resp.phone_numbers[0].capabilities.inbound_sms #=> Boolean
|
1416
|
+
# resp.phone_numbers[0].capabilities.outbound_sms #=> Boolean
|
1417
|
+
# resp.phone_numbers[0].capabilities.inbound_mms #=> Boolean
|
1418
|
+
# resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
|
1419
|
+
# resp.phone_numbers[0].associations #=> Array
|
1420
|
+
# resp.phone_numbers[0].associations[0].value #=> String
|
1421
|
+
# resp.phone_numbers[0].associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId"
|
1422
|
+
# resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
|
1423
|
+
# resp.phone_numbers[0].created_timestamp #=> Time
|
1424
|
+
# resp.phone_numbers[0].updated_timestamp #=> Time
|
1425
|
+
# resp.phone_numbers[0].deletion_timestamp #=> Time
|
1426
|
+
# resp.next_token #=> String
|
1427
|
+
#
|
1428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListPhoneNumbers AWS API Documentation
|
1429
|
+
#
|
1430
|
+
# @overload list_phone_numbers(params = {})
|
1431
|
+
# @param [Hash] params ({})
|
1432
|
+
def list_phone_numbers(params = {}, options = {})
|
1433
|
+
req = build_request(:list_phone_numbers, params)
|
1434
|
+
req.send_request(options)
|
1435
|
+
end
|
1436
|
+
|
639
1437
|
# Lists the users that belong to the specified Amazon Chime account. You
|
640
1438
|
# can specify an email address to list only the user that the email
|
641
1439
|
# address belongs to.
|
@@ -673,6 +1471,7 @@ module Aws::Chime
|
|
673
1471
|
# resp.users[0].user_id #=> String
|
674
1472
|
# resp.users[0].account_id #=> String
|
675
1473
|
# resp.users[0].primary_email #=> String
|
1474
|
+
# resp.users[0].primary_provisioned_number #=> String
|
676
1475
|
# resp.users[0].display_name #=> String
|
677
1476
|
# resp.users[0].license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
678
1477
|
# resp.users[0].user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
@@ -691,6 +1490,77 @@ module Aws::Chime
|
|
691
1490
|
req.send_request(options)
|
692
1491
|
end
|
693
1492
|
|
1493
|
+
# Lists the SIP credentials for the specified Amazon Chime Voice
|
1494
|
+
# Connector.
|
1495
|
+
#
|
1496
|
+
# @option params [required, String] :voice_connector_id
|
1497
|
+
# The Amazon Chime Voice Connector ID.
|
1498
|
+
#
|
1499
|
+
# @return [Types::ListVoiceConnectorTerminationCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1500
|
+
#
|
1501
|
+
# * {Types::ListVoiceConnectorTerminationCredentialsResponse#usernames #usernames} => Array<String>
|
1502
|
+
#
|
1503
|
+
# @example Request syntax with placeholder values
|
1504
|
+
#
|
1505
|
+
# resp = client.list_voice_connector_termination_credentials({
|
1506
|
+
# voice_connector_id: "NonEmptyString", # required
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
#
|
1511
|
+
# resp.usernames #=> Array
|
1512
|
+
# resp.usernames[0] #=> String
|
1513
|
+
#
|
1514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectorTerminationCredentials AWS API Documentation
|
1515
|
+
#
|
1516
|
+
# @overload list_voice_connector_termination_credentials(params = {})
|
1517
|
+
# @param [Hash] params ({})
|
1518
|
+
def list_voice_connector_termination_credentials(params = {}, options = {})
|
1519
|
+
req = build_request(:list_voice_connector_termination_credentials, params)
|
1520
|
+
req.send_request(options)
|
1521
|
+
end
|
1522
|
+
|
1523
|
+
# Lists the Amazon Chime Voice Connectors for the administrator's AWS
|
1524
|
+
# account.
|
1525
|
+
#
|
1526
|
+
# @option params [String] :next_token
|
1527
|
+
# The token to use to retrieve the next page of results.
|
1528
|
+
#
|
1529
|
+
# @option params [Integer] :max_results
|
1530
|
+
# The maximum number of results to return in a single call.
|
1531
|
+
#
|
1532
|
+
# @return [Types::ListVoiceConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1533
|
+
#
|
1534
|
+
# * {Types::ListVoiceConnectorsResponse#voice_connectors #voice_connectors} => Array<Types::VoiceConnector>
|
1535
|
+
# * {Types::ListVoiceConnectorsResponse#next_token #next_token} => String
|
1536
|
+
#
|
1537
|
+
# @example Request syntax with placeholder values
|
1538
|
+
#
|
1539
|
+
# resp = client.list_voice_connectors({
|
1540
|
+
# next_token: "String",
|
1541
|
+
# max_results: 1,
|
1542
|
+
# })
|
1543
|
+
#
|
1544
|
+
# @example Response structure
|
1545
|
+
#
|
1546
|
+
# resp.voice_connectors #=> Array
|
1547
|
+
# resp.voice_connectors[0].voice_connector_id #=> String
|
1548
|
+
# resp.voice_connectors[0].name #=> String
|
1549
|
+
# resp.voice_connectors[0].outbound_host_name #=> String
|
1550
|
+
# resp.voice_connectors[0].require_encryption #=> Boolean
|
1551
|
+
# resp.voice_connectors[0].created_timestamp #=> Time
|
1552
|
+
# resp.voice_connectors[0].updated_timestamp #=> Time
|
1553
|
+
# resp.next_token #=> String
|
1554
|
+
#
|
1555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListVoiceConnectors AWS API Documentation
|
1556
|
+
#
|
1557
|
+
# @overload list_voice_connectors(params = {})
|
1558
|
+
# @param [Hash] params ({})
|
1559
|
+
def list_voice_connectors(params = {}, options = {})
|
1560
|
+
req = build_request(:list_voice_connectors, params)
|
1561
|
+
req.send_request(options)
|
1562
|
+
end
|
1563
|
+
|
694
1564
|
# Logs out the specified user from all of the devices they are currently
|
695
1565
|
# logged into.
|
696
1566
|
#
|
@@ -718,6 +1588,133 @@ module Aws::Chime
|
|
718
1588
|
req.send_request(options)
|
719
1589
|
end
|
720
1590
|
|
1591
|
+
# Adds origination settings for the specified Amazon Chime Voice
|
1592
|
+
# Connector.
|
1593
|
+
#
|
1594
|
+
# @option params [required, String] :voice_connector_id
|
1595
|
+
# The Amazon Chime Voice Connector ID.
|
1596
|
+
#
|
1597
|
+
# @option params [required, Types::Origination] :origination
|
1598
|
+
# The origination setting details to add.
|
1599
|
+
#
|
1600
|
+
# @return [Types::PutVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1601
|
+
#
|
1602
|
+
# * {Types::PutVoiceConnectorOriginationResponse#origination #origination} => Types::Origination
|
1603
|
+
#
|
1604
|
+
# @example Request syntax with placeholder values
|
1605
|
+
#
|
1606
|
+
# resp = client.put_voice_connector_origination({
|
1607
|
+
# voice_connector_id: "NonEmptyString", # required
|
1608
|
+
# origination: { # required
|
1609
|
+
# routes: [
|
1610
|
+
# {
|
1611
|
+
# host: "String",
|
1612
|
+
# port: 1,
|
1613
|
+
# protocol: "TCP", # accepts TCP, UDP
|
1614
|
+
# priority: 1,
|
1615
|
+
# weight: 1,
|
1616
|
+
# },
|
1617
|
+
# ],
|
1618
|
+
# disabled: false,
|
1619
|
+
# },
|
1620
|
+
# })
|
1621
|
+
#
|
1622
|
+
# @example Response structure
|
1623
|
+
#
|
1624
|
+
# resp.origination.routes #=> Array
|
1625
|
+
# resp.origination.routes[0].host #=> String
|
1626
|
+
# resp.origination.routes[0].port #=> Integer
|
1627
|
+
# resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
|
1628
|
+
# resp.origination.routes[0].priority #=> Integer
|
1629
|
+
# resp.origination.routes[0].weight #=> Integer
|
1630
|
+
# resp.origination.disabled #=> Boolean
|
1631
|
+
#
|
1632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorOrigination AWS API Documentation
|
1633
|
+
#
|
1634
|
+
# @overload put_voice_connector_origination(params = {})
|
1635
|
+
# @param [Hash] params ({})
|
1636
|
+
def put_voice_connector_origination(params = {}, options = {})
|
1637
|
+
req = build_request(:put_voice_connector_origination, params)
|
1638
|
+
req.send_request(options)
|
1639
|
+
end
|
1640
|
+
|
1641
|
+
# Adds termination settings for the specified Amazon Chime Voice
|
1642
|
+
# Connector.
|
1643
|
+
#
|
1644
|
+
# @option params [required, String] :voice_connector_id
|
1645
|
+
# The Amazon Chime Voice Connector ID.
|
1646
|
+
#
|
1647
|
+
# @option params [required, Types::Termination] :termination
|
1648
|
+
# The termination setting details to add.
|
1649
|
+
#
|
1650
|
+
# @return [Types::PutVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1651
|
+
#
|
1652
|
+
# * {Types::PutVoiceConnectorTerminationResponse#termination #termination} => Types::Termination
|
1653
|
+
#
|
1654
|
+
# @example Request syntax with placeholder values
|
1655
|
+
#
|
1656
|
+
# resp = client.put_voice_connector_termination({
|
1657
|
+
# voice_connector_id: "NonEmptyString", # required
|
1658
|
+
# termination: { # required
|
1659
|
+
# cps_limit: 1,
|
1660
|
+
# default_phone_number: "E164PhoneNumber",
|
1661
|
+
# calling_regions: ["CallingRegion"],
|
1662
|
+
# cidr_allowed_list: ["String"],
|
1663
|
+
# disabled: false,
|
1664
|
+
# },
|
1665
|
+
# })
|
1666
|
+
#
|
1667
|
+
# @example Response structure
|
1668
|
+
#
|
1669
|
+
# resp.termination.cps_limit #=> Integer
|
1670
|
+
# resp.termination.default_phone_number #=> String
|
1671
|
+
# resp.termination.calling_regions #=> Array
|
1672
|
+
# resp.termination.calling_regions[0] #=> String
|
1673
|
+
# resp.termination.cidr_allowed_list #=> Array
|
1674
|
+
# resp.termination.cidr_allowed_list[0] #=> String
|
1675
|
+
# resp.termination.disabled #=> Boolean
|
1676
|
+
#
|
1677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorTermination AWS API Documentation
|
1678
|
+
#
|
1679
|
+
# @overload put_voice_connector_termination(params = {})
|
1680
|
+
# @param [Hash] params ({})
|
1681
|
+
def put_voice_connector_termination(params = {}, options = {})
|
1682
|
+
req = build_request(:put_voice_connector_termination, params)
|
1683
|
+
req.send_request(options)
|
1684
|
+
end
|
1685
|
+
|
1686
|
+
# Adds termination SIP credentials for the specified Amazon Chime Voice
|
1687
|
+
# Connector.
|
1688
|
+
#
|
1689
|
+
# @option params [required, String] :voice_connector_id
|
1690
|
+
# The Amazon Chime Voice Connector ID.
|
1691
|
+
#
|
1692
|
+
# @option params [Array<Types::Credential>] :credentials
|
1693
|
+
# The termination SIP credentials.
|
1694
|
+
#
|
1695
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1696
|
+
#
|
1697
|
+
# @example Request syntax with placeholder values
|
1698
|
+
#
|
1699
|
+
# resp = client.put_voice_connector_termination_credentials({
|
1700
|
+
# voice_connector_id: "NonEmptyString", # required
|
1701
|
+
# credentials: [
|
1702
|
+
# {
|
1703
|
+
# username: "SensitiveString",
|
1704
|
+
# password: "SensitiveString",
|
1705
|
+
# },
|
1706
|
+
# ],
|
1707
|
+
# })
|
1708
|
+
#
|
1709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutVoiceConnectorTerminationCredentials AWS API Documentation
|
1710
|
+
#
|
1711
|
+
# @overload put_voice_connector_termination_credentials(params = {})
|
1712
|
+
# @param [Hash] params ({})
|
1713
|
+
def put_voice_connector_termination_credentials(params = {}, options = {})
|
1714
|
+
req = build_request(:put_voice_connector_termination_credentials, params)
|
1715
|
+
req.send_request(options)
|
1716
|
+
end
|
1717
|
+
|
721
1718
|
# Resets the personal meeting PIN for the specified user on an Amazon
|
722
1719
|
# Chime account. Returns the User object with the updated personal
|
723
1720
|
# meeting PIN.
|
@@ -744,6 +1741,7 @@ module Aws::Chime
|
|
744
1741
|
# resp.user.user_id #=> String
|
745
1742
|
# resp.user.account_id #=> String
|
746
1743
|
# resp.user.primary_email #=> String
|
1744
|
+
# resp.user.primary_provisioned_number #=> String
|
747
1745
|
# resp.user.display_name #=> String
|
748
1746
|
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
749
1747
|
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
@@ -761,6 +1759,100 @@ module Aws::Chime
|
|
761
1759
|
req.send_request(options)
|
762
1760
|
end
|
763
1761
|
|
1762
|
+
# Moves a phone number from the **Deletion queue** back into the phone
|
1763
|
+
# number **Inventory**.
|
1764
|
+
#
|
1765
|
+
# @option params [required, String] :phone_number_id
|
1766
|
+
# The phone number.
|
1767
|
+
#
|
1768
|
+
# @return [Types::RestorePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1769
|
+
#
|
1770
|
+
# * {Types::RestorePhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
1771
|
+
#
|
1772
|
+
# @example Request syntax with placeholder values
|
1773
|
+
#
|
1774
|
+
# resp = client.restore_phone_number({
|
1775
|
+
# phone_number_id: "NonEmptyString", # required
|
1776
|
+
# })
|
1777
|
+
#
|
1778
|
+
# @example Response structure
|
1779
|
+
#
|
1780
|
+
# resp.phone_number.phone_number_id #=> String
|
1781
|
+
# resp.phone_number.e164_phone_number #=> String
|
1782
|
+
# resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
1783
|
+
# resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
1784
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
1785
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
1786
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
1787
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
1788
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
1789
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
1790
|
+
# resp.phone_number.associations #=> Array
|
1791
|
+
# resp.phone_number.associations[0].value #=> String
|
1792
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId"
|
1793
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
1794
|
+
# resp.phone_number.created_timestamp #=> Time
|
1795
|
+
# resp.phone_number.updated_timestamp #=> Time
|
1796
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
1797
|
+
#
|
1798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RestorePhoneNumber AWS API Documentation
|
1799
|
+
#
|
1800
|
+
# @overload restore_phone_number(params = {})
|
1801
|
+
# @param [Hash] params ({})
|
1802
|
+
def restore_phone_number(params = {}, options = {})
|
1803
|
+
req = build_request(:restore_phone_number, params)
|
1804
|
+
req.send_request(options)
|
1805
|
+
end
|
1806
|
+
|
1807
|
+
# Searches phone numbers that can be ordered.
|
1808
|
+
#
|
1809
|
+
# @option params [String] :area_code
|
1810
|
+
# The area code used to filter results.
|
1811
|
+
#
|
1812
|
+
# @option params [String] :city
|
1813
|
+
# The city used to filter results.
|
1814
|
+
#
|
1815
|
+
# @option params [String] :country
|
1816
|
+
# The country used to filter results.
|
1817
|
+
#
|
1818
|
+
# @option params [String] :state
|
1819
|
+
# The state used to filter results.
|
1820
|
+
#
|
1821
|
+
# @option params [Integer] :max_results
|
1822
|
+
# The maximum number of results to return in a single call.
|
1823
|
+
#
|
1824
|
+
# @option params [String] :next_token
|
1825
|
+
# The token to use to retrieve the next page of results.
|
1826
|
+
#
|
1827
|
+
# @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1828
|
+
#
|
1829
|
+
# * {Types::SearchAvailablePhoneNumbersResponse#e164_phone_numbers #e164_phone_numbers} => Array<String>
|
1830
|
+
#
|
1831
|
+
# @example Request syntax with placeholder values
|
1832
|
+
#
|
1833
|
+
# resp = client.search_available_phone_numbers({
|
1834
|
+
# area_code: "String",
|
1835
|
+
# city: "String",
|
1836
|
+
# country: "String",
|
1837
|
+
# state: "String",
|
1838
|
+
# max_results: 1,
|
1839
|
+
# next_token: "String",
|
1840
|
+
# })
|
1841
|
+
#
|
1842
|
+
# @example Response structure
|
1843
|
+
#
|
1844
|
+
# resp.e164_phone_numbers #=> Array
|
1845
|
+
# resp.e164_phone_numbers[0] #=> String
|
1846
|
+
#
|
1847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SearchAvailablePhoneNumbers AWS API Documentation
|
1848
|
+
#
|
1849
|
+
# @overload search_available_phone_numbers(params = {})
|
1850
|
+
# @param [Hash] params ({})
|
1851
|
+
def search_available_phone_numbers(params = {}, options = {})
|
1852
|
+
req = build_request(:search_available_phone_numbers, params)
|
1853
|
+
req.send_request(options)
|
1854
|
+
end
|
1855
|
+
|
764
1856
|
# Updates account details for the specified Amazon Chime account.
|
765
1857
|
# Currently, only account name updates are supported for this action.
|
766
1858
|
#
|
@@ -837,6 +1929,87 @@ module Aws::Chime
|
|
837
1929
|
req.send_request(options)
|
838
1930
|
end
|
839
1931
|
|
1932
|
+
# Updates global settings for the administrator's AWS account, such as
|
1933
|
+
# Amazon Chime Business Calling and Amazon Chime Voice Connector
|
1934
|
+
# settings.
|
1935
|
+
#
|
1936
|
+
# @option params [required, Types::BusinessCallingSettings] :business_calling
|
1937
|
+
# The Amazon Chime Business Calling settings.
|
1938
|
+
#
|
1939
|
+
# @option params [required, Types::VoiceConnectorSettings] :voice_connector
|
1940
|
+
# The Amazon Chime Voice Connector settings.
|
1941
|
+
#
|
1942
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1943
|
+
#
|
1944
|
+
# @example Request syntax with placeholder values
|
1945
|
+
#
|
1946
|
+
# resp = client.update_global_settings({
|
1947
|
+
# business_calling: { # required
|
1948
|
+
# cdr_bucket: "String",
|
1949
|
+
# },
|
1950
|
+
# voice_connector: { # required
|
1951
|
+
# cdr_bucket: "String",
|
1952
|
+
# },
|
1953
|
+
# })
|
1954
|
+
#
|
1955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateGlobalSettings AWS API Documentation
|
1956
|
+
#
|
1957
|
+
# @overload update_global_settings(params = {})
|
1958
|
+
# @param [Hash] params ({})
|
1959
|
+
def update_global_settings(params = {}, options = {})
|
1960
|
+
req = build_request(:update_global_settings, params)
|
1961
|
+
req.send_request(options)
|
1962
|
+
end
|
1963
|
+
|
1964
|
+
# Updates phone number details, such as product type, for the specified
|
1965
|
+
# phone number ID.
|
1966
|
+
#
|
1967
|
+
# @option params [required, String] :phone_number_id
|
1968
|
+
# The phone number ID.
|
1969
|
+
#
|
1970
|
+
# @option params [String] :product_type
|
1971
|
+
# The product type.
|
1972
|
+
#
|
1973
|
+
# @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1974
|
+
#
|
1975
|
+
# * {Types::UpdatePhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
1976
|
+
#
|
1977
|
+
# @example Request syntax with placeholder values
|
1978
|
+
#
|
1979
|
+
# resp = client.update_phone_number({
|
1980
|
+
# phone_number_id: "String", # required
|
1981
|
+
# product_type: "BusinessCalling", # accepts BusinessCalling, VoiceConnector
|
1982
|
+
# })
|
1983
|
+
#
|
1984
|
+
# @example Response structure
|
1985
|
+
#
|
1986
|
+
# resp.phone_number.phone_number_id #=> String
|
1987
|
+
# resp.phone_number.e164_phone_number #=> String
|
1988
|
+
# resp.phone_number.product_type #=> String, one of "BusinessCalling", "VoiceConnector"
|
1989
|
+
# resp.phone_number.status #=> String, one of "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
1990
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
1991
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
1992
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
1993
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
1994
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
1995
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
1996
|
+
# resp.phone_number.associations #=> Array
|
1997
|
+
# resp.phone_number.associations[0].value #=> String
|
1998
|
+
# resp.phone_number.associations[0].name #=> String, one of "AccountId", "UserId", "VoiceConnectorId"
|
1999
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2000
|
+
# resp.phone_number.created_timestamp #=> Time
|
2001
|
+
# resp.phone_number.updated_timestamp #=> Time
|
2002
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
2003
|
+
#
|
2004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdatePhoneNumber AWS API Documentation
|
2005
|
+
#
|
2006
|
+
# @overload update_phone_number(params = {})
|
2007
|
+
# @param [Hash] params ({})
|
2008
|
+
def update_phone_number(params = {}, options = {})
|
2009
|
+
req = build_request(:update_phone_number, params)
|
2010
|
+
req.send_request(options)
|
2011
|
+
end
|
2012
|
+
|
840
2013
|
# Updates user details for a specified user ID. Currently, only
|
841
2014
|
# `LicenseType` updates are supported for this action.
|
842
2015
|
#
|
@@ -867,6 +2040,7 @@ module Aws::Chime
|
|
867
2040
|
# resp.user.user_id #=> String
|
868
2041
|
# resp.user.account_id #=> String
|
869
2042
|
# resp.user.primary_email #=> String
|
2043
|
+
# resp.user.primary_provisioned_number #=> String
|
870
2044
|
# resp.user.display_name #=> String
|
871
2045
|
# resp.user.license_type #=> String, one of "Basic", "Plus", "Pro", "ProTrial"
|
872
2046
|
# resp.user.user_registration_status #=> String, one of "Unregistered", "Registered", "Suspended"
|
@@ -884,6 +2058,85 @@ module Aws::Chime
|
|
884
2058
|
req.send_request(options)
|
885
2059
|
end
|
886
2060
|
|
2061
|
+
# Updates the settings for the specified user, such as phone number
|
2062
|
+
# settings.
|
2063
|
+
#
|
2064
|
+
# @option params [required, String] :account_id
|
2065
|
+
# The Amazon Chime account ID.
|
2066
|
+
#
|
2067
|
+
# @option params [required, String] :user_id
|
2068
|
+
# The user ID.
|
2069
|
+
#
|
2070
|
+
# @option params [required, Types::UserSettings] :user_settings
|
2071
|
+
# The user settings to update.
|
2072
|
+
#
|
2073
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2074
|
+
#
|
2075
|
+
# @example Request syntax with placeholder values
|
2076
|
+
#
|
2077
|
+
# resp = client.update_user_settings({
|
2078
|
+
# account_id: "String", # required
|
2079
|
+
# user_id: "String", # required
|
2080
|
+
# user_settings: { # required
|
2081
|
+
# telephony: { # required
|
2082
|
+
# inbound_calling: false, # required
|
2083
|
+
# outbound_calling: false, # required
|
2084
|
+
# sms: false, # required
|
2085
|
+
# },
|
2086
|
+
# },
|
2087
|
+
# })
|
2088
|
+
#
|
2089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateUserSettings AWS API Documentation
|
2090
|
+
#
|
2091
|
+
# @overload update_user_settings(params = {})
|
2092
|
+
# @param [Hash] params ({})
|
2093
|
+
def update_user_settings(params = {}, options = {})
|
2094
|
+
req = build_request(:update_user_settings, params)
|
2095
|
+
req.send_request(options)
|
2096
|
+
end
|
2097
|
+
|
2098
|
+
# Updates details for the specified Amazon Chime Voice Connector.
|
2099
|
+
#
|
2100
|
+
# @option params [required, String] :voice_connector_id
|
2101
|
+
# The Amazon Chime Voice Connector ID.
|
2102
|
+
#
|
2103
|
+
# @option params [required, String] :name
|
2104
|
+
# The name of the Amazon Chime Voice Connector.
|
2105
|
+
#
|
2106
|
+
# @option params [required, Boolean] :require_encryption
|
2107
|
+
# When enabled, requires encryption for the Amazon Chime Voice
|
2108
|
+
# Connector.
|
2109
|
+
#
|
2110
|
+
# @return [Types::UpdateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2111
|
+
#
|
2112
|
+
# * {Types::UpdateVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
2113
|
+
#
|
2114
|
+
# @example Request syntax with placeholder values
|
2115
|
+
#
|
2116
|
+
# resp = client.update_voice_connector({
|
2117
|
+
# voice_connector_id: "NonEmptyString", # required
|
2118
|
+
# name: "VoiceConnectorName", # required
|
2119
|
+
# require_encryption: false, # required
|
2120
|
+
# })
|
2121
|
+
#
|
2122
|
+
# @example Response structure
|
2123
|
+
#
|
2124
|
+
# resp.voice_connector.voice_connector_id #=> String
|
2125
|
+
# resp.voice_connector.name #=> String
|
2126
|
+
# resp.voice_connector.outbound_host_name #=> String
|
2127
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
2128
|
+
# resp.voice_connector.created_timestamp #=> Time
|
2129
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
2130
|
+
#
|
2131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateVoiceConnector AWS API Documentation
|
2132
|
+
#
|
2133
|
+
# @overload update_voice_connector(params = {})
|
2134
|
+
# @param [Hash] params ({})
|
2135
|
+
def update_voice_connector(params = {}, options = {})
|
2136
|
+
req = build_request(:update_voice_connector, params)
|
2137
|
+
req.send_request(options)
|
2138
|
+
end
|
2139
|
+
|
887
2140
|
# @!endgroup
|
888
2141
|
|
889
2142
|
# @param params ({})
|
@@ -897,7 +2150,7 @@ module Aws::Chime
|
|
897
2150
|
params: params,
|
898
2151
|
config: config)
|
899
2152
|
context[:gem_name] = 'aws-sdk-chime'
|
900
|
-
context[:gem_version] = '1.
|
2153
|
+
context[:gem_version] = '1.5.0'
|
901
2154
|
Seahorse::Client::Request.new(handlers, context)
|
902
2155
|
end
|
903
2156
|
|