aws-sdk-connect 1.77.0 → 1.79.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.
@@ -603,6 +603,17 @@ module Aws::Connect
603
603
  # Associates a flow with a phone number claimed to your Amazon Connect
604
604
  # instance.
605
605
  #
606
+ # If the number is claimed to a traffic distribution group, and you are
607
+ # calling this API using an instance in the Amazon Web Services Region
608
+ # where the traffic distribution group was created, you can use either a
609
+ # full phone number ARN or UUID value for the `PhoneNumberId` URI
610
+ # request parameter. However, if the number is claimed to a traffic
611
+ # distribution group and you are calling this API using an instance in
612
+ # the alternate Amazon Web Services Region associated with the traffic
613
+ # distribution group, you must provide a full phone number ARN. If a
614
+ # UUID is provided in this scenario, you will receive a
615
+ # `ResourceNotFoundException`.
616
+ #
606
617
  # @option params [required, String] :phone_number_id
607
618
  # A unique identifier for the phone number.
608
619
  #
@@ -742,11 +753,22 @@ module Aws::Connect
742
753
  req.send_request(options)
743
754
  end
744
755
 
745
- # Claims an available phone number to your Amazon Connect instance.
756
+ # Claims an available phone number to your Amazon Connect instance or
757
+ # traffic distribution group. You can call this API only in the same
758
+ # Amazon Web Services Region where the Amazon Connect instance or
759
+ # traffic distribution group was created.
760
+ #
761
+ # You can call the [DescribePhoneNumber][1] API to verify the status of
762
+ # a previous [ClaimPhoneNumber][2] operation.
763
+ #
764
+ #
765
+ #
766
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
767
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
746
768
  #
747
769
  # @option params [required, String] :target_arn
748
- # The Amazon Resource Name (ARN) for Amazon Connect instances that phone
749
- # numbers are claimed to.
770
+ # The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
771
+ # distribution groups that phone numbers are claimed to.
750
772
  #
751
773
  # @option params [required, String] :phone_number
752
774
  # The phone number you want to claim. Phone numbers are formatted `[+]
@@ -762,11 +784,17 @@ module Aws::Connect
762
784
  #
763
785
  # @option params [String] :client_token
764
786
  # A unique, case-sensitive identifier that you provide to ensure the
765
- # idempotency of the request.
787
+ # idempotency of the request. If not provided, the Amazon Web Services
788
+ # SDK populates this field. For more information about idempotency, see
789
+ # [Making retries safe with idempotent APIs][1].
766
790
  #
767
791
  # **A suitable default value is auto-generated.** You should normally
768
792
  # not need to pass this option.**
769
793
  #
794
+ #
795
+ #
796
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
797
+ #
770
798
  # @return [Types::ClaimPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
771
799
  #
772
800
  # * {Types::ClaimPhoneNumberResponse#phone_number_id #phone_number_id} => String
@@ -944,11 +972,17 @@ module Aws::Connect
944
972
  #
945
973
  # @option params [String] :client_token
946
974
  # A unique, case-sensitive identifier that you provide to ensure the
947
- # idempotency of the request.
975
+ # idempotency of the request. If not provided, the Amazon Web Services
976
+ # SDK populates this field. For more information about idempotency, see
977
+ # [Making retries safe with idempotent APIs][1].
948
978
  #
949
979
  # **A suitable default value is auto-generated.** You should normally
950
980
  # not need to pass this option.**
951
981
  #
982
+ #
983
+ #
984
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
985
+ #
952
986
  # @return [Types::CreateContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
953
987
  #
954
988
  # * {Types::CreateContactFlowModuleResponse#id #id} => String
@@ -1188,6 +1222,22 @@ module Aws::Connect
1188
1222
  #
1189
1223
  # Creates a new queue for the specified Amazon Connect instance.
1190
1224
  #
1225
+ # If the number being used in the input is claimed to a traffic
1226
+ # distribution group, and you are calling this API using an instance in
1227
+ # the Amazon Web Services Region where the traffic distribution group
1228
+ # was created, you can use either a full phone number ARN or UUID value
1229
+ # for the `OutboundCallerIdNumberId` value of the
1230
+ # [OutboundCallerConfig][1] request body parameter. However, if the
1231
+ # number is claimed to a traffic distribution group and you are calling
1232
+ # this API using an instance in the alternate Amazon Web Services Region
1233
+ # associated with the traffic distribution group, you must provide a
1234
+ # full phone number ARN. If a UUID is provided in this scenario, you
1235
+ # will receive a `ResourceNotFoundException`.
1236
+ #
1237
+ #
1238
+ #
1239
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig
1240
+ #
1191
1241
  # @option params [required, String] :instance_id
1192
1242
  # The identifier of the Amazon Connect instance. You can find the
1193
1243
  # instanceId in the ARN of the instance.
@@ -1487,11 +1537,17 @@ module Aws::Connect
1487
1537
  #
1488
1538
  # @option params [String] :client_token
1489
1539
  # A unique, case-sensitive identifier that you provide to ensure the
1490
- # idempotency of the request.
1540
+ # idempotency of the request. If not provided, the Amazon Web Services
1541
+ # SDK populates this field. For more information about idempotency, see
1542
+ # [Making retries safe with idempotent APIs][1].
1491
1543
  #
1492
1544
  # **A suitable default value is auto-generated.** You should normally
1493
1545
  # not need to pass this option.**
1494
1546
  #
1547
+ #
1548
+ #
1549
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1550
+ #
1495
1551
  # @return [Types::CreateTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1496
1552
  #
1497
1553
  # * {Types::CreateTaskTemplateResponse#id #id} => String
@@ -1565,6 +1621,76 @@ module Aws::Connect
1565
1621
  req.send_request(options)
1566
1622
  end
1567
1623
 
1624
+ # Creates a traffic distribution group given an Amazon Connect instance
1625
+ # that has been replicated.
1626
+ #
1627
+ # For more information about creating traffic distribution groups, see
1628
+ # [Set up traffic distribution groups][1] in the *Amazon Connect
1629
+ # Administrator Guide*.
1630
+ #
1631
+ #
1632
+ #
1633
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html
1634
+ #
1635
+ # @option params [required, String] :name
1636
+ # The name for the traffic distribution group.
1637
+ #
1638
+ # @option params [String] :description
1639
+ # A description for the traffic distribution group.
1640
+ #
1641
+ # @option params [required, String] :instance_id
1642
+ # The identifier of the Amazon Connect instance that has been
1643
+ # replicated. You can find the `instanceId` in the ARN of the instance.
1644
+ #
1645
+ # @option params [String] :client_token
1646
+ # A unique, case-sensitive identifier that you provide to ensure the
1647
+ # idempotency of the request. If not provided, the Amazon Web Services
1648
+ # SDK populates this field. For more information about idempotency, see
1649
+ # [Making retries safe with idempotent APIs][1].
1650
+ #
1651
+ # **A suitable default value is auto-generated.** You should normally
1652
+ # not need to pass this option.**
1653
+ #
1654
+ #
1655
+ #
1656
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1657
+ #
1658
+ # @option params [Hash<String,String>] :tags
1659
+ # The tags used to organize, track, or control access for this resource.
1660
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1661
+ # "key2":"value2"\\} \\}.
1662
+ #
1663
+ # @return [Types::CreateTrafficDistributionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1664
+ #
1665
+ # * {Types::CreateTrafficDistributionGroupResponse#id #id} => String
1666
+ # * {Types::CreateTrafficDistributionGroupResponse#arn #arn} => String
1667
+ #
1668
+ # @example Request syntax with placeholder values
1669
+ #
1670
+ # resp = client.create_traffic_distribution_group({
1671
+ # name: "Name128", # required
1672
+ # description: "Description250",
1673
+ # instance_id: "InstanceIdOrArn", # required
1674
+ # client_token: "ClientToken",
1675
+ # tags: {
1676
+ # "TagKey" => "TagValue",
1677
+ # },
1678
+ # })
1679
+ #
1680
+ # @example Response structure
1681
+ #
1682
+ # resp.id #=> String
1683
+ # resp.arn #=> String
1684
+ #
1685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTrafficDistributionGroup AWS API Documentation
1686
+ #
1687
+ # @overload create_traffic_distribution_group(params = {})
1688
+ # @param [Hash] params ({})
1689
+ def create_traffic_distribution_group(params = {}, options = {})
1690
+ req = build_request(:create_traffic_distribution_group, params)
1691
+ req.send_request(options)
1692
+ end
1693
+
1568
1694
  # Creates a use case for an integration association.
1569
1695
  #
1570
1696
  # @option params [required, String] :instance_id
@@ -1685,6 +1811,8 @@ module Aws::Connect
1685
1811
  # first_name: "AgentFirstName",
1686
1812
  # last_name: "AgentLastName",
1687
1813
  # email: "Email",
1814
+ # secondary_email: "Email",
1815
+ # mobile: "PhoneNumber",
1688
1816
  # },
1689
1817
  # phone_config: { # required
1690
1818
  # phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
@@ -1773,13 +1901,19 @@ module Aws::Connect
1773
1901
  #
1774
1902
  # @option params [String] :client_token
1775
1903
  # A unique, case-sensitive identifier that you provide to ensure the
1776
- # idempotency of the request. If a create request is received more than
1777
- # once with same client token, subsequent requests return the previous
1778
- # response without creating a vocabulary again.
1904
+ # idempotency of the request. If not provided, the Amazon Web Services
1905
+ # SDK populates this field. For more information about idempotency, see
1906
+ # [Making retries safe with idempotent APIs][1]. If a create request is
1907
+ # received more than once with same client token, subsequent requests
1908
+ # return the previous response without creating a vocabulary again.
1779
1909
  #
1780
1910
  # **A suitable default value is auto-generated.** You should normally
1781
1911
  # not need to pass this option.**
1782
1912
  #
1913
+ #
1914
+ #
1915
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1916
+ #
1783
1917
  # @option params [required, String] :instance_id
1784
1918
  # The identifier of the Amazon Connect instance. You can find the
1785
1919
  # instanceId in the ARN of the instance.
@@ -2076,6 +2210,40 @@ module Aws::Connect
2076
2210
  req.send_request(options)
2077
2211
  end
2078
2212
 
2213
+ # Deletes a traffic distribution group. This API can be called only in
2214
+ # the Region where the traffic distribution group is created.
2215
+ #
2216
+ # For more information about deleting traffic distribution groups, see
2217
+ # [Delete traffic distribution groups][1] in the *Amazon Connect
2218
+ # Administrator Guide*.
2219
+ #
2220
+ #
2221
+ #
2222
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html
2223
+ #
2224
+ # @option params [required, String] :traffic_distribution_group_id
2225
+ # The identifier of the traffic distribution group. This can be the ID
2226
+ # or the ARN if the API is being called in the Region where the traffic
2227
+ # distribution group was created. The ARN must be provided if the call
2228
+ # is from the replicated Region.
2229
+ #
2230
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2231
+ #
2232
+ # @example Request syntax with placeholder values
2233
+ #
2234
+ # resp = client.delete_traffic_distribution_group({
2235
+ # traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
2236
+ # })
2237
+ #
2238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTrafficDistributionGroup AWS API Documentation
2239
+ #
2240
+ # @overload delete_traffic_distribution_group(params = {})
2241
+ # @param [Hash] params ({})
2242
+ def delete_traffic_distribution_group(params = {}, options = {})
2243
+ req = build_request(:delete_traffic_distribution_group, params)
2244
+ req.send_request(options)
2245
+ end
2246
+
2079
2247
  # Deletes a use case from an integration association.
2080
2248
  #
2081
2249
  # @option params [required, String] :instance_id
@@ -2582,7 +2750,17 @@ module Aws::Connect
2582
2750
  end
2583
2751
 
2584
2752
  # Gets details and status of a phone number that’s claimed to your
2585
- # Amazon Connect instance
2753
+ # Amazon Connect instance or traffic distribution group.
2754
+ #
2755
+ # If the number is claimed to a traffic distribution group, and you are
2756
+ # calling in the Amazon Web Services Region where the traffic
2757
+ # distribution group was created, you can use either a phone number ARN
2758
+ # or UUID value for the `PhoneNumberId` URI request parameter. However,
2759
+ # if the number is claimed to a traffic distribution group and you are
2760
+ # calling this API in the alternate Amazon Web Services Region
2761
+ # associated with the traffic distribution group, you must provide a
2762
+ # full phone number ARN. If a UUID is provided in this scenario, you
2763
+ # will receive a `ResourceNotFoundException`.
2586
2764
  #
2587
2765
  # @option params [required, String] :phone_number_id
2588
2766
  # A unique identifier for the phone number.
@@ -2798,6 +2976,44 @@ module Aws::Connect
2798
2976
  req.send_request(options)
2799
2977
  end
2800
2978
 
2979
+ # Gets details and status of a traffic distribution group.
2980
+ #
2981
+ # @option params [required, String] :traffic_distribution_group_id
2982
+ # The identifier of the traffic distribution group. This can be the ID
2983
+ # or the ARN if the API is being called in the Region where the traffic
2984
+ # distribution group was created. The ARN must be provided if the call
2985
+ # is from the replicated Region.
2986
+ #
2987
+ # @return [Types::DescribeTrafficDistributionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2988
+ #
2989
+ # * {Types::DescribeTrafficDistributionGroupResponse#traffic_distribution_group #traffic_distribution_group} => Types::TrafficDistributionGroup
2990
+ #
2991
+ # @example Request syntax with placeholder values
2992
+ #
2993
+ # resp = client.describe_traffic_distribution_group({
2994
+ # traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
2995
+ # })
2996
+ #
2997
+ # @example Response structure
2998
+ #
2999
+ # resp.traffic_distribution_group.id #=> String
3000
+ # resp.traffic_distribution_group.arn #=> String
3001
+ # resp.traffic_distribution_group.name #=> String
3002
+ # resp.traffic_distribution_group.description #=> String
3003
+ # resp.traffic_distribution_group.instance_arn #=> String
3004
+ # resp.traffic_distribution_group.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
3005
+ # resp.traffic_distribution_group.tags #=> Hash
3006
+ # resp.traffic_distribution_group.tags["TagKey"] #=> String
3007
+ #
3008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTrafficDistributionGroup AWS API Documentation
3009
+ #
3010
+ # @overload describe_traffic_distribution_group(params = {})
3011
+ # @param [Hash] params ({})
3012
+ def describe_traffic_distribution_group(params = {}, options = {})
3013
+ req = build_request(:describe_traffic_distribution_group, params)
3014
+ req.send_request(options)
3015
+ end
3016
+
2801
3017
  # Describes the specified user account. You can find the instance ID in
2802
3018
  # the console (it’s the final part of the ARN). The console does not
2803
3019
  # display the user IDs. Instead, list the users and note the IDs
@@ -2829,6 +3045,8 @@ module Aws::Connect
2829
3045
  # resp.user.identity_info.first_name #=> String
2830
3046
  # resp.user.identity_info.last_name #=> String
2831
3047
  # resp.user.identity_info.email #=> String
3048
+ # resp.user.identity_info.secondary_email #=> String
3049
+ # resp.user.identity_info.mobile #=> String
2832
3050
  # resp.user.phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
2833
3051
  # resp.user.phone_config.auto_accept #=> Boolean
2834
3052
  # resp.user.phone_config.after_contact_work_time_limit #=> Integer
@@ -3141,7 +3359,8 @@ module Aws::Connect
3141
3359
  # The name of the Amazon Lex bot. Maximum character limit of 50.
3142
3360
  #
3143
3361
  # @option params [required, String] :lex_region
3144
- # The Region in which the Amazon Lex bot has been created.
3362
+ # The Amazon Web Services Region in which the Amazon Lex bot has been
3363
+ # created.
3145
3364
  #
3146
3365
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3147
3366
  #
@@ -3163,7 +3382,18 @@ module Aws::Connect
3163
3382
  end
3164
3383
 
3165
3384
  # Removes the flow association from a phone number claimed to your
3166
- # Amazon Connect instance, if a flow association exists.
3385
+ # Amazon Connect instance.
3386
+ #
3387
+ # If the number is claimed to a traffic distribution group, and you are
3388
+ # calling this API using an instance in the Amazon Web Services Region
3389
+ # where the traffic distribution group was created, you can use either a
3390
+ # full phone number ARN or UUID value for the `PhoneNumberId` URI
3391
+ # request parameter. However, if the number is claimed to a traffic
3392
+ # distribution group and you are calling this API using an instance in
3393
+ # the alternate Amazon Web Services Region associated with the traffic
3394
+ # distribution group, you must provide a full phone number ARN. If a
3395
+ # UUID is provided in this scenario, you will receive a
3396
+ # `ResourceNotFoundException`.
3167
3397
  #
3168
3398
  # @option params [required, String] :phone_number_id
3169
3399
  # A unique identifier for the phone number.
@@ -4020,6 +4250,41 @@ module Aws::Connect
4020
4250
  req.send_request(options)
4021
4251
  end
4022
4252
 
4253
+ # Retrieves the current traffic distribution for a given traffic
4254
+ # distribution group.
4255
+ #
4256
+ # @option params [required, String] :id
4257
+ # The identifier of the traffic distribution group.
4258
+ #
4259
+ # @return [Types::GetTrafficDistributionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4260
+ #
4261
+ # * {Types::GetTrafficDistributionResponse#telephony_config #telephony_config} => Types::TelephonyConfig
4262
+ # * {Types::GetTrafficDistributionResponse#id #id} => String
4263
+ # * {Types::GetTrafficDistributionResponse#arn #arn} => String
4264
+ #
4265
+ # @example Request syntax with placeholder values
4266
+ #
4267
+ # resp = client.get_traffic_distribution({
4268
+ # id: "TrafficDistributionGroupIdOrArn", # required
4269
+ # })
4270
+ #
4271
+ # @example Response structure
4272
+ #
4273
+ # resp.telephony_config.distributions #=> Array
4274
+ # resp.telephony_config.distributions[0].region #=> String
4275
+ # resp.telephony_config.distributions[0].percentage #=> Integer
4276
+ # resp.id #=> String
4277
+ # resp.arn #=> String
4278
+ #
4279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTrafficDistribution AWS API Documentation
4280
+ #
4281
+ # @overload get_traffic_distribution(params = {})
4282
+ # @param [Hash] params ({})
4283
+ def get_traffic_distribution(params = {}, options = {})
4284
+ req = build_request(:get_traffic_distribution, params)
4285
+ req.send_request(options)
4286
+ end
4287
+
4023
4288
  # This API is in preview release for Amazon Connect and is subject to
4024
4289
  # change.
4025
4290
  #
@@ -4805,9 +5070,17 @@ module Aws::Connect
4805
5070
  # for Your Contact Center][1] in the *Amazon Connect Administrator
4806
5071
  # Guide*.
4807
5072
  #
5073
+ # The phone number `Arn` value that is returned from each of the items
5074
+ # in the [PhoneNumberSummaryList][2] cannot be used to tag phone number
5075
+ # resources. It will fail with a `ResourceNotFoundException`. Instead,
5076
+ # use the [ListPhoneNumbersV2][3] API. It returns the new phone number
5077
+ # ARN that can be used to tag phone number resources.
5078
+ #
4808
5079
  #
4809
5080
  #
4810
5081
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
5082
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList
5083
+ # [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html
4811
5084
  #
4812
5085
  # @option params [required, String] :instance_id
4813
5086
  # The identifier of the Amazon Connect instance. You can find the
@@ -4864,7 +5137,10 @@ module Aws::Connect
4864
5137
  req.send_request(options)
4865
5138
  end
4866
5139
 
4867
- # Lists phone numbers claimed to your Amazon Connect instance.
5140
+ # Lists phone numbers claimed to your Amazon Connect instance or traffic
5141
+ # distribution group. If the provided `TargetArn` is a traffic
5142
+ # distribution group, you can call this API in both Amazon Web Services
5143
+ # Regions associated with traffic distribution group.
4868
5144
  #
4869
5145
  # For more information about phone numbers, see [Set Up Phone Numbers
4870
5146
  # for Your Contact Center][1] in the *Amazon Connect Administrator
@@ -4875,10 +5151,11 @@ module Aws::Connect
4875
5151
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
4876
5152
  #
4877
5153
  # @option params [String] :target_arn
4878
- # The Amazon Resource Name (ARN) for Amazon Connect instances that phone
4879
- # numbers are claimed to. If `TargetArn` input is not provided, this API
4880
- # lists numbers claimed to all the Amazon Connect instances belonging to
4881
- # your account.
5154
+ # The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
5155
+ # distribution groups that phone numbers are claimed to. If `TargetArn`
5156
+ # input is not provided, this API lists numbers claimed to all the
5157
+ # Amazon Connect instances belonging to your account in the same Amazon
5158
+ # Web Services Region as the request.
4882
5159
  #
4883
5160
  # @option params [Integer] :max_results
4884
5161
  # The maximum number of results to return per page.
@@ -5528,6 +5805,54 @@ module Aws::Connect
5528
5805
  req.send_request(options)
5529
5806
  end
5530
5807
 
5808
+ # Lists traffic distribution groups.
5809
+ #
5810
+ # @option params [Integer] :max_results
5811
+ # The maximum number of results to return per page.
5812
+ #
5813
+ # @option params [String] :next_token
5814
+ # The token for the next set of results. Use the value returned in the
5815
+ # previous response in the next request to retrieve the next set of
5816
+ # results.
5817
+ #
5818
+ # @option params [String] :instance_id
5819
+ # The identifier of the Amazon Connect instance. You can find the
5820
+ # instanceId in the ARN of the instance.
5821
+ #
5822
+ # @return [Types::ListTrafficDistributionGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5823
+ #
5824
+ # * {Types::ListTrafficDistributionGroupsResponse#next_token #next_token} => String
5825
+ # * {Types::ListTrafficDistributionGroupsResponse#traffic_distribution_group_summary_list #traffic_distribution_group_summary_list} => Array&lt;Types::TrafficDistributionGroupSummary&gt;
5826
+ #
5827
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5828
+ #
5829
+ # @example Request syntax with placeholder values
5830
+ #
5831
+ # resp = client.list_traffic_distribution_groups({
5832
+ # max_results: 1,
5833
+ # next_token: "NextToken",
5834
+ # instance_id: "InstanceIdOrArn",
5835
+ # })
5836
+ #
5837
+ # @example Response structure
5838
+ #
5839
+ # resp.next_token #=> String
5840
+ # resp.traffic_distribution_group_summary_list #=> Array
5841
+ # resp.traffic_distribution_group_summary_list[0].id #=> String
5842
+ # resp.traffic_distribution_group_summary_list[0].arn #=> String
5843
+ # resp.traffic_distribution_group_summary_list[0].name #=> String
5844
+ # resp.traffic_distribution_group_summary_list[0].instance_arn #=> String
5845
+ # resp.traffic_distribution_group_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
5846
+ #
5847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroups AWS API Documentation
5848
+ #
5849
+ # @overload list_traffic_distribution_groups(params = {})
5850
+ # @param [Hash] params ({})
5851
+ def list_traffic_distribution_groups(params = {}, options = {})
5852
+ req = build_request(:list_traffic_distribution_groups, params)
5853
+ req.send_request(options)
5854
+ end
5855
+
5531
5856
  # Lists the use cases for the integration association.
5532
5857
  #
5533
5858
  # @option params [required, String] :instance_id
@@ -5723,18 +6048,33 @@ module Aws::Connect
5723
6048
  end
5724
6049
 
5725
6050
  # Releases a phone number previously claimed to an Amazon Connect
5726
- # instance.
6051
+ # instance or traffic distribution group. You can call this API only in
6052
+ # the Amazon Web Services Region where the number was claimed.
6053
+ #
6054
+ # To release phone numbers from a traffic distribution group, use the
6055
+ # `ReleasePhoneNumber` API, not the Amazon Connect console.
6056
+ #
6057
+ # After releasing a phone number, the phone number enters into a
6058
+ # cooldown period of 30 days. It cannot be searched for or claimed again
6059
+ # until the period has ended. If you accidentally release a phone
6060
+ # number, contact Amazon Web Services Support.
5727
6061
  #
5728
6062
  # @option params [required, String] :phone_number_id
5729
6063
  # A unique identifier for the phone number.
5730
6064
  #
5731
6065
  # @option params [String] :client_token
5732
6066
  # A unique, case-sensitive identifier that you provide to ensure the
5733
- # idempotency of the request.
6067
+ # idempotency of the request. If not provided, the Amazon Web Services
6068
+ # SDK populates this field. For more information about idempotency, see
6069
+ # [Making retries safe with idempotent APIs][1].
5734
6070
  #
5735
6071
  # **A suitable default value is auto-generated.** You should normally
5736
6072
  # not need to pass this option.**
5737
6073
  #
6074
+ #
6075
+ #
6076
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
6077
+ #
5738
6078
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5739
6079
  #
5740
6080
  # @example Request syntax with placeholder values
@@ -5753,6 +6093,70 @@ module Aws::Connect
5753
6093
  req.send_request(options)
5754
6094
  end
5755
6095
 
6096
+ # Replicates an Amazon Connect instance in the specified Amazon Web
6097
+ # Services Region.
6098
+ #
6099
+ # For more information about replicating an Amazon Connect instance, see
6100
+ # [Create a replica of your existing Amazon Connect instance][1] in the
6101
+ # *Amazon Connect Administrator Guide*.
6102
+ #
6103
+ #
6104
+ #
6105
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html
6106
+ #
6107
+ # @option params [required, String] :instance_id
6108
+ # The identifier of the Amazon Connect instance. You can find the
6109
+ # instanceId in the ARN of the instance.
6110
+ #
6111
+ # @option params [required, String] :replica_region
6112
+ # The Amazon Web Services Region where to replicate the Amazon Connect
6113
+ # instance.
6114
+ #
6115
+ # @option params [String] :client_token
6116
+ # A unique, case-sensitive identifier that you provide to ensure the
6117
+ # idempotency of the request. If not provided, the Amazon Web Services
6118
+ # SDK populates this field. For more information about idempotency, see
6119
+ # [Making retries safe with idempotent APIs][1].
6120
+ #
6121
+ # **A suitable default value is auto-generated.** You should normally
6122
+ # not need to pass this option.**
6123
+ #
6124
+ #
6125
+ #
6126
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
6127
+ #
6128
+ # @option params [required, String] :replica_alias
6129
+ # The alias for the replicated instance. The `ReplicaAlias` must be
6130
+ # unique.
6131
+ #
6132
+ # @return [Types::ReplicateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6133
+ #
6134
+ # * {Types::ReplicateInstanceResponse#id #id} => String
6135
+ # * {Types::ReplicateInstanceResponse#arn #arn} => String
6136
+ #
6137
+ # @example Request syntax with placeholder values
6138
+ #
6139
+ # resp = client.replicate_instance({
6140
+ # instance_id: "InstanceIdOrArn", # required
6141
+ # replica_region: "AwsRegion", # required
6142
+ # client_token: "ClientToken",
6143
+ # replica_alias: "DirectoryAlias", # required
6144
+ # })
6145
+ #
6146
+ # @example Response structure
6147
+ #
6148
+ # resp.id #=> String
6149
+ # resp.arn #=> String
6150
+ #
6151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicateInstance AWS API Documentation
6152
+ #
6153
+ # @overload replicate_instance(params = {})
6154
+ # @param [Hash] params ({})
6155
+ def replicate_instance(params = {}, options = {})
6156
+ req = build_request(:replicate_instance, params)
6157
+ req.send_request(options)
6158
+ end
6159
+
5756
6160
  # When a contact is being recorded, and the recording has been suspended
5757
6161
  # using SuspendContactRecording, this API resumes recording the call.
5758
6162
  #
@@ -5789,11 +6193,14 @@ module Aws::Connect
5789
6193
  end
5790
6194
 
5791
6195
  # Searches for available phone numbers that you can claim to your Amazon
5792
- # Connect instance.
6196
+ # Connect instance or traffic distribution group. If the provided
6197
+ # `TargetArn` is a traffic distribution group, you can call this API in
6198
+ # both Amazon Web Services Regions associated with the traffic
6199
+ # distribution group.
5793
6200
  #
5794
6201
  # @option params [required, String] :target_arn
5795
- # The Amazon Resource Name (ARN) for Amazon Connect instances that phone
5796
- # numbers are claimed to.
6202
+ # The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
6203
+ # distribution groups that phone numbers are claimed to.
5797
6204
  #
5798
6205
  # @option params [required, String] :phone_number_country_code
5799
6206
  # The ISO country code.
@@ -6083,6 +6490,10 @@ module Aws::Connect
6083
6490
  # @option params [Types::SecurityProfileSearchCriteria] :search_criteria
6084
6491
  # The search criteria to be used to return security profiles.
6085
6492
  #
6493
+ # <note markdown="1"> The currently supported value for `FieldName`\: `name`
6494
+ #
6495
+ # </note>
6496
+ #
6086
6497
  # @option params [Types::SecurityProfilesSearchFilter] :search_filter
6087
6498
  # Filters to be applied to search results.
6088
6499
  #
@@ -6165,6 +6576,10 @@ module Aws::Connect
6165
6576
 
6166
6577
  # Searches users in an Amazon Connect instance, with optional filtering.
6167
6578
  #
6579
+ # <note markdown="1"> `AfterContactWorkTimeLimit` is returned in milliseconds.
6580
+ #
6581
+ # </note>
6582
+ #
6168
6583
  # @option params [String] :instance_id
6169
6584
  # The identifier of the Amazon Connect instance. You can find the
6170
6585
  # instanceId in the ARN of the instance.
@@ -6413,11 +6828,17 @@ module Aws::Connect
6413
6828
  #
6414
6829
  # @option params [String] :client_token
6415
6830
  # A unique, case-sensitive identifier that you provide to ensure the
6416
- # idempotency of the request.
6831
+ # idempotency of the request. If not provided, the Amazon Web Services
6832
+ # SDK populates this field. For more information about idempotency, see
6833
+ # [Making retries safe with idempotent APIs][1].
6417
6834
  #
6418
6835
  # **A suitable default value is auto-generated.** You should normally
6419
6836
  # not need to pass this option.**
6420
6837
  #
6838
+ #
6839
+ #
6840
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
6841
+ #
6421
6842
  # @option params [Integer] :chat_duration_in_minutes
6422
6843
  # The total duration of the newly started chat session. If not
6423
6844
  # specified, the chat session duration defaults to 25 hour. The minumum
@@ -6553,11 +6974,17 @@ module Aws::Connect
6553
6974
  #
6554
6975
  # @option params [required, String] :client_token
6555
6976
  # A unique, case-sensitive identifier that you provide to ensure the
6556
- # idempotency of the request.
6977
+ # idempotency of the request. If not provided, the Amazon Web Services
6978
+ # SDK populates this field. For more information about idempotency, see
6979
+ # [Making retries safe with idempotent APIs][1].
6557
6980
  #
6558
6981
  # **A suitable default value is auto-generated.** You should normally
6559
6982
  # not need to pass this option.**
6560
6983
  #
6984
+ #
6985
+ #
6986
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
6987
+ #
6561
6988
  # @return [Types::StartContactStreamingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6562
6989
  #
6563
6990
  # * {Types::StartContactStreamingResponse#streaming_id #streaming_id} => String
@@ -6635,12 +7062,19 @@ module Aws::Connect
6635
7062
  #
6636
7063
  # @option params [String] :client_token
6637
7064
  # A unique, case-sensitive identifier that you provide to ensure the
6638
- # idempotency of the request. The token is valid for 7 days after
6639
- # creation. If a contact is already started, the contact ID is returned.
7065
+ # idempotency of the request. If not provided, the Amazon Web Services
7066
+ # SDK populates this field. For more information about idempotency, see
7067
+ # [Making retries safe with idempotent APIs][1]. The token is valid for
7068
+ # 7 days after creation. If a contact is already started, the contact ID
7069
+ # is returned.
6640
7070
  #
6641
7071
  # **A suitable default value is auto-generated.** You should normally
6642
7072
  # not need to pass this option.**
6643
7073
  #
7074
+ #
7075
+ #
7076
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
7077
+ #
6644
7078
  # @option params [String] :source_phone_number
6645
7079
  # The phone number associated with the Amazon Connect instance, in E.164
6646
7080
  # format. If you do not specify a source phone number, you must specify
@@ -6753,11 +7187,17 @@ module Aws::Connect
6753
7187
  #
6754
7188
  # @option params [String] :client_token
6755
7189
  # A unique, case-sensitive identifier that you provide to ensure the
6756
- # idempotency of the request.
7190
+ # idempotency of the request. If not provided, the Amazon Web Services
7191
+ # SDK populates this field. For more information about idempotency, see
7192
+ # [Making retries safe with idempotent APIs][1].
6757
7193
  #
6758
7194
  # **A suitable default value is auto-generated.** You should normally
6759
7195
  # not need to pass this option.**
6760
7196
  #
7197
+ #
7198
+ #
7199
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
7200
+ #
6761
7201
  # @option params [Time,DateTime,Date,Integer,String] :scheduled_time
6762
7202
  # The timestamp, in Unix Epoch seconds format, at which to start running
6763
7203
  # the inbound flow. The scheduled time cannot be in the past. It must be
@@ -7041,11 +7481,17 @@ module Aws::Connect
7041
7481
  #
7042
7482
  # @option params [String] :client_token
7043
7483
  # A unique, case-sensitive identifier that you provide to ensure the
7044
- # idempotency of the request.
7484
+ # idempotency of the request. If not provided, the Amazon Web Services
7485
+ # SDK populates this field. For more information about idempotency, see
7486
+ # [Making retries safe with idempotent APIs][1].
7045
7487
  #
7046
7488
  # **A suitable default value is auto-generated.** You should normally
7047
7489
  # not need to pass this option.**
7048
7490
  #
7491
+ #
7492
+ #
7493
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
7494
+ #
7049
7495
  # @return [Types::TransferContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7050
7496
  #
7051
7497
  # * {Types::TransferContactResponse#contact_id #contact_id} => String
@@ -7658,22 +8104,38 @@ module Aws::Connect
7658
8104
  end
7659
8105
 
7660
8106
  # Updates your claimed phone number from its current Amazon Connect
7661
- # instance to another Amazon Connect instance in the same Region.
8107
+ # instance or traffic distribution group to another Amazon Connect
8108
+ # instance or traffic distribution group in the same Amazon Web Services
8109
+ # Region.
8110
+ #
8111
+ # You can call [DescribePhoneNumber][1] API to verify the status of a
8112
+ # previous [UpdatePhoneNumber][2] operation.
8113
+ #
8114
+ #
8115
+ #
8116
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
8117
+ # [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
7662
8118
  #
7663
8119
  # @option params [required, String] :phone_number_id
7664
8120
  # A unique identifier for the phone number.
7665
8121
  #
7666
8122
  # @option params [required, String] :target_arn
7667
- # The Amazon Resource Name (ARN) for Amazon Connect instances that phone
7668
- # numbers are claimed to.
8123
+ # The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
8124
+ # distribution groups that phone numbers are claimed to.
7669
8125
  #
7670
8126
  # @option params [String] :client_token
7671
8127
  # A unique, case-sensitive identifier that you provide to ensure the
7672
- # idempotency of the request.
8128
+ # idempotency of the request. If not provided, the Amazon Web Services
8129
+ # SDK populates this field. For more information about idempotency, see
8130
+ # [Making retries safe with idempotent APIs][1].
7673
8131
  #
7674
8132
  # **A suitable default value is auto-generated.** You should normally
7675
8133
  # not need to pass this option.**
7676
8134
  #
8135
+ #
8136
+ #
8137
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
8138
+ #
7677
8139
  # @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7678
8140
  #
7679
8141
  # * {Types::UpdatePhoneNumberResponse#phone_number_id #phone_number_id} => String
@@ -7816,6 +8278,22 @@ module Aws::Connect
7816
8278
  # Updates the outbound caller ID name, number, and outbound whisper flow
7817
8279
  # for a specified queue.
7818
8280
  #
8281
+ # If the number being used in the input is claimed to a traffic
8282
+ # distribution group, and you are calling this API using an instance in
8283
+ # the Amazon Web Services Region where the traffic distribution group
8284
+ # was created, you can use either a full phone number ARN or UUID value
8285
+ # for the `OutboundCallerIdNumberId` value of the
8286
+ # [OutboundCallerConfig][1] request body parameter. However, if the
8287
+ # number is claimed to a traffic distribution group and you are calling
8288
+ # this API using an instance in the alternate Amazon Web Services Region
8289
+ # associated with the traffic distribution group, you must provide a
8290
+ # full phone number ARN. If a UUID is provided in this scenario, you
8291
+ # will receive a `ResourceNotFoundException`.
8292
+ #
8293
+ #
8294
+ #
8295
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_OutboundCallerConfig
8296
+ #
7819
8297
  # @option params [required, String] :instance_id
7820
8298
  # The identifier of the Amazon Connect instance. You can find the
7821
8299
  # instanceId in the ARN of the instance.
@@ -8299,6 +8777,49 @@ module Aws::Connect
8299
8777
  req.send_request(options)
8300
8778
  end
8301
8779
 
8780
+ # Updates the traffic distribution for a given traffic distribution
8781
+ # group. For more information about updating a traffic distribution
8782
+ # group see [Update telephony traffic distribution across Amazon Web
8783
+ # Services Regions ][1] in the *Amazon Connect Administrator Guide*.
8784
+ #
8785
+ #
8786
+ #
8787
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html
8788
+ #
8789
+ # @option params [required, String] :id
8790
+ # The identifier of the traffic distribution group. This can be the ID
8791
+ # or the ARN if the API is being called in the Region where the traffic
8792
+ # distribution group was created. The ARN must be provided if the call
8793
+ # is from the replicated Region.
8794
+ #
8795
+ # @option params [Types::TelephonyConfig] :telephony_config
8796
+ # The distribution of traffic between the instance and its replica(s).
8797
+ #
8798
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
8799
+ #
8800
+ # @example Request syntax with placeholder values
8801
+ #
8802
+ # resp = client.update_traffic_distribution({
8803
+ # id: "TrafficDistributionGroupIdOrArn", # required
8804
+ # telephony_config: {
8805
+ # distributions: [ # required
8806
+ # {
8807
+ # region: "AwsRegion", # required
8808
+ # percentage: 1, # required
8809
+ # },
8810
+ # ],
8811
+ # },
8812
+ # })
8813
+ #
8814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTrafficDistribution AWS API Documentation
8815
+ #
8816
+ # @overload update_traffic_distribution(params = {})
8817
+ # @param [Hash] params ({})
8818
+ def update_traffic_distribution(params = {}, options = {})
8819
+ req = build_request(:update_traffic_distribution, params)
8820
+ req.send_request(options)
8821
+ end
8822
+
8302
8823
  # Assigns the specified hierarchy group to the specified user.
8303
8824
  #
8304
8825
  # @option params [String] :hierarchy_group_id
@@ -8438,6 +8959,8 @@ module Aws::Connect
8438
8959
  # first_name: "AgentFirstName",
8439
8960
  # last_name: "AgentLastName",
8440
8961
  # email: "Email",
8962
+ # secondary_email: "Email",
8963
+ # mobile: "PhoneNumber",
8441
8964
  # },
8442
8965
  # user_id: "UserId", # required
8443
8966
  # instance_id: "InstanceId", # required
@@ -8563,7 +9086,7 @@ module Aws::Connect
8563
9086
  params: params,
8564
9087
  config: config)
8565
9088
  context[:gem_name] = 'aws-sdk-connect'
8566
- context[:gem_version] = '1.77.0'
9089
+ context[:gem_version] = '1.79.0'
8567
9090
  Seahorse::Client::Request.new(handlers, context)
8568
9091
  end
8569
9092