aws-sdk-chimesdkvoice 1.3.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkvoice/client.rb +632 -1
- data/lib/aws-sdk-chimesdkvoice/client_api.rb +3 -0
- data/lib/aws-sdk-chimesdkvoice/types.rb +773 -3
- data/lib/aws-sdk-chimesdkvoice.rb +1 -1
- metadata +2 -2
@@ -368,11 +368,20 @@ module Aws::ChimeSDKVoice
|
|
368
368
|
|
369
369
|
# @!group API Operations
|
370
370
|
|
371
|
+
# Associates phone numbers with the specified Amazon Chime SDK Voice
|
372
|
+
# Connector.
|
373
|
+
#
|
371
374
|
# @option params [required, String] :voice_connector_id
|
375
|
+
# The Voice Connector ID.
|
372
376
|
#
|
373
377
|
# @option params [required, Array<String>] :e164_phone_numbers
|
378
|
+
# List of phone numbers, in E.164 format.
|
374
379
|
#
|
375
380
|
# @option params [Boolean] :force_associate
|
381
|
+
# If true, associates the provided phone numbers with the provided
|
382
|
+
# Amazon Chime SDK Voice Connector and removes any previously existing
|
383
|
+
# associations. If false, does not associate any phone numbers that have
|
384
|
+
# previously existing associations.
|
376
385
|
#
|
377
386
|
# @return [Types::AssociatePhoneNumbersWithVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
378
387
|
#
|
@@ -402,11 +411,20 @@ module Aws::ChimeSDKVoice
|
|
402
411
|
req.send_request(options)
|
403
412
|
end
|
404
413
|
|
414
|
+
# Associates phone numbers with the specified Amazon Chime SDK Voice
|
415
|
+
# Connector group.
|
416
|
+
#
|
405
417
|
# @option params [required, String] :voice_connector_group_id
|
418
|
+
# The Amazon Chime SDK Voice Connector group ID.
|
406
419
|
#
|
407
420
|
# @option params [required, Array<String>] :e164_phone_numbers
|
421
|
+
# List of phone numbers, in E.164 format.
|
408
422
|
#
|
409
423
|
# @option params [Boolean] :force_associate
|
424
|
+
# If true, associates the provided phone numbers with the provided
|
425
|
+
# Amazon Chime SDK Voice Connector Group and removes any previously
|
426
|
+
# existing associations. If false, does not associate any phone numbers
|
427
|
+
# that have previously existing associations.
|
410
428
|
#
|
411
429
|
# @return [Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
412
430
|
#
|
@@ -436,7 +454,15 @@ module Aws::ChimeSDKVoice
|
|
436
454
|
req.send_request(options)
|
437
455
|
end
|
438
456
|
|
457
|
+
# Moves phone numbers into the **Deletion queue**. Phone numbers must be
|
458
|
+
# disassociated from any users or Amazon Chime SDK Voice Connectors
|
459
|
+
# before they can be deleted.
|
460
|
+
#
|
461
|
+
# Phone numbers remain in the **Deletion queue** for 7 days before they
|
462
|
+
# are deleted permanently.
|
463
|
+
#
|
439
464
|
# @option params [required, Array<String>] :phone_number_ids
|
465
|
+
# List of phone number IDs.
|
440
466
|
#
|
441
467
|
# @return [Types::BatchDeletePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
442
468
|
#
|
@@ -464,7 +490,10 @@ module Aws::ChimeSDKVoice
|
|
464
490
|
req.send_request(options)
|
465
491
|
end
|
466
492
|
|
493
|
+
# Updates one or more phone numbers.
|
494
|
+
#
|
467
495
|
# @option params [required, Array<Types::UpdatePhoneNumberRequestItem>] :update_phone_number_request_items
|
496
|
+
# Lists the phone numbers in the update request.
|
468
497
|
#
|
469
498
|
# @return [Types::BatchUpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
470
499
|
#
|
@@ -498,9 +527,15 @@ module Aws::ChimeSDKVoice
|
|
498
527
|
req.send_request(options)
|
499
528
|
end
|
500
529
|
|
530
|
+
# Creates an order for phone numbers to be provisioned. For numbers
|
531
|
+
# outside the U.S., you must use the Amazon Chime SDK SIP media
|
532
|
+
# application dial-in product type.
|
533
|
+
#
|
501
534
|
# @option params [required, String] :product_type
|
535
|
+
# The phone number product type.
|
502
536
|
#
|
503
537
|
# @option params [required, Array<String>] :e164_phone_numbers
|
538
|
+
# List of phone numbers, in E.164 format.
|
504
539
|
#
|
505
540
|
# @return [Types::CreatePhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
506
541
|
#
|
@@ -534,21 +569,34 @@ module Aws::ChimeSDKVoice
|
|
534
569
|
req.send_request(options)
|
535
570
|
end
|
536
571
|
|
572
|
+
# Creates a proxy session for the specified Amazon Chime SDK Voice
|
573
|
+
# Connector for the specified participant phone numbers.
|
574
|
+
#
|
537
575
|
# @option params [required, String] :voice_connector_id
|
576
|
+
# The Voice Connector ID.
|
538
577
|
#
|
539
578
|
# @option params [required, Array<String>] :participant_phone_numbers
|
579
|
+
# The participant phone numbers.
|
540
580
|
#
|
541
581
|
# @option params [String] :name
|
582
|
+
# The name of the proxy session.
|
542
583
|
#
|
543
584
|
# @option params [Integer] :expiry_minutes
|
585
|
+
# The number of minutes allowed for the proxy session.
|
544
586
|
#
|
545
587
|
# @option params [required, Array<String>] :capabilities
|
588
|
+
# The proxy session's capabilities.
|
546
589
|
#
|
547
590
|
# @option params [String] :number_selection_behavior
|
591
|
+
# The preference for proxy phone number reuse, or stickiness, between
|
592
|
+
# the same participants across sessions.
|
548
593
|
#
|
549
594
|
# @option params [String] :geo_match_level
|
595
|
+
# The preference for matching the country or area code of the proxy
|
596
|
+
# phone number with that of the first participant.
|
550
597
|
#
|
551
598
|
# @option params [Types::GeoMatchParams] :geo_match_params
|
599
|
+
# The country and area code for the proxy phone number.
|
552
600
|
#
|
553
601
|
# @return [Types::CreateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
554
602
|
#
|
@@ -599,11 +647,26 @@ module Aws::ChimeSDKVoice
|
|
599
647
|
req.send_request(options)
|
600
648
|
end
|
601
649
|
|
650
|
+
# Creates a SIP media application. For more information about SIP media
|
651
|
+
# applications, see [Managing SIP media applications and rules][1] in
|
652
|
+
# the *Amazon Chime SDK Administrator Guide*.
|
653
|
+
#
|
654
|
+
#
|
655
|
+
#
|
656
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html
|
657
|
+
#
|
602
658
|
# @option params [required, String] :aws_region
|
659
|
+
# The AWS Region assigned to the SIP media application.
|
603
660
|
#
|
604
661
|
# @option params [required, String] :name
|
662
|
+
# The SIP media application's name.
|
605
663
|
#
|
606
664
|
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
665
|
+
# List of endpoints (Lambda ARNs) specified for the SIP media
|
666
|
+
# application.
|
667
|
+
#
|
668
|
+
# @option params [Array<Types::Tag>] :tags
|
669
|
+
# The tags assigned to the SIP media application.
|
607
670
|
#
|
608
671
|
# @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
609
672
|
#
|
@@ -619,6 +682,12 @@ module Aws::ChimeSDKVoice
|
|
619
682
|
# lambda_arn: "FunctionArn",
|
620
683
|
# },
|
621
684
|
# ],
|
685
|
+
# tags: [
|
686
|
+
# {
|
687
|
+
# key: "TagKey", # required
|
688
|
+
# value: "TagValue", # required
|
689
|
+
# },
|
690
|
+
# ],
|
622
691
|
# })
|
623
692
|
#
|
624
693
|
# @example Response structure
|
@@ -630,6 +699,7 @@ module Aws::ChimeSDKVoice
|
|
630
699
|
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
631
700
|
# resp.sip_media_application.created_timestamp #=> Time
|
632
701
|
# resp.sip_media_application.updated_timestamp #=> Time
|
702
|
+
# resp.sip_media_application.sip_media_application_arn #=> String
|
633
703
|
#
|
634
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplication AWS API Documentation
|
635
705
|
#
|
@@ -640,15 +710,27 @@ module Aws::ChimeSDKVoice
|
|
640
710
|
req.send_request(options)
|
641
711
|
end
|
642
712
|
|
713
|
+
# Creates an outbound call to a phone number from the phone number
|
714
|
+
# specified in the request, and it invokes the endpoint of the specified
|
715
|
+
# `sipMediaApplicationId`.
|
716
|
+
#
|
643
717
|
# @option params [required, String] :from_phone_number
|
718
|
+
# The phone number that a user calls from. This is a phone number in
|
719
|
+
# your Amazon Chime SDK phone number inventory.
|
644
720
|
#
|
645
721
|
# @option params [required, String] :to_phone_number
|
722
|
+
# The phone number that the service should call.
|
646
723
|
#
|
647
724
|
# @option params [required, String] :sip_media_application_id
|
725
|
+
# The ID of the SIP media application.
|
648
726
|
#
|
649
727
|
# @option params [Hash<String,String>] :sip_headers
|
728
|
+
# The SIP headers added to an outbound call leg.
|
650
729
|
#
|
651
730
|
# @option params [Hash<String,String>] :arguments_map
|
731
|
+
# Context passed to a CreateSipMediaApplication API call. For example,
|
732
|
+
# you could pass key-value pairs such as: `"FirstName": "John",
|
733
|
+
# "LastName": "Doe"`
|
652
734
|
#
|
653
735
|
# @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
654
736
|
#
|
@@ -681,15 +763,38 @@ module Aws::ChimeSDKVoice
|
|
681
763
|
req.send_request(options)
|
682
764
|
end
|
683
765
|
|
766
|
+
# Creates a SIP rule, which can be used to run a SIP media application
|
767
|
+
# as a target for a specific trigger type. For more information about
|
768
|
+
# SIP rules, see [Managing SIP media applications and rules][1] in the
|
769
|
+
# *Amazon Chime SDK Administrator Guide*.
|
770
|
+
#
|
771
|
+
#
|
772
|
+
#
|
773
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html
|
774
|
+
#
|
684
775
|
# @option params [required, String] :name
|
776
|
+
# The name of the SIP rule.
|
685
777
|
#
|
686
778
|
# @option params [required, String] :trigger_type
|
779
|
+
# The type of trigger assigned to the SIP rule in `TriggerValue`,
|
780
|
+
# currently `RequestUriHostname` or `ToPhoneNumber`.
|
687
781
|
#
|
688
782
|
# @option params [required, String] :trigger_value
|
783
|
+
# If `TriggerType` is `RequestUriHostname`, the value can be the
|
784
|
+
# outbound host name of a Voice Connector. If `TriggerType` is
|
785
|
+
# `ToPhoneNumber`, the value can be a customer-owned phone number in the
|
786
|
+
# E164 format. The `SipMediaApplication` specified in the `SipRule` is
|
787
|
+
# triggered if the request URI in an incoming SIP request matches the
|
788
|
+
# `RequestUriHostname`, or if the `To` header in the incoming SIP
|
789
|
+
# request matches the `ToPhoneNumber` value.
|
689
790
|
#
|
690
791
|
# @option params [Boolean] :disabled
|
792
|
+
# Disables or enables a SIP rule. You must disable SIP rules before you
|
793
|
+
# can delete them.
|
691
794
|
#
|
692
795
|
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
796
|
+
# List of SIP media applications, with priority and AWS Region. Only one
|
797
|
+
# SIP application per AWS Region can be used.
|
693
798
|
#
|
694
799
|
# @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
800
|
#
|
@@ -734,11 +839,26 @@ module Aws::ChimeSDKVoice
|
|
734
839
|
req.send_request(options)
|
735
840
|
end
|
736
841
|
|
842
|
+
# Creates an Amazon Chime SDK Voice Connector. For more information
|
843
|
+
# about Voice Connectors, see [Managing Amazon Chime SDK Voice Connector
|
844
|
+
# groups][1] in the *Amazon Chime SDK Administrator Guide*.
|
845
|
+
#
|
846
|
+
#
|
847
|
+
#
|
848
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html
|
849
|
+
#
|
737
850
|
# @option params [required, String] :name
|
851
|
+
# The name of the Voice Connector.
|
738
852
|
#
|
739
853
|
# @option params [String] :aws_region
|
854
|
+
# The AWS Region in which the Amazon Chime SDK Voice Connector is
|
855
|
+
# created. Default value: `us-east-1` .
|
740
856
|
#
|
741
857
|
# @option params [required, Boolean] :require_encryption
|
858
|
+
# Enables or disables encryption for the Voice Connector.
|
859
|
+
#
|
860
|
+
# @option params [Array<Types::Tag>] :tags
|
861
|
+
# The tags assigned to the Voice Connector.
|
742
862
|
#
|
743
863
|
# @return [Types::CreateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
744
864
|
#
|
@@ -750,6 +870,12 @@ module Aws::ChimeSDKVoice
|
|
750
870
|
# name: "VoiceConnectorName", # required
|
751
871
|
# aws_region: "us-east-1", # accepts us-east-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2
|
752
872
|
# require_encryption: false, # required
|
873
|
+
# tags: [
|
874
|
+
# {
|
875
|
+
# key: "TagKey", # required
|
876
|
+
# value: "TagValue", # required
|
877
|
+
# },
|
878
|
+
# ],
|
753
879
|
# })
|
754
880
|
#
|
755
881
|
# @example Response structure
|
@@ -772,9 +898,20 @@ module Aws::ChimeSDKVoice
|
|
772
898
|
req.send_request(options)
|
773
899
|
end
|
774
900
|
|
901
|
+
# Creates an Amazon Chime SDK Voice Connector group under the
|
902
|
+
# administrator's AWS account. You can associate Amazon Chime SDK Voice
|
903
|
+
# Connectors with the Voice Connector group by including
|
904
|
+
# `VoiceConnectorItems` in the request.
|
905
|
+
#
|
906
|
+
# You can include Voice Connectors from different AWS Regions in your
|
907
|
+
# group. This creates a fault tolerant mechanism for fallback in case of
|
908
|
+
# availability events.
|
909
|
+
#
|
775
910
|
# @option params [required, String] :name
|
911
|
+
# The name of the Voice Connector group.
|
776
912
|
#
|
777
913
|
# @option params [Array<Types::VoiceConnectorItem>] :voice_connector_items
|
914
|
+
# Lists the Voice Connectors that inbound calls are routed to.
|
778
915
|
#
|
779
916
|
# @return [Types::CreateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
917
|
#
|
@@ -812,7 +949,25 @@ module Aws::ChimeSDKVoice
|
|
812
949
|
req.send_request(options)
|
813
950
|
end
|
814
951
|
|
952
|
+
# Creates a voice profile, which consists of an enrolled user and their
|
953
|
+
# latest voice print.
|
954
|
+
#
|
955
|
+
# Before creating any voice profiles, you must provide all notices and
|
956
|
+
# obtain all consents from the speaker as required under applicable
|
957
|
+
# privacy and biometrics laws, and as required under the [AWS service
|
958
|
+
# terms][1] for the Amazon Chime SDK.
|
959
|
+
#
|
960
|
+
# For more information about voice profiles and voice analytics, see
|
961
|
+
# [Using Amazon Chime SDK Voice Analytics][2] in the *Amazon Chime SDK
|
962
|
+
# Developer Guide*.
|
963
|
+
#
|
964
|
+
#
|
965
|
+
#
|
966
|
+
# [1]: https://aws.amazon.com/service-terms/
|
967
|
+
# [2]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
|
968
|
+
#
|
815
969
|
# @option params [required, String] :speaker_search_task_id
|
970
|
+
# The ID of the speaker search task.
|
816
971
|
#
|
817
972
|
# @return [Types::CreateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
973
|
#
|
@@ -842,15 +997,38 @@ module Aws::ChimeSDKVoice
|
|
842
997
|
req.send_request(options)
|
843
998
|
end
|
844
999
|
|
1000
|
+
# Creates a voice profile domain, a collection of voice profiles, their
|
1001
|
+
# voice prints, and encrypted enrollment audio.
|
1002
|
+
#
|
1003
|
+
# Before creating any voice profiles, you must provide all notices and
|
1004
|
+
# obtain all consents from the speaker as required under applicable
|
1005
|
+
# privacy and biometrics laws, and as required under the [AWS service
|
1006
|
+
# terms][1] for the Amazon Chime SDK.
|
1007
|
+
#
|
1008
|
+
# For more information about voice profile domains, see [Using Amazon
|
1009
|
+
# Chime SDK Voice Analytics][2] in the *Amazon Chime SDK Developer
|
1010
|
+
# Guide*.
|
1011
|
+
#
|
1012
|
+
#
|
1013
|
+
#
|
1014
|
+
# [1]: https://aws.amazon.com/service-terms/
|
1015
|
+
# [2]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
|
1016
|
+
#
|
845
1017
|
# @option params [required, String] :name
|
1018
|
+
# The name of the voice profile domain.
|
846
1019
|
#
|
847
1020
|
# @option params [String] :description
|
1021
|
+
# A description of the voice profile domain.
|
848
1022
|
#
|
849
1023
|
# @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
1024
|
+
# The server-side encryption configuration for the request.
|
850
1025
|
#
|
851
1026
|
# @option params [String] :client_request_token
|
1027
|
+
# The unique identifier for the client request. Use a different token
|
1028
|
+
# for different domain creation requests.
|
852
1029
|
#
|
853
1030
|
# @option params [Array<Types::Tag>] :tags
|
1031
|
+
# The tags assigned to the domain.
|
854
1032
|
#
|
855
1033
|
# @return [Types::CreateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
856
1034
|
#
|
@@ -892,7 +1070,15 @@ module Aws::ChimeSDKVoice
|
|
892
1070
|
req.send_request(options)
|
893
1071
|
end
|
894
1072
|
|
1073
|
+
# Moves the specified phone number into the **Deletion queue**. A phone
|
1074
|
+
# number must be disassociated from any users or Amazon Chime SDK Voice
|
1075
|
+
# Connectors before it can be deleted.
|
1076
|
+
#
|
1077
|
+
# Deleted phone numbers remain in the **Deletion queue** queue for 7
|
1078
|
+
# days before they are deleted permanently.
|
1079
|
+
#
|
895
1080
|
# @option params [required, String] :phone_number_id
|
1081
|
+
# The phone number ID.
|
896
1082
|
#
|
897
1083
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
898
1084
|
#
|
@@ -911,9 +1097,14 @@ module Aws::ChimeSDKVoice
|
|
911
1097
|
req.send_request(options)
|
912
1098
|
end
|
913
1099
|
|
1100
|
+
# Deletes the specified proxy session from the specified Amazon Chime
|
1101
|
+
# SDK Voice Connector.
|
1102
|
+
#
|
914
1103
|
# @option params [required, String] :voice_connector_id
|
1104
|
+
# The Voice Connector ID.
|
915
1105
|
#
|
916
1106
|
# @option params [required, String] :proxy_session_id
|
1107
|
+
# The proxy session ID.
|
917
1108
|
#
|
918
1109
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
919
1110
|
#
|
@@ -933,7 +1124,10 @@ module Aws::ChimeSDKVoice
|
|
933
1124
|
req.send_request(options)
|
934
1125
|
end
|
935
1126
|
|
1127
|
+
# Deletes a SIP media application.
|
1128
|
+
#
|
936
1129
|
# @option params [required, String] :sip_media_application_id
|
1130
|
+
# The SIP media application ID.
|
937
1131
|
#
|
938
1132
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
939
1133
|
#
|
@@ -952,7 +1146,10 @@ module Aws::ChimeSDKVoice
|
|
952
1146
|
req.send_request(options)
|
953
1147
|
end
|
954
1148
|
|
1149
|
+
# Deletes a SIP rule.
|
1150
|
+
#
|
955
1151
|
# @option params [required, String] :sip_rule_id
|
1152
|
+
# The SIP rule ID.
|
956
1153
|
#
|
957
1154
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
958
1155
|
#
|
@@ -971,7 +1168,12 @@ module Aws::ChimeSDKVoice
|
|
971
1168
|
req.send_request(options)
|
972
1169
|
end
|
973
1170
|
|
1171
|
+
# Deletes an Amazon Chime SDK Voice Connector. Any phone numbers
|
1172
|
+
# associated with the Amazon Chime SDK Voice Connector must be
|
1173
|
+
# disassociated from it before it can be deleted.
|
1174
|
+
#
|
974
1175
|
# @option params [required, String] :voice_connector_id
|
1176
|
+
# The Voice Connector ID.
|
975
1177
|
#
|
976
1178
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
977
1179
|
#
|
@@ -990,7 +1192,11 @@ module Aws::ChimeSDKVoice
|
|
990
1192
|
req.send_request(options)
|
991
1193
|
end
|
992
1194
|
|
1195
|
+
# Deletes the emergency calling details from the specified Amazon Chime
|
1196
|
+
# SDK Voice Connector.
|
1197
|
+
#
|
993
1198
|
# @option params [required, String] :voice_connector_id
|
1199
|
+
# The Voice Connector ID.
|
994
1200
|
#
|
995
1201
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
996
1202
|
#
|
@@ -1009,7 +1215,12 @@ module Aws::ChimeSDKVoice
|
|
1009
1215
|
req.send_request(options)
|
1010
1216
|
end
|
1011
1217
|
|
1218
|
+
# Deletes an Amazon Chime SDK Voice Connector group. Any
|
1219
|
+
# `VoiceConnectorItems` and phone numbers associated with the group must
|
1220
|
+
# be removed before it can be deleted.
|
1221
|
+
#
|
1012
1222
|
# @option params [required, String] :voice_connector_group_id
|
1223
|
+
# The Voice Connector Group ID.
|
1013
1224
|
#
|
1014
1225
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1015
1226
|
#
|
@@ -1028,7 +1239,16 @@ module Aws::ChimeSDKVoice
|
|
1028
1239
|
req.send_request(options)
|
1029
1240
|
end
|
1030
1241
|
|
1242
|
+
# Deletes the origination settings for the specified Amazon Chime SDK
|
1243
|
+
# Voice Connector.
|
1244
|
+
#
|
1245
|
+
# <note markdown="1"> If emergency calling is configured for the Voice Connector, it must be
|
1246
|
+
# deleted prior to deleting the origination settings.
|
1247
|
+
#
|
1248
|
+
# </note>
|
1249
|
+
#
|
1031
1250
|
# @option params [required, String] :voice_connector_id
|
1251
|
+
# The Voice Connector ID.
|
1032
1252
|
#
|
1033
1253
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1034
1254
|
#
|
@@ -1047,7 +1267,11 @@ module Aws::ChimeSDKVoice
|
|
1047
1267
|
req.send_request(options)
|
1048
1268
|
end
|
1049
1269
|
|
1270
|
+
# Deletes the proxy configuration from the specified Amazon Chime SDK
|
1271
|
+
# Voice Connector.
|
1272
|
+
#
|
1050
1273
|
# @option params [required, String] :voice_connector_id
|
1274
|
+
# The Voice Connector ID.
|
1051
1275
|
#
|
1052
1276
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1053
1277
|
#
|
@@ -1066,7 +1290,10 @@ module Aws::ChimeSDKVoice
|
|
1066
1290
|
req.send_request(options)
|
1067
1291
|
end
|
1068
1292
|
|
1293
|
+
# Deletes a Voice Connector's streaming configuration.
|
1294
|
+
#
|
1069
1295
|
# @option params [required, String] :voice_connector_id
|
1296
|
+
# The Voice Connector ID.
|
1070
1297
|
#
|
1071
1298
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1072
1299
|
#
|
@@ -1085,7 +1312,16 @@ module Aws::ChimeSDKVoice
|
|
1085
1312
|
req.send_request(options)
|
1086
1313
|
end
|
1087
1314
|
|
1315
|
+
# Deletes the termination settings for the specified Amazon Chime SDK
|
1316
|
+
# Voice Connector.
|
1317
|
+
#
|
1318
|
+
# <note markdown="1"> If emergency calling is configured for the Voice Connector, it must be
|
1319
|
+
# deleted prior to deleting the termination settings.
|
1320
|
+
#
|
1321
|
+
# </note>
|
1322
|
+
#
|
1088
1323
|
# @option params [required, String] :voice_connector_id
|
1324
|
+
# The Voice Connector ID.
|
1089
1325
|
#
|
1090
1326
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1091
1327
|
#
|
@@ -1104,9 +1340,15 @@ module Aws::ChimeSDKVoice
|
|
1104
1340
|
req.send_request(options)
|
1105
1341
|
end
|
1106
1342
|
|
1343
|
+
# Deletes the specified SIP credentials used by your equipment to
|
1344
|
+
# authenticate during call termination.
|
1345
|
+
#
|
1107
1346
|
# @option params [required, String] :voice_connector_id
|
1347
|
+
# The Voice Connector ID.
|
1108
1348
|
#
|
1109
1349
|
# @option params [required, Array<String>] :usernames
|
1350
|
+
# The RFC2617 compliant username associated with the SIP credentials, in
|
1351
|
+
# US-ASCII format.
|
1110
1352
|
#
|
1111
1353
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1112
1354
|
#
|
@@ -1126,7 +1368,11 @@ module Aws::ChimeSDKVoice
|
|
1126
1368
|
req.send_request(options)
|
1127
1369
|
end
|
1128
1370
|
|
1371
|
+
# Deletes a voice profile, including its voice print and enrollment
|
1372
|
+
# data. WARNING: This action is not reversible.
|
1373
|
+
#
|
1129
1374
|
# @option params [required, String] :voice_profile_id
|
1375
|
+
# The voice profile ID.
|
1130
1376
|
#
|
1131
1377
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1132
1378
|
#
|
@@ -1145,7 +1391,11 @@ module Aws::ChimeSDKVoice
|
|
1145
1391
|
req.send_request(options)
|
1146
1392
|
end
|
1147
1393
|
|
1394
|
+
# Deletes all voice profiles in the domain. WARNING: This action is not
|
1395
|
+
# reversible.
|
1396
|
+
#
|
1148
1397
|
# @option params [required, String] :voice_profile_domain_id
|
1398
|
+
# The voice profile domain ID.
|
1149
1399
|
#
|
1150
1400
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1151
1401
|
#
|
@@ -1164,9 +1414,14 @@ module Aws::ChimeSDKVoice
|
|
1164
1414
|
req.send_request(options)
|
1165
1415
|
end
|
1166
1416
|
|
1417
|
+
# Disassociates the specified phone numbers from the specified Amazon
|
1418
|
+
# Chime SDK Voice Connector.
|
1419
|
+
#
|
1167
1420
|
# @option params [required, String] :voice_connector_id
|
1421
|
+
# The Voice Connector ID.
|
1168
1422
|
#
|
1169
1423
|
# @option params [required, Array<String>] :e164_phone_numbers
|
1424
|
+
# List of phone numbers, in E.164 format.
|
1170
1425
|
#
|
1171
1426
|
# @return [Types::DisassociatePhoneNumbersFromVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1172
1427
|
#
|
@@ -1195,9 +1450,14 @@ module Aws::ChimeSDKVoice
|
|
1195
1450
|
req.send_request(options)
|
1196
1451
|
end
|
1197
1452
|
|
1453
|
+
# Disassociates the specified phone numbers from the specified Amazon
|
1454
|
+
# Chime SDK Voice Connector group.
|
1455
|
+
#
|
1198
1456
|
# @option params [required, String] :voice_connector_group_id
|
1457
|
+
# The Voice Connector group ID.
|
1199
1458
|
#
|
1200
1459
|
# @option params [required, Array<String>] :e164_phone_numbers
|
1460
|
+
# The list of phone numbers, in E.164 format.
|
1201
1461
|
#
|
1202
1462
|
# @return [Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1203
1463
|
#
|
@@ -1226,6 +1486,9 @@ module Aws::ChimeSDKVoice
|
|
1226
1486
|
req.send_request(options)
|
1227
1487
|
end
|
1228
1488
|
|
1489
|
+
# Retrieves the global settings for the Amazon Chime SDK Voice
|
1490
|
+
# Connectors in an AWS account.
|
1491
|
+
#
|
1229
1492
|
# @return [Types::GetGlobalSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1230
1493
|
#
|
1231
1494
|
# * {Types::GetGlobalSettingsResponse#voice_connector #voice_connector} => Types::VoiceConnectorSettings
|
@@ -1243,7 +1506,11 @@ module Aws::ChimeSDKVoice
|
|
1243
1506
|
req.send_request(options)
|
1244
1507
|
end
|
1245
1508
|
|
1509
|
+
# Retrieves details for the specified phone number ID, such as
|
1510
|
+
# associations, capabilities, and product type.
|
1511
|
+
#
|
1246
1512
|
# @option params [required, String] :phone_number_id
|
1513
|
+
# The phone number ID.
|
1247
1514
|
#
|
1248
1515
|
# @return [Types::GetPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1249
1516
|
#
|
@@ -1289,7 +1556,12 @@ module Aws::ChimeSDKVoice
|
|
1289
1556
|
req.send_request(options)
|
1290
1557
|
end
|
1291
1558
|
|
1559
|
+
# Retrieves details for the specified phone number order, such as the
|
1560
|
+
# order creation timestamp, phone numbers in E.164 format, product type,
|
1561
|
+
# and order status.
|
1562
|
+
#
|
1292
1563
|
# @option params [required, String] :phone_number_order_id
|
1564
|
+
# The ID of the phone number order .
|
1293
1565
|
#
|
1294
1566
|
# @return [Types::GetPhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1295
1567
|
#
|
@@ -1322,6 +1594,9 @@ module Aws::ChimeSDKVoice
|
|
1322
1594
|
req.send_request(options)
|
1323
1595
|
end
|
1324
1596
|
|
1597
|
+
# Retrieves the phone number settings for the administrator's AWS
|
1598
|
+
# account, such as the default outbound calling name.
|
1599
|
+
#
|
1325
1600
|
# @return [Types::GetPhoneNumberSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1326
1601
|
#
|
1327
1602
|
# * {Types::GetPhoneNumberSettingsResponse#calling_name #calling_name} => String
|
@@ -1341,9 +1616,14 @@ module Aws::ChimeSDKVoice
|
|
1341
1616
|
req.send_request(options)
|
1342
1617
|
end
|
1343
1618
|
|
1619
|
+
# Retrieves the specified proxy session details for the specified Amazon
|
1620
|
+
# Chime SDK Voice Connector.
|
1621
|
+
#
|
1344
1622
|
# @option params [required, String] :voice_connector_id
|
1623
|
+
# The Voice Connector ID.
|
1345
1624
|
#
|
1346
1625
|
# @option params [required, String] :proxy_session_id
|
1626
|
+
# The proxy session ID.
|
1347
1627
|
#
|
1348
1628
|
# @return [Types::GetProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1349
1629
|
#
|
@@ -1385,7 +1665,11 @@ module Aws::ChimeSDKVoice
|
|
1385
1665
|
req.send_request(options)
|
1386
1666
|
end
|
1387
1667
|
|
1668
|
+
# Retrieves the information for a SIP media application, including name,
|
1669
|
+
# AWS Region, and endpoints.
|
1670
|
+
#
|
1388
1671
|
# @option params [required, String] :sip_media_application_id
|
1672
|
+
# The SIP media application ID .
|
1389
1673
|
#
|
1390
1674
|
# @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
1675
|
#
|
@@ -1406,6 +1690,7 @@ module Aws::ChimeSDKVoice
|
|
1406
1690
|
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
1407
1691
|
# resp.sip_media_application.created_timestamp #=> Time
|
1408
1692
|
# resp.sip_media_application.updated_timestamp #=> Time
|
1693
|
+
# resp.sip_media_application.sip_media_application_arn #=> String
|
1409
1694
|
#
|
1410
1695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplication AWS API Documentation
|
1411
1696
|
#
|
@@ -1416,7 +1701,10 @@ module Aws::ChimeSDKVoice
|
|
1416
1701
|
req.send_request(options)
|
1417
1702
|
end
|
1418
1703
|
|
1704
|
+
# Gets the Alexa Skill configuration for the SIP media application.
|
1705
|
+
#
|
1419
1706
|
# @option params [required, String] :sip_media_application_id
|
1707
|
+
# The SIP media application ID.
|
1420
1708
|
#
|
1421
1709
|
# @return [Types::GetSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1422
1710
|
#
|
@@ -1443,7 +1731,11 @@ module Aws::ChimeSDKVoice
|
|
1443
1731
|
req.send_request(options)
|
1444
1732
|
end
|
1445
1733
|
|
1734
|
+
# Retrieves the logging configuration for the specified SIP media
|
1735
|
+
# application.
|
1736
|
+
#
|
1446
1737
|
# @option params [required, String] :sip_media_application_id
|
1738
|
+
# The SIP media application ID.
|
1447
1739
|
#
|
1448
1740
|
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1449
1741
|
#
|
@@ -1468,7 +1760,11 @@ module Aws::ChimeSDKVoice
|
|
1468
1760
|
req.send_request(options)
|
1469
1761
|
end
|
1470
1762
|
|
1763
|
+
# Retrieves the details of a SIP rule, such as the rule ID, name,
|
1764
|
+
# triggers, and target endpoints.
|
1765
|
+
#
|
1471
1766
|
# @option params [required, String] :sip_rule_id
|
1767
|
+
# The SIP rule ID.
|
1472
1768
|
#
|
1473
1769
|
# @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1474
1770
|
#
|
@@ -1503,9 +1799,13 @@ module Aws::ChimeSDKVoice
|
|
1503
1799
|
req.send_request(options)
|
1504
1800
|
end
|
1505
1801
|
|
1802
|
+
# Retrieves the details of the specified speaker search task.
|
1803
|
+
#
|
1506
1804
|
# @option params [required, String] :voice_connector_id
|
1805
|
+
# The Voice Connector ID.
|
1507
1806
|
#
|
1508
1807
|
# @option params [required, String] :speaker_search_task_id
|
1808
|
+
# The ID of the speaker search task.
|
1509
1809
|
#
|
1510
1810
|
# @return [Types::GetSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1511
1811
|
#
|
@@ -1543,7 +1843,11 @@ module Aws::ChimeSDKVoice
|
|
1543
1843
|
req.send_request(options)
|
1544
1844
|
end
|
1545
1845
|
|
1846
|
+
# Retrieves details for the specified Amazon Chime SDK Voice Connector,
|
1847
|
+
# such as timestamps,name, outbound host, and encryption requirements.
|
1848
|
+
#
|
1546
1849
|
# @option params [required, String] :voice_connector_id
|
1850
|
+
# The Voice Connector ID.
|
1547
1851
|
#
|
1548
1852
|
# @return [Types::GetVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1549
1853
|
#
|
@@ -1575,7 +1879,11 @@ module Aws::ChimeSDKVoice
|
|
1575
1879
|
req.send_request(options)
|
1576
1880
|
end
|
1577
1881
|
|
1882
|
+
# Retrieves the emergency calling configuration details for the
|
1883
|
+
# specified Voice Connector.
|
1884
|
+
#
|
1578
1885
|
# @option params [required, String] :voice_connector_id
|
1886
|
+
# The Voice Connector ID.
|
1579
1887
|
#
|
1580
1888
|
# @return [Types::GetVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1581
1889
|
#
|
@@ -1603,7 +1911,11 @@ module Aws::ChimeSDKVoice
|
|
1603
1911
|
req.send_request(options)
|
1604
1912
|
end
|
1605
1913
|
|
1914
|
+
# Retrieves details for the specified Amazon Chime SDK Voice Connector
|
1915
|
+
# group, such as timestamps,name, and associated `VoiceConnectorItems`.
|
1916
|
+
#
|
1606
1917
|
# @option params [required, String] :voice_connector_group_id
|
1918
|
+
# The Voice Connector group ID.
|
1607
1919
|
#
|
1608
1920
|
# @return [Types::GetVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1609
1921
|
#
|
@@ -1635,7 +1947,12 @@ module Aws::ChimeSDKVoice
|
|
1635
1947
|
req.send_request(options)
|
1636
1948
|
end
|
1637
1949
|
|
1950
|
+
# Retrieves the logging configuration settings for the specified Voice
|
1951
|
+
# Connector. Shows whether SIP message logs are enabled for sending to
|
1952
|
+
# Amazon CloudWatch Logs.
|
1953
|
+
#
|
1638
1954
|
# @option params [required, String] :voice_connector_id
|
1955
|
+
# The Voice Connector ID.
|
1639
1956
|
#
|
1640
1957
|
# @return [Types::GetVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1641
1958
|
#
|
@@ -1661,7 +1978,10 @@ module Aws::ChimeSDKVoice
|
|
1661
1978
|
req.send_request(options)
|
1662
1979
|
end
|
1663
1980
|
|
1981
|
+
# Retrieves the origination settings for the specified Voice Connector.
|
1982
|
+
#
|
1664
1983
|
# @option params [required, String] :voice_connector_id
|
1984
|
+
# The Voice Connector ID.
|
1665
1985
|
#
|
1666
1986
|
# @return [Types::GetVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1667
1987
|
#
|
@@ -1692,7 +2012,11 @@ module Aws::ChimeSDKVoice
|
|
1692
2012
|
req.send_request(options)
|
1693
2013
|
end
|
1694
2014
|
|
2015
|
+
# Retrieves the proxy configuration details for the specified Amazon
|
2016
|
+
# Chime SDK Voice Connector.
|
2017
|
+
#
|
1695
2018
|
# @option params [required, String] :voice_connector_id
|
2019
|
+
# The Voice Connector ID.
|
1696
2020
|
#
|
1697
2021
|
# @return [Types::GetVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1698
2022
|
#
|
@@ -1721,7 +2045,13 @@ module Aws::ChimeSDKVoice
|
|
1721
2045
|
req.send_request(options)
|
1722
2046
|
end
|
1723
2047
|
|
2048
|
+
# Retrieves the streaming configuration details for the specified Amazon
|
2049
|
+
# Chime SDK Voice Connector. Shows whether media streaming is enabled
|
2050
|
+
# for sending to Amazon Kinesis. It also shows the retention period, in
|
2051
|
+
# hours, for the Amazon Kinesis data.
|
2052
|
+
#
|
1724
2053
|
# @option params [required, String] :voice_connector_id
|
2054
|
+
# The Voice Connector ID.
|
1725
2055
|
#
|
1726
2056
|
# @return [Types::GetVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1727
2057
|
#
|
@@ -1751,7 +2081,11 @@ module Aws::ChimeSDKVoice
|
|
1751
2081
|
req.send_request(options)
|
1752
2082
|
end
|
1753
2083
|
|
2084
|
+
# Retrieves the termination setting details for the specified Voice
|
2085
|
+
# Connector.
|
2086
|
+
#
|
1754
2087
|
# @option params [required, String] :voice_connector_id
|
2088
|
+
# The Voice Connector ID.
|
1755
2089
|
#
|
1756
2090
|
# @return [Types::GetVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1757
2091
|
#
|
@@ -1782,7 +2116,12 @@ module Aws::ChimeSDKVoice
|
|
1782
2116
|
req.send_request(options)
|
1783
2117
|
end
|
1784
2118
|
|
2119
|
+
# Retrieves information about the last time a `SIP OPTIONS` ping was
|
2120
|
+
# received from your SIP infrastructure for the specified Amazon Chime
|
2121
|
+
# SDK Voice Connector.
|
2122
|
+
#
|
1785
2123
|
# @option params [required, String] :voice_connector_id
|
2124
|
+
# The Voice Connector ID.
|
1786
2125
|
#
|
1787
2126
|
# @return [Types::GetVoiceConnectorTerminationHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1788
2127
|
#
|
@@ -1808,7 +2147,10 @@ module Aws::ChimeSDKVoice
|
|
1808
2147
|
req.send_request(options)
|
1809
2148
|
end
|
1810
2149
|
|
2150
|
+
# Retrieves the details of the specified voice profile.
|
2151
|
+
#
|
1811
2152
|
# @option params [required, String] :voice_profile_id
|
2153
|
+
# The voice profile ID.
|
1812
2154
|
#
|
1813
2155
|
# @return [Types::GetVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1814
2156
|
#
|
@@ -1838,7 +2180,10 @@ module Aws::ChimeSDKVoice
|
|
1838
2180
|
req.send_request(options)
|
1839
2181
|
end
|
1840
2182
|
|
2183
|
+
# Retrieves the details of the specified voice profile domain.
|
2184
|
+
#
|
1841
2185
|
# @option params [required, String] :voice_profile_domain_id
|
2186
|
+
# The voice profile domain ID.
|
1842
2187
|
#
|
1843
2188
|
# @return [Types::GetVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1844
2189
|
#
|
@@ -1869,11 +2214,17 @@ module Aws::ChimeSDKVoice
|
|
1869
2214
|
req.send_request(options)
|
1870
2215
|
end
|
1871
2216
|
|
2217
|
+
# Retrieves the details of a voice tone analysis task.
|
2218
|
+
#
|
1872
2219
|
# @option params [required, String] :voice_connector_id
|
2220
|
+
# The Voice Connector ID.
|
1873
2221
|
#
|
1874
2222
|
# @option params [required, String] :voice_tone_analysis_task_id
|
2223
|
+
# The ID of the voice tone anlysis task.
|
1875
2224
|
#
|
1876
2225
|
# @option params [required, Boolean] :is_caller
|
2226
|
+
# Specifies whether the voice being analyzed is the caller (originator)
|
2227
|
+
# or the callee (responder).
|
1877
2228
|
#
|
1878
2229
|
# @return [Types::GetVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1879
2230
|
#
|
@@ -1908,6 +2259,9 @@ module Aws::ChimeSDKVoice
|
|
1908
2259
|
req.send_request(options)
|
1909
2260
|
end
|
1910
2261
|
|
2262
|
+
# Lists the available AWS Regions in which you can create an Amazon
|
2263
|
+
# Chime SDK Voice Connector.
|
2264
|
+
#
|
1911
2265
|
# @return [Types::ListAvailableVoiceConnectorRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1912
2266
|
#
|
1913
2267
|
# * {Types::ListAvailableVoiceConnectorRegionsResponse#voice_connector_regions #voice_connector_regions} => Array<String>
|
@@ -1926,9 +2280,14 @@ module Aws::ChimeSDKVoice
|
|
1926
2280
|
req.send_request(options)
|
1927
2281
|
end
|
1928
2282
|
|
2283
|
+
# Lists the phone numbers for an administrator's Amazon Chime SDK
|
2284
|
+
# account.
|
2285
|
+
#
|
1929
2286
|
# @option params [String] :next_token
|
2287
|
+
# The token used to retrieve the next page of results.
|
1930
2288
|
#
|
1931
2289
|
# @option params [Integer] :max_results
|
2290
|
+
# The maximum number of results to return in a single call.
|
1932
2291
|
#
|
1933
2292
|
# @return [Types::ListPhoneNumberOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1934
2293
|
#
|
@@ -1967,17 +2326,27 @@ module Aws::ChimeSDKVoice
|
|
1967
2326
|
req.send_request(options)
|
1968
2327
|
end
|
1969
2328
|
|
2329
|
+
# Lists the phone numbers for the specified Amazon Chime SDK account,
|
2330
|
+
# Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon
|
2331
|
+
# Chime SDK Voice Connector group.
|
2332
|
+
#
|
1970
2333
|
# @option params [String] :status
|
2334
|
+
# The status of your organization's phone numbers.
|
1971
2335
|
#
|
1972
2336
|
# @option params [String] :product_type
|
2337
|
+
# The phone number product types.
|
1973
2338
|
#
|
1974
2339
|
# @option params [String] :filter_name
|
2340
|
+
# The filter to limit the number of results.
|
1975
2341
|
#
|
1976
2342
|
# @option params [String] :filter_value
|
2343
|
+
# The filter value.
|
1977
2344
|
#
|
1978
2345
|
# @option params [Integer] :max_results
|
2346
|
+
# The maximum number of results to return in a single call.
|
1979
2347
|
#
|
1980
2348
|
# @option params [String] :next_token
|
2349
|
+
# The token used to return the next page of results.
|
1981
2350
|
#
|
1982
2351
|
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1983
2352
|
#
|
@@ -2033,13 +2402,20 @@ module Aws::ChimeSDKVoice
|
|
2033
2402
|
req.send_request(options)
|
2034
2403
|
end
|
2035
2404
|
|
2405
|
+
# Lists the proxy sessions for the specified Amazon Chime SDK Voice
|
2406
|
+
# Connector.
|
2407
|
+
#
|
2036
2408
|
# @option params [required, String] :voice_connector_id
|
2409
|
+
# The Voice Connector ID.
|
2037
2410
|
#
|
2038
2411
|
# @option params [String] :status
|
2412
|
+
# The proxy session status.
|
2039
2413
|
#
|
2040
2414
|
# @option params [String] :next_token
|
2415
|
+
# The token used to retrieve the next page of results.
|
2041
2416
|
#
|
2042
2417
|
# @option params [Integer] :max_results
|
2418
|
+
# The maximum number of results to return in a single call.
|
2043
2419
|
#
|
2044
2420
|
# @return [Types::ListProxySessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2045
2421
|
#
|
@@ -2088,9 +2464,15 @@ module Aws::ChimeSDKVoice
|
|
2088
2464
|
req.send_request(options)
|
2089
2465
|
end
|
2090
2466
|
|
2467
|
+
# Lists the SIP media applications under the administrator's AWS
|
2468
|
+
# account.
|
2469
|
+
#
|
2091
2470
|
# @option params [Integer] :max_results
|
2471
|
+
# The maximum number of results to return in a single call. Defaults to
|
2472
|
+
# 100.
|
2092
2473
|
#
|
2093
2474
|
# @option params [String] :next_token
|
2475
|
+
# The token used to return the next page of results.
|
2094
2476
|
#
|
2095
2477
|
# @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2096
2478
|
#
|
@@ -2116,6 +2498,7 @@ module Aws::ChimeSDKVoice
|
|
2116
2498
|
# resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
|
2117
2499
|
# resp.sip_media_applications[0].created_timestamp #=> Time
|
2118
2500
|
# resp.sip_media_applications[0].updated_timestamp #=> Time
|
2501
|
+
# resp.sip_media_applications[0].sip_media_application_arn #=> String
|
2119
2502
|
# resp.next_token #=> String
|
2120
2503
|
#
|
2121
2504
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplications AWS API Documentation
|
@@ -2127,11 +2510,17 @@ module Aws::ChimeSDKVoice
|
|
2127
2510
|
req.send_request(options)
|
2128
2511
|
end
|
2129
2512
|
|
2513
|
+
# Lists the SIP rules under the administrator's AWS account.
|
2514
|
+
#
|
2130
2515
|
# @option params [String] :sip_media_application_id
|
2516
|
+
# The SIP media application ID.
|
2131
2517
|
#
|
2132
2518
|
# @option params [Integer] :max_results
|
2519
|
+
# The maximum number of results to return in a single call. Defaults to
|
2520
|
+
# 100.
|
2133
2521
|
#
|
2134
2522
|
# @option params [String] :next_token
|
2523
|
+
# The token used to return the next page of results.
|
2135
2524
|
#
|
2136
2525
|
# @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2137
2526
|
#
|
@@ -2173,7 +2562,10 @@ module Aws::ChimeSDKVoice
|
|
2173
2562
|
req.send_request(options)
|
2174
2563
|
end
|
2175
2564
|
|
2565
|
+
# Lists the countries that you can order phone numbers from.
|
2566
|
+
#
|
2176
2567
|
# @option params [required, String] :product_type
|
2568
|
+
# The phone number product type.
|
2177
2569
|
#
|
2178
2570
|
# @return [Types::ListSupportedPhoneNumberCountriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2179
2571
|
#
|
@@ -2201,7 +2593,10 @@ module Aws::ChimeSDKVoice
|
|
2201
2593
|
req.send_request(options)
|
2202
2594
|
end
|
2203
2595
|
|
2596
|
+
# Returns a list of the tags in a given resource.
|
2597
|
+
#
|
2204
2598
|
# @option params [required, String] :resource_arn
|
2599
|
+
# The resource ARN.
|
2205
2600
|
#
|
2206
2601
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2207
2602
|
#
|
@@ -2228,9 +2623,14 @@ module Aws::ChimeSDKVoice
|
|
2228
2623
|
req.send_request(options)
|
2229
2624
|
end
|
2230
2625
|
|
2626
|
+
# Lists the Amazon Chime SDK Voice Connector groups in the
|
2627
|
+
# administrator's AWS account.
|
2628
|
+
#
|
2231
2629
|
# @option params [String] :next_token
|
2630
|
+
# The token used to return the next page of results.
|
2232
2631
|
#
|
2233
2632
|
# @option params [Integer] :max_results
|
2633
|
+
# The maximum number of results to return in a single call.
|
2234
2634
|
#
|
2235
2635
|
# @return [Types::ListVoiceConnectorGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2236
2636
|
#
|
@@ -2268,7 +2668,11 @@ module Aws::ChimeSDKVoice
|
|
2268
2668
|
req.send_request(options)
|
2269
2669
|
end
|
2270
2670
|
|
2671
|
+
# Lists the SIP credentials for the specified Amazon Chime SDK Voice
|
2672
|
+
# Connector.
|
2673
|
+
#
|
2271
2674
|
# @option params [required, String] :voice_connector_id
|
2675
|
+
# The Voice Connector ID.
|
2272
2676
|
#
|
2273
2677
|
# @return [Types::ListVoiceConnectorTerminationCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2274
2678
|
#
|
@@ -2294,9 +2698,14 @@ module Aws::ChimeSDKVoice
|
|
2294
2698
|
req.send_request(options)
|
2295
2699
|
end
|
2296
2700
|
|
2701
|
+
# Lists the Amazon Chime SDK Voice Connectors in the administrators AWS
|
2702
|
+
# account.
|
2703
|
+
#
|
2297
2704
|
# @option params [String] :next_token
|
2705
|
+
# The token used to return the next page of results.
|
2298
2706
|
#
|
2299
2707
|
# @option params [Integer] :max_results
|
2708
|
+
# The maximum number of results to return in a single call.
|
2300
2709
|
#
|
2301
2710
|
# @return [Types::ListVoiceConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2302
2711
|
#
|
@@ -2334,9 +2743,14 @@ module Aws::ChimeSDKVoice
|
|
2334
2743
|
req.send_request(options)
|
2335
2744
|
end
|
2336
2745
|
|
2746
|
+
# Lists the specified voice profile domains in the administrator's AWS
|
2747
|
+
# account.
|
2748
|
+
#
|
2337
2749
|
# @option params [String] :next_token
|
2750
|
+
# The token used to return the next page of results.
|
2338
2751
|
#
|
2339
2752
|
# @option params [Integer] :max_results
|
2753
|
+
# The maximum number of results to return in a single call.
|
2340
2754
|
#
|
2341
2755
|
# @return [Types::ListVoiceProfileDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2342
2756
|
#
|
@@ -2372,11 +2786,16 @@ module Aws::ChimeSDKVoice
|
|
2372
2786
|
req.send_request(options)
|
2373
2787
|
end
|
2374
2788
|
|
2789
|
+
# Lists the voice profiles in a voice profile domain.
|
2790
|
+
#
|
2375
2791
|
# @option params [required, String] :voice_profile_domain_id
|
2792
|
+
# The ID of the voice profile domain.
|
2376
2793
|
#
|
2377
2794
|
# @option params [String] :next_token
|
2795
|
+
# The token used to retrieve the next page of results.
|
2378
2796
|
#
|
2379
2797
|
# @option params [Integer] :max_results
|
2798
|
+
# The maximum number of results in the request.
|
2380
2799
|
#
|
2381
2800
|
# @return [Types::ListVoiceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2382
2801
|
#
|
@@ -2413,9 +2832,13 @@ module Aws::ChimeSDKVoice
|
|
2413
2832
|
req.send_request(options)
|
2414
2833
|
end
|
2415
2834
|
|
2835
|
+
# Updates the Alexa Skill configuration for the SIP media application.
|
2836
|
+
#
|
2416
2837
|
# @option params [required, String] :sip_media_application_id
|
2838
|
+
# The SIP media application ID.
|
2417
2839
|
#
|
2418
2840
|
# @option params [Types::SipMediaApplicationAlexaSkillConfiguration] :sip_media_application_alexa_skill_configuration
|
2841
|
+
# The Alexa Skill configuration.
|
2419
2842
|
#
|
2420
2843
|
# @return [Types::PutSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2421
2844
|
#
|
@@ -2446,9 +2869,14 @@ module Aws::ChimeSDKVoice
|
|
2446
2869
|
req.send_request(options)
|
2447
2870
|
end
|
2448
2871
|
|
2872
|
+
# Updates the logging configuration for the specified SIP media
|
2873
|
+
# application.
|
2874
|
+
#
|
2449
2875
|
# @option params [required, String] :sip_media_application_id
|
2876
|
+
# The SIP media application ID.
|
2450
2877
|
#
|
2451
2878
|
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
2879
|
+
# The logging configuration for the specified SIP media application.
|
2452
2880
|
#
|
2453
2881
|
# @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2454
2882
|
#
|
@@ -2476,9 +2904,13 @@ module Aws::ChimeSDKVoice
|
|
2476
2904
|
req.send_request(options)
|
2477
2905
|
end
|
2478
2906
|
|
2907
|
+
# Updates a Voice Connector's emergency calling configuration.
|
2908
|
+
#
|
2479
2909
|
# @option params [required, String] :voice_connector_id
|
2910
|
+
# The Voice Connector ID.
|
2480
2911
|
#
|
2481
2912
|
# @option params [required, Types::EmergencyCallingConfiguration] :emergency_calling_configuration
|
2913
|
+
# The configuration being updated.
|
2482
2914
|
#
|
2483
2915
|
# @return [Types::PutVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2484
2916
|
#
|
@@ -2515,9 +2947,13 @@ module Aws::ChimeSDKVoice
|
|
2515
2947
|
req.send_request(options)
|
2516
2948
|
end
|
2517
2949
|
|
2950
|
+
# Updates a Voice Connector's logging configuration.
|
2951
|
+
#
|
2518
2952
|
# @option params [required, String] :voice_connector_id
|
2953
|
+
# The Voice Connector ID.
|
2519
2954
|
#
|
2520
2955
|
# @option params [required, Types::LoggingConfiguration] :logging_configuration
|
2956
|
+
# The logging configuration being updated.
|
2521
2957
|
#
|
2522
2958
|
# @return [Types::PutVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2523
2959
|
#
|
@@ -2547,9 +2983,13 @@ module Aws::ChimeSDKVoice
|
|
2547
2983
|
req.send_request(options)
|
2548
2984
|
end
|
2549
2985
|
|
2986
|
+
# Updates a Voice Connector's origination settings.
|
2987
|
+
#
|
2550
2988
|
# @option params [required, String] :voice_connector_id
|
2989
|
+
# The Voice Connector ID.
|
2551
2990
|
#
|
2552
2991
|
# @option params [required, Types::Origination] :origination
|
2992
|
+
# The origination settings being updated.
|
2553
2993
|
#
|
2554
2994
|
# @return [Types::PutVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2555
2995
|
#
|
@@ -2592,15 +3032,24 @@ module Aws::ChimeSDKVoice
|
|
2592
3032
|
req.send_request(options)
|
2593
3033
|
end
|
2594
3034
|
|
3035
|
+
# Puts the specified proxy configuration to the specified Amazon Chime
|
3036
|
+
# SDK Voice Connector.
|
3037
|
+
#
|
2595
3038
|
# @option params [required, String] :voice_connector_id
|
3039
|
+
# The Voice Connector ID.
|
2596
3040
|
#
|
2597
3041
|
# @option params [required, Integer] :default_session_expiry_minutes
|
3042
|
+
# The default number of minutes allowed for proxy session.
|
2598
3043
|
#
|
2599
3044
|
# @option params [required, Array<String>] :phone_number_pool_countries
|
3045
|
+
# The countries for proxy phone numbers to be selected from.
|
2600
3046
|
#
|
2601
3047
|
# @option params [String] :fall_back_phone_number
|
3048
|
+
# The phone number to route calls to after a proxy session expires.
|
2602
3049
|
#
|
2603
3050
|
# @option params [Boolean] :disabled
|
3051
|
+
# When true, stops proxy sessions from being created on the specified
|
3052
|
+
# Amazon Chime SDK Voice Connector.
|
2604
3053
|
#
|
2605
3054
|
# @return [Types::PutVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2606
3055
|
#
|
@@ -2633,9 +3082,13 @@ module Aws::ChimeSDKVoice
|
|
2633
3082
|
req.send_request(options)
|
2634
3083
|
end
|
2635
3084
|
|
3085
|
+
# Updates a Voice Connector's streaming configuration settings.
|
3086
|
+
#
|
2636
3087
|
# @option params [required, String] :voice_connector_id
|
3088
|
+
# The Voice Connector ID.
|
2637
3089
|
#
|
2638
3090
|
# @option params [required, Types::StreamingConfiguration] :streaming_configuration
|
3091
|
+
# The streaming settings being updated.
|
2639
3092
|
#
|
2640
3093
|
# @return [Types::PutVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2641
3094
|
#
|
@@ -2678,9 +3131,13 @@ module Aws::ChimeSDKVoice
|
|
2678
3131
|
req.send_request(options)
|
2679
3132
|
end
|
2680
3133
|
|
3134
|
+
# Updates a Voice Connector's termination settings.
|
3135
|
+
#
|
2681
3136
|
# @option params [required, String] :voice_connector_id
|
3137
|
+
# The Voice Connector ID.
|
2682
3138
|
#
|
2683
3139
|
# @option params [required, Types::Termination] :termination
|
3140
|
+
# The termination settings to be updated.
|
2684
3141
|
#
|
2685
3142
|
# @return [Types::PutVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2686
3143
|
#
|
@@ -2718,9 +3175,13 @@ module Aws::ChimeSDKVoice
|
|
2718
3175
|
req.send_request(options)
|
2719
3176
|
end
|
2720
3177
|
|
3178
|
+
# Updates a Voice Connector's termination credentials.
|
3179
|
+
#
|
2721
3180
|
# @option params [required, String] :voice_connector_id
|
3181
|
+
# The Voice Connector ID.
|
2722
3182
|
#
|
2723
3183
|
# @option params [Array<Types::Credential>] :credentials
|
3184
|
+
# The termination credentials being updated.
|
2724
3185
|
#
|
2725
3186
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2726
3187
|
#
|
@@ -2745,7 +3206,10 @@ module Aws::ChimeSDKVoice
|
|
2745
3206
|
req.send_request(options)
|
2746
3207
|
end
|
2747
3208
|
|
3209
|
+
# Restores a deleted phone number.
|
3210
|
+
#
|
2748
3211
|
# @option params [required, String] :phone_number_id
|
3212
|
+
# The ID of the phone number being restored.
|
2749
3213
|
#
|
2750
3214
|
# @return [Types::RestorePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2751
3215
|
#
|
@@ -2791,21 +3255,37 @@ module Aws::ChimeSDKVoice
|
|
2791
3255
|
req.send_request(options)
|
2792
3256
|
end
|
2793
3257
|
|
3258
|
+
# Searches the provisioned phone numbers in an organization.
|
3259
|
+
#
|
2794
3260
|
# @option params [String] :area_code
|
3261
|
+
# Confines a search to just the phone numbers associated with the
|
3262
|
+
# specified area code.
|
2795
3263
|
#
|
2796
3264
|
# @option params [String] :city
|
3265
|
+
# Confines a search to just the phone numbers associated with the
|
3266
|
+
# specified city.
|
2797
3267
|
#
|
2798
3268
|
# @option params [String] :country
|
3269
|
+
# Confines a search to just the phone numbers associated with the
|
3270
|
+
# specified country.
|
2799
3271
|
#
|
2800
3272
|
# @option params [String] :state
|
3273
|
+
# Confines a search to just the phone numbers associated with the
|
3274
|
+
# specified state.
|
2801
3275
|
#
|
2802
3276
|
# @option params [String] :toll_free_prefix
|
3277
|
+
# Confines a search to just the phone numbers associated with the
|
3278
|
+
# specified toll-free prefix.
|
2803
3279
|
#
|
2804
3280
|
# @option params [String] :phone_number_type
|
3281
|
+
# Confines a search to just the phone numbers associated with the
|
3282
|
+
# specified phone number type, either **local** or **toll-free**.
|
2805
3283
|
#
|
2806
3284
|
# @option params [Integer] :max_results
|
3285
|
+
# The maximum number of results to return.
|
2807
3286
|
#
|
2808
3287
|
# @option params [String] :next_token
|
3288
|
+
# The token used to return the next page of results.
|
2809
3289
|
#
|
2810
3290
|
# @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2811
3291
|
#
|
@@ -2842,13 +3322,29 @@ module Aws::ChimeSDKVoice
|
|
2842
3322
|
req.send_request(options)
|
2843
3323
|
end
|
2844
3324
|
|
3325
|
+
# Starts a speaker search task.
|
3326
|
+
#
|
3327
|
+
# Before starting any speaker search tasks, you must provide all notices
|
3328
|
+
# and obtain all consents from the speaker as required under applicable
|
3329
|
+
# privacy and biometrics laws, and as required under the [AWS service
|
3330
|
+
# terms][1] for the Amazon Chime SDK.
|
3331
|
+
#
|
3332
|
+
#
|
3333
|
+
#
|
3334
|
+
# [1]: https://aws.amazon.com/service-terms/
|
3335
|
+
#
|
2845
3336
|
# @option params [required, String] :voice_connector_id
|
3337
|
+
# The Voice Connector ID.
|
2846
3338
|
#
|
2847
3339
|
# @option params [required, String] :transaction_id
|
3340
|
+
# The transaction ID of the call being analyzed.
|
2848
3341
|
#
|
2849
3342
|
# @option params [required, String] :voice_profile_domain_id
|
3343
|
+
# The ID of the voice profile domain that will store the voice profile.
|
2850
3344
|
#
|
2851
3345
|
# @option params [String] :client_request_token
|
3346
|
+
# The unique identifier for the client request. Use a different token
|
3347
|
+
# for different speaker search tasks.
|
2852
3348
|
#
|
2853
3349
|
# @return [Types::StartSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2854
3350
|
#
|
@@ -2888,13 +3384,32 @@ module Aws::ChimeSDKVoice
|
|
2888
3384
|
req.send_request(options)
|
2889
3385
|
end
|
2890
3386
|
|
3387
|
+
# Starts a voice tone analysis task. For more information about voice
|
3388
|
+
# tone analysis, see [Using Amazon Chime SDK voice analytics][1] in the
|
3389
|
+
# *Amazon Chime SDK Developer Guide*.
|
3390
|
+
#
|
3391
|
+
# Before starting any voice tone analysis tasks, you must provide all
|
3392
|
+
# notices and obtain all consents from the speaker as required under
|
3393
|
+
# applicable privacy and biometrics laws, and as required under the [AWS
|
3394
|
+
# service terms][2] for the Amazon Chime SDK.
|
3395
|
+
#
|
3396
|
+
#
|
3397
|
+
#
|
3398
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
|
3399
|
+
# [2]: https://aws.amazon.com/service-terms/
|
3400
|
+
#
|
2891
3401
|
# @option params [required, String] :voice_connector_id
|
3402
|
+
# The Voice Connector ID.
|
2892
3403
|
#
|
2893
3404
|
# @option params [required, String] :transaction_id
|
3405
|
+
# The transaction ID.
|
2894
3406
|
#
|
2895
3407
|
# @option params [required, String] :language_code
|
3408
|
+
# The language code.
|
2896
3409
|
#
|
2897
3410
|
# @option params [String] :client_request_token
|
3411
|
+
# The unique identifier for the client request. Use a different token
|
3412
|
+
# for different voice tone analysis tasks.
|
2898
3413
|
#
|
2899
3414
|
# @return [Types::StartVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2900
3415
|
#
|
@@ -2930,9 +3445,13 @@ module Aws::ChimeSDKVoice
|
|
2930
3445
|
req.send_request(options)
|
2931
3446
|
end
|
2932
3447
|
|
3448
|
+
# Stops a speaker search task.
|
3449
|
+
#
|
2933
3450
|
# @option params [required, String] :voice_connector_id
|
3451
|
+
# The Voice Connector ID.
|
2934
3452
|
#
|
2935
3453
|
# @option params [required, String] :speaker_search_task_id
|
3454
|
+
# The speaker search task ID.
|
2936
3455
|
#
|
2937
3456
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2938
3457
|
#
|
@@ -2952,9 +3471,13 @@ module Aws::ChimeSDKVoice
|
|
2952
3471
|
req.send_request(options)
|
2953
3472
|
end
|
2954
3473
|
|
3474
|
+
# Stops a voice tone analysis task.
|
3475
|
+
#
|
2955
3476
|
# @option params [required, String] :voice_connector_id
|
3477
|
+
# The Voice Connector ID.
|
2956
3478
|
#
|
2957
3479
|
# @option params [required, String] :voice_tone_analysis_task_id
|
3480
|
+
# The ID of the voice tone analysis task.
|
2958
3481
|
#
|
2959
3482
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2960
3483
|
#
|
@@ -2974,9 +3497,13 @@ module Aws::ChimeSDKVoice
|
|
2974
3497
|
req.send_request(options)
|
2975
3498
|
end
|
2976
3499
|
|
3500
|
+
# Adds a tag to the specified resource.
|
3501
|
+
#
|
2977
3502
|
# @option params [required, String] :resource_arn
|
3503
|
+
# The ARN of the resource being tagged.
|
2978
3504
|
#
|
2979
3505
|
# @option params [required, Array<Types::Tag>] :tags
|
3506
|
+
# A list of the tags being added to the resource.
|
2980
3507
|
#
|
2981
3508
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2982
3509
|
#
|
@@ -3001,9 +3528,13 @@ module Aws::ChimeSDKVoice
|
|
3001
3528
|
req.send_request(options)
|
3002
3529
|
end
|
3003
3530
|
|
3531
|
+
# Removes tags from a resource.
|
3532
|
+
#
|
3004
3533
|
# @option params [required, String] :resource_arn
|
3534
|
+
# The ARN of the resource having its tags removed.
|
3005
3535
|
#
|
3006
3536
|
# @option params [required, Array<String>] :tag_keys
|
3537
|
+
# The keys of the tags being removed from the resource.
|
3007
3538
|
#
|
3008
3539
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3009
3540
|
#
|
@@ -3023,7 +3554,11 @@ module Aws::ChimeSDKVoice
|
|
3023
3554
|
req.send_request(options)
|
3024
3555
|
end
|
3025
3556
|
|
3557
|
+
# Updates global settings for the Amazon Chime SDK Voice Connectors in
|
3558
|
+
# an AWS account.
|
3559
|
+
#
|
3026
3560
|
# @option params [Types::VoiceConnectorSettings] :voice_connector
|
3561
|
+
# The Voice Connector settings.
|
3027
3562
|
#
|
3028
3563
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3029
3564
|
#
|
@@ -3044,11 +3579,26 @@ module Aws::ChimeSDKVoice
|
|
3044
3579
|
req.send_request(options)
|
3045
3580
|
end
|
3046
3581
|
|
3582
|
+
# Updates phone number details, such as product type or calling name,
|
3583
|
+
# for the specified phone number ID. You can update one phone number
|
3584
|
+
# detail at a time. For example, you can update either the product type
|
3585
|
+
# or the calling name in one action.
|
3586
|
+
#
|
3587
|
+
# For numbers outside the U.S., you must use the Amazon Chime SDK SIP
|
3588
|
+
# Media Application Dial-In product type.
|
3589
|
+
#
|
3590
|
+
# Updates to outbound calling names can take 72 hours to complete.
|
3591
|
+
# Pending updates to outbound calling names must be complete before you
|
3592
|
+
# can request another update.
|
3593
|
+
#
|
3047
3594
|
# @option params [required, String] :phone_number_id
|
3595
|
+
# The phone number ID.
|
3048
3596
|
#
|
3049
3597
|
# @option params [String] :product_type
|
3598
|
+
# The product type.
|
3050
3599
|
#
|
3051
3600
|
# @option params [String] :calling_name
|
3601
|
+
# The outbound calling name associated with the phone number.
|
3052
3602
|
#
|
3053
3603
|
# @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3054
3604
|
#
|
@@ -3096,7 +3646,13 @@ module Aws::ChimeSDKVoice
|
|
3096
3646
|
req.send_request(options)
|
3097
3647
|
end
|
3098
3648
|
|
3649
|
+
# Updates the phone number settings for the administrator's AWS
|
3650
|
+
# account, such as the default outbound calling name. You can update the
|
3651
|
+
# default outbound calling name once every seven days. Outbound calling
|
3652
|
+
# names can take up to 72 hours to update.
|
3653
|
+
#
|
3099
3654
|
# @option params [required, String] :calling_name
|
3655
|
+
# The default outbound calling name for the account.
|
3100
3656
|
#
|
3101
3657
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3102
3658
|
#
|
@@ -3115,13 +3671,20 @@ module Aws::ChimeSDKVoice
|
|
3115
3671
|
req.send_request(options)
|
3116
3672
|
end
|
3117
3673
|
|
3674
|
+
# Updates the specified proxy session details, such as voice or SMS
|
3675
|
+
# capabilities.
|
3676
|
+
#
|
3118
3677
|
# @option params [required, String] :voice_connector_id
|
3678
|
+
# The Voice Connector ID.
|
3119
3679
|
#
|
3120
3680
|
# @option params [required, String] :proxy_session_id
|
3681
|
+
# The proxy session ID.
|
3121
3682
|
#
|
3122
3683
|
# @option params [required, Array<String>] :capabilities
|
3684
|
+
# The proxy session capabilities.
|
3123
3685
|
#
|
3124
3686
|
# @option params [Integer] :expiry_minutes
|
3687
|
+
# The number of minutes allowed for the proxy session.
|
3125
3688
|
#
|
3126
3689
|
# @return [Types::UpdateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3127
3690
|
#
|
@@ -3165,11 +3728,16 @@ module Aws::ChimeSDKVoice
|
|
3165
3728
|
req.send_request(options)
|
3166
3729
|
end
|
3167
3730
|
|
3731
|
+
# Updates the details of the specified SIP media application.
|
3732
|
+
#
|
3168
3733
|
# @option params [required, String] :sip_media_application_id
|
3734
|
+
# The SIP media application ID.
|
3169
3735
|
#
|
3170
3736
|
# @option params [String] :name
|
3737
|
+
# The new name for the specified SIP media application.
|
3171
3738
|
#
|
3172
3739
|
# @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
3740
|
+
# The new set of endpoints for the specified SIP media application.
|
3173
3741
|
#
|
3174
3742
|
# @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3175
3743
|
#
|
@@ -3196,6 +3764,7 @@ module Aws::ChimeSDKVoice
|
|
3196
3764
|
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
3197
3765
|
# resp.sip_media_application.created_timestamp #=> Time
|
3198
3766
|
# resp.sip_media_application.updated_timestamp #=> Time
|
3767
|
+
# resp.sip_media_application.sip_media_application_arn #=> String
|
3199
3768
|
#
|
3200
3769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication AWS API Documentation
|
3201
3770
|
#
|
@@ -3206,11 +3775,19 @@ module Aws::ChimeSDKVoice
|
|
3206
3775
|
req.send_request(options)
|
3207
3776
|
end
|
3208
3777
|
|
3778
|
+
# Invokes the AWS Lambda function associated with the SIP media
|
3779
|
+
# application and transaction ID in an update request. The Lambda
|
3780
|
+
# function can then return a new set of actions.
|
3781
|
+
#
|
3209
3782
|
# @option params [required, String] :sip_media_application_id
|
3783
|
+
# The ID of the SIP media application handling the call.
|
3210
3784
|
#
|
3211
3785
|
# @option params [required, String] :transaction_id
|
3786
|
+
# The ID of the call transaction.
|
3212
3787
|
#
|
3213
3788
|
# @option params [required, Hash<String,String>] :arguments
|
3789
|
+
# Arguments made available to the Lambda function as part of the
|
3790
|
+
# `CALL_UPDATE_REQUESTED` event. Can contain 0-20 key-value pairs.
|
3214
3791
|
#
|
3215
3792
|
# @return [Types::UpdateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3216
3793
|
#
|
@@ -3239,13 +3816,19 @@ module Aws::ChimeSDKVoice
|
|
3239
3816
|
req.send_request(options)
|
3240
3817
|
end
|
3241
3818
|
|
3819
|
+
# Updates the details of the specified SIP rule.
|
3820
|
+
#
|
3242
3821
|
# @option params [required, String] :sip_rule_id
|
3822
|
+
# The SIP rule ID.
|
3243
3823
|
#
|
3244
3824
|
# @option params [required, String] :name
|
3825
|
+
# The new name for the specified SIP rule.
|
3245
3826
|
#
|
3246
3827
|
# @option params [Boolean] :disabled
|
3828
|
+
# The new value that indicates whether the rule is disabled.
|
3247
3829
|
#
|
3248
3830
|
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
3831
|
+
# The new list of target applications.
|
3249
3832
|
#
|
3250
3833
|
# @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3251
3834
|
#
|
@@ -3289,11 +3872,17 @@ module Aws::ChimeSDKVoice
|
|
3289
3872
|
req.send_request(options)
|
3290
3873
|
end
|
3291
3874
|
|
3875
|
+
# Updates the details for the specified Amazon Chime SDK Voice
|
3876
|
+
# Connector.
|
3877
|
+
#
|
3292
3878
|
# @option params [required, String] :voice_connector_id
|
3879
|
+
# The Voice Connector ID.
|
3293
3880
|
#
|
3294
3881
|
# @option params [required, String] :name
|
3882
|
+
# The name of the Voice Connector.
|
3295
3883
|
#
|
3296
3884
|
# @option params [required, Boolean] :require_encryption
|
3885
|
+
# When enabled, requires encryption for the Voice Connector.
|
3297
3886
|
#
|
3298
3887
|
# @return [Types::UpdateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3299
3888
|
#
|
@@ -3327,11 +3916,17 @@ module Aws::ChimeSDKVoice
|
|
3327
3916
|
req.send_request(options)
|
3328
3917
|
end
|
3329
3918
|
|
3919
|
+
# Updates the settings for the specified Amazon Chime SDK Voice
|
3920
|
+
# Connector group.
|
3921
|
+
#
|
3330
3922
|
# @option params [required, String] :voice_connector_group_id
|
3923
|
+
# The Voice Connector ID.
|
3331
3924
|
#
|
3332
3925
|
# @option params [required, String] :name
|
3926
|
+
# The name of the Voice Connector group.
|
3333
3927
|
#
|
3334
3928
|
# @option params [required, Array<Types::VoiceConnectorItem>] :voice_connector_items
|
3929
|
+
# The `VoiceConnectorItems` to associate with the Voice Connector group.
|
3335
3930
|
#
|
3336
3931
|
# @return [Types::UpdateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3337
3932
|
#
|
@@ -3370,9 +3965,27 @@ module Aws::ChimeSDKVoice
|
|
3370
3965
|
req.send_request(options)
|
3371
3966
|
end
|
3372
3967
|
|
3968
|
+
# Updates the specified voice profile’s voice print and refreshes its
|
3969
|
+
# expiration timestamp.
|
3970
|
+
#
|
3971
|
+
# As a condition of using this feature, you acknowledge that the
|
3972
|
+
# collection, use, storage, and retention of your caller’s biometric
|
3973
|
+
# identifiers and biometric information (“biometric data”) in the form
|
3974
|
+
# of a digital voiceprint requires the caller’s informed consent via a
|
3975
|
+
# written release. Such consent is required under various state laws,
|
3976
|
+
# including biometrics laws in Illinois, Texas, Washington and other
|
3977
|
+
# state privacy laws.
|
3978
|
+
#
|
3979
|
+
# You must provide a written release to each caller through a process
|
3980
|
+
# that clearly reflects each caller’s informed consent before using
|
3981
|
+
# Amazon Chime SDK Voice Insights service, as required under the terms
|
3982
|
+
# of your agreement with AWS governing your use of the service.
|
3983
|
+
#
|
3373
3984
|
# @option params [required, String] :voice_profile_id
|
3985
|
+
# The profile ID.
|
3374
3986
|
#
|
3375
3987
|
# @option params [required, String] :speaker_search_task_id
|
3988
|
+
# The ID of the speaker search task.
|
3376
3989
|
#
|
3377
3990
|
# @return [Types::UpdateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3378
3991
|
#
|
@@ -3403,11 +4016,16 @@ module Aws::ChimeSDKVoice
|
|
3403
4016
|
req.send_request(options)
|
3404
4017
|
end
|
3405
4018
|
|
4019
|
+
# Updates the settings for the specified voice profile domain.
|
4020
|
+
#
|
3406
4021
|
# @option params [required, String] :voice_profile_domain_id
|
4022
|
+
# The domain ID.
|
3407
4023
|
#
|
3408
4024
|
# @option params [String] :name
|
4025
|
+
# The name of the voice profile domain.
|
3409
4026
|
#
|
3410
4027
|
# @option params [String] :description
|
4028
|
+
# The description of the voice profile domain.
|
3411
4029
|
#
|
3412
4030
|
# @return [Types::UpdateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3413
4031
|
#
|
@@ -3440,19 +4058,32 @@ module Aws::ChimeSDKVoice
|
|
3440
4058
|
req.send_request(options)
|
3441
4059
|
end
|
3442
4060
|
|
4061
|
+
# Validates an address to be used for 911 calls made with Amazon Chime
|
4062
|
+
# SDK Voice Connectors. You can use validated addresses in a Presence
|
4063
|
+
# Information Data Format Location Object file that you include in SIP
|
4064
|
+
# requests. That helps ensure that addresses are routed to the
|
4065
|
+
# appropriate Public Safety Answering Point.
|
4066
|
+
#
|
3443
4067
|
# @option params [required, String] :aws_account_id
|
4068
|
+
# The AWS account ID.
|
3444
4069
|
#
|
3445
4070
|
# @option params [required, String] :street_number
|
4071
|
+
# The address street number, such as `200` or `2121`.
|
3446
4072
|
#
|
3447
4073
|
# @option params [required, String] :street_info
|
4074
|
+
# The address street information, such as `8th Avenue`.
|
3448
4075
|
#
|
3449
4076
|
# @option params [required, String] :city
|
4077
|
+
# The address city, such as `Portland`.
|
3450
4078
|
#
|
3451
4079
|
# @option params [required, String] :state
|
4080
|
+
# The address state, such as `ME`.
|
3452
4081
|
#
|
3453
4082
|
# @option params [required, String] :country
|
4083
|
+
# The country in the address being validated.
|
3454
4084
|
#
|
3455
4085
|
# @option params [required, String] :postal_code
|
4086
|
+
# The dress postal code, such `04352`.
|
3456
4087
|
#
|
3457
4088
|
# @return [Types::ValidateE911AddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3458
4089
|
#
|
@@ -3518,7 +4149,7 @@ module Aws::ChimeSDKVoice
|
|
3518
4149
|
params: params,
|
3519
4150
|
config: config)
|
3520
4151
|
context[:gem_name] = 'aws-sdk-chimesdkvoice'
|
3521
|
-
context[:gem_version] = '1.
|
4152
|
+
context[:gem_version] = '1.5.0'
|
3522
4153
|
Seahorse::Client::Request.new(handlers, context)
|
3523
4154
|
end
|
3524
4155
|
|