aws-sdk-chimesdkvoice 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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,25 @@ 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
+ #
815
950
  # @option params [required, String] :speaker_search_task_id
951
+ # The ID of the speaker search task.
816
952
  #
817
953
  # @return [Types::CreateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
818
954
  #
@@ -842,15 +978,38 @@ module Aws::ChimeSDKVoice
842
978
  req.send_request(options)
843
979
  end
844
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
+ #
845
998
  # @option params [required, String] :name
999
+ # The name of the voice profile domain.
846
1000
  #
847
1001
  # @option params [String] :description
1002
+ # A description of the voice profile domain.
848
1003
  #
849
1004
  # @option params [required, Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
1005
+ # The server-side encryption configuration for the request.
850
1006
  #
851
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.
852
1010
  #
853
1011
  # @option params [Array<Types::Tag>] :tags
1012
+ # The tags assigned to the domain.
854
1013
  #
855
1014
  # @return [Types::CreateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
856
1015
  #
@@ -892,7 +1051,15 @@ module Aws::ChimeSDKVoice
892
1051
  req.send_request(options)
893
1052
  end
894
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
+ #
895
1061
  # @option params [required, String] :phone_number_id
1062
+ # The phone number ID.
896
1063
  #
897
1064
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
898
1065
  #
@@ -911,9 +1078,14 @@ module Aws::ChimeSDKVoice
911
1078
  req.send_request(options)
912
1079
  end
913
1080
 
1081
+ # Deletes the specified proxy session from the specified Amazon Chime
1082
+ # SDK Voice Connector.
1083
+ #
914
1084
  # @option params [required, String] :voice_connector_id
1085
+ # The Voice Connector ID.
915
1086
  #
916
1087
  # @option params [required, String] :proxy_session_id
1088
+ # The proxy session ID.
917
1089
  #
918
1090
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
919
1091
  #
@@ -933,7 +1105,10 @@ module Aws::ChimeSDKVoice
933
1105
  req.send_request(options)
934
1106
  end
935
1107
 
1108
+ # Deletes a SIP media application.
1109
+ #
936
1110
  # @option params [required, String] :sip_media_application_id
1111
+ # The SIP media application ID.
937
1112
  #
938
1113
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
939
1114
  #
@@ -952,7 +1127,10 @@ module Aws::ChimeSDKVoice
952
1127
  req.send_request(options)
953
1128
  end
954
1129
 
1130
+ # Deletes a SIP rule.
1131
+ #
955
1132
  # @option params [required, String] :sip_rule_id
1133
+ # The SIP rule ID.
956
1134
  #
957
1135
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
958
1136
  #
@@ -971,7 +1149,12 @@ module Aws::ChimeSDKVoice
971
1149
  req.send_request(options)
972
1150
  end
973
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
+ #
974
1156
  # @option params [required, String] :voice_connector_id
1157
+ # The Voice Connector ID.
975
1158
  #
976
1159
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
977
1160
  #
@@ -990,7 +1173,11 @@ module Aws::ChimeSDKVoice
990
1173
  req.send_request(options)
991
1174
  end
992
1175
 
1176
+ # Deletes the emergency calling details from the specified Amazon Chime
1177
+ # SDK Voice Connector.
1178
+ #
993
1179
  # @option params [required, String] :voice_connector_id
1180
+ # The Voice Connector ID.
994
1181
  #
995
1182
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
996
1183
  #
@@ -1009,7 +1196,12 @@ module Aws::ChimeSDKVoice
1009
1196
  req.send_request(options)
1010
1197
  end
1011
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
+ #
1012
1203
  # @option params [required, String] :voice_connector_group_id
1204
+ # The Voice Connector Group ID.
1013
1205
  #
1014
1206
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1015
1207
  #
@@ -1028,7 +1220,16 @@ module Aws::ChimeSDKVoice
1028
1220
  req.send_request(options)
1029
1221
  end
1030
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
+ #
1031
1231
  # @option params [required, String] :voice_connector_id
1232
+ # The Voice Connector ID.
1032
1233
  #
1033
1234
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1034
1235
  #
@@ -1047,7 +1248,11 @@ module Aws::ChimeSDKVoice
1047
1248
  req.send_request(options)
1048
1249
  end
1049
1250
 
1251
+ # Deletes the proxy configuration from the specified Amazon Chime SDK
1252
+ # Voice Connector.
1253
+ #
1050
1254
  # @option params [required, String] :voice_connector_id
1255
+ # The Voice Connector ID.
1051
1256
  #
1052
1257
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1053
1258
  #
@@ -1066,7 +1271,10 @@ module Aws::ChimeSDKVoice
1066
1271
  req.send_request(options)
1067
1272
  end
1068
1273
 
1274
+ # Deletes a Voice Connector's streaming configuration.
1275
+ #
1069
1276
  # @option params [required, String] :voice_connector_id
1277
+ # The Voice Connector ID.
1070
1278
  #
1071
1279
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1072
1280
  #
@@ -1085,7 +1293,16 @@ module Aws::ChimeSDKVoice
1085
1293
  req.send_request(options)
1086
1294
  end
1087
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
+ #
1088
1304
  # @option params [required, String] :voice_connector_id
1305
+ # The Voice Connector ID.
1089
1306
  #
1090
1307
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1091
1308
  #
@@ -1104,9 +1321,15 @@ module Aws::ChimeSDKVoice
1104
1321
  req.send_request(options)
1105
1322
  end
1106
1323
 
1324
+ # Deletes the specified SIP credentials used by your equipment to
1325
+ # authenticate during call termination.
1326
+ #
1107
1327
  # @option params [required, String] :voice_connector_id
1328
+ # The Voice Connector ID.
1108
1329
  #
1109
1330
  # @option params [required, Array<String>] :usernames
1331
+ # The RFC2617 compliant username associated with the SIP credentials, in
1332
+ # US-ASCII format.
1110
1333
  #
1111
1334
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1112
1335
  #
@@ -1126,7 +1349,11 @@ module Aws::ChimeSDKVoice
1126
1349
  req.send_request(options)
1127
1350
  end
1128
1351
 
1352
+ # Deletes a voice profile, including its voice print and enrollment
1353
+ # data. WARNING: This action is not reversible.
1354
+ #
1129
1355
  # @option params [required, String] :voice_profile_id
1356
+ # The voice profile ID.
1130
1357
  #
1131
1358
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1132
1359
  #
@@ -1145,7 +1372,11 @@ module Aws::ChimeSDKVoice
1145
1372
  req.send_request(options)
1146
1373
  end
1147
1374
 
1375
+ # Deletes all voice profiles in the domain. WARNING: This action is not
1376
+ # reversible.
1377
+ #
1148
1378
  # @option params [required, String] :voice_profile_domain_id
1379
+ # The voice profile domain ID.
1149
1380
  #
1150
1381
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1151
1382
  #
@@ -1164,9 +1395,14 @@ module Aws::ChimeSDKVoice
1164
1395
  req.send_request(options)
1165
1396
  end
1166
1397
 
1398
+ # Disassociates the specified phone numbers from the specified Amazon
1399
+ # Chime SDK Voice Connector.
1400
+ #
1167
1401
  # @option params [required, String] :voice_connector_id
1402
+ # The Voice Connector ID.
1168
1403
  #
1169
1404
  # @option params [required, Array<String>] :e164_phone_numbers
1405
+ # List of phone numbers, in E.164 format.
1170
1406
  #
1171
1407
  # @return [Types::DisassociatePhoneNumbersFromVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1172
1408
  #
@@ -1195,9 +1431,14 @@ module Aws::ChimeSDKVoice
1195
1431
  req.send_request(options)
1196
1432
  end
1197
1433
 
1434
+ # Disassociates the specified phone numbers from the specified Amazon
1435
+ # Chime SDK Voice Connector group.
1436
+ #
1198
1437
  # @option params [required, String] :voice_connector_group_id
1438
+ # The Voice Connector group ID.
1199
1439
  #
1200
1440
  # @option params [required, Array<String>] :e164_phone_numbers
1441
+ # The list of phone numbers, in E.164 format.
1201
1442
  #
1202
1443
  # @return [Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1203
1444
  #
@@ -1226,6 +1467,9 @@ module Aws::ChimeSDKVoice
1226
1467
  req.send_request(options)
1227
1468
  end
1228
1469
 
1470
+ # Retrieves the global settings for the Amazon Chime SDK Voice
1471
+ # Connectors in an AWS account.
1472
+ #
1229
1473
  # @return [Types::GetGlobalSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1230
1474
  #
1231
1475
  # * {Types::GetGlobalSettingsResponse#voice_connector #voice_connector} => Types::VoiceConnectorSettings
@@ -1243,7 +1487,11 @@ module Aws::ChimeSDKVoice
1243
1487
  req.send_request(options)
1244
1488
  end
1245
1489
 
1490
+ # Retrieves details for the specified phone number ID, such as
1491
+ # associations, capabilities, and product type.
1492
+ #
1246
1493
  # @option params [required, String] :phone_number_id
1494
+ # The phone number ID.
1247
1495
  #
1248
1496
  # @return [Types::GetPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1249
1497
  #
@@ -1289,7 +1537,12 @@ module Aws::ChimeSDKVoice
1289
1537
  req.send_request(options)
1290
1538
  end
1291
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
+ #
1292
1544
  # @option params [required, String] :phone_number_order_id
1545
+ # The ID of the phone number order .
1293
1546
  #
1294
1547
  # @return [Types::GetPhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1295
1548
  #
@@ -1322,6 +1575,9 @@ module Aws::ChimeSDKVoice
1322
1575
  req.send_request(options)
1323
1576
  end
1324
1577
 
1578
+ # Retrieves the phone number settings for the administrator's AWS
1579
+ # account, such as the default outbound calling name.
1580
+ #
1325
1581
  # @return [Types::GetPhoneNumberSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1326
1582
  #
1327
1583
  # * {Types::GetPhoneNumberSettingsResponse#calling_name #calling_name} => String
@@ -1341,9 +1597,14 @@ module Aws::ChimeSDKVoice
1341
1597
  req.send_request(options)
1342
1598
  end
1343
1599
 
1600
+ # Retrieves the specified proxy session details for the specified Amazon
1601
+ # Chime SDK Voice Connector.
1602
+ #
1344
1603
  # @option params [required, String] :voice_connector_id
1604
+ # The Voice Connector ID.
1345
1605
  #
1346
1606
  # @option params [required, String] :proxy_session_id
1607
+ # The proxy session ID.
1347
1608
  #
1348
1609
  # @return [Types::GetProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1349
1610
  #
@@ -1385,7 +1646,11 @@ module Aws::ChimeSDKVoice
1385
1646
  req.send_request(options)
1386
1647
  end
1387
1648
 
1649
+ # Retrieves the information for a SIP media application, including name,
1650
+ # AWS Region, and endpoints.
1651
+ #
1388
1652
  # @option params [required, String] :sip_media_application_id
1653
+ # The SIP media application ID .
1389
1654
  #
1390
1655
  # @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1391
1656
  #
@@ -1416,7 +1681,10 @@ module Aws::ChimeSDKVoice
1416
1681
  req.send_request(options)
1417
1682
  end
1418
1683
 
1684
+ # Gets the Alexa Skill configuration for the SIP media application.
1685
+ #
1419
1686
  # @option params [required, String] :sip_media_application_id
1687
+ # The SIP media application ID.
1420
1688
  #
1421
1689
  # @return [Types::GetSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1422
1690
  #
@@ -1443,7 +1711,11 @@ module Aws::ChimeSDKVoice
1443
1711
  req.send_request(options)
1444
1712
  end
1445
1713
 
1714
+ # Retrieves the logging configuration for the specified SIP media
1715
+ # application.
1716
+ #
1446
1717
  # @option params [required, String] :sip_media_application_id
1718
+ # The SIP media application ID.
1447
1719
  #
1448
1720
  # @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1449
1721
  #
@@ -1468,7 +1740,11 @@ module Aws::ChimeSDKVoice
1468
1740
  req.send_request(options)
1469
1741
  end
1470
1742
 
1743
+ # Retrieves the details of a SIP rule, such as the rule ID, name,
1744
+ # triggers, and target endpoints.
1745
+ #
1471
1746
  # @option params [required, String] :sip_rule_id
1747
+ # The SIP rule ID.
1472
1748
  #
1473
1749
  # @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1474
1750
  #
@@ -1503,9 +1779,13 @@ module Aws::ChimeSDKVoice
1503
1779
  req.send_request(options)
1504
1780
  end
1505
1781
 
1782
+ # Retrieves the details of the specified speaker search task.
1783
+ #
1506
1784
  # @option params [required, String] :voice_connector_id
1785
+ # The Voice Connector ID.
1507
1786
  #
1508
1787
  # @option params [required, String] :speaker_search_task_id
1788
+ # The ID of the speaker search task.
1509
1789
  #
1510
1790
  # @return [Types::GetSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1511
1791
  #
@@ -1543,7 +1823,11 @@ module Aws::ChimeSDKVoice
1543
1823
  req.send_request(options)
1544
1824
  end
1545
1825
 
1826
+ # Retrieves details for the specified Amazon Chime SDK Voice Connector,
1827
+ # such as timestamps,name, outbound host, and encryption requirements.
1828
+ #
1546
1829
  # @option params [required, String] :voice_connector_id
1830
+ # The Voice Connector ID.
1547
1831
  #
1548
1832
  # @return [Types::GetVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1549
1833
  #
@@ -1575,7 +1859,11 @@ module Aws::ChimeSDKVoice
1575
1859
  req.send_request(options)
1576
1860
  end
1577
1861
 
1862
+ # Retrieves the emergency calling configuration details for the
1863
+ # specified Voice Connector.
1864
+ #
1578
1865
  # @option params [required, String] :voice_connector_id
1866
+ # The Voice Connector ID.
1579
1867
  #
1580
1868
  # @return [Types::GetVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1581
1869
  #
@@ -1603,7 +1891,11 @@ module Aws::ChimeSDKVoice
1603
1891
  req.send_request(options)
1604
1892
  end
1605
1893
 
1894
+ # Retrieves details for the specified Amazon Chime SDK Voice Connector
1895
+ # group, such as timestamps,name, and associated `VoiceConnectorItems`.
1896
+ #
1606
1897
  # @option params [required, String] :voice_connector_group_id
1898
+ # The Voice Connector group ID.
1607
1899
  #
1608
1900
  # @return [Types::GetVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1609
1901
  #
@@ -1635,7 +1927,12 @@ module Aws::ChimeSDKVoice
1635
1927
  req.send_request(options)
1636
1928
  end
1637
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
+ #
1638
1934
  # @option params [required, String] :voice_connector_id
1935
+ # The Voice Connector ID.
1639
1936
  #
1640
1937
  # @return [Types::GetVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1641
1938
  #
@@ -1661,7 +1958,10 @@ module Aws::ChimeSDKVoice
1661
1958
  req.send_request(options)
1662
1959
  end
1663
1960
 
1961
+ # Retrieves the origination settings for the specified Voice Connector.
1962
+ #
1664
1963
  # @option params [required, String] :voice_connector_id
1964
+ # The Voice Connector ID.
1665
1965
  #
1666
1966
  # @return [Types::GetVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1667
1967
  #
@@ -1692,7 +1992,11 @@ module Aws::ChimeSDKVoice
1692
1992
  req.send_request(options)
1693
1993
  end
1694
1994
 
1995
+ # Retrieves the proxy configuration details for the specified Amazon
1996
+ # Chime SDK Voice Connector.
1997
+ #
1695
1998
  # @option params [required, String] :voice_connector_id
1999
+ # The Voice Connector ID.
1696
2000
  #
1697
2001
  # @return [Types::GetVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1698
2002
  #
@@ -1721,7 +2025,13 @@ module Aws::ChimeSDKVoice
1721
2025
  req.send_request(options)
1722
2026
  end
1723
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
+ #
1724
2033
  # @option params [required, String] :voice_connector_id
2034
+ # The Voice Connector ID.
1725
2035
  #
1726
2036
  # @return [Types::GetVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1727
2037
  #
@@ -1751,7 +2061,11 @@ module Aws::ChimeSDKVoice
1751
2061
  req.send_request(options)
1752
2062
  end
1753
2063
 
2064
+ # Retrieves the termination setting details for the specified Voice
2065
+ # Connector.
2066
+ #
1754
2067
  # @option params [required, String] :voice_connector_id
2068
+ # The Voice Connector ID.
1755
2069
  #
1756
2070
  # @return [Types::GetVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1757
2071
  #
@@ -1782,7 +2096,12 @@ module Aws::ChimeSDKVoice
1782
2096
  req.send_request(options)
1783
2097
  end
1784
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
+ #
1785
2103
  # @option params [required, String] :voice_connector_id
2104
+ # The Voice Connector ID.
1786
2105
  #
1787
2106
  # @return [Types::GetVoiceConnectorTerminationHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1788
2107
  #
@@ -1808,7 +2127,10 @@ module Aws::ChimeSDKVoice
1808
2127
  req.send_request(options)
1809
2128
  end
1810
2129
 
2130
+ # Retrieves the details of the specified voice profile.
2131
+ #
1811
2132
  # @option params [required, String] :voice_profile_id
2133
+ # The voice profile ID.
1812
2134
  #
1813
2135
  # @return [Types::GetVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1814
2136
  #
@@ -1838,7 +2160,10 @@ module Aws::ChimeSDKVoice
1838
2160
  req.send_request(options)
1839
2161
  end
1840
2162
 
2163
+ # Retrieves the details of the specified voice profile domain.
2164
+ #
1841
2165
  # @option params [required, String] :voice_profile_domain_id
2166
+ # The voice profile domain ID.
1842
2167
  #
1843
2168
  # @return [Types::GetVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1844
2169
  #
@@ -1869,11 +2194,17 @@ module Aws::ChimeSDKVoice
1869
2194
  req.send_request(options)
1870
2195
  end
1871
2196
 
2197
+ # Retrieves the details of a voice tone analysis task.
2198
+ #
1872
2199
  # @option params [required, String] :voice_connector_id
2200
+ # The Voice Connector ID.
1873
2201
  #
1874
2202
  # @option params [required, String] :voice_tone_analysis_task_id
2203
+ # The ID of the voice tone anlysis task.
1875
2204
  #
1876
2205
  # @option params [required, Boolean] :is_caller
2206
+ # Specifies whether the voice being analyzed is the caller (originator)
2207
+ # or the callee (responder).
1877
2208
  #
1878
2209
  # @return [Types::GetVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1879
2210
  #
@@ -1908,6 +2239,9 @@ module Aws::ChimeSDKVoice
1908
2239
  req.send_request(options)
1909
2240
  end
1910
2241
 
2242
+ # Lists the available AWS Regions in which you can create an Amazon
2243
+ # Chime SDK Voice Connector.
2244
+ #
1911
2245
  # @return [Types::ListAvailableVoiceConnectorRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1912
2246
  #
1913
2247
  # * {Types::ListAvailableVoiceConnectorRegionsResponse#voice_connector_regions #voice_connector_regions} => Array&lt;String&gt;
@@ -1926,9 +2260,14 @@ module Aws::ChimeSDKVoice
1926
2260
  req.send_request(options)
1927
2261
  end
1928
2262
 
2263
+ # Lists the phone numbers for an administrator's Amazon Chime SDK
2264
+ # account.
2265
+ #
1929
2266
  # @option params [String] :next_token
2267
+ # The token used to retrieve the next page of results.
1930
2268
  #
1931
2269
  # @option params [Integer] :max_results
2270
+ # The maximum number of results to return in a single call.
1932
2271
  #
1933
2272
  # @return [Types::ListPhoneNumberOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1934
2273
  #
@@ -1967,17 +2306,27 @@ module Aws::ChimeSDKVoice
1967
2306
  req.send_request(options)
1968
2307
  end
1969
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
+ #
1970
2313
  # @option params [String] :status
2314
+ # The status of your organization's phone numbers.
1971
2315
  #
1972
2316
  # @option params [String] :product_type
2317
+ # The phone number product types.
1973
2318
  #
1974
2319
  # @option params [String] :filter_name
2320
+ # The filter to limit the number of results.
1975
2321
  #
1976
2322
  # @option params [String] :filter_value
2323
+ # The filter value.
1977
2324
  #
1978
2325
  # @option params [Integer] :max_results
2326
+ # The maximum number of results to return in a single call.
1979
2327
  #
1980
2328
  # @option params [String] :next_token
2329
+ # The token used to return the next page of results.
1981
2330
  #
1982
2331
  # @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1983
2332
  #
@@ -2033,13 +2382,20 @@ module Aws::ChimeSDKVoice
2033
2382
  req.send_request(options)
2034
2383
  end
2035
2384
 
2385
+ # Lists the proxy sessions for the specified Amazon Chime SDK Voice
2386
+ # Connector.
2387
+ #
2036
2388
  # @option params [required, String] :voice_connector_id
2389
+ # The Voice Connector ID.
2037
2390
  #
2038
2391
  # @option params [String] :status
2392
+ # The proxy session status.
2039
2393
  #
2040
2394
  # @option params [String] :next_token
2395
+ # The token used to retrieve the next page of results.
2041
2396
  #
2042
2397
  # @option params [Integer] :max_results
2398
+ # The maximum number of results to return in a single call.
2043
2399
  #
2044
2400
  # @return [Types::ListProxySessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2045
2401
  #
@@ -2088,9 +2444,15 @@ module Aws::ChimeSDKVoice
2088
2444
  req.send_request(options)
2089
2445
  end
2090
2446
 
2447
+ # Lists the SIP media applications under the administrator's AWS
2448
+ # account.
2449
+ #
2091
2450
  # @option params [Integer] :max_results
2451
+ # The maximum number of results to return in a single call. Defaults to
2452
+ # 100.
2092
2453
  #
2093
2454
  # @option params [String] :next_token
2455
+ # The token used to return the next page of results.
2094
2456
  #
2095
2457
  # @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2096
2458
  #
@@ -2127,11 +2489,17 @@ module Aws::ChimeSDKVoice
2127
2489
  req.send_request(options)
2128
2490
  end
2129
2491
 
2492
+ # Lists the SIP rules under the administrator's AWS account.
2493
+ #
2130
2494
  # @option params [String] :sip_media_application_id
2495
+ # The SIP media application ID.
2131
2496
  #
2132
2497
  # @option params [Integer] :max_results
2498
+ # The maximum number of results to return in a single call. Defaults to
2499
+ # 100.
2133
2500
  #
2134
2501
  # @option params [String] :next_token
2502
+ # The token used to return the next page of results.
2135
2503
  #
2136
2504
  # @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2137
2505
  #
@@ -2173,7 +2541,10 @@ module Aws::ChimeSDKVoice
2173
2541
  req.send_request(options)
2174
2542
  end
2175
2543
 
2544
+ # Lists the countries that you can order phone numbers from.
2545
+ #
2176
2546
  # @option params [required, String] :product_type
2547
+ # The phone number product type.
2177
2548
  #
2178
2549
  # @return [Types::ListSupportedPhoneNumberCountriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2179
2550
  #
@@ -2201,7 +2572,10 @@ module Aws::ChimeSDKVoice
2201
2572
  req.send_request(options)
2202
2573
  end
2203
2574
 
2575
+ # Returns a list of the tags in a given resource.
2576
+ #
2204
2577
  # @option params [required, String] :resource_arn
2578
+ # The resource ARN.
2205
2579
  #
2206
2580
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2207
2581
  #
@@ -2228,9 +2602,14 @@ module Aws::ChimeSDKVoice
2228
2602
  req.send_request(options)
2229
2603
  end
2230
2604
 
2605
+ # Lists the Amazon Chime SDK Voice Connector groups in the
2606
+ # administrator's AWS account.
2607
+ #
2231
2608
  # @option params [String] :next_token
2609
+ # The token used to return the next page of results.
2232
2610
  #
2233
2611
  # @option params [Integer] :max_results
2612
+ # The maximum number of results to return in a single call.
2234
2613
  #
2235
2614
  # @return [Types::ListVoiceConnectorGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2236
2615
  #
@@ -2268,7 +2647,11 @@ module Aws::ChimeSDKVoice
2268
2647
  req.send_request(options)
2269
2648
  end
2270
2649
 
2650
+ # Lists the SIP credentials for the specified Amazon Chime SDK Voice
2651
+ # Connector.
2652
+ #
2271
2653
  # @option params [required, String] :voice_connector_id
2654
+ # The Voice Connector ID.
2272
2655
  #
2273
2656
  # @return [Types::ListVoiceConnectorTerminationCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2274
2657
  #
@@ -2294,9 +2677,14 @@ module Aws::ChimeSDKVoice
2294
2677
  req.send_request(options)
2295
2678
  end
2296
2679
 
2680
+ # Lists the Amazon Chime SDK Voice Connectors in the administrators AWS
2681
+ # account.
2682
+ #
2297
2683
  # @option params [String] :next_token
2684
+ # The token used to return the next page of results.
2298
2685
  #
2299
2686
  # @option params [Integer] :max_results
2687
+ # The maximum number of results to return in a single call.
2300
2688
  #
2301
2689
  # @return [Types::ListVoiceConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2302
2690
  #
@@ -2334,9 +2722,14 @@ module Aws::ChimeSDKVoice
2334
2722
  req.send_request(options)
2335
2723
  end
2336
2724
 
2725
+ # Lists the specified voice profile domains in the administrator's AWS
2726
+ # account.
2727
+ #
2337
2728
  # @option params [String] :next_token
2729
+ # The token used to return the next page of results.
2338
2730
  #
2339
2731
  # @option params [Integer] :max_results
2732
+ # The maximum number of results to return in a single call.
2340
2733
  #
2341
2734
  # @return [Types::ListVoiceProfileDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2342
2735
  #
@@ -2372,11 +2765,16 @@ module Aws::ChimeSDKVoice
2372
2765
  req.send_request(options)
2373
2766
  end
2374
2767
 
2768
+ # Lists the voice profiles in a voice profile domain.
2769
+ #
2375
2770
  # @option params [required, String] :voice_profile_domain_id
2771
+ # The ID of the voice profile domain.
2376
2772
  #
2377
2773
  # @option params [String] :next_token
2774
+ # The token used to retrieve the next page of results.
2378
2775
  #
2379
2776
  # @option params [Integer] :max_results
2777
+ # The maximum number of results in the request.
2380
2778
  #
2381
2779
  # @return [Types::ListVoiceProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2382
2780
  #
@@ -2413,9 +2811,13 @@ module Aws::ChimeSDKVoice
2413
2811
  req.send_request(options)
2414
2812
  end
2415
2813
 
2814
+ # Updates the Alexa Skill configuration for the SIP media application.
2815
+ #
2416
2816
  # @option params [required, String] :sip_media_application_id
2817
+ # The SIP media application ID.
2417
2818
  #
2418
2819
  # @option params [Types::SipMediaApplicationAlexaSkillConfiguration] :sip_media_application_alexa_skill_configuration
2820
+ # The Alexa Skill configuration.
2419
2821
  #
2420
2822
  # @return [Types::PutSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2421
2823
  #
@@ -2446,9 +2848,14 @@ module Aws::ChimeSDKVoice
2446
2848
  req.send_request(options)
2447
2849
  end
2448
2850
 
2851
+ # Updates the logging configuration for the specified SIP media
2852
+ # application.
2853
+ #
2449
2854
  # @option params [required, String] :sip_media_application_id
2855
+ # The SIP media application ID.
2450
2856
  #
2451
2857
  # @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
2858
+ # The logging configuration for the specified SIP media application.
2452
2859
  #
2453
2860
  # @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2454
2861
  #
@@ -2476,9 +2883,13 @@ module Aws::ChimeSDKVoice
2476
2883
  req.send_request(options)
2477
2884
  end
2478
2885
 
2886
+ # Updates a Voice Connector's emergency calling configuration.
2887
+ #
2479
2888
  # @option params [required, String] :voice_connector_id
2889
+ # The Voice Connector ID.
2480
2890
  #
2481
2891
  # @option params [required, Types::EmergencyCallingConfiguration] :emergency_calling_configuration
2892
+ # The configuration being updated.
2482
2893
  #
2483
2894
  # @return [Types::PutVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2484
2895
  #
@@ -2515,9 +2926,13 @@ module Aws::ChimeSDKVoice
2515
2926
  req.send_request(options)
2516
2927
  end
2517
2928
 
2929
+ # Updates a Voice Connector's logging configuration.
2930
+ #
2518
2931
  # @option params [required, String] :voice_connector_id
2932
+ # The Voice Connector ID.
2519
2933
  #
2520
2934
  # @option params [required, Types::LoggingConfiguration] :logging_configuration
2935
+ # The logging configuration being updated.
2521
2936
  #
2522
2937
  # @return [Types::PutVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2523
2938
  #
@@ -2547,9 +2962,13 @@ module Aws::ChimeSDKVoice
2547
2962
  req.send_request(options)
2548
2963
  end
2549
2964
 
2965
+ # Updates a Voice Connector's origination settings.
2966
+ #
2550
2967
  # @option params [required, String] :voice_connector_id
2968
+ # The Voice Connector ID.
2551
2969
  #
2552
2970
  # @option params [required, Types::Origination] :origination
2971
+ # The origination settings being updated.
2553
2972
  #
2554
2973
  # @return [Types::PutVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2555
2974
  #
@@ -2592,15 +3011,24 @@ module Aws::ChimeSDKVoice
2592
3011
  req.send_request(options)
2593
3012
  end
2594
3013
 
3014
+ # Puts the specified proxy configuration to the specified Amazon Chime
3015
+ # SDK Voice Connector.
3016
+ #
2595
3017
  # @option params [required, String] :voice_connector_id
3018
+ # The Voice Connector ID.
2596
3019
  #
2597
3020
  # @option params [required, Integer] :default_session_expiry_minutes
3021
+ # The default number of minutes allowed for proxy session.
2598
3022
  #
2599
3023
  # @option params [required, Array<String>] :phone_number_pool_countries
3024
+ # The countries for proxy phone numbers to be selected from.
2600
3025
  #
2601
3026
  # @option params [String] :fall_back_phone_number
3027
+ # The phone number to route calls to after a proxy session expires.
2602
3028
  #
2603
3029
  # @option params [Boolean] :disabled
3030
+ # When true, stops proxy sessions from being created on the specified
3031
+ # Amazon Chime SDK Voice Connector.
2604
3032
  #
2605
3033
  # @return [Types::PutVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2606
3034
  #
@@ -2633,9 +3061,13 @@ module Aws::ChimeSDKVoice
2633
3061
  req.send_request(options)
2634
3062
  end
2635
3063
 
3064
+ # Updates a Voice Connector's streaming configuration settings.
3065
+ #
2636
3066
  # @option params [required, String] :voice_connector_id
3067
+ # The Voice Connector ID.
2637
3068
  #
2638
3069
  # @option params [required, Types::StreamingConfiguration] :streaming_configuration
3070
+ # The streaming settings being updated.
2639
3071
  #
2640
3072
  # @return [Types::PutVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2641
3073
  #
@@ -2678,9 +3110,13 @@ module Aws::ChimeSDKVoice
2678
3110
  req.send_request(options)
2679
3111
  end
2680
3112
 
3113
+ # Updates a Voice Connector's termination settings.
3114
+ #
2681
3115
  # @option params [required, String] :voice_connector_id
3116
+ # The Voice Connector ID.
2682
3117
  #
2683
3118
  # @option params [required, Types::Termination] :termination
3119
+ # The termination settings to be updated.
2684
3120
  #
2685
3121
  # @return [Types::PutVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2686
3122
  #
@@ -2718,9 +3154,13 @@ module Aws::ChimeSDKVoice
2718
3154
  req.send_request(options)
2719
3155
  end
2720
3156
 
3157
+ # Updates a Voice Connector's termination credentials.
3158
+ #
2721
3159
  # @option params [required, String] :voice_connector_id
3160
+ # The Voice Connector ID.
2722
3161
  #
2723
3162
  # @option params [Array<Types::Credential>] :credentials
3163
+ # The termination credentials being updated.
2724
3164
  #
2725
3165
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2726
3166
  #
@@ -2745,7 +3185,10 @@ module Aws::ChimeSDKVoice
2745
3185
  req.send_request(options)
2746
3186
  end
2747
3187
 
3188
+ # Restores a deleted phone number.
3189
+ #
2748
3190
  # @option params [required, String] :phone_number_id
3191
+ # The ID of the phone number being restored.
2749
3192
  #
2750
3193
  # @return [Types::RestorePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2751
3194
  #
@@ -2791,21 +3234,37 @@ module Aws::ChimeSDKVoice
2791
3234
  req.send_request(options)
2792
3235
  end
2793
3236
 
3237
+ # Searches the provisioned phone numbers in an organization.
3238
+ #
2794
3239
  # @option params [String] :area_code
3240
+ # Confines a search to just the phone numbers associated with the
3241
+ # specified area code.
2795
3242
  #
2796
3243
  # @option params [String] :city
3244
+ # Confines a search to just the phone numbers associated with the
3245
+ # specified city.
2797
3246
  #
2798
3247
  # @option params [String] :country
3248
+ # Confines a search to just the phone numbers associated with the
3249
+ # specified country.
2799
3250
  #
2800
3251
  # @option params [String] :state
3252
+ # Confines a search to just the phone numbers associated with the
3253
+ # specified state.
2801
3254
  #
2802
3255
  # @option params [String] :toll_free_prefix
3256
+ # Confines a search to just the phone numbers associated with the
3257
+ # specified toll-free prefix.
2803
3258
  #
2804
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**.
2805
3262
  #
2806
3263
  # @option params [Integer] :max_results
3264
+ # The maximum number of results to return.
2807
3265
  #
2808
3266
  # @option params [String] :next_token
3267
+ # The token used to return the next page of results.
2809
3268
  #
2810
3269
  # @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2811
3270
  #
@@ -2842,13 +3301,29 @@ module Aws::ChimeSDKVoice
2842
3301
  req.send_request(options)
2843
3302
  end
2844
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
+ #
2845
3315
  # @option params [required, String] :voice_connector_id
3316
+ # The Voice Connector ID.
2846
3317
  #
2847
3318
  # @option params [required, String] :transaction_id
3319
+ # The transaction ID of the call being analyzed.
2848
3320
  #
2849
3321
  # @option params [required, String] :voice_profile_domain_id
3322
+ # The ID of the voice profile domain that will store the voice profile.
2850
3323
  #
2851
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.
2852
3327
  #
2853
3328
  # @return [Types::StartSpeakerSearchTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2854
3329
  #
@@ -2888,13 +3363,32 @@ module Aws::ChimeSDKVoice
2888
3363
  req.send_request(options)
2889
3364
  end
2890
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
+ #
2891
3380
  # @option params [required, String] :voice_connector_id
3381
+ # The Voice Connector ID.
2892
3382
  #
2893
3383
  # @option params [required, String] :transaction_id
3384
+ # The transaction ID.
2894
3385
  #
2895
3386
  # @option params [required, String] :language_code
3387
+ # The language code.
2896
3388
  #
2897
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.
2898
3392
  #
2899
3393
  # @return [Types::StartVoiceToneAnalysisTaskResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2900
3394
  #
@@ -2930,9 +3424,13 @@ module Aws::ChimeSDKVoice
2930
3424
  req.send_request(options)
2931
3425
  end
2932
3426
 
3427
+ # Stops a speaker search task.
3428
+ #
2933
3429
  # @option params [required, String] :voice_connector_id
3430
+ # The Voice Connector ID.
2934
3431
  #
2935
3432
  # @option params [required, String] :speaker_search_task_id
3433
+ # The speaker search task ID.
2936
3434
  #
2937
3435
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2938
3436
  #
@@ -2952,9 +3450,13 @@ module Aws::ChimeSDKVoice
2952
3450
  req.send_request(options)
2953
3451
  end
2954
3452
 
3453
+ # Stops a voice tone analysis task.
3454
+ #
2955
3455
  # @option params [required, String] :voice_connector_id
3456
+ # The Voice Connector ID.
2956
3457
  #
2957
3458
  # @option params [required, String] :voice_tone_analysis_task_id
3459
+ # The ID of the voice tone analysis task.
2958
3460
  #
2959
3461
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2960
3462
  #
@@ -2974,9 +3476,13 @@ module Aws::ChimeSDKVoice
2974
3476
  req.send_request(options)
2975
3477
  end
2976
3478
 
3479
+ # Adds a tag to the specified resource.
3480
+ #
2977
3481
  # @option params [required, String] :resource_arn
3482
+ # The ARN of the resource being tagged.
2978
3483
  #
2979
3484
  # @option params [required, Array<Types::Tag>] :tags
3485
+ # A list of the tags being added to the resource.
2980
3486
  #
2981
3487
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2982
3488
  #
@@ -3001,9 +3507,13 @@ module Aws::ChimeSDKVoice
3001
3507
  req.send_request(options)
3002
3508
  end
3003
3509
 
3510
+ # Removes tags from a resource.
3511
+ #
3004
3512
  # @option params [required, String] :resource_arn
3513
+ # The ARN of the resource having its tags removed.
3005
3514
  #
3006
3515
  # @option params [required, Array<String>] :tag_keys
3516
+ # The keys of the tags being removed from the resource.
3007
3517
  #
3008
3518
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3009
3519
  #
@@ -3023,7 +3533,11 @@ module Aws::ChimeSDKVoice
3023
3533
  req.send_request(options)
3024
3534
  end
3025
3535
 
3536
+ # Updates global settings for the Amazon Chime SDK Voice Connectors in
3537
+ # an AWS account.
3538
+ #
3026
3539
  # @option params [Types::VoiceConnectorSettings] :voice_connector
3540
+ # The Voice Connector settings.
3027
3541
  #
3028
3542
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3029
3543
  #
@@ -3044,11 +3558,26 @@ module Aws::ChimeSDKVoice
3044
3558
  req.send_request(options)
3045
3559
  end
3046
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
+ #
3047
3573
  # @option params [required, String] :phone_number_id
3574
+ # The phone number ID.
3048
3575
  #
3049
3576
  # @option params [String] :product_type
3577
+ # The product type.
3050
3578
  #
3051
3579
  # @option params [String] :calling_name
3580
+ # The outbound calling name associated with the phone number.
3052
3581
  #
3053
3582
  # @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3054
3583
  #
@@ -3096,7 +3625,13 @@ module Aws::ChimeSDKVoice
3096
3625
  req.send_request(options)
3097
3626
  end
3098
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
+ #
3099
3633
  # @option params [required, String] :calling_name
3634
+ # The default outbound calling name for the account.
3100
3635
  #
3101
3636
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3102
3637
  #
@@ -3115,13 +3650,20 @@ module Aws::ChimeSDKVoice
3115
3650
  req.send_request(options)
3116
3651
  end
3117
3652
 
3653
+ # Updates the specified proxy session details, such as voice or SMS
3654
+ # capabilities.
3655
+ #
3118
3656
  # @option params [required, String] :voice_connector_id
3657
+ # The Voice Connector ID.
3119
3658
  #
3120
3659
  # @option params [required, String] :proxy_session_id
3660
+ # The proxy session ID.
3121
3661
  #
3122
3662
  # @option params [required, Array<String>] :capabilities
3663
+ # The proxy session capabilities.
3123
3664
  #
3124
3665
  # @option params [Integer] :expiry_minutes
3666
+ # The number of minutes allowed for the proxy session.
3125
3667
  #
3126
3668
  # @return [Types::UpdateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3127
3669
  #
@@ -3165,11 +3707,16 @@ module Aws::ChimeSDKVoice
3165
3707
  req.send_request(options)
3166
3708
  end
3167
3709
 
3710
+ # Updates the details of the specified SIP media application.
3711
+ #
3168
3712
  # @option params [required, String] :sip_media_application_id
3713
+ # The SIP media application ID.
3169
3714
  #
3170
3715
  # @option params [String] :name
3716
+ # The new name for the specified SIP media application.
3171
3717
  #
3172
3718
  # @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
3719
+ # The new set of endpoints for the specified SIP media application.
3173
3720
  #
3174
3721
  # @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3175
3722
  #
@@ -3206,11 +3753,19 @@ module Aws::ChimeSDKVoice
3206
3753
  req.send_request(options)
3207
3754
  end
3208
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
+ #
3209
3760
  # @option params [required, String] :sip_media_application_id
3761
+ # The ID of the SIP media application handling the call.
3210
3762
  #
3211
3763
  # @option params [required, String] :transaction_id
3764
+ # The ID of the call transaction.
3212
3765
  #
3213
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.
3214
3769
  #
3215
3770
  # @return [Types::UpdateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3216
3771
  #
@@ -3239,13 +3794,19 @@ module Aws::ChimeSDKVoice
3239
3794
  req.send_request(options)
3240
3795
  end
3241
3796
 
3797
+ # Updates the details of the specified SIP rule.
3798
+ #
3242
3799
  # @option params [required, String] :sip_rule_id
3800
+ # The SIP rule ID.
3243
3801
  #
3244
3802
  # @option params [required, String] :name
3803
+ # The new name for the specified SIP rule.
3245
3804
  #
3246
3805
  # @option params [Boolean] :disabled
3806
+ # The new value that indicates whether the rule is disabled.
3247
3807
  #
3248
3808
  # @option params [Array<Types::SipRuleTargetApplication>] :target_applications
3809
+ # The new list of target applications.
3249
3810
  #
3250
3811
  # @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3251
3812
  #
@@ -3289,11 +3850,17 @@ module Aws::ChimeSDKVoice
3289
3850
  req.send_request(options)
3290
3851
  end
3291
3852
 
3853
+ # Updates the details for the specified Amazon Chime SDK Voice
3854
+ # Connector.
3855
+ #
3292
3856
  # @option params [required, String] :voice_connector_id
3857
+ # The Voice Connector ID.
3293
3858
  #
3294
3859
  # @option params [required, String] :name
3860
+ # The name of the Voice Connector.
3295
3861
  #
3296
3862
  # @option params [required, Boolean] :require_encryption
3863
+ # When enabled, requires encryption for the Voice Connector.
3297
3864
  #
3298
3865
  # @return [Types::UpdateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3299
3866
  #
@@ -3327,11 +3894,17 @@ module Aws::ChimeSDKVoice
3327
3894
  req.send_request(options)
3328
3895
  end
3329
3896
 
3897
+ # Updates the settings for the specified Amazon Chime SDK Voice
3898
+ # Connector group.
3899
+ #
3330
3900
  # @option params [required, String] :voice_connector_group_id
3901
+ # The Voice Connector ID.
3331
3902
  #
3332
3903
  # @option params [required, String] :name
3904
+ # The name of the Voice Connector group.
3333
3905
  #
3334
3906
  # @option params [required, Array<Types::VoiceConnectorItem>] :voice_connector_items
3907
+ # The `VoiceConnectorItems` to associate with the Voice Connector group.
3335
3908
  #
3336
3909
  # @return [Types::UpdateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3337
3910
  #
@@ -3370,9 +3943,27 @@ module Aws::ChimeSDKVoice
3370
3943
  req.send_request(options)
3371
3944
  end
3372
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
+ #
3373
3962
  # @option params [required, String] :voice_profile_id
3963
+ # The profile ID.
3374
3964
  #
3375
3965
  # @option params [required, String] :speaker_search_task_id
3966
+ # The ID of the speaker search task.
3376
3967
  #
3377
3968
  # @return [Types::UpdateVoiceProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3378
3969
  #
@@ -3403,11 +3994,16 @@ module Aws::ChimeSDKVoice
3403
3994
  req.send_request(options)
3404
3995
  end
3405
3996
 
3997
+ # Updates the settings for the specified voice profile domain.
3998
+ #
3406
3999
  # @option params [required, String] :voice_profile_domain_id
4000
+ # The domain ID.
3407
4001
  #
3408
4002
  # @option params [String] :name
4003
+ # The name of the voice profile domain.
3409
4004
  #
3410
4005
  # @option params [String] :description
4006
+ # The description of the voice profile domain.
3411
4007
  #
3412
4008
  # @return [Types::UpdateVoiceProfileDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3413
4009
  #
@@ -3440,19 +4036,32 @@ module Aws::ChimeSDKVoice
3440
4036
  req.send_request(options)
3441
4037
  end
3442
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
+ #
3443
4045
  # @option params [required, String] :aws_account_id
4046
+ # The AWS account ID.
3444
4047
  #
3445
4048
  # @option params [required, String] :street_number
4049
+ # The address street number, such as `200` or `2121`.
3446
4050
  #
3447
4051
  # @option params [required, String] :street_info
4052
+ # The address street information, such as `8th Avenue`.
3448
4053
  #
3449
4054
  # @option params [required, String] :city
4055
+ # The address city, such as `Portland`.
3450
4056
  #
3451
4057
  # @option params [required, String] :state
4058
+ # The address state, such as `ME`.
3452
4059
  #
3453
4060
  # @option params [required, String] :country
4061
+ # The country in the address being validated.
3454
4062
  #
3455
4063
  # @option params [required, String] :postal_code
4064
+ # The dress postal code, such `04352`.
3456
4065
  #
3457
4066
  # @return [Types::ValidateE911AddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3458
4067
  #
@@ -3518,7 +4127,7 @@ module Aws::ChimeSDKVoice
3518
4127
  params: params,
3519
4128
  config: config)
3520
4129
  context[:gem_name] = 'aws-sdk-chimesdkvoice'
3521
- context[:gem_version] = '1.3.0'
4130
+ context[:gem_version] = '1.4.0'
3522
4131
  Seahorse::Client::Request.new(handlers, context)
3523
4132
  end
3524
4133