aws-sdk-connect 1.78.0 → 1.80.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +569 -35
- data/lib/aws-sdk-connect/client_api.rb +219 -0
- data/lib/aws-sdk-connect/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-connect/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-connect/endpoints.rb +2269 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +390 -0
- data/lib/aws-sdk-connect/types.rb +752 -53
- data/lib/aws-sdk-connect.rb +5 -1
- metadata +8 -4
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:connect)
|
@@ -79,8 +79,9 @@ module Aws::Connect
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::Connect::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::Connect
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::Connect
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::Connect::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Connect::EndpointParameters`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -603,6 +620,17 @@ module Aws::Connect
|
|
603
620
|
# Associates a flow with a phone number claimed to your Amazon Connect
|
604
621
|
# instance.
|
605
622
|
#
|
623
|
+
# If the number is claimed to a traffic distribution group, and you are
|
624
|
+
# calling this API using an instance in the Amazon Web Services Region
|
625
|
+
# where the traffic distribution group was created, you can use either a
|
626
|
+
# full phone number ARN or UUID value for the `PhoneNumberId` URI
|
627
|
+
# request parameter. However, if the number is claimed to a traffic
|
628
|
+
# distribution group and you are calling this API using an instance in
|
629
|
+
# the alternate Amazon Web Services Region associated with the traffic
|
630
|
+
# distribution group, you must provide a full phone number ARN. If a
|
631
|
+
# UUID is provided in this scenario, you will receive a
|
632
|
+
# `ResourceNotFoundException`.
|
633
|
+
#
|
606
634
|
# @option params [required, String] :phone_number_id
|
607
635
|
# A unique identifier for the phone number.
|
608
636
|
#
|
@@ -742,11 +770,22 @@ module Aws::Connect
|
|
742
770
|
req.send_request(options)
|
743
771
|
end
|
744
772
|
|
745
|
-
# Claims an available phone number to your Amazon Connect instance
|
773
|
+
# Claims an available phone number to your Amazon Connect instance or
|
774
|
+
# traffic distribution group. You can call this API only in the same
|
775
|
+
# Amazon Web Services Region where the Amazon Connect instance or
|
776
|
+
# traffic distribution group was created.
|
777
|
+
#
|
778
|
+
# You can call the [DescribePhoneNumber][1] API to verify the status of
|
779
|
+
# a previous [ClaimPhoneNumber][2] operation.
|
780
|
+
#
|
781
|
+
#
|
782
|
+
#
|
783
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
784
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
|
746
785
|
#
|
747
786
|
# @option params [required, String] :target_arn
|
748
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
749
|
-
# numbers are claimed to.
|
787
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
|
788
|
+
# distribution groups that phone numbers are claimed to.
|
750
789
|
#
|
751
790
|
# @option params [required, String] :phone_number
|
752
791
|
# The phone number you want to claim. Phone numbers are formatted `[+]
|
@@ -762,11 +801,17 @@ module Aws::Connect
|
|
762
801
|
#
|
763
802
|
# @option params [String] :client_token
|
764
803
|
# A unique, case-sensitive identifier that you provide to ensure the
|
765
|
-
# idempotency of the request.
|
804
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
805
|
+
# SDK populates this field. For more information about idempotency, see
|
806
|
+
# [Making retries safe with idempotent APIs][1].
|
766
807
|
#
|
767
808
|
# **A suitable default value is auto-generated.** You should normally
|
768
809
|
# not need to pass this option.**
|
769
810
|
#
|
811
|
+
#
|
812
|
+
#
|
813
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
814
|
+
#
|
770
815
|
# @return [Types::ClaimPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
771
816
|
#
|
772
817
|
# * {Types::ClaimPhoneNumberResponse#phone_number_id #phone_number_id} => String
|
@@ -944,11 +989,17 @@ module Aws::Connect
|
|
944
989
|
#
|
945
990
|
# @option params [String] :client_token
|
946
991
|
# A unique, case-sensitive identifier that you provide to ensure the
|
947
|
-
# idempotency of the request.
|
992
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
993
|
+
# SDK populates this field. For more information about idempotency, see
|
994
|
+
# [Making retries safe with idempotent APIs][1].
|
948
995
|
#
|
949
996
|
# **A suitable default value is auto-generated.** You should normally
|
950
997
|
# not need to pass this option.**
|
951
998
|
#
|
999
|
+
#
|
1000
|
+
#
|
1001
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1002
|
+
#
|
952
1003
|
# @return [Types::CreateContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
953
1004
|
#
|
954
1005
|
# * {Types::CreateContactFlowModuleResponse#id #id} => String
|
@@ -1188,6 +1239,22 @@ module Aws::Connect
|
|
1188
1239
|
#
|
1189
1240
|
# Creates a new queue for the specified Amazon Connect instance.
|
1190
1241
|
#
|
1242
|
+
# If the number being used in the input is claimed to a traffic
|
1243
|
+
# distribution group, and you are calling this API using an instance in
|
1244
|
+
# the Amazon Web Services Region where the traffic distribution group
|
1245
|
+
# was created, you can use either a full phone number ARN or UUID value
|
1246
|
+
# for the `OutboundCallerIdNumberId` value of the
|
1247
|
+
# [OutboundCallerConfig][1] request body parameter. However, if the
|
1248
|
+
# number is claimed to a traffic distribution group and you are calling
|
1249
|
+
# this API using an instance in the alternate Amazon Web Services Region
|
1250
|
+
# associated with the traffic distribution group, you must provide a
|
1251
|
+
# full phone number ARN. If a UUID is provided in this scenario, you
|
1252
|
+
# will receive a `ResourceNotFoundException`.
|
1253
|
+
#
|
1254
|
+
#
|
1255
|
+
#
|
1256
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig
|
1257
|
+
#
|
1191
1258
|
# @option params [required, String] :instance_id
|
1192
1259
|
# The identifier of the Amazon Connect instance. You can find the
|
1193
1260
|
# instanceId in the ARN of the instance.
|
@@ -1487,11 +1554,17 @@ module Aws::Connect
|
|
1487
1554
|
#
|
1488
1555
|
# @option params [String] :client_token
|
1489
1556
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1490
|
-
# idempotency of the request.
|
1557
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1558
|
+
# SDK populates this field. For more information about idempotency, see
|
1559
|
+
# [Making retries safe with idempotent APIs][1].
|
1491
1560
|
#
|
1492
1561
|
# **A suitable default value is auto-generated.** You should normally
|
1493
1562
|
# not need to pass this option.**
|
1494
1563
|
#
|
1564
|
+
#
|
1565
|
+
#
|
1566
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1567
|
+
#
|
1495
1568
|
# @return [Types::CreateTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1496
1569
|
#
|
1497
1570
|
# * {Types::CreateTaskTemplateResponse#id #id} => String
|
@@ -1565,6 +1638,76 @@ module Aws::Connect
|
|
1565
1638
|
req.send_request(options)
|
1566
1639
|
end
|
1567
1640
|
|
1641
|
+
# Creates a traffic distribution group given an Amazon Connect instance
|
1642
|
+
# that has been replicated.
|
1643
|
+
#
|
1644
|
+
# For more information about creating traffic distribution groups, see
|
1645
|
+
# [Set up traffic distribution groups][1] in the *Amazon Connect
|
1646
|
+
# Administrator Guide*.
|
1647
|
+
#
|
1648
|
+
#
|
1649
|
+
#
|
1650
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html
|
1651
|
+
#
|
1652
|
+
# @option params [required, String] :name
|
1653
|
+
# The name for the traffic distribution group.
|
1654
|
+
#
|
1655
|
+
# @option params [String] :description
|
1656
|
+
# A description for the traffic distribution group.
|
1657
|
+
#
|
1658
|
+
# @option params [required, String] :instance_id
|
1659
|
+
# The identifier of the Amazon Connect instance that has been
|
1660
|
+
# replicated. You can find the `instanceId` in the ARN of the instance.
|
1661
|
+
#
|
1662
|
+
# @option params [String] :client_token
|
1663
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1664
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1665
|
+
# SDK populates this field. For more information about idempotency, see
|
1666
|
+
# [Making retries safe with idempotent APIs][1].
|
1667
|
+
#
|
1668
|
+
# **A suitable default value is auto-generated.** You should normally
|
1669
|
+
# not need to pass this option.**
|
1670
|
+
#
|
1671
|
+
#
|
1672
|
+
#
|
1673
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1674
|
+
#
|
1675
|
+
# @option params [Hash<String,String>] :tags
|
1676
|
+
# The tags used to organize, track, or control access for this resource.
|
1677
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1678
|
+
# "key2":"value2"\\} \\}.
|
1679
|
+
#
|
1680
|
+
# @return [Types::CreateTrafficDistributionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1681
|
+
#
|
1682
|
+
# * {Types::CreateTrafficDistributionGroupResponse#id #id} => String
|
1683
|
+
# * {Types::CreateTrafficDistributionGroupResponse#arn #arn} => String
|
1684
|
+
#
|
1685
|
+
# @example Request syntax with placeholder values
|
1686
|
+
#
|
1687
|
+
# resp = client.create_traffic_distribution_group({
|
1688
|
+
# name: "Name128", # required
|
1689
|
+
# description: "Description250",
|
1690
|
+
# instance_id: "InstanceIdOrArn", # required
|
1691
|
+
# client_token: "ClientToken",
|
1692
|
+
# tags: {
|
1693
|
+
# "TagKey" => "TagValue",
|
1694
|
+
# },
|
1695
|
+
# })
|
1696
|
+
#
|
1697
|
+
# @example Response structure
|
1698
|
+
#
|
1699
|
+
# resp.id #=> String
|
1700
|
+
# resp.arn #=> String
|
1701
|
+
#
|
1702
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTrafficDistributionGroup AWS API Documentation
|
1703
|
+
#
|
1704
|
+
# @overload create_traffic_distribution_group(params = {})
|
1705
|
+
# @param [Hash] params ({})
|
1706
|
+
def create_traffic_distribution_group(params = {}, options = {})
|
1707
|
+
req = build_request(:create_traffic_distribution_group, params)
|
1708
|
+
req.send_request(options)
|
1709
|
+
end
|
1710
|
+
|
1568
1711
|
# Creates a use case for an integration association.
|
1569
1712
|
#
|
1570
1713
|
# @option params [required, String] :instance_id
|
@@ -1775,13 +1918,19 @@ module Aws::Connect
|
|
1775
1918
|
#
|
1776
1919
|
# @option params [String] :client_token
|
1777
1920
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1778
|
-
# idempotency of the request. If
|
1779
|
-
#
|
1780
|
-
#
|
1921
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1922
|
+
# SDK populates this field. For more information about idempotency, see
|
1923
|
+
# [Making retries safe with idempotent APIs][1]. If a create request is
|
1924
|
+
# received more than once with same client token, subsequent requests
|
1925
|
+
# return the previous response without creating a vocabulary again.
|
1781
1926
|
#
|
1782
1927
|
# **A suitable default value is auto-generated.** You should normally
|
1783
1928
|
# not need to pass this option.**
|
1784
1929
|
#
|
1930
|
+
#
|
1931
|
+
#
|
1932
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1933
|
+
#
|
1785
1934
|
# @option params [required, String] :instance_id
|
1786
1935
|
# The identifier of the Amazon Connect instance. You can find the
|
1787
1936
|
# instanceId in the ARN of the instance.
|
@@ -2078,6 +2227,40 @@ module Aws::Connect
|
|
2078
2227
|
req.send_request(options)
|
2079
2228
|
end
|
2080
2229
|
|
2230
|
+
# Deletes a traffic distribution group. This API can be called only in
|
2231
|
+
# the Region where the traffic distribution group is created.
|
2232
|
+
#
|
2233
|
+
# For more information about deleting traffic distribution groups, see
|
2234
|
+
# [Delete traffic distribution groups][1] in the *Amazon Connect
|
2235
|
+
# Administrator Guide*.
|
2236
|
+
#
|
2237
|
+
#
|
2238
|
+
#
|
2239
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html
|
2240
|
+
#
|
2241
|
+
# @option params [required, String] :traffic_distribution_group_id
|
2242
|
+
# The identifier of the traffic distribution group. This can be the ID
|
2243
|
+
# or the ARN if the API is being called in the Region where the traffic
|
2244
|
+
# distribution group was created. The ARN must be provided if the call
|
2245
|
+
# is from the replicated Region.
|
2246
|
+
#
|
2247
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2248
|
+
#
|
2249
|
+
# @example Request syntax with placeholder values
|
2250
|
+
#
|
2251
|
+
# resp = client.delete_traffic_distribution_group({
|
2252
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
2253
|
+
# })
|
2254
|
+
#
|
2255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTrafficDistributionGroup AWS API Documentation
|
2256
|
+
#
|
2257
|
+
# @overload delete_traffic_distribution_group(params = {})
|
2258
|
+
# @param [Hash] params ({})
|
2259
|
+
def delete_traffic_distribution_group(params = {}, options = {})
|
2260
|
+
req = build_request(:delete_traffic_distribution_group, params)
|
2261
|
+
req.send_request(options)
|
2262
|
+
end
|
2263
|
+
|
2081
2264
|
# Deletes a use case from an integration association.
|
2082
2265
|
#
|
2083
2266
|
# @option params [required, String] :instance_id
|
@@ -2584,7 +2767,17 @@ module Aws::Connect
|
|
2584
2767
|
end
|
2585
2768
|
|
2586
2769
|
# Gets details and status of a phone number that’s claimed to your
|
2587
|
-
# Amazon Connect instance
|
2770
|
+
# Amazon Connect instance or traffic distribution group.
|
2771
|
+
#
|
2772
|
+
# If the number is claimed to a traffic distribution group, and you are
|
2773
|
+
# calling in the Amazon Web Services Region where the traffic
|
2774
|
+
# distribution group was created, you can use either a phone number ARN
|
2775
|
+
# or UUID value for the `PhoneNumberId` URI request parameter. However,
|
2776
|
+
# if the number is claimed to a traffic distribution group and you are
|
2777
|
+
# calling this API in the alternate Amazon Web Services Region
|
2778
|
+
# associated with the traffic distribution group, you must provide a
|
2779
|
+
# full phone number ARN. If a UUID is provided in this scenario, you
|
2780
|
+
# will receive a `ResourceNotFoundException`.
|
2588
2781
|
#
|
2589
2782
|
# @option params [required, String] :phone_number_id
|
2590
2783
|
# A unique identifier for the phone number.
|
@@ -2800,6 +2993,44 @@ module Aws::Connect
|
|
2800
2993
|
req.send_request(options)
|
2801
2994
|
end
|
2802
2995
|
|
2996
|
+
# Gets details and status of a traffic distribution group.
|
2997
|
+
#
|
2998
|
+
# @option params [required, String] :traffic_distribution_group_id
|
2999
|
+
# The identifier of the traffic distribution group. This can be the ID
|
3000
|
+
# or the ARN if the API is being called in the Region where the traffic
|
3001
|
+
# distribution group was created. The ARN must be provided if the call
|
3002
|
+
# is from the replicated Region.
|
3003
|
+
#
|
3004
|
+
# @return [Types::DescribeTrafficDistributionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3005
|
+
#
|
3006
|
+
# * {Types::DescribeTrafficDistributionGroupResponse#traffic_distribution_group #traffic_distribution_group} => Types::TrafficDistributionGroup
|
3007
|
+
#
|
3008
|
+
# @example Request syntax with placeholder values
|
3009
|
+
#
|
3010
|
+
# resp = client.describe_traffic_distribution_group({
|
3011
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
3012
|
+
# })
|
3013
|
+
#
|
3014
|
+
# @example Response structure
|
3015
|
+
#
|
3016
|
+
# resp.traffic_distribution_group.id #=> String
|
3017
|
+
# resp.traffic_distribution_group.arn #=> String
|
3018
|
+
# resp.traffic_distribution_group.name #=> String
|
3019
|
+
# resp.traffic_distribution_group.description #=> String
|
3020
|
+
# resp.traffic_distribution_group.instance_arn #=> String
|
3021
|
+
# resp.traffic_distribution_group.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
|
3022
|
+
# resp.traffic_distribution_group.tags #=> Hash
|
3023
|
+
# resp.traffic_distribution_group.tags["TagKey"] #=> String
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTrafficDistributionGroup AWS API Documentation
|
3026
|
+
#
|
3027
|
+
# @overload describe_traffic_distribution_group(params = {})
|
3028
|
+
# @param [Hash] params ({})
|
3029
|
+
def describe_traffic_distribution_group(params = {}, options = {})
|
3030
|
+
req = build_request(:describe_traffic_distribution_group, params)
|
3031
|
+
req.send_request(options)
|
3032
|
+
end
|
3033
|
+
|
2803
3034
|
# Describes the specified user account. You can find the instance ID in
|
2804
3035
|
# the console (it’s the final part of the ARN). The console does not
|
2805
3036
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -3145,7 +3376,8 @@ module Aws::Connect
|
|
3145
3376
|
# The name of the Amazon Lex bot. Maximum character limit of 50.
|
3146
3377
|
#
|
3147
3378
|
# @option params [required, String] :lex_region
|
3148
|
-
# The Region in which the Amazon Lex bot has been
|
3379
|
+
# The Amazon Web Services Region in which the Amazon Lex bot has been
|
3380
|
+
# created.
|
3149
3381
|
#
|
3150
3382
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3151
3383
|
#
|
@@ -3167,7 +3399,18 @@ module Aws::Connect
|
|
3167
3399
|
end
|
3168
3400
|
|
3169
3401
|
# Removes the flow association from a phone number claimed to your
|
3170
|
-
# Amazon Connect instance
|
3402
|
+
# Amazon Connect instance.
|
3403
|
+
#
|
3404
|
+
# If the number is claimed to a traffic distribution group, and you are
|
3405
|
+
# calling this API using an instance in the Amazon Web Services Region
|
3406
|
+
# where the traffic distribution group was created, you can use either a
|
3407
|
+
# full phone number ARN or UUID value for the `PhoneNumberId` URI
|
3408
|
+
# request parameter. However, if the number is claimed to a traffic
|
3409
|
+
# distribution group and you are calling this API using an instance in
|
3410
|
+
# the alternate Amazon Web Services Region associated with the traffic
|
3411
|
+
# distribution group, you must provide a full phone number ARN. If a
|
3412
|
+
# UUID is provided in this scenario, you will receive a
|
3413
|
+
# `ResourceNotFoundException`.
|
3171
3414
|
#
|
3172
3415
|
# @option params [required, String] :phone_number_id
|
3173
3416
|
# A unique identifier for the phone number.
|
@@ -4024,6 +4267,41 @@ module Aws::Connect
|
|
4024
4267
|
req.send_request(options)
|
4025
4268
|
end
|
4026
4269
|
|
4270
|
+
# Retrieves the current traffic distribution for a given traffic
|
4271
|
+
# distribution group.
|
4272
|
+
#
|
4273
|
+
# @option params [required, String] :id
|
4274
|
+
# The identifier of the traffic distribution group.
|
4275
|
+
#
|
4276
|
+
# @return [Types::GetTrafficDistributionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4277
|
+
#
|
4278
|
+
# * {Types::GetTrafficDistributionResponse#telephony_config #telephony_config} => Types::TelephonyConfig
|
4279
|
+
# * {Types::GetTrafficDistributionResponse#id #id} => String
|
4280
|
+
# * {Types::GetTrafficDistributionResponse#arn #arn} => String
|
4281
|
+
#
|
4282
|
+
# @example Request syntax with placeholder values
|
4283
|
+
#
|
4284
|
+
# resp = client.get_traffic_distribution({
|
4285
|
+
# id: "TrafficDistributionGroupIdOrArn", # required
|
4286
|
+
# })
|
4287
|
+
#
|
4288
|
+
# @example Response structure
|
4289
|
+
#
|
4290
|
+
# resp.telephony_config.distributions #=> Array
|
4291
|
+
# resp.telephony_config.distributions[0].region #=> String
|
4292
|
+
# resp.telephony_config.distributions[0].percentage #=> Integer
|
4293
|
+
# resp.id #=> String
|
4294
|
+
# resp.arn #=> String
|
4295
|
+
#
|
4296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTrafficDistribution AWS API Documentation
|
4297
|
+
#
|
4298
|
+
# @overload get_traffic_distribution(params = {})
|
4299
|
+
# @param [Hash] params ({})
|
4300
|
+
def get_traffic_distribution(params = {}, options = {})
|
4301
|
+
req = build_request(:get_traffic_distribution, params)
|
4302
|
+
req.send_request(options)
|
4303
|
+
end
|
4304
|
+
|
4027
4305
|
# This API is in preview release for Amazon Connect and is subject to
|
4028
4306
|
# change.
|
4029
4307
|
#
|
@@ -4809,9 +5087,17 @@ module Aws::Connect
|
|
4809
5087
|
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
4810
5088
|
# Guide*.
|
4811
5089
|
#
|
5090
|
+
# The phone number `Arn` value that is returned from each of the items
|
5091
|
+
# in the [PhoneNumberSummaryList][2] cannot be used to tag phone number
|
5092
|
+
# resources. It will fail with a `ResourceNotFoundException`. Instead,
|
5093
|
+
# use the [ListPhoneNumbersV2][3] API. It returns the new phone number
|
5094
|
+
# ARN that can be used to tag phone number resources.
|
5095
|
+
#
|
4812
5096
|
#
|
4813
5097
|
#
|
4814
5098
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
5099
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList
|
5100
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html
|
4815
5101
|
#
|
4816
5102
|
# @option params [required, String] :instance_id
|
4817
5103
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -4868,7 +5154,10 @@ module Aws::Connect
|
|
4868
5154
|
req.send_request(options)
|
4869
5155
|
end
|
4870
5156
|
|
4871
|
-
# Lists phone numbers claimed to your Amazon Connect instance
|
5157
|
+
# Lists phone numbers claimed to your Amazon Connect instance or traffic
|
5158
|
+
# distribution group. If the provided `TargetArn` is a traffic
|
5159
|
+
# distribution group, you can call this API in both Amazon Web Services
|
5160
|
+
# Regions associated with traffic distribution group.
|
4872
5161
|
#
|
4873
5162
|
# For more information about phone numbers, see [Set Up Phone Numbers
|
4874
5163
|
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
@@ -4879,10 +5168,11 @@ module Aws::Connect
|
|
4879
5168
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
4880
5169
|
#
|
4881
5170
|
# @option params [String] :target_arn
|
4882
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
4883
|
-
# numbers are claimed to. If `TargetArn`
|
4884
|
-
# lists numbers claimed to all the
|
4885
|
-
# your account
|
5171
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
|
5172
|
+
# distribution groups that phone numbers are claimed to. If `TargetArn`
|
5173
|
+
# input is not provided, this API lists numbers claimed to all the
|
5174
|
+
# Amazon Connect instances belonging to your account in the same Amazon
|
5175
|
+
# Web Services Region as the request.
|
4886
5176
|
#
|
4887
5177
|
# @option params [Integer] :max_results
|
4888
5178
|
# The maximum number of results to return per page.
|
@@ -5532,6 +5822,54 @@ module Aws::Connect
|
|
5532
5822
|
req.send_request(options)
|
5533
5823
|
end
|
5534
5824
|
|
5825
|
+
# Lists traffic distribution groups.
|
5826
|
+
#
|
5827
|
+
# @option params [Integer] :max_results
|
5828
|
+
# The maximum number of results to return per page.
|
5829
|
+
#
|
5830
|
+
# @option params [String] :next_token
|
5831
|
+
# The token for the next set of results. Use the value returned in the
|
5832
|
+
# previous response in the next request to retrieve the next set of
|
5833
|
+
# results.
|
5834
|
+
#
|
5835
|
+
# @option params [String] :instance_id
|
5836
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5837
|
+
# instanceId in the ARN of the instance.
|
5838
|
+
#
|
5839
|
+
# @return [Types::ListTrafficDistributionGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5840
|
+
#
|
5841
|
+
# * {Types::ListTrafficDistributionGroupsResponse#next_token #next_token} => String
|
5842
|
+
# * {Types::ListTrafficDistributionGroupsResponse#traffic_distribution_group_summary_list #traffic_distribution_group_summary_list} => Array<Types::TrafficDistributionGroupSummary>
|
5843
|
+
#
|
5844
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5845
|
+
#
|
5846
|
+
# @example Request syntax with placeholder values
|
5847
|
+
#
|
5848
|
+
# resp = client.list_traffic_distribution_groups({
|
5849
|
+
# max_results: 1,
|
5850
|
+
# next_token: "NextToken",
|
5851
|
+
# instance_id: "InstanceIdOrArn",
|
5852
|
+
# })
|
5853
|
+
#
|
5854
|
+
# @example Response structure
|
5855
|
+
#
|
5856
|
+
# resp.next_token #=> String
|
5857
|
+
# resp.traffic_distribution_group_summary_list #=> Array
|
5858
|
+
# resp.traffic_distribution_group_summary_list[0].id #=> String
|
5859
|
+
# resp.traffic_distribution_group_summary_list[0].arn #=> String
|
5860
|
+
# resp.traffic_distribution_group_summary_list[0].name #=> String
|
5861
|
+
# resp.traffic_distribution_group_summary_list[0].instance_arn #=> String
|
5862
|
+
# resp.traffic_distribution_group_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
|
5863
|
+
#
|
5864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroups AWS API Documentation
|
5865
|
+
#
|
5866
|
+
# @overload list_traffic_distribution_groups(params = {})
|
5867
|
+
# @param [Hash] params ({})
|
5868
|
+
def list_traffic_distribution_groups(params = {}, options = {})
|
5869
|
+
req = build_request(:list_traffic_distribution_groups, params)
|
5870
|
+
req.send_request(options)
|
5871
|
+
end
|
5872
|
+
|
5535
5873
|
# Lists the use cases for the integration association.
|
5536
5874
|
#
|
5537
5875
|
# @option params [required, String] :instance_id
|
@@ -5727,18 +6065,33 @@ module Aws::Connect
|
|
5727
6065
|
end
|
5728
6066
|
|
5729
6067
|
# Releases a phone number previously claimed to an Amazon Connect
|
5730
|
-
# instance.
|
6068
|
+
# instance or traffic distribution group. You can call this API only in
|
6069
|
+
# the Amazon Web Services Region where the number was claimed.
|
6070
|
+
#
|
6071
|
+
# To release phone numbers from a traffic distribution group, use the
|
6072
|
+
# `ReleasePhoneNumber` API, not the Amazon Connect console.
|
6073
|
+
#
|
6074
|
+
# After releasing a phone number, the phone number enters into a
|
6075
|
+
# cooldown period of 30 days. It cannot be searched for or claimed again
|
6076
|
+
# until the period has ended. If you accidentally release a phone
|
6077
|
+
# number, contact Amazon Web Services Support.
|
5731
6078
|
#
|
5732
6079
|
# @option params [required, String] :phone_number_id
|
5733
6080
|
# A unique identifier for the phone number.
|
5734
6081
|
#
|
5735
6082
|
# @option params [String] :client_token
|
5736
6083
|
# A unique, case-sensitive identifier that you provide to ensure the
|
5737
|
-
# idempotency of the request.
|
6084
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
6085
|
+
# SDK populates this field. For more information about idempotency, see
|
6086
|
+
# [Making retries safe with idempotent APIs][1].
|
5738
6087
|
#
|
5739
6088
|
# **A suitable default value is auto-generated.** You should normally
|
5740
6089
|
# not need to pass this option.**
|
5741
6090
|
#
|
6091
|
+
#
|
6092
|
+
#
|
6093
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6094
|
+
#
|
5742
6095
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5743
6096
|
#
|
5744
6097
|
# @example Request syntax with placeholder values
|
@@ -5757,6 +6110,70 @@ module Aws::Connect
|
|
5757
6110
|
req.send_request(options)
|
5758
6111
|
end
|
5759
6112
|
|
6113
|
+
# Replicates an Amazon Connect instance in the specified Amazon Web
|
6114
|
+
# Services Region.
|
6115
|
+
#
|
6116
|
+
# For more information about replicating an Amazon Connect instance, see
|
6117
|
+
# [Create a replica of your existing Amazon Connect instance][1] in the
|
6118
|
+
# *Amazon Connect Administrator Guide*.
|
6119
|
+
#
|
6120
|
+
#
|
6121
|
+
#
|
6122
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html
|
6123
|
+
#
|
6124
|
+
# @option params [required, String] :instance_id
|
6125
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6126
|
+
# instanceId in the ARN of the instance.
|
6127
|
+
#
|
6128
|
+
# @option params [required, String] :replica_region
|
6129
|
+
# The Amazon Web Services Region where to replicate the Amazon Connect
|
6130
|
+
# instance.
|
6131
|
+
#
|
6132
|
+
# @option params [String] :client_token
|
6133
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
6134
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
6135
|
+
# SDK populates this field. For more information about idempotency, see
|
6136
|
+
# [Making retries safe with idempotent APIs][1].
|
6137
|
+
#
|
6138
|
+
# **A suitable default value is auto-generated.** You should normally
|
6139
|
+
# not need to pass this option.**
|
6140
|
+
#
|
6141
|
+
#
|
6142
|
+
#
|
6143
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6144
|
+
#
|
6145
|
+
# @option params [required, String] :replica_alias
|
6146
|
+
# The alias for the replicated instance. The `ReplicaAlias` must be
|
6147
|
+
# unique.
|
6148
|
+
#
|
6149
|
+
# @return [Types::ReplicateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6150
|
+
#
|
6151
|
+
# * {Types::ReplicateInstanceResponse#id #id} => String
|
6152
|
+
# * {Types::ReplicateInstanceResponse#arn #arn} => String
|
6153
|
+
#
|
6154
|
+
# @example Request syntax with placeholder values
|
6155
|
+
#
|
6156
|
+
# resp = client.replicate_instance({
|
6157
|
+
# instance_id: "InstanceIdOrArn", # required
|
6158
|
+
# replica_region: "AwsRegion", # required
|
6159
|
+
# client_token: "ClientToken",
|
6160
|
+
# replica_alias: "DirectoryAlias", # required
|
6161
|
+
# })
|
6162
|
+
#
|
6163
|
+
# @example Response structure
|
6164
|
+
#
|
6165
|
+
# resp.id #=> String
|
6166
|
+
# resp.arn #=> String
|
6167
|
+
#
|
6168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicateInstance AWS API Documentation
|
6169
|
+
#
|
6170
|
+
# @overload replicate_instance(params = {})
|
6171
|
+
# @param [Hash] params ({})
|
6172
|
+
def replicate_instance(params = {}, options = {})
|
6173
|
+
req = build_request(:replicate_instance, params)
|
6174
|
+
req.send_request(options)
|
6175
|
+
end
|
6176
|
+
|
5760
6177
|
# When a contact is being recorded, and the recording has been suspended
|
5761
6178
|
# using SuspendContactRecording, this API resumes recording the call.
|
5762
6179
|
#
|
@@ -5793,11 +6210,14 @@ module Aws::Connect
|
|
5793
6210
|
end
|
5794
6211
|
|
5795
6212
|
# Searches for available phone numbers that you can claim to your Amazon
|
5796
|
-
# Connect instance.
|
6213
|
+
# Connect instance or traffic distribution group. If the provided
|
6214
|
+
# `TargetArn` is a traffic distribution group, you can call this API in
|
6215
|
+
# both Amazon Web Services Regions associated with the traffic
|
6216
|
+
# distribution group.
|
5797
6217
|
#
|
5798
6218
|
# @option params [required, String] :target_arn
|
5799
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
5800
|
-
# numbers are claimed to.
|
6219
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
|
6220
|
+
# distribution groups that phone numbers are claimed to.
|
5801
6221
|
#
|
5802
6222
|
# @option params [required, String] :phone_number_country_code
|
5803
6223
|
# The ISO country code.
|
@@ -6087,6 +6507,10 @@ module Aws::Connect
|
|
6087
6507
|
# @option params [Types::SecurityProfileSearchCriteria] :search_criteria
|
6088
6508
|
# The search criteria to be used to return security profiles.
|
6089
6509
|
#
|
6510
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
6511
|
+
#
|
6512
|
+
# </note>
|
6513
|
+
#
|
6090
6514
|
# @option params [Types::SecurityProfilesSearchFilter] :search_filter
|
6091
6515
|
# Filters to be applied to search results.
|
6092
6516
|
#
|
@@ -6169,6 +6593,10 @@ module Aws::Connect
|
|
6169
6593
|
|
6170
6594
|
# Searches users in an Amazon Connect instance, with optional filtering.
|
6171
6595
|
#
|
6596
|
+
# <note markdown="1"> `AfterContactWorkTimeLimit` is returned in milliseconds.
|
6597
|
+
#
|
6598
|
+
# </note>
|
6599
|
+
#
|
6172
6600
|
# @option params [String] :instance_id
|
6173
6601
|
# The identifier of the Amazon Connect instance. You can find the
|
6174
6602
|
# instanceId in the ARN of the instance.
|
@@ -6417,11 +6845,17 @@ module Aws::Connect
|
|
6417
6845
|
#
|
6418
6846
|
# @option params [String] :client_token
|
6419
6847
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6420
|
-
# idempotency of the request.
|
6848
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
6849
|
+
# SDK populates this field. For more information about idempotency, see
|
6850
|
+
# [Making retries safe with idempotent APIs][1].
|
6421
6851
|
#
|
6422
6852
|
# **A suitable default value is auto-generated.** You should normally
|
6423
6853
|
# not need to pass this option.**
|
6424
6854
|
#
|
6855
|
+
#
|
6856
|
+
#
|
6857
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6858
|
+
#
|
6425
6859
|
# @option params [Integer] :chat_duration_in_minutes
|
6426
6860
|
# The total duration of the newly started chat session. If not
|
6427
6861
|
# specified, the chat session duration defaults to 25 hour. The minumum
|
@@ -6557,11 +6991,17 @@ module Aws::Connect
|
|
6557
6991
|
#
|
6558
6992
|
# @option params [required, String] :client_token
|
6559
6993
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6560
|
-
# idempotency of the request.
|
6994
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
6995
|
+
# SDK populates this field. For more information about idempotency, see
|
6996
|
+
# [Making retries safe with idempotent APIs][1].
|
6561
6997
|
#
|
6562
6998
|
# **A suitable default value is auto-generated.** You should normally
|
6563
6999
|
# not need to pass this option.**
|
6564
7000
|
#
|
7001
|
+
#
|
7002
|
+
#
|
7003
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
7004
|
+
#
|
6565
7005
|
# @return [Types::StartContactStreamingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6566
7006
|
#
|
6567
7007
|
# * {Types::StartContactStreamingResponse#streaming_id #streaming_id} => String
|
@@ -6639,12 +7079,19 @@ module Aws::Connect
|
|
6639
7079
|
#
|
6640
7080
|
# @option params [String] :client_token
|
6641
7081
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6642
|
-
# idempotency of the request.
|
6643
|
-
#
|
7082
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
7083
|
+
# SDK populates this field. For more information about idempotency, see
|
7084
|
+
# [Making retries safe with idempotent APIs][1]. The token is valid for
|
7085
|
+
# 7 days after creation. If a contact is already started, the contact ID
|
7086
|
+
# is returned.
|
6644
7087
|
#
|
6645
7088
|
# **A suitable default value is auto-generated.** You should normally
|
6646
7089
|
# not need to pass this option.**
|
6647
7090
|
#
|
7091
|
+
#
|
7092
|
+
#
|
7093
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
7094
|
+
#
|
6648
7095
|
# @option params [String] :source_phone_number
|
6649
7096
|
# The phone number associated with the Amazon Connect instance, in E.164
|
6650
7097
|
# format. If you do not specify a source phone number, you must specify
|
@@ -6757,11 +7204,17 @@ module Aws::Connect
|
|
6757
7204
|
#
|
6758
7205
|
# @option params [String] :client_token
|
6759
7206
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6760
|
-
# idempotency of the request.
|
7207
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
7208
|
+
# SDK populates this field. For more information about idempotency, see
|
7209
|
+
# [Making retries safe with idempotent APIs][1].
|
6761
7210
|
#
|
6762
7211
|
# **A suitable default value is auto-generated.** You should normally
|
6763
7212
|
# not need to pass this option.**
|
6764
7213
|
#
|
7214
|
+
#
|
7215
|
+
#
|
7216
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
7217
|
+
#
|
6765
7218
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
6766
7219
|
# The timestamp, in Unix Epoch seconds format, at which to start running
|
6767
7220
|
# the inbound flow. The scheduled time cannot be in the past. It must be
|
@@ -7045,11 +7498,17 @@ module Aws::Connect
|
|
7045
7498
|
#
|
7046
7499
|
# @option params [String] :client_token
|
7047
7500
|
# A unique, case-sensitive identifier that you provide to ensure the
|
7048
|
-
# idempotency of the request.
|
7501
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
7502
|
+
# SDK populates this field. For more information about idempotency, see
|
7503
|
+
# [Making retries safe with idempotent APIs][1].
|
7049
7504
|
#
|
7050
7505
|
# **A suitable default value is auto-generated.** You should normally
|
7051
7506
|
# not need to pass this option.**
|
7052
7507
|
#
|
7508
|
+
#
|
7509
|
+
#
|
7510
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
7511
|
+
#
|
7053
7512
|
# @return [Types::TransferContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7054
7513
|
#
|
7055
7514
|
# * {Types::TransferContactResponse#contact_id #contact_id} => String
|
@@ -7662,22 +8121,38 @@ module Aws::Connect
|
|
7662
8121
|
end
|
7663
8122
|
|
7664
8123
|
# Updates your claimed phone number from its current Amazon Connect
|
7665
|
-
# instance to another Amazon Connect
|
8124
|
+
# instance or traffic distribution group to another Amazon Connect
|
8125
|
+
# instance or traffic distribution group in the same Amazon Web Services
|
8126
|
+
# Region.
|
8127
|
+
#
|
8128
|
+
# You can call [DescribePhoneNumber][1] API to verify the status of a
|
8129
|
+
# previous [UpdatePhoneNumber][2] operation.
|
8130
|
+
#
|
8131
|
+
#
|
8132
|
+
#
|
8133
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
8134
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
|
7666
8135
|
#
|
7667
8136
|
# @option params [required, String] :phone_number_id
|
7668
8137
|
# A unique identifier for the phone number.
|
7669
8138
|
#
|
7670
8139
|
# @option params [required, String] :target_arn
|
7671
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
7672
|
-
# numbers are claimed to.
|
8140
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
|
8141
|
+
# distribution groups that phone numbers are claimed to.
|
7673
8142
|
#
|
7674
8143
|
# @option params [String] :client_token
|
7675
8144
|
# A unique, case-sensitive identifier that you provide to ensure the
|
7676
|
-
# idempotency of the request.
|
8145
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
8146
|
+
# SDK populates this field. For more information about idempotency, see
|
8147
|
+
# [Making retries safe with idempotent APIs][1].
|
7677
8148
|
#
|
7678
8149
|
# **A suitable default value is auto-generated.** You should normally
|
7679
8150
|
# not need to pass this option.**
|
7680
8151
|
#
|
8152
|
+
#
|
8153
|
+
#
|
8154
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
8155
|
+
#
|
7681
8156
|
# @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7682
8157
|
#
|
7683
8158
|
# * {Types::UpdatePhoneNumberResponse#phone_number_id #phone_number_id} => String
|
@@ -7820,6 +8295,22 @@ module Aws::Connect
|
|
7820
8295
|
# Updates the outbound caller ID name, number, and outbound whisper flow
|
7821
8296
|
# for a specified queue.
|
7822
8297
|
#
|
8298
|
+
# If the number being used in the input is claimed to a traffic
|
8299
|
+
# distribution group, and you are calling this API using an instance in
|
8300
|
+
# the Amazon Web Services Region where the traffic distribution group
|
8301
|
+
# was created, you can use either a full phone number ARN or UUID value
|
8302
|
+
# for the `OutboundCallerIdNumberId` value of the
|
8303
|
+
# [OutboundCallerConfig][1] request body parameter. However, if the
|
8304
|
+
# number is claimed to a traffic distribution group and you are calling
|
8305
|
+
# this API using an instance in the alternate Amazon Web Services Region
|
8306
|
+
# associated with the traffic distribution group, you must provide a
|
8307
|
+
# full phone number ARN. If a UUID is provided in this scenario, you
|
8308
|
+
# will receive a `ResourceNotFoundException`.
|
8309
|
+
#
|
8310
|
+
#
|
8311
|
+
#
|
8312
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig
|
8313
|
+
#
|
7823
8314
|
# @option params [required, String] :instance_id
|
7824
8315
|
# The identifier of the Amazon Connect instance. You can find the
|
7825
8316
|
# instanceId in the ARN of the instance.
|
@@ -8303,6 +8794,49 @@ module Aws::Connect
|
|
8303
8794
|
req.send_request(options)
|
8304
8795
|
end
|
8305
8796
|
|
8797
|
+
# Updates the traffic distribution for a given traffic distribution
|
8798
|
+
# group. For more information about updating a traffic distribution
|
8799
|
+
# group see [Update telephony traffic distribution across Amazon Web
|
8800
|
+
# Services Regions ][1] in the *Amazon Connect Administrator Guide*.
|
8801
|
+
#
|
8802
|
+
#
|
8803
|
+
#
|
8804
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html
|
8805
|
+
#
|
8806
|
+
# @option params [required, String] :id
|
8807
|
+
# The identifier of the traffic distribution group. This can be the ID
|
8808
|
+
# or the ARN if the API is being called in the Region where the traffic
|
8809
|
+
# distribution group was created. The ARN must be provided if the call
|
8810
|
+
# is from the replicated Region.
|
8811
|
+
#
|
8812
|
+
# @option params [Types::TelephonyConfig] :telephony_config
|
8813
|
+
# The distribution of traffic between the instance and its replica(s).
|
8814
|
+
#
|
8815
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
8816
|
+
#
|
8817
|
+
# @example Request syntax with placeholder values
|
8818
|
+
#
|
8819
|
+
# resp = client.update_traffic_distribution({
|
8820
|
+
# id: "TrafficDistributionGroupIdOrArn", # required
|
8821
|
+
# telephony_config: {
|
8822
|
+
# distributions: [ # required
|
8823
|
+
# {
|
8824
|
+
# region: "AwsRegion", # required
|
8825
|
+
# percentage: 1, # required
|
8826
|
+
# },
|
8827
|
+
# ],
|
8828
|
+
# },
|
8829
|
+
# })
|
8830
|
+
#
|
8831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTrafficDistribution AWS API Documentation
|
8832
|
+
#
|
8833
|
+
# @overload update_traffic_distribution(params = {})
|
8834
|
+
# @param [Hash] params ({})
|
8835
|
+
def update_traffic_distribution(params = {}, options = {})
|
8836
|
+
req = build_request(:update_traffic_distribution, params)
|
8837
|
+
req.send_request(options)
|
8838
|
+
end
|
8839
|
+
|
8306
8840
|
# Assigns the specified hierarchy group to the specified user.
|
8307
8841
|
#
|
8308
8842
|
# @option params [String] :hierarchy_group_id
|
@@ -8569,7 +9103,7 @@ module Aws::Connect
|
|
8569
9103
|
params: params,
|
8570
9104
|
config: config)
|
8571
9105
|
context[:gem_name] = 'aws-sdk-connect'
|
8572
|
-
context[:gem_version] = '1.
|
9106
|
+
context[:gem_version] = '1.80.0'
|
8573
9107
|
Seahorse::Client::Request.new(handlers, context)
|
8574
9108
|
end
|
8575
9109
|
|