aws-sdk-chimesdkvoice 1.2.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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,23 @@ 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.
607
667
  #
608
668
  # @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
609
669
  #
@@ -640,15 +700,27 @@ module Aws::ChimeSDKVoice
640
700
  req.send_request(options)
641
701
  end
642
702
 
703
+ # Creates an outbound call to a phone number from the phone number
704
+ # specified in the request, and it invokes the endpoint of the specified
705
+ # `sipMediaApplicationId`.
706
+ #
643
707
  # @option params [required, String] :from_phone_number
708
+ # The phone number that a user calls from. This is a phone number in
709
+ # your Amazon Chime SDK phone number inventory.
644
710
  #
645
711
  # @option params [required, String] :to_phone_number
712
+ # The phone number that the service should call.
646
713
  #
647
714
  # @option params [required, String] :sip_media_application_id
715
+ # The ID of the SIP media application.
648
716
  #
649
717
  # @option params [Hash<String,String>] :sip_headers
718
+ # The SIP headers added to an outbound call leg.
650
719
  #
651
720
  # @option params [Hash<String,String>] :arguments_map
721
+ # Context passed to a CreateSipMediaApplication API call. For example,
722
+ # you could pass key-value pairs such as: `"FirstName": "John",
723
+ # "LastName": "Doe"`
652
724
  #
653
725
  # @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
654
726
  #
@@ -681,15 +753,38 @@ module Aws::ChimeSDKVoice
681
753
  req.send_request(options)
682
754
  end
683
755
 
756
+ # Creates a SIP rule, which can be used to run a SIP media application
757
+ # as a target for a specific trigger type. For more information about
758
+ # SIP rules, see [Managing SIP media applications and rules][1] in the
759
+ # *Amazon Chime SDK Administrator Guide*.
760
+ #
761
+ #
762
+ #
763
+ # [1]: https://docs.aws.amazon.com/chime-sdk/latest/ag/manage-sip-applications.html
764
+ #
684
765
  # @option params [required, String] :name
766
+ # The name of the SIP rule.
685
767
  #
686
768
  # @option params [required, String] :trigger_type
769
+ # The type of trigger assigned to the SIP rule in `TriggerValue`,
770
+ # currently `RequestUriHostname` or `ToPhoneNumber`.
687
771
  #
688
772
  # @option params [required, String] :trigger_value
773
+ # If `TriggerType` is `RequestUriHostname`, the value can be the
774
+ # outbound host name of a Voice Connector. If `TriggerType` is
775
+ # `ToPhoneNumber`, the value can be a customer-owned phone number in the
776
+ # E164 format. The `SipMediaApplication` specified in the `SipRule` is
777
+ # triggered if the request URI in an incoming SIP request matches the
778
+ # `RequestUriHostname`, or if the `To` header in the incoming SIP
779
+ # request matches the `ToPhoneNumber` value.
689
780
  #
690
781
  # @option params [Boolean] :disabled
782
+ # Disables or enables a SIP rule. You must disable SIP rules before you
783
+ # can delete them.
691
784
  #
692
785
  # @option params [Array<Types::SipRuleTargetApplication>] :target_applications
786
+ # List of SIP media applications, with priority and AWS Region. Only one
787
+ # SIP application per AWS Region can be used.
693
788
  #
694
789
  # @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
695
790
  #
@@ -734,11 +829,23 @@ module Aws::ChimeSDKVoice
734
829
  req.send_request(options)
735
830
  end
736
831
 
832
+ # Creates an Amazon Chime SDK Voice Connector. For more information
833
+ # about Voice Connectors, see [Managing Amazon Chime SDK Voice Connector
834
+ # groups][1] in the *Amazon Chime SDK Administrator Guide*.
835
+ #
836
+ #
837
+ #
838
+ # [1]: https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html
839
+ #
737
840
  # @option params [required, String] :name
841
+ # The name of the Voice Connector.
738
842
  #
739
843
  # @option params [String] :aws_region
844
+ # The AWS Region in which the Amazon Chime SDK Voice Connector is
845
+ # created. Default value: `us-east-1` .
740
846
  #
741
847
  # @option params [required, Boolean] :require_encryption
848
+ # Enables or disables encryption for the Voice Connector.
742
849
  #
743
850
  # @return [Types::CreateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
744
851
  #
@@ -772,9 +879,20 @@ module Aws::ChimeSDKVoice
772
879
  req.send_request(options)
773
880
  end
774
881
 
882
+ # Creates an Amazon Chime SDK Voice Connector group under the
883
+ # administrator's AWS account. You can associate Amazon Chime SDK Voice
884
+ # Connectors with the Voice Connector group by including
885
+ # `VoiceConnectorItems` in the request.
886
+ #
887
+ # You can include Voice Connectors from different AWS Regions in your
888
+ # group. This creates a fault tolerant mechanism for fallback in case of
889
+ # availability events.
890
+ #
775
891
  # @option params [required, String] :name
892
+ # The name of the Voice Connector group.
776
893
  #
777
894
  # @option params [Array<Types::VoiceConnectorItem>] :voice_connector_items
895
+ # Lists the Voice Connectors that inbound calls are routed to.
778
896
  #
779
897
  # @return [Types::CreateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
780
898
  #
@@ -812,7 +930,136 @@ module Aws::ChimeSDKVoice
812
930
  req.send_request(options)
813
931
  end
814
932
 
933
+ # Creates a voice profile, which consists of an enrolled user and their
934
+ # latest voice print.
935
+ #
936
+ # Before creating any voice profiles, you must provide all notices and
937
+ # obtain all consents from the speaker as required under applicable
938
+ # privacy and biometrics laws, and as required under the [AWS service
939
+ # terms][1] for the Amazon Chime SDK.
940
+ #
941
+ # For more information about voice profiles and voice analytics, see
942
+ # [Using Amazon Chime SDK Voice Analytics][2] in the *Amazon Chime SDK
943
+ # Developer Guide*.
944
+ #
945
+ #
946
+ #
947
+ # [1]: https://aws.amazon.com/service-terms/
948
+ # [2]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
949
+ #
950
+ # @option params [required, String] :speaker_search_task_id
951
+ # The ID of the speaker search task.
952
+ #
953
+ # @return [Types::CreateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
954
+ #
955
+ # * {Types::CreateVoiceProfileResponse#voice_profile #voice_profile} => Types::VoiceProfile
956
+ #
957
+ # @example Request syntax with placeholder values
958
+ #
959
+ # resp = client.create_voice_profile({
960
+ # speaker_search_task_id: "NonEmptyString256", # required
961
+ # })
962
+ #
963
+ # @example Response structure
964
+ #
965
+ # resp.voice_profile.voice_profile_id #=> String
966
+ # resp.voice_profile.voice_profile_arn #=> String
967
+ # resp.voice_profile.voice_profile_domain_id #=> String
968
+ # resp.voice_profile.created_timestamp #=> Time
969
+ # resp.voice_profile.updated_timestamp #=> Time
970
+ # resp.voice_profile.expiration_timestamp #=> Time
971
+ #
972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfile AWS API Documentation
973
+ #
974
+ # @overload create_voice_profile(params = {})
975
+ # @param [Hash] params ({})
976
+ def create_voice_profile(params = {}, options = {})
977
+ req = build_request(:create_voice_profile, params)
978
+ req.send_request(options)
979
+ end
980
+
981
+ # Creates a voice profile domain, a collection of voice profiles, their
982
+ # voice prints, and encrypted enrollment audio.
983
+ #
984
+ # Before creating any voice profiles, you must provide all notices and
985
+ # obtain all consents from the speaker as required under applicable
986
+ # privacy and biometrics laws, and as required under the [AWS service
987
+ # terms][1] for the Amazon Chime SDK.
988
+ #
989
+ # For more information about voice profile domains, see [Using Amazon
990
+ # Chime SDK Voice Analytics][2] in the *Amazon Chime SDK Developer
991
+ # Guide*.
992
+ #
993
+ #
994
+ #
995
+ # [1]: https://aws.amazon.com/service-terms/
996
+ # [2]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
997
+ #
998
+ # @option params [required, String] :name
999
+ # The name of the voice profile domain.
1000
+ #
1001
+ # @option params [String] :description
1002
+ # A description of the voice profile domain.
1003
+ #
1004
+ # @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
1005
+ # The server-side encryption configuration for the request.
1006
+ #
1007
+ # @option params [String] :client_request_token
1008
+ # The unique identifier for the client request. Use a different token
1009
+ # for different domain creation requests.
1010
+ #
1011
+ # @option params [Array<Types::Tag>] :tags
1012
+ # The tags assigned to the domain.
1013
+ #
1014
+ # @return [Types::CreateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1015
+ #
1016
+ # * {Types::CreateVoiceProfileDomainResponse#voice_profile_domain #voice_profile_domain} => Types::VoiceProfileDomain
1017
+ #
1018
+ # @example Request syntax with placeholder values
1019
+ #
1020
+ # resp = client.create_voice_profile_domain({
1021
+ # name: "VoiceProfileDomainName", # required
1022
+ # description: "VoiceProfileDomainDescription",
1023
+ # server_side_encryption_configuration: { # required
1024
+ # kms_key_arn: "Arn", # required
1025
+ # },
1026
+ # client_request_token: "ClientRequestId",
1027
+ # tags: [
1028
+ # {
1029
+ # key: "TagKey", # required
1030
+ # value: "TagValue", # required
1031
+ # },
1032
+ # ],
1033
+ # })
1034
+ #
1035
+ # @example Response structure
1036
+ #
1037
+ # resp.voice_profile_domain.voice_profile_domain_id #=> String
1038
+ # resp.voice_profile_domain.voice_profile_domain_arn #=> String
1039
+ # resp.voice_profile_domain.name #=> String
1040
+ # resp.voice_profile_domain.description #=> String
1041
+ # resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
1042
+ # resp.voice_profile_domain.created_timestamp #=> Time
1043
+ # resp.voice_profile_domain.updated_timestamp #=> Time
1044
+ #
1045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain AWS API Documentation
1046
+ #
1047
+ # @overload create_voice_profile_domain(params = {})
1048
+ # @param [Hash] params ({})
1049
+ def create_voice_profile_domain(params = {}, options = {})
1050
+ req = build_request(:create_voice_profile_domain, params)
1051
+ req.send_request(options)
1052
+ end
1053
+
1054
+ # Moves the specified phone number into the **Deletion queue**. A phone
1055
+ # number must be disassociated from any users or Amazon Chime SDK Voice
1056
+ # Connectors before it can be deleted.
1057
+ #
1058
+ # Deleted phone numbers remain in the **Deletion queue** queue for 7
1059
+ # days before they are deleted permanently.
1060
+ #
815
1061
  # @option params [required, String] :phone_number_id
1062
+ # The phone number ID.
816
1063
  #
817
1064
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
818
1065
  #
@@ -831,9 +1078,14 @@ module Aws::ChimeSDKVoice
831
1078
  req.send_request(options)
832
1079
  end
833
1080
 
1081
+ # Deletes the specified proxy session from the specified Amazon Chime
1082
+ # SDK Voice Connector.
1083
+ #
834
1084
  # @option params [required, String] :voice_connector_id
1085
+ # The Voice Connector ID.
835
1086
  #
836
1087
  # @option params [required, String] :proxy_session_id
1088
+ # The proxy session ID.
837
1089
  #
838
1090
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
839
1091
  #
@@ -853,7 +1105,10 @@ module Aws::ChimeSDKVoice
853
1105
  req.send_request(options)
854
1106
  end
855
1107
 
1108
+ # Deletes a SIP media application.
1109
+ #
856
1110
  # @option params [required, String] :sip_media_application_id
1111
+ # The SIP media application ID.
857
1112
  #
858
1113
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
859
1114
  #
@@ -872,7 +1127,10 @@ module Aws::ChimeSDKVoice
872
1127
  req.send_request(options)
873
1128
  end
874
1129
 
1130
+ # Deletes a SIP rule.
1131
+ #
875
1132
  # @option params [required, String] :sip_rule_id
1133
+ # The SIP rule ID.
876
1134
  #
877
1135
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
878
1136
  #
@@ -891,7 +1149,12 @@ module Aws::ChimeSDKVoice
891
1149
  req.send_request(options)
892
1150
  end
893
1151
 
1152
+ # Deletes an Amazon Chime SDK Voice Connector. Any phone numbers
1153
+ # associated with the Amazon Chime SDK Voice Connector must be
1154
+ # disassociated from it before it can be deleted.
1155
+ #
894
1156
  # @option params [required, String] :voice_connector_id
1157
+ # The Voice Connector ID.
895
1158
  #
896
1159
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
897
1160
  #
@@ -910,7 +1173,11 @@ module Aws::ChimeSDKVoice
910
1173
  req.send_request(options)
911
1174
  end
912
1175
 
1176
+ # Deletes the emergency calling details from the specified Amazon Chime
1177
+ # SDK Voice Connector.
1178
+ #
913
1179
  # @option params [required, String] :voice_connector_id
1180
+ # The Voice Connector ID.
914
1181
  #
915
1182
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
916
1183
  #
@@ -929,7 +1196,12 @@ module Aws::ChimeSDKVoice
929
1196
  req.send_request(options)
930
1197
  end
931
1198
 
1199
+ # Deletes an Amazon Chime SDK Voice Connector group. Any
1200
+ # `VoiceConnectorItems` and phone numbers associated with the group must
1201
+ # be removed before it can be deleted.
1202
+ #
932
1203
  # @option params [required, String] :voice_connector_group_id
1204
+ # The Voice Connector Group ID.
933
1205
  #
934
1206
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
935
1207
  #
@@ -948,7 +1220,16 @@ module Aws::ChimeSDKVoice
948
1220
  req.send_request(options)
949
1221
  end
950
1222
 
1223
+ # Deletes the origination settings for the specified Amazon Chime SDK
1224
+ # Voice Connector.
1225
+ #
1226
+ # <note markdown="1"> If emergency calling is configured for the Voice Connector, it must be
1227
+ # deleted prior to deleting the origination settings.
1228
+ #
1229
+ # </note>
1230
+ #
951
1231
  # @option params [required, String] :voice_connector_id
1232
+ # The Voice Connector ID.
952
1233
  #
953
1234
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
954
1235
  #
@@ -967,7 +1248,11 @@ module Aws::ChimeSDKVoice
967
1248
  req.send_request(options)
968
1249
  end
969
1250
 
1251
+ # Deletes the proxy configuration from the specified Amazon Chime SDK
1252
+ # Voice Connector.
1253
+ #
970
1254
  # @option params [required, String] :voice_connector_id
1255
+ # The Voice Connector ID.
971
1256
  #
972
1257
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
973
1258
  #
@@ -986,7 +1271,10 @@ module Aws::ChimeSDKVoice
986
1271
  req.send_request(options)
987
1272
  end
988
1273
 
1274
+ # Deletes a Voice Connector's streaming configuration.
1275
+ #
989
1276
  # @option params [required, String] :voice_connector_id
1277
+ # The Voice Connector ID.
990
1278
  #
991
1279
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
992
1280
  #
@@ -1005,7 +1293,16 @@ module Aws::ChimeSDKVoice
1005
1293
  req.send_request(options)
1006
1294
  end
1007
1295
 
1296
+ # Deletes the termination settings for the specified Amazon Chime SDK
1297
+ # Voice Connector.
1298
+ #
1299
+ # <note markdown="1"> If emergency calling is configured for the Voice Connector, it must be
1300
+ # deleted prior to deleting the termination settings.
1301
+ #
1302
+ # </note>
1303
+ #
1008
1304
  # @option params [required, String] :voice_connector_id
1305
+ # The Voice Connector ID.
1009
1306
  #
1010
1307
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1011
1308
  #
@@ -1024,9 +1321,15 @@ module Aws::ChimeSDKVoice
1024
1321
  req.send_request(options)
1025
1322
  end
1026
1323
 
1324
+ # Deletes the specified SIP credentials used by your equipment to
1325
+ # authenticate during call termination.
1326
+ #
1027
1327
  # @option params [required, String] :voice_connector_id
1328
+ # The Voice Connector ID.
1028
1329
  #
1029
1330
  # @option params [required, Array<String>] :usernames
1331
+ # The RFC2617 compliant username associated with the SIP credentials, in
1332
+ # US-ASCII format.
1030
1333
  #
1031
1334
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1032
1335
  #
@@ -1046,9 +1349,60 @@ module Aws::ChimeSDKVoice
1046
1349
  req.send_request(options)
1047
1350
  end
1048
1351
 
1352
+ # Deletes a voice profile, including its voice print and enrollment
1353
+ # data. WARNING: This action is not reversible.
1354
+ #
1355
+ # @option params [required, String] :voice_profile_id
1356
+ # The voice profile ID.
1357
+ #
1358
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1359
+ #
1360
+ # @example Request syntax with placeholder values
1361
+ #
1362
+ # resp = client.delete_voice_profile({
1363
+ # voice_profile_id: "NonEmptyString256", # required
1364
+ # })
1365
+ #
1366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfile AWS API Documentation
1367
+ #
1368
+ # @overload delete_voice_profile(params = {})
1369
+ # @param [Hash] params ({})
1370
+ def delete_voice_profile(params = {}, options = {})
1371
+ req = build_request(:delete_voice_profile, params)
1372
+ req.send_request(options)
1373
+ end
1374
+
1375
+ # Deletes all voice profiles in the domain. WARNING: This action is not
1376
+ # reversible.
1377
+ #
1378
+ # @option params [required, String] :voice_profile_domain_id
1379
+ # The voice profile domain ID.
1380
+ #
1381
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1382
+ #
1383
+ # @example Request syntax with placeholder values
1384
+ #
1385
+ # resp = client.delete_voice_profile_domain({
1386
+ # voice_profile_domain_id: "NonEmptyString256", # required
1387
+ # })
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceProfileDomain AWS API Documentation
1390
+ #
1391
+ # @overload delete_voice_profile_domain(params = {})
1392
+ # @param [Hash] params ({})
1393
+ def delete_voice_profile_domain(params = {}, options = {})
1394
+ req = build_request(:delete_voice_profile_domain, params)
1395
+ req.send_request(options)
1396
+ end
1397
+
1398
+ # Disassociates the specified phone numbers from the specified Amazon
1399
+ # Chime SDK Voice Connector.
1400
+ #
1049
1401
  # @option params [required, String] :voice_connector_id
1402
+ # The Voice Connector ID.
1050
1403
  #
1051
1404
  # @option params [required, Array<String>] :e164_phone_numbers
1405
+ # List of phone numbers, in E.164 format.
1052
1406
  #
1053
1407
  # @return [Types::DisassociatePhoneNumbersFromVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1054
1408
  #
@@ -1077,9 +1431,14 @@ module Aws::ChimeSDKVoice
1077
1431
  req.send_request(options)
1078
1432
  end
1079
1433
 
1434
+ # Disassociates the specified phone numbers from the specified Amazon
1435
+ # Chime SDK Voice Connector group.
1436
+ #
1080
1437
  # @option params [required, String] :voice_connector_group_id
1438
+ # The Voice Connector group ID.
1081
1439
  #
1082
1440
  # @option params [required, Array<String>] :e164_phone_numbers
1441
+ # The list of phone numbers, in E.164 format.
1083
1442
  #
1084
1443
  # @return [Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1085
1444
  #
@@ -1108,6 +1467,9 @@ module Aws::ChimeSDKVoice
1108
1467
  req.send_request(options)
1109
1468
  end
1110
1469
 
1470
+ # Retrieves the global settings for the Amazon Chime SDK Voice
1471
+ # Connectors in an AWS account.
1472
+ #
1111
1473
  # @return [Types::GetGlobalSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1112
1474
  #
1113
1475
  # * {Types::GetGlobalSettingsResponse#voice_connector #voice_connector} => Types::VoiceConnectorSettings
@@ -1125,7 +1487,11 @@ module Aws::ChimeSDKVoice
1125
1487
  req.send_request(options)
1126
1488
  end
1127
1489
 
1490
+ # Retrieves details for the specified phone number ID, such as
1491
+ # associations, capabilities, and product type.
1492
+ #
1128
1493
  # @option params [required, String] :phone_number_id
1494
+ # The phone number ID.
1129
1495
  #
1130
1496
  # @return [Types::GetPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1131
1497
  #
@@ -1171,7 +1537,12 @@ module Aws::ChimeSDKVoice
1171
1537
  req.send_request(options)
1172
1538
  end
1173
1539
 
1540
+ # Retrieves details for the specified phone number order, such as the
1541
+ # order creation timestamp, phone numbers in E.164 format, product type,
1542
+ # and order status.
1543
+ #
1174
1544
  # @option params [required, String] :phone_number_order_id
1545
+ # The ID of the phone number order .
1175
1546
  #
1176
1547
  # @return [Types::GetPhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1177
1548
  #
@@ -1204,6 +1575,9 @@ module Aws::ChimeSDKVoice
1204
1575
  req.send_request(options)
1205
1576
  end
1206
1577
 
1578
+ # Retrieves the phone number settings for the administrator's AWS
1579
+ # account, such as the default outbound calling name.
1580
+ #
1207
1581
  # @return [Types::GetPhoneNumberSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1208
1582
  #
1209
1583
  # * {Types::GetPhoneNumberSettingsResponse#calling_name #calling_name} => String
@@ -1223,9 +1597,14 @@ module Aws::ChimeSDKVoice
1223
1597
  req.send_request(options)
1224
1598
  end
1225
1599
 
1600
+ # Retrieves the specified proxy session details for the specified Amazon
1601
+ # Chime SDK Voice Connector.
1602
+ #
1226
1603
  # @option params [required, String] :voice_connector_id
1604
+ # The Voice Connector ID.
1227
1605
  #
1228
1606
  # @option params [required, String] :proxy_session_id
1607
+ # The proxy session ID.
1229
1608
  #
1230
1609
  # @return [Types::GetProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1231
1610
  #
@@ -1267,7 +1646,11 @@ module Aws::ChimeSDKVoice
1267
1646
  req.send_request(options)
1268
1647
  end
1269
1648
 
1649
+ # Retrieves the information for a SIP media application, including name,
1650
+ # AWS Region, and endpoints.
1651
+ #
1270
1652
  # @option params [required, String] :sip_media_application_id
1653
+ # The SIP media application ID .
1271
1654
  #
1272
1655
  # @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1273
1656
  #
@@ -1298,7 +1681,10 @@ module Aws::ChimeSDKVoice
1298
1681
  req.send_request(options)
1299
1682
  end
1300
1683
 
1684
+ # Gets the Alexa Skill configuration for the SIP media application.
1685
+ #
1301
1686
  # @option params [required, String] :sip_media_application_id
1687
+ # The SIP media application ID.
1302
1688
  #
1303
1689
  # @return [Types::GetSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1304
1690
  #
@@ -1325,7 +1711,11 @@ module Aws::ChimeSDKVoice
1325
1711
  req.send_request(options)
1326
1712
  end
1327
1713
 
1714
+ # Retrieves the logging configuration for the specified SIP media
1715
+ # application.
1716
+ #
1328
1717
  # @option params [required, String] :sip_media_application_id
1718
+ # The SIP media application ID.
1329
1719
  #
1330
1720
  # @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1331
1721
  #
@@ -1350,7 +1740,11 @@ module Aws::ChimeSDKVoice
1350
1740
  req.send_request(options)
1351
1741
  end
1352
1742
 
1743
+ # Retrieves the details of a SIP rule, such as the rule ID, name,
1744
+ # triggers, and target endpoints.
1745
+ #
1353
1746
  # @option params [required, String] :sip_rule_id
1747
+ # The SIP rule ID.
1354
1748
  #
1355
1749
  # @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1356
1750
  #
@@ -1385,7 +1779,55 @@ module Aws::ChimeSDKVoice
1385
1779
  req.send_request(options)
1386
1780
  end
1387
1781
 
1782
+ # Retrieves the details of the specified speaker search task.
1783
+ #
1388
1784
  # @option params [required, String] :voice_connector_id
1785
+ # The Voice Connector ID.
1786
+ #
1787
+ # @option params [required, String] :speaker_search_task_id
1788
+ # The ID of the speaker search task.
1789
+ #
1790
+ # @return [Types::GetSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1791
+ #
1792
+ # * {Types::GetSpeakerSearchTaskResponse#speaker_search_task #speaker_search_task} => Types::SpeakerSearchTask
1793
+ #
1794
+ # @example Request syntax with placeholder values
1795
+ #
1796
+ # resp = client.get_speaker_search_task({
1797
+ # voice_connector_id: "NonEmptyString128", # required
1798
+ # speaker_search_task_id: "NonEmptyString256", # required
1799
+ # })
1800
+ #
1801
+ # @example Response structure
1802
+ #
1803
+ # resp.speaker_search_task.speaker_search_task_id #=> String
1804
+ # resp.speaker_search_task.speaker_search_task_status #=> String
1805
+ # resp.speaker_search_task.call_details.voice_connector_id #=> String
1806
+ # resp.speaker_search_task.call_details.transaction_id #=> String
1807
+ # resp.speaker_search_task.call_details.is_caller #=> Boolean
1808
+ # resp.speaker_search_task.speaker_search_details.results #=> Array
1809
+ # resp.speaker_search_task.speaker_search_details.results[0].confidence_score #=> Float
1810
+ # resp.speaker_search_task.speaker_search_details.results[0].voice_profile_id #=> String
1811
+ # resp.speaker_search_task.speaker_search_details.voiceprint_generation_status #=> String
1812
+ # resp.speaker_search_task.created_timestamp #=> Time
1813
+ # resp.speaker_search_task.updated_timestamp #=> Time
1814
+ # resp.speaker_search_task.started_timestamp #=> Time
1815
+ # resp.speaker_search_task.status_message #=> String
1816
+ #
1817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSpeakerSearchTask AWS API Documentation
1818
+ #
1819
+ # @overload get_speaker_search_task(params = {})
1820
+ # @param [Hash] params ({})
1821
+ def get_speaker_search_task(params = {}, options = {})
1822
+ req = build_request(:get_speaker_search_task, params)
1823
+ req.send_request(options)
1824
+ end
1825
+
1826
+ # Retrieves details for the specified Amazon Chime SDK Voice Connector,
1827
+ # such as timestamps,name, outbound host, and encryption requirements.
1828
+ #
1829
+ # @option params [required, String] :voice_connector_id
1830
+ # The Voice Connector ID.
1389
1831
  #
1390
1832
  # @return [Types::GetVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1391
1833
  #
@@ -1417,7 +1859,11 @@ module Aws::ChimeSDKVoice
1417
1859
  req.send_request(options)
1418
1860
  end
1419
1861
 
1862
+ # Retrieves the emergency calling configuration details for the
1863
+ # specified Voice Connector.
1864
+ #
1420
1865
  # @option params [required, String] :voice_connector_id
1866
+ # The Voice Connector ID.
1421
1867
  #
1422
1868
  # @return [Types::GetVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1423
1869
  #
@@ -1445,7 +1891,11 @@ module Aws::ChimeSDKVoice
1445
1891
  req.send_request(options)
1446
1892
  end
1447
1893
 
1894
+ # Retrieves details for the specified Amazon Chime SDK Voice Connector
1895
+ # group, such as timestamps,name, and associated `VoiceConnectorItems`.
1896
+ #
1448
1897
  # @option params [required, String] :voice_connector_group_id
1898
+ # The Voice Connector group ID.
1449
1899
  #
1450
1900
  # @return [Types::GetVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1451
1901
  #
@@ -1477,7 +1927,12 @@ module Aws::ChimeSDKVoice
1477
1927
  req.send_request(options)
1478
1928
  end
1479
1929
 
1930
+ # Retrieves the logging configuration settings for the specified Voice
1931
+ # Connector. Shows whether SIP message logs are enabled for sending to
1932
+ # Amazon CloudWatch Logs.
1933
+ #
1480
1934
  # @option params [required, String] :voice_connector_id
1935
+ # The Voice Connector ID.
1481
1936
  #
1482
1937
  # @return [Types::GetVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1483
1938
  #
@@ -1503,7 +1958,10 @@ module Aws::ChimeSDKVoice
1503
1958
  req.send_request(options)
1504
1959
  end
1505
1960
 
1961
+ # Retrieves the origination settings for the specified Voice Connector.
1962
+ #
1506
1963
  # @option params [required, String] :voice_connector_id
1964
+ # The Voice Connector ID.
1507
1965
  #
1508
1966
  # @return [Types::GetVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1509
1967
  #
@@ -1534,7 +1992,11 @@ module Aws::ChimeSDKVoice
1534
1992
  req.send_request(options)
1535
1993
  end
1536
1994
 
1995
+ # Retrieves the proxy configuration details for the specified Amazon
1996
+ # Chime SDK Voice Connector.
1997
+ #
1537
1998
  # @option params [required, String] :voice_connector_id
1999
+ # The Voice Connector ID.
1538
2000
  #
1539
2001
  # @return [Types::GetVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1540
2002
  #
@@ -1563,7 +2025,13 @@ module Aws::ChimeSDKVoice
1563
2025
  req.send_request(options)
1564
2026
  end
1565
2027
 
2028
+ # Retrieves the streaming configuration details for the specified Amazon
2029
+ # Chime SDK Voice Connector. Shows whether media streaming is enabled
2030
+ # for sending to Amazon Kinesis. It also shows the retention period, in
2031
+ # hours, for the Amazon Kinesis data.
2032
+ #
1566
2033
  # @option params [required, String] :voice_connector_id
2034
+ # The Voice Connector ID.
1567
2035
  #
1568
2036
  # @return [Types::GetVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1569
2037
  #
@@ -1581,6 +2049,8 @@ module Aws::ChimeSDKVoice
1581
2049
  # resp.streaming_configuration.disabled #=> Boolean
1582
2050
  # resp.streaming_configuration.streaming_notification_targets #=> Array
1583
2051
  # resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"
2052
+ # resp.streaming_configuration.media_insights_configuration.disabled #=> Boolean
2053
+ # resp.streaming_configuration.media_insights_configuration.configuration_arn #=> String
1584
2054
  #
1585
2055
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration AWS API Documentation
1586
2056
  #
@@ -1591,7 +2061,11 @@ module Aws::ChimeSDKVoice
1591
2061
  req.send_request(options)
1592
2062
  end
1593
2063
 
2064
+ # Retrieves the termination setting details for the specified Voice
2065
+ # Connector.
2066
+ #
1594
2067
  # @option params [required, String] :voice_connector_id
2068
+ # The Voice Connector ID.
1595
2069
  #
1596
2070
  # @return [Types::GetVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1597
2071
  #
@@ -1622,7 +2096,12 @@ module Aws::ChimeSDKVoice
1622
2096
  req.send_request(options)
1623
2097
  end
1624
2098
 
2099
+ # Retrieves information about the last time a `SIP OPTIONS` ping was
2100
+ # received from your SIP infrastructure for the specified Amazon Chime
2101
+ # SDK Voice Connector.
2102
+ #
1625
2103
  # @option params [required, String] :voice_connector_id
2104
+ # The Voice Connector ID.
1626
2105
  #
1627
2106
  # @return [Types::GetVoiceConnectorTerminationHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1628
2107
  #
@@ -1648,6 +2127,121 @@ module Aws::ChimeSDKVoice
1648
2127
  req.send_request(options)
1649
2128
  end
1650
2129
 
2130
+ # Retrieves the details of the specified voice profile.
2131
+ #
2132
+ # @option params [required, String] :voice_profile_id
2133
+ # The voice profile ID.
2134
+ #
2135
+ # @return [Types::GetVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2136
+ #
2137
+ # * {Types::GetVoiceProfileResponse#voice_profile #voice_profile} => Types::VoiceProfile
2138
+ #
2139
+ # @example Request syntax with placeholder values
2140
+ #
2141
+ # resp = client.get_voice_profile({
2142
+ # voice_profile_id: "NonEmptyString256", # required
2143
+ # })
2144
+ #
2145
+ # @example Response structure
2146
+ #
2147
+ # resp.voice_profile.voice_profile_id #=> String
2148
+ # resp.voice_profile.voice_profile_arn #=> String
2149
+ # resp.voice_profile.voice_profile_domain_id #=> String
2150
+ # resp.voice_profile.created_timestamp #=> Time
2151
+ # resp.voice_profile.updated_timestamp #=> Time
2152
+ # resp.voice_profile.expiration_timestamp #=> Time
2153
+ #
2154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfile AWS API Documentation
2155
+ #
2156
+ # @overload get_voice_profile(params = {})
2157
+ # @param [Hash] params ({})
2158
+ def get_voice_profile(params = {}, options = {})
2159
+ req = build_request(:get_voice_profile, params)
2160
+ req.send_request(options)
2161
+ end
2162
+
2163
+ # Retrieves the details of the specified voice profile domain.
2164
+ #
2165
+ # @option params [required, String] :voice_profile_domain_id
2166
+ # The voice profile domain ID.
2167
+ #
2168
+ # @return [Types::GetVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2169
+ #
2170
+ # * {Types::GetVoiceProfileDomainResponse#voice_profile_domain #voice_profile_domain} => Types::VoiceProfileDomain
2171
+ #
2172
+ # @example Request syntax with placeholder values
2173
+ #
2174
+ # resp = client.get_voice_profile_domain({
2175
+ # voice_profile_domain_id: "NonEmptyString256", # required
2176
+ # })
2177
+ #
2178
+ # @example Response structure
2179
+ #
2180
+ # resp.voice_profile_domain.voice_profile_domain_id #=> String
2181
+ # resp.voice_profile_domain.voice_profile_domain_arn #=> String
2182
+ # resp.voice_profile_domain.name #=> String
2183
+ # resp.voice_profile_domain.description #=> String
2184
+ # resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
2185
+ # resp.voice_profile_domain.created_timestamp #=> Time
2186
+ # resp.voice_profile_domain.updated_timestamp #=> Time
2187
+ #
2188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceProfileDomain AWS API Documentation
2189
+ #
2190
+ # @overload get_voice_profile_domain(params = {})
2191
+ # @param [Hash] params ({})
2192
+ def get_voice_profile_domain(params = {}, options = {})
2193
+ req = build_request(:get_voice_profile_domain, params)
2194
+ req.send_request(options)
2195
+ end
2196
+
2197
+ # Retrieves the details of a voice tone analysis task.
2198
+ #
2199
+ # @option params [required, String] :voice_connector_id
2200
+ # The Voice Connector ID.
2201
+ #
2202
+ # @option params [required, String] :voice_tone_analysis_task_id
2203
+ # The ID of the voice tone anlysis task.
2204
+ #
2205
+ # @option params [required, Boolean] :is_caller
2206
+ # Specifies whether the voice being analyzed is the caller (originator)
2207
+ # or the callee (responder).
2208
+ #
2209
+ # @return [Types::GetVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2210
+ #
2211
+ # * {Types::GetVoiceToneAnalysisTaskResponse#voice_tone_analysis_task #voice_tone_analysis_task} => Types::VoiceToneAnalysisTask
2212
+ #
2213
+ # @example Request syntax with placeholder values
2214
+ #
2215
+ # resp = client.get_voice_tone_analysis_task({
2216
+ # voice_connector_id: "NonEmptyString128", # required
2217
+ # voice_tone_analysis_task_id: "NonEmptyString256", # required
2218
+ # is_caller: false, # required
2219
+ # })
2220
+ #
2221
+ # @example Response structure
2222
+ #
2223
+ # resp.voice_tone_analysis_task.voice_tone_analysis_task_id #=> String
2224
+ # resp.voice_tone_analysis_task.voice_tone_analysis_task_status #=> String
2225
+ # resp.voice_tone_analysis_task.call_details.voice_connector_id #=> String
2226
+ # resp.voice_tone_analysis_task.call_details.transaction_id #=> String
2227
+ # resp.voice_tone_analysis_task.call_details.is_caller #=> Boolean
2228
+ # resp.voice_tone_analysis_task.created_timestamp #=> Time
2229
+ # resp.voice_tone_analysis_task.updated_timestamp #=> Time
2230
+ # resp.voice_tone_analysis_task.started_timestamp #=> Time
2231
+ # resp.voice_tone_analysis_task.status_message #=> String
2232
+ #
2233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceToneAnalysisTask AWS API Documentation
2234
+ #
2235
+ # @overload get_voice_tone_analysis_task(params = {})
2236
+ # @param [Hash] params ({})
2237
+ def get_voice_tone_analysis_task(params = {}, options = {})
2238
+ req = build_request(:get_voice_tone_analysis_task, params)
2239
+ req.send_request(options)
2240
+ end
2241
+
2242
+ # Lists the available AWS Regions in which you can create an Amazon
2243
+ # Chime SDK Voice Connector.
2244
+ #
1651
2245
  # @return [Types::ListAvailableVoiceConnectorRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1652
2246
  #
1653
2247
  # * {Types::ListAvailableVoiceConnectorRegionsResponse#voice_connector_regions #voice_connector_regions} => Array&lt;String&gt;
@@ -1666,9 +2260,14 @@ module Aws::ChimeSDKVoice
1666
2260
  req.send_request(options)
1667
2261
  end
1668
2262
 
2263
+ # Lists the phone numbers for an administrator's Amazon Chime SDK
2264
+ # account.
2265
+ #
1669
2266
  # @option params [String] :next_token
2267
+ # The token used to retrieve the next page of results.
1670
2268
  #
1671
2269
  # @option params [Integer] :max_results
2270
+ # The maximum number of results to return in a single call.
1672
2271
  #
1673
2272
  # @return [Types::ListPhoneNumberOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1674
2273
  #
@@ -1707,17 +2306,27 @@ module Aws::ChimeSDKVoice
1707
2306
  req.send_request(options)
1708
2307
  end
1709
2308
 
2309
+ # Lists the phone numbers for the specified Amazon Chime SDK account,
2310
+ # Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon
2311
+ # Chime SDK Voice Connector group.
2312
+ #
1710
2313
  # @option params [String] :status
2314
+ # The status of your organization's phone numbers.
1711
2315
  #
1712
2316
  # @option params [String] :product_type
2317
+ # The phone number product types.
1713
2318
  #
1714
2319
  # @option params [String] :filter_name
2320
+ # The filter to limit the number of results.
1715
2321
  #
1716
2322
  # @option params [String] :filter_value
2323
+ # The filter value.
1717
2324
  #
1718
2325
  # @option params [Integer] :max_results
2326
+ # The maximum number of results to return in a single call.
1719
2327
  #
1720
2328
  # @option params [String] :next_token
2329
+ # The token used to return the next page of results.
1721
2330
  #
1722
2331
  # @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1723
2332
  #
@@ -1773,13 +2382,20 @@ module Aws::ChimeSDKVoice
1773
2382
  req.send_request(options)
1774
2383
  end
1775
2384
 
2385
+ # Lists the proxy sessions for the specified Amazon Chime SDK Voice
2386
+ # Connector.
2387
+ #
1776
2388
  # @option params [required, String] :voice_connector_id
2389
+ # The Voice Connector ID.
1777
2390
  #
1778
2391
  # @option params [String] :status
2392
+ # The proxy session status.
1779
2393
  #
1780
2394
  # @option params [String] :next_token
2395
+ # The token used to retrieve the next page of results.
1781
2396
  #
1782
2397
  # @option params [Integer] :max_results
2398
+ # The maximum number of results to return in a single call.
1783
2399
  #
1784
2400
  # @return [Types::ListProxySessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1785
2401
  #
@@ -1828,9 +2444,15 @@ module Aws::ChimeSDKVoice
1828
2444
  req.send_request(options)
1829
2445
  end
1830
2446
 
2447
+ # Lists the SIP media applications under the administrator's AWS
2448
+ # account.
2449
+ #
1831
2450
  # @option params [Integer] :max_results
2451
+ # The maximum number of results to return in a single call. Defaults to
2452
+ # 100.
1832
2453
  #
1833
2454
  # @option params [String] :next_token
2455
+ # The token used to return the next page of results.
1834
2456
  #
1835
2457
  # @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1836
2458
  #
@@ -1867,11 +2489,17 @@ module Aws::ChimeSDKVoice
1867
2489
  req.send_request(options)
1868
2490
  end
1869
2491
 
2492
+ # Lists the SIP rules under the administrator's AWS account.
2493
+ #
1870
2494
  # @option params [String] :sip_media_application_id
2495
+ # The SIP media application ID.
1871
2496
  #
1872
2497
  # @option params [Integer] :max_results
2498
+ # The maximum number of results to return in a single call. Defaults to
2499
+ # 100.
1873
2500
  #
1874
2501
  # @option params [String] :next_token
2502
+ # The token used to return the next page of results.
1875
2503
  #
1876
2504
  # @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1877
2505
  #
@@ -1913,7 +2541,10 @@ module Aws::ChimeSDKVoice
1913
2541
  req.send_request(options)
1914
2542
  end
1915
2543
 
2544
+ # Lists the countries that you can order phone numbers from.
2545
+ #
1916
2546
  # @option params [required, String] :product_type
2547
+ # The phone number product type.
1917
2548
  #
1918
2549
  # @return [Types::ListSupportedPhoneNumberCountriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1919
2550
  #
@@ -1941,9 +2572,44 @@ module Aws::ChimeSDKVoice
1941
2572
  req.send_request(options)
1942
2573
  end
1943
2574
 
2575
+ # Returns a list of the tags in a given resource.
2576
+ #
2577
+ # @option params [required, String] :resource_arn
2578
+ # The resource ARN.
2579
+ #
2580
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2581
+ #
2582
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
2583
+ #
2584
+ # @example Request syntax with placeholder values
2585
+ #
2586
+ # resp = client.list_tags_for_resource({
2587
+ # resource_arn: "Arn", # required
2588
+ # })
2589
+ #
2590
+ # @example Response structure
2591
+ #
2592
+ # resp.tags #=> Array
2593
+ # resp.tags[0].key #=> String
2594
+ # resp.tags[0].value #=> String
2595
+ #
2596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListTagsForResource AWS API Documentation
2597
+ #
2598
+ # @overload list_tags_for_resource(params = {})
2599
+ # @param [Hash] params ({})
2600
+ def list_tags_for_resource(params = {}, options = {})
2601
+ req = build_request(:list_tags_for_resource, params)
2602
+ req.send_request(options)
2603
+ end
2604
+
2605
+ # Lists the Amazon Chime SDK Voice Connector groups in the
2606
+ # administrator's AWS account.
2607
+ #
1944
2608
  # @option params [String] :next_token
2609
+ # The token used to return the next page of results.
1945
2610
  #
1946
2611
  # @option params [Integer] :max_results
2612
+ # The maximum number of results to return in a single call.
1947
2613
  #
1948
2614
  # @return [Types::ListVoiceConnectorGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1949
2615
  #
@@ -1981,7 +2647,11 @@ module Aws::ChimeSDKVoice
1981
2647
  req.send_request(options)
1982
2648
  end
1983
2649
 
2650
+ # Lists the SIP credentials for the specified Amazon Chime SDK Voice
2651
+ # Connector.
2652
+ #
1984
2653
  # @option params [required, String] :voice_connector_id
2654
+ # The Voice Connector ID.
1985
2655
  #
1986
2656
  # @return [Types::ListVoiceConnectorTerminationCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1987
2657
  #
@@ -2007,9 +2677,14 @@ module Aws::ChimeSDKVoice
2007
2677
  req.send_request(options)
2008
2678
  end
2009
2679
 
2680
+ # Lists the Amazon Chime SDK Voice Connectors in the administrators AWS
2681
+ # account.
2682
+ #
2010
2683
  # @option params [String] :next_token
2684
+ # The token used to return the next page of results.
2011
2685
  #
2012
2686
  # @option params [Integer] :max_results
2687
+ # The maximum number of results to return in a single call.
2013
2688
  #
2014
2689
  # @return [Types::ListVoiceConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2015
2690
  #
@@ -2047,9 +2722,102 @@ module Aws::ChimeSDKVoice
2047
2722
  req.send_request(options)
2048
2723
  end
2049
2724
 
2725
+ # Lists the specified voice profile domains in the administrator's AWS
2726
+ # account.
2727
+ #
2728
+ # @option params [String] :next_token
2729
+ # The token used to return the next page of results.
2730
+ #
2731
+ # @option params [Integer] :max_results
2732
+ # The maximum number of results to return in a single call.
2733
+ #
2734
+ # @return [Types::ListVoiceProfileDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2735
+ #
2736
+ # * {Types::ListVoiceProfileDomainsResponse#voice_profile_domains #voice_profile_domains} => Array&lt;Types::VoiceProfileDomainSummary&gt;
2737
+ # * {Types::ListVoiceProfileDomainsResponse#next_token #next_token} => String
2738
+ #
2739
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2740
+ #
2741
+ # @example Request syntax with placeholder values
2742
+ #
2743
+ # resp = client.list_voice_profile_domains({
2744
+ # next_token: "String",
2745
+ # max_results: 1,
2746
+ # })
2747
+ #
2748
+ # @example Response structure
2749
+ #
2750
+ # resp.voice_profile_domains #=> Array
2751
+ # resp.voice_profile_domains[0].voice_profile_domain_id #=> String
2752
+ # resp.voice_profile_domains[0].voice_profile_domain_arn #=> String
2753
+ # resp.voice_profile_domains[0].name #=> String
2754
+ # resp.voice_profile_domains[0].description #=> String
2755
+ # resp.voice_profile_domains[0].created_timestamp #=> Time
2756
+ # resp.voice_profile_domains[0].updated_timestamp #=> Time
2757
+ # resp.next_token #=> String
2758
+ #
2759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfileDomains AWS API Documentation
2760
+ #
2761
+ # @overload list_voice_profile_domains(params = {})
2762
+ # @param [Hash] params ({})
2763
+ def list_voice_profile_domains(params = {}, options = {})
2764
+ req = build_request(:list_voice_profile_domains, params)
2765
+ req.send_request(options)
2766
+ end
2767
+
2768
+ # Lists the voice profiles in a voice profile domain.
2769
+ #
2770
+ # @option params [required, String] :voice_profile_domain_id
2771
+ # The ID of the voice profile domain.
2772
+ #
2773
+ # @option params [String] :next_token
2774
+ # The token used to retrieve the next page of results.
2775
+ #
2776
+ # @option params [Integer] :max_results
2777
+ # The maximum number of results in the request.
2778
+ #
2779
+ # @return [Types::ListVoiceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2780
+ #
2781
+ # * {Types::ListVoiceProfilesResponse#voice_profiles #voice_profiles} => Array&lt;Types::VoiceProfileSummary&gt;
2782
+ # * {Types::ListVoiceProfilesResponse#next_token #next_token} => String
2783
+ #
2784
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2785
+ #
2786
+ # @example Request syntax with placeholder values
2787
+ #
2788
+ # resp = client.list_voice_profiles({
2789
+ # voice_profile_domain_id: "NonEmptyString256", # required
2790
+ # next_token: "String",
2791
+ # max_results: 1,
2792
+ # })
2793
+ #
2794
+ # @example Response structure
2795
+ #
2796
+ # resp.voice_profiles #=> Array
2797
+ # resp.voice_profiles[0].voice_profile_id #=> String
2798
+ # resp.voice_profiles[0].voice_profile_arn #=> String
2799
+ # resp.voice_profiles[0].voice_profile_domain_id #=> String
2800
+ # resp.voice_profiles[0].created_timestamp #=> Time
2801
+ # resp.voice_profiles[0].updated_timestamp #=> Time
2802
+ # resp.voice_profiles[0].expiration_timestamp #=> Time
2803
+ # resp.next_token #=> String
2804
+ #
2805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceProfiles AWS API Documentation
2806
+ #
2807
+ # @overload list_voice_profiles(params = {})
2808
+ # @param [Hash] params ({})
2809
+ def list_voice_profiles(params = {}, options = {})
2810
+ req = build_request(:list_voice_profiles, params)
2811
+ req.send_request(options)
2812
+ end
2813
+
2814
+ # Updates the Alexa Skill configuration for the SIP media application.
2815
+ #
2050
2816
  # @option params [required, String] :sip_media_application_id
2817
+ # The SIP media application ID.
2051
2818
  #
2052
2819
  # @option params [Types::SipMediaApplicationAlexaSkillConfiguration] :sip_media_application_alexa_skill_configuration
2820
+ # The Alexa Skill configuration.
2053
2821
  #
2054
2822
  # @return [Types::PutSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2055
2823
  #
@@ -2080,9 +2848,14 @@ module Aws::ChimeSDKVoice
2080
2848
  req.send_request(options)
2081
2849
  end
2082
2850
 
2851
+ # Updates the logging configuration for the specified SIP media
2852
+ # application.
2853
+ #
2083
2854
  # @option params [required, String] :sip_media_application_id
2855
+ # The SIP media application ID.
2084
2856
  #
2085
2857
  # @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
2858
+ # The logging configuration for the specified SIP media application.
2086
2859
  #
2087
2860
  # @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2088
2861
  #
@@ -2110,9 +2883,13 @@ module Aws::ChimeSDKVoice
2110
2883
  req.send_request(options)
2111
2884
  end
2112
2885
 
2886
+ # Updates a Voice Connector's emergency calling configuration.
2887
+ #
2113
2888
  # @option params [required, String] :voice_connector_id
2889
+ # The Voice Connector ID.
2114
2890
  #
2115
2891
  # @option params [required, Types::EmergencyCallingConfiguration] :emergency_calling_configuration
2892
+ # The configuration being updated.
2116
2893
  #
2117
2894
  # @return [Types::PutVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2118
2895
  #
@@ -2149,9 +2926,13 @@ module Aws::ChimeSDKVoice
2149
2926
  req.send_request(options)
2150
2927
  end
2151
2928
 
2929
+ # Updates a Voice Connector's logging configuration.
2930
+ #
2152
2931
  # @option params [required, String] :voice_connector_id
2932
+ # The Voice Connector ID.
2153
2933
  #
2154
2934
  # @option params [required, Types::LoggingConfiguration] :logging_configuration
2935
+ # The logging configuration being updated.
2155
2936
  #
2156
2937
  # @return [Types::PutVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2157
2938
  #
@@ -2181,9 +2962,13 @@ module Aws::ChimeSDKVoice
2181
2962
  req.send_request(options)
2182
2963
  end
2183
2964
 
2965
+ # Updates a Voice Connector's origination settings.
2966
+ #
2184
2967
  # @option params [required, String] :voice_connector_id
2968
+ # The Voice Connector ID.
2185
2969
  #
2186
2970
  # @option params [required, Types::Origination] :origination
2971
+ # The origination settings being updated.
2187
2972
  #
2188
2973
  # @return [Types::PutVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2189
2974
  #
@@ -2226,15 +3011,24 @@ module Aws::ChimeSDKVoice
2226
3011
  req.send_request(options)
2227
3012
  end
2228
3013
 
3014
+ # Puts the specified proxy configuration to the specified Amazon Chime
3015
+ # SDK Voice Connector.
3016
+ #
2229
3017
  # @option params [required, String] :voice_connector_id
3018
+ # The Voice Connector ID.
2230
3019
  #
2231
3020
  # @option params [required, Integer] :default_session_expiry_minutes
3021
+ # The default number of minutes allowed for proxy session.
2232
3022
  #
2233
3023
  # @option params [required, Array<String>] :phone_number_pool_countries
3024
+ # The countries for proxy phone numbers to be selected from.
2234
3025
  #
2235
3026
  # @option params [String] :fall_back_phone_number
3027
+ # The phone number to route calls to after a proxy session expires.
2236
3028
  #
2237
3029
  # @option params [Boolean] :disabled
3030
+ # When true, stops proxy sessions from being created on the specified
3031
+ # Amazon Chime SDK Voice Connector.
2238
3032
  #
2239
3033
  # @return [Types::PutVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2240
3034
  #
@@ -2267,9 +3061,13 @@ module Aws::ChimeSDKVoice
2267
3061
  req.send_request(options)
2268
3062
  end
2269
3063
 
3064
+ # Updates a Voice Connector's streaming configuration settings.
3065
+ #
2270
3066
  # @option params [required, String] :voice_connector_id
3067
+ # The Voice Connector ID.
2271
3068
  #
2272
3069
  # @option params [required, Types::StreamingConfiguration] :streaming_configuration
3070
+ # The streaming settings being updated.
2273
3071
  #
2274
3072
  # @return [Types::PutVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2275
3073
  #
@@ -2287,6 +3085,10 @@ module Aws::ChimeSDKVoice
2287
3085
  # notification_target: "EventBridge", # accepts EventBridge, SNS, SQS
2288
3086
  # },
2289
3087
  # ],
3088
+ # media_insights_configuration: {
3089
+ # disabled: false,
3090
+ # configuration_arn: "Arn",
3091
+ # },
2290
3092
  # },
2291
3093
  # })
2292
3094
  #
@@ -2296,6 +3098,8 @@ module Aws::ChimeSDKVoice
2296
3098
  # resp.streaming_configuration.disabled #=> Boolean
2297
3099
  # resp.streaming_configuration.streaming_notification_targets #=> Array
2298
3100
  # resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"
3101
+ # resp.streaming_configuration.media_insights_configuration.disabled #=> Boolean
3102
+ # resp.streaming_configuration.media_insights_configuration.configuration_arn #=> String
2299
3103
  #
2300
3104
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration AWS API Documentation
2301
3105
  #
@@ -2306,9 +3110,13 @@ module Aws::ChimeSDKVoice
2306
3110
  req.send_request(options)
2307
3111
  end
2308
3112
 
3113
+ # Updates a Voice Connector's termination settings.
3114
+ #
2309
3115
  # @option params [required, String] :voice_connector_id
3116
+ # The Voice Connector ID.
2310
3117
  #
2311
3118
  # @option params [required, Types::Termination] :termination
3119
+ # The termination settings to be updated.
2312
3120
  #
2313
3121
  # @return [Types::PutVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2314
3122
  #
@@ -2346,9 +3154,13 @@ module Aws::ChimeSDKVoice
2346
3154
  req.send_request(options)
2347
3155
  end
2348
3156
 
3157
+ # Updates a Voice Connector's termination credentials.
3158
+ #
2349
3159
  # @option params [required, String] :voice_connector_id
3160
+ # The Voice Connector ID.
2350
3161
  #
2351
3162
  # @option params [Array<Types::Credential>] :credentials
3163
+ # The termination credentials being updated.
2352
3164
  #
2353
3165
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2354
3166
  #
@@ -2373,7 +3185,10 @@ module Aws::ChimeSDKVoice
2373
3185
  req.send_request(options)
2374
3186
  end
2375
3187
 
3188
+ # Restores a deleted phone number.
3189
+ #
2376
3190
  # @option params [required, String] :phone_number_id
3191
+ # The ID of the phone number being restored.
2377
3192
  #
2378
3193
  # @return [Types::RestorePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2379
3194
  #
@@ -2419,21 +3234,37 @@ module Aws::ChimeSDKVoice
2419
3234
  req.send_request(options)
2420
3235
  end
2421
3236
 
3237
+ # Searches the provisioned phone numbers in an organization.
3238
+ #
2422
3239
  # @option params [String] :area_code
3240
+ # Confines a search to just the phone numbers associated with the
3241
+ # specified area code.
2423
3242
  #
2424
3243
  # @option params [String] :city
3244
+ # Confines a search to just the phone numbers associated with the
3245
+ # specified city.
2425
3246
  #
2426
3247
  # @option params [String] :country
3248
+ # Confines a search to just the phone numbers associated with the
3249
+ # specified country.
2427
3250
  #
2428
3251
  # @option params [String] :state
3252
+ # Confines a search to just the phone numbers associated with the
3253
+ # specified state.
2429
3254
  #
2430
3255
  # @option params [String] :toll_free_prefix
3256
+ # Confines a search to just the phone numbers associated with the
3257
+ # specified toll-free prefix.
2431
3258
  #
2432
3259
  # @option params [String] :phone_number_type
3260
+ # Confines a search to just the phone numbers associated with the
3261
+ # specified phone number type, either **local** or **toll-free**.
2433
3262
  #
2434
3263
  # @option params [Integer] :max_results
3264
+ # The maximum number of results to return.
2435
3265
  #
2436
3266
  # @option params [String] :next_token
3267
+ # The token used to return the next page of results.
2437
3268
  #
2438
3269
  # @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2439
3270
  #
@@ -2470,7 +3301,243 @@ module Aws::ChimeSDKVoice
2470
3301
  req.send_request(options)
2471
3302
  end
2472
3303
 
3304
+ # Starts a speaker search task.
3305
+ #
3306
+ # Before starting any speaker search tasks, you must provide all notices
3307
+ # and obtain all consents from the speaker as required under applicable
3308
+ # privacy and biometrics laws, and as required under the [AWS service
3309
+ # terms][1] for the Amazon Chime SDK.
3310
+ #
3311
+ #
3312
+ #
3313
+ # [1]: https://aws.amazon.com/service-terms/
3314
+ #
3315
+ # @option params [required, String] :voice_connector_id
3316
+ # The Voice Connector ID.
3317
+ #
3318
+ # @option params [required, String] :transaction_id
3319
+ # The transaction ID of the call being analyzed.
3320
+ #
3321
+ # @option params [required, String] :voice_profile_domain_id
3322
+ # The ID of the voice profile domain that will store the voice profile.
3323
+ #
3324
+ # @option params [String] :client_request_token
3325
+ # The unique identifier for the client request. Use a different token
3326
+ # for different speaker search tasks.
3327
+ #
3328
+ # @return [Types::StartSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3329
+ #
3330
+ # * {Types::StartSpeakerSearchTaskResponse#speaker_search_task #speaker_search_task} => Types::SpeakerSearchTask
3331
+ #
3332
+ # @example Request syntax with placeholder values
3333
+ #
3334
+ # resp = client.start_speaker_search_task({
3335
+ # voice_connector_id: "NonEmptyString128", # required
3336
+ # transaction_id: "NonEmptyString256", # required
3337
+ # voice_profile_domain_id: "NonEmptyString256", # required
3338
+ # client_request_token: "ClientRequestId",
3339
+ # })
3340
+ #
3341
+ # @example Response structure
3342
+ #
3343
+ # resp.speaker_search_task.speaker_search_task_id #=> String
3344
+ # resp.speaker_search_task.speaker_search_task_status #=> String
3345
+ # resp.speaker_search_task.call_details.voice_connector_id #=> String
3346
+ # resp.speaker_search_task.call_details.transaction_id #=> String
3347
+ # resp.speaker_search_task.call_details.is_caller #=> Boolean
3348
+ # resp.speaker_search_task.speaker_search_details.results #=> Array
3349
+ # resp.speaker_search_task.speaker_search_details.results[0].confidence_score #=> Float
3350
+ # resp.speaker_search_task.speaker_search_details.results[0].voice_profile_id #=> String
3351
+ # resp.speaker_search_task.speaker_search_details.voiceprint_generation_status #=> String
3352
+ # resp.speaker_search_task.created_timestamp #=> Time
3353
+ # resp.speaker_search_task.updated_timestamp #=> Time
3354
+ # resp.speaker_search_task.started_timestamp #=> Time
3355
+ # resp.speaker_search_task.status_message #=> String
3356
+ #
3357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartSpeakerSearchTask AWS API Documentation
3358
+ #
3359
+ # @overload start_speaker_search_task(params = {})
3360
+ # @param [Hash] params ({})
3361
+ def start_speaker_search_task(params = {}, options = {})
3362
+ req = build_request(:start_speaker_search_task, params)
3363
+ req.send_request(options)
3364
+ end
3365
+
3366
+ # Starts a voice tone analysis task. For more information about voice
3367
+ # tone analysis, see [Using Amazon Chime SDK voice analytics][1] in the
3368
+ # *Amazon Chime SDK Developer Guide*.
3369
+ #
3370
+ # Before starting any voice tone analysis tasks, you must provide all
3371
+ # notices and obtain all consents from the speaker as required under
3372
+ # applicable privacy and biometrics laws, and as required under the [AWS
3373
+ # service terms][2] for the Amazon Chime SDK.
3374
+ #
3375
+ #
3376
+ #
3377
+ # [1]: https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html
3378
+ # [2]: https://aws.amazon.com/service-terms/
3379
+ #
3380
+ # @option params [required, String] :voice_connector_id
3381
+ # The Voice Connector ID.
3382
+ #
3383
+ # @option params [required, String] :transaction_id
3384
+ # The transaction ID.
3385
+ #
3386
+ # @option params [required, String] :language_code
3387
+ # The language code.
3388
+ #
3389
+ # @option params [String] :client_request_token
3390
+ # The unique identifier for the client request. Use a different token
3391
+ # for different voice tone analysis tasks.
3392
+ #
3393
+ # @return [Types::StartVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3394
+ #
3395
+ # * {Types::StartVoiceToneAnalysisTaskResponse#voice_tone_analysis_task #voice_tone_analysis_task} => Types::VoiceToneAnalysisTask
3396
+ #
3397
+ # @example Request syntax with placeholder values
3398
+ #
3399
+ # resp = client.start_voice_tone_analysis_task({
3400
+ # voice_connector_id: "NonEmptyString128", # required
3401
+ # transaction_id: "NonEmptyString256", # required
3402
+ # language_code: "en-US", # required, accepts en-US
3403
+ # client_request_token: "ClientRequestId",
3404
+ # })
3405
+ #
3406
+ # @example Response structure
3407
+ #
3408
+ # resp.voice_tone_analysis_task.voice_tone_analysis_task_id #=> String
3409
+ # resp.voice_tone_analysis_task.voice_tone_analysis_task_status #=> String
3410
+ # resp.voice_tone_analysis_task.call_details.voice_connector_id #=> String
3411
+ # resp.voice_tone_analysis_task.call_details.transaction_id #=> String
3412
+ # resp.voice_tone_analysis_task.call_details.is_caller #=> Boolean
3413
+ # resp.voice_tone_analysis_task.created_timestamp #=> Time
3414
+ # resp.voice_tone_analysis_task.updated_timestamp #=> Time
3415
+ # resp.voice_tone_analysis_task.started_timestamp #=> Time
3416
+ # resp.voice_tone_analysis_task.status_message #=> String
3417
+ #
3418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StartVoiceToneAnalysisTask AWS API Documentation
3419
+ #
3420
+ # @overload start_voice_tone_analysis_task(params = {})
3421
+ # @param [Hash] params ({})
3422
+ def start_voice_tone_analysis_task(params = {}, options = {})
3423
+ req = build_request(:start_voice_tone_analysis_task, params)
3424
+ req.send_request(options)
3425
+ end
3426
+
3427
+ # Stops a speaker search task.
3428
+ #
3429
+ # @option params [required, String] :voice_connector_id
3430
+ # The Voice Connector ID.
3431
+ #
3432
+ # @option params [required, String] :speaker_search_task_id
3433
+ # The speaker search task ID.
3434
+ #
3435
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3436
+ #
3437
+ # @example Request syntax with placeholder values
3438
+ #
3439
+ # resp = client.stop_speaker_search_task({
3440
+ # voice_connector_id: "NonEmptyString128", # required
3441
+ # speaker_search_task_id: "NonEmptyString256", # required
3442
+ # })
3443
+ #
3444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopSpeakerSearchTask AWS API Documentation
3445
+ #
3446
+ # @overload stop_speaker_search_task(params = {})
3447
+ # @param [Hash] params ({})
3448
+ def stop_speaker_search_task(params = {}, options = {})
3449
+ req = build_request(:stop_speaker_search_task, params)
3450
+ req.send_request(options)
3451
+ end
3452
+
3453
+ # Stops a voice tone analysis task.
3454
+ #
3455
+ # @option params [required, String] :voice_connector_id
3456
+ # The Voice Connector ID.
3457
+ #
3458
+ # @option params [required, String] :voice_tone_analysis_task_id
3459
+ # The ID of the voice tone analysis task.
3460
+ #
3461
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3462
+ #
3463
+ # @example Request syntax with placeholder values
3464
+ #
3465
+ # resp = client.stop_voice_tone_analysis_task({
3466
+ # voice_connector_id: "NonEmptyString128", # required
3467
+ # voice_tone_analysis_task_id: "NonEmptyString256", # required
3468
+ # })
3469
+ #
3470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/StopVoiceToneAnalysisTask AWS API Documentation
3471
+ #
3472
+ # @overload stop_voice_tone_analysis_task(params = {})
3473
+ # @param [Hash] params ({})
3474
+ def stop_voice_tone_analysis_task(params = {}, options = {})
3475
+ req = build_request(:stop_voice_tone_analysis_task, params)
3476
+ req.send_request(options)
3477
+ end
3478
+
3479
+ # Adds a tag to the specified resource.
3480
+ #
3481
+ # @option params [required, String] :resource_arn
3482
+ # The ARN of the resource being tagged.
3483
+ #
3484
+ # @option params [required, Array<Types::Tag>] :tags
3485
+ # A list of the tags being added to the resource.
3486
+ #
3487
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3488
+ #
3489
+ # @example Request syntax with placeholder values
3490
+ #
3491
+ # resp = client.tag_resource({
3492
+ # resource_arn: "Arn", # required
3493
+ # tags: [ # required
3494
+ # {
3495
+ # key: "TagKey", # required
3496
+ # value: "TagValue", # required
3497
+ # },
3498
+ # ],
3499
+ # })
3500
+ #
3501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/TagResource AWS API Documentation
3502
+ #
3503
+ # @overload tag_resource(params = {})
3504
+ # @param [Hash] params ({})
3505
+ def tag_resource(params = {}, options = {})
3506
+ req = build_request(:tag_resource, params)
3507
+ req.send_request(options)
3508
+ end
3509
+
3510
+ # Removes tags from a resource.
3511
+ #
3512
+ # @option params [required, String] :resource_arn
3513
+ # The ARN of the resource having its tags removed.
3514
+ #
3515
+ # @option params [required, Array<String>] :tag_keys
3516
+ # The keys of the tags being removed from the resource.
3517
+ #
3518
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3519
+ #
3520
+ # @example Request syntax with placeholder values
3521
+ #
3522
+ # resp = client.untag_resource({
3523
+ # resource_arn: "Arn", # required
3524
+ # tag_keys: ["TagKey"], # required
3525
+ # })
3526
+ #
3527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UntagResource AWS API Documentation
3528
+ #
3529
+ # @overload untag_resource(params = {})
3530
+ # @param [Hash] params ({})
3531
+ def untag_resource(params = {}, options = {})
3532
+ req = build_request(:untag_resource, params)
3533
+ req.send_request(options)
3534
+ end
3535
+
3536
+ # Updates global settings for the Amazon Chime SDK Voice Connectors in
3537
+ # an AWS account.
3538
+ #
2473
3539
  # @option params [Types::VoiceConnectorSettings] :voice_connector
3540
+ # The Voice Connector settings.
2474
3541
  #
2475
3542
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2476
3543
  #
@@ -2491,11 +3558,26 @@ module Aws::ChimeSDKVoice
2491
3558
  req.send_request(options)
2492
3559
  end
2493
3560
 
3561
+ # Updates phone number details, such as product type or calling name,
3562
+ # for the specified phone number ID. You can update one phone number
3563
+ # detail at a time. For example, you can update either the product type
3564
+ # or the calling name in one action.
3565
+ #
3566
+ # For numbers outside the U.S., you must use the Amazon Chime SDK SIP
3567
+ # Media Application Dial-In product type.
3568
+ #
3569
+ # Updates to outbound calling names can take 72 hours to complete.
3570
+ # Pending updates to outbound calling names must be complete before you
3571
+ # can request another update.
3572
+ #
2494
3573
  # @option params [required, String] :phone_number_id
3574
+ # The phone number ID.
2495
3575
  #
2496
3576
  # @option params [String] :product_type
3577
+ # The product type.
2497
3578
  #
2498
3579
  # @option params [String] :calling_name
3580
+ # The outbound calling name associated with the phone number.
2499
3581
  #
2500
3582
  # @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2501
3583
  #
@@ -2543,7 +3625,13 @@ module Aws::ChimeSDKVoice
2543
3625
  req.send_request(options)
2544
3626
  end
2545
3627
 
3628
+ # Updates the phone number settings for the administrator's AWS
3629
+ # account, such as the default outbound calling name. You can update the
3630
+ # default outbound calling name once every seven days. Outbound calling
3631
+ # names can take up to 72 hours to update.
3632
+ #
2546
3633
  # @option params [required, String] :calling_name
3634
+ # The default outbound calling name for the account.
2547
3635
  #
2548
3636
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2549
3637
  #
@@ -2562,13 +3650,20 @@ module Aws::ChimeSDKVoice
2562
3650
  req.send_request(options)
2563
3651
  end
2564
3652
 
3653
+ # Updates the specified proxy session details, such as voice or SMS
3654
+ # capabilities.
3655
+ #
2565
3656
  # @option params [required, String] :voice_connector_id
3657
+ # The Voice Connector ID.
2566
3658
  #
2567
3659
  # @option params [required, String] :proxy_session_id
3660
+ # The proxy session ID.
2568
3661
  #
2569
3662
  # @option params [required, Array<String>] :capabilities
3663
+ # The proxy session capabilities.
2570
3664
  #
2571
3665
  # @option params [Integer] :expiry_minutes
3666
+ # The number of minutes allowed for the proxy session.
2572
3667
  #
2573
3668
  # @return [Types::UpdateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2574
3669
  #
@@ -2612,11 +3707,16 @@ module Aws::ChimeSDKVoice
2612
3707
  req.send_request(options)
2613
3708
  end
2614
3709
 
3710
+ # Updates the details of the specified SIP media application.
3711
+ #
2615
3712
  # @option params [required, String] :sip_media_application_id
3713
+ # The SIP media application ID.
2616
3714
  #
2617
3715
  # @option params [String] :name
3716
+ # The new name for the specified SIP media application.
2618
3717
  #
2619
3718
  # @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
3719
+ # The new set of endpoints for the specified SIP media application.
2620
3720
  #
2621
3721
  # @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2622
3722
  #
@@ -2653,11 +3753,19 @@ module Aws::ChimeSDKVoice
2653
3753
  req.send_request(options)
2654
3754
  end
2655
3755
 
3756
+ # Invokes the AWS Lambda function associated with the SIP media
3757
+ # application and transaction ID in an update request. The Lambda
3758
+ # function can then return a new set of actions.
3759
+ #
2656
3760
  # @option params [required, String] :sip_media_application_id
3761
+ # The ID of the SIP media application handling the call.
2657
3762
  #
2658
3763
  # @option params [required, String] :transaction_id
3764
+ # The ID of the call transaction.
2659
3765
  #
2660
3766
  # @option params [required, Hash<String,String>] :arguments
3767
+ # Arguments made available to the Lambda function as part of the
3768
+ # `CALL_UPDATE_REQUESTED` event. Can contain 0-20 key-value pairs.
2661
3769
  #
2662
3770
  # @return [Types::UpdateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2663
3771
  #
@@ -2686,13 +3794,19 @@ module Aws::ChimeSDKVoice
2686
3794
  req.send_request(options)
2687
3795
  end
2688
3796
 
3797
+ # Updates the details of the specified SIP rule.
3798
+ #
2689
3799
  # @option params [required, String] :sip_rule_id
3800
+ # The SIP rule ID.
2690
3801
  #
2691
3802
  # @option params [required, String] :name
3803
+ # The new name for the specified SIP rule.
2692
3804
  #
2693
3805
  # @option params [Boolean] :disabled
3806
+ # The new value that indicates whether the rule is disabled.
2694
3807
  #
2695
3808
  # @option params [Array<Types::SipRuleTargetApplication>] :target_applications
3809
+ # The new list of target applications.
2696
3810
  #
2697
3811
  # @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2698
3812
  #
@@ -2736,11 +3850,17 @@ module Aws::ChimeSDKVoice
2736
3850
  req.send_request(options)
2737
3851
  end
2738
3852
 
3853
+ # Updates the details for the specified Amazon Chime SDK Voice
3854
+ # Connector.
3855
+ #
2739
3856
  # @option params [required, String] :voice_connector_id
3857
+ # The Voice Connector ID.
2740
3858
  #
2741
3859
  # @option params [required, String] :name
3860
+ # The name of the Voice Connector.
2742
3861
  #
2743
3862
  # @option params [required, Boolean] :require_encryption
3863
+ # When enabled, requires encryption for the Voice Connector.
2744
3864
  #
2745
3865
  # @return [Types::UpdateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2746
3866
  #
@@ -2774,11 +3894,17 @@ module Aws::ChimeSDKVoice
2774
3894
  req.send_request(options)
2775
3895
  end
2776
3896
 
3897
+ # Updates the settings for the specified Amazon Chime SDK Voice
3898
+ # Connector group.
3899
+ #
2777
3900
  # @option params [required, String] :voice_connector_group_id
3901
+ # The Voice Connector ID.
2778
3902
  #
2779
3903
  # @option params [required, String] :name
3904
+ # The name of the Voice Connector group.
2780
3905
  #
2781
3906
  # @option params [required, Array<Types::VoiceConnectorItem>] :voice_connector_items
3907
+ # The `VoiceConnectorItems` to associate with the Voice Connector group.
2782
3908
  #
2783
3909
  # @return [Types::UpdateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2784
3910
  #
@@ -2817,19 +3943,125 @@ module Aws::ChimeSDKVoice
2817
3943
  req.send_request(options)
2818
3944
  end
2819
3945
 
3946
+ # Updates the specified voice profile’s voice print and refreshes its
3947
+ # expiration timestamp.
3948
+ #
3949
+ # As a condition of using this feature, you acknowledge that the
3950
+ # collection, use, storage, and retention of your caller’s biometric
3951
+ # identifiers and biometric information (“biometric data”) in the form
3952
+ # of a digital voiceprint requires the caller’s informed consent via a
3953
+ # written release. Such consent is required under various state laws,
3954
+ # including biometrics laws in Illinois, Texas, Washington and other
3955
+ # state privacy laws.
3956
+ #
3957
+ # You must provide a written release to each caller through a process
3958
+ # that clearly reflects each caller’s informed consent before using
3959
+ # Amazon Chime SDK Voice Insights service, as required under the terms
3960
+ # of your agreement with AWS governing your use of the service.
3961
+ #
3962
+ # @option params [required, String] :voice_profile_id
3963
+ # The profile ID.
3964
+ #
3965
+ # @option params [required, String] :speaker_search_task_id
3966
+ # The ID of the speaker search task.
3967
+ #
3968
+ # @return [Types::UpdateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3969
+ #
3970
+ # * {Types::UpdateVoiceProfileResponse#voice_profile #voice_profile} => Types::VoiceProfile
3971
+ #
3972
+ # @example Request syntax with placeholder values
3973
+ #
3974
+ # resp = client.update_voice_profile({
3975
+ # voice_profile_id: "NonEmptyString256", # required
3976
+ # speaker_search_task_id: "NonEmptyString256", # required
3977
+ # })
3978
+ #
3979
+ # @example Response structure
3980
+ #
3981
+ # resp.voice_profile.voice_profile_id #=> String
3982
+ # resp.voice_profile.voice_profile_arn #=> String
3983
+ # resp.voice_profile.voice_profile_domain_id #=> String
3984
+ # resp.voice_profile.created_timestamp #=> Time
3985
+ # resp.voice_profile.updated_timestamp #=> Time
3986
+ # resp.voice_profile.expiration_timestamp #=> Time
3987
+ #
3988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfile AWS API Documentation
3989
+ #
3990
+ # @overload update_voice_profile(params = {})
3991
+ # @param [Hash] params ({})
3992
+ def update_voice_profile(params = {}, options = {})
3993
+ req = build_request(:update_voice_profile, params)
3994
+ req.send_request(options)
3995
+ end
3996
+
3997
+ # Updates the settings for the specified voice profile domain.
3998
+ #
3999
+ # @option params [required, String] :voice_profile_domain_id
4000
+ # The domain ID.
4001
+ #
4002
+ # @option params [String] :name
4003
+ # The name of the voice profile domain.
4004
+ #
4005
+ # @option params [String] :description
4006
+ # The description of the voice profile domain.
4007
+ #
4008
+ # @return [Types::UpdateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4009
+ #
4010
+ # * {Types::UpdateVoiceProfileDomainResponse#voice_profile_domain #voice_profile_domain} => Types::VoiceProfileDomain
4011
+ #
4012
+ # @example Request syntax with placeholder values
4013
+ #
4014
+ # resp = client.update_voice_profile_domain({
4015
+ # voice_profile_domain_id: "NonEmptyString256", # required
4016
+ # name: "VoiceProfileDomainName",
4017
+ # description: "VoiceProfileDomainDescription",
4018
+ # })
4019
+ #
4020
+ # @example Response structure
4021
+ #
4022
+ # resp.voice_profile_domain.voice_profile_domain_id #=> String
4023
+ # resp.voice_profile_domain.voice_profile_domain_arn #=> String
4024
+ # resp.voice_profile_domain.name #=> String
4025
+ # resp.voice_profile_domain.description #=> String
4026
+ # resp.voice_profile_domain.server_side_encryption_configuration.kms_key_arn #=> String
4027
+ # resp.voice_profile_domain.created_timestamp #=> Time
4028
+ # resp.voice_profile_domain.updated_timestamp #=> Time
4029
+ #
4030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceProfileDomain AWS API Documentation
4031
+ #
4032
+ # @overload update_voice_profile_domain(params = {})
4033
+ # @param [Hash] params ({})
4034
+ def update_voice_profile_domain(params = {}, options = {})
4035
+ req = build_request(:update_voice_profile_domain, params)
4036
+ req.send_request(options)
4037
+ end
4038
+
4039
+ # Validates an address to be used for 911 calls made with Amazon Chime
4040
+ # SDK Voice Connectors. You can use validated addresses in a Presence
4041
+ # Information Data Format Location Object file that you include in SIP
4042
+ # requests. That helps ensure that addresses are routed to the
4043
+ # appropriate Public Safety Answering Point.
4044
+ #
2820
4045
  # @option params [required, String] :aws_account_id
4046
+ # The AWS account ID.
2821
4047
  #
2822
4048
  # @option params [required, String] :street_number
4049
+ # The address street number, such as `200` or `2121`.
2823
4050
  #
2824
4051
  # @option params [required, String] :street_info
4052
+ # The address street information, such as `8th Avenue`.
2825
4053
  #
2826
4054
  # @option params [required, String] :city
4055
+ # The address city, such as `Portland`.
2827
4056
  #
2828
4057
  # @option params [required, String] :state
4058
+ # The address state, such as `ME`.
2829
4059
  #
2830
4060
  # @option params [required, String] :country
4061
+ # The country in the address being validated.
2831
4062
  #
2832
4063
  # @option params [required, String] :postal_code
4064
+ # The dress postal code, such `04352`.
2833
4065
  #
2834
4066
  # @return [Types::ValidateE911AddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2835
4067
  #
@@ -2895,7 +4127,7 @@ module Aws::ChimeSDKVoice
2895
4127
  params: params,
2896
4128
  config: config)
2897
4129
  context[:gem_name] = 'aws-sdk-chimesdkvoice'
2898
- context[:gem_version] = '1.2.0'
4130
+ context[:gem_version] = '1.4.0'
2899
4131
  Seahorse::Client::Request.new(handlers, context)
2900
4132
  end
2901
4133