aws-sdk-connect 1.77.0 → 1.79.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 +556 -33
- data/lib/aws-sdk-connect/client_api.rb +221 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/types.rb +770 -52
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -733,8 +733,8 @@ module Aws::Connect
|
|
733
733
|
# }
|
734
734
|
#
|
735
735
|
# @!attribute [rw] target_arn
|
736
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
737
|
-
# phone numbers are claimed to.
|
736
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
737
|
+
# traffic distribution groups that phone numbers are claimed to.
|
738
738
|
# @return [String]
|
739
739
|
#
|
740
740
|
# @!attribute [rw] phone_number
|
@@ -754,10 +754,16 @@ module Aws::Connect
|
|
754
754
|
#
|
755
755
|
# @!attribute [rw] client_token
|
756
756
|
# A unique, case-sensitive identifier that you provide to ensure the
|
757
|
-
# idempotency of the request.
|
757
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
758
|
+
# SDK populates this field. For more information about idempotency,
|
759
|
+
# see [Making retries safe with idempotent APIs][1].
|
758
760
|
#
|
759
761
|
# **A suitable default value is auto-generated.** You should normally
|
760
762
|
# not need to pass this option.
|
763
|
+
#
|
764
|
+
#
|
765
|
+
#
|
766
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
761
767
|
# @return [String]
|
762
768
|
#
|
763
769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimPhoneNumberRequest AWS API Documentation
|
@@ -790,7 +796,7 @@ module Aws::Connect
|
|
790
796
|
end
|
791
797
|
|
792
798
|
# Information about a phone number that has been claimed to your Amazon
|
793
|
-
# Connect instance.
|
799
|
+
# Connect instance or traffic distribution group.
|
794
800
|
#
|
795
801
|
# @!attribute [rw] phone_number_id
|
796
802
|
# A unique identifier for the phone number.
|
@@ -818,8 +824,8 @@ module Aws::Connect
|
|
818
824
|
# @return [String]
|
819
825
|
#
|
820
826
|
# @!attribute [rw] target_arn
|
821
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
822
|
-
# phone numbers are claimed to.
|
827
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
828
|
+
# traffic distribution groups that phone numbers are claimed to.
|
823
829
|
# @return [String]
|
824
830
|
#
|
825
831
|
# @!attribute [rw] tags
|
@@ -830,6 +836,35 @@ module Aws::Connect
|
|
830
836
|
#
|
831
837
|
# @!attribute [rw] phone_number_status
|
832
838
|
# The status of the phone number.
|
839
|
+
#
|
840
|
+
# * `CLAIMED` means the previous [ClaimedPhoneNumber][1] or
|
841
|
+
# [UpdatePhoneNumber][2] operation succeeded.
|
842
|
+
#
|
843
|
+
# * `IN_PROGRESS` means a [ClaimedPhoneNumber][1] or
|
844
|
+
# [UpdatePhoneNumber][2] operation is still in progress and has not
|
845
|
+
# yet completed. You can call [DescribePhoneNumber][3] at a later
|
846
|
+
# time to verify if the previous operation has completed.
|
847
|
+
#
|
848
|
+
# * `FAILED` indicates that the previous [ClaimedPhoneNumber][1] or
|
849
|
+
# [UpdatePhoneNumber][2] operation has failed. It will include a
|
850
|
+
# message indicating the failure reason. A common reason for a
|
851
|
+
# failure may be that the `TargetArn` value you are claiming or
|
852
|
+
# updating a phone number to has reached its limit of total claimed
|
853
|
+
# numbers. If you received a `FAILED` status from a
|
854
|
+
# `ClaimPhoneNumber` API call, you have one day to retry claiming
|
855
|
+
# the phone number before the number is released back to the
|
856
|
+
# inventory for other customers to claim.
|
857
|
+
#
|
858
|
+
# <note markdown="1"> You will not be billed for the phone number during the 1-day period
|
859
|
+
# if number claiming fails.
|
860
|
+
#
|
861
|
+
# </note>
|
862
|
+
#
|
863
|
+
#
|
864
|
+
#
|
865
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html
|
866
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
|
867
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
833
868
|
# @return [Types::PhoneNumberStatus]
|
834
869
|
#
|
835
870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimedPhoneNumberSummary AWS API Documentation
|
@@ -1339,10 +1374,16 @@ module Aws::Connect
|
|
1339
1374
|
#
|
1340
1375
|
# @!attribute [rw] client_token
|
1341
1376
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1342
|
-
# idempotency of the request.
|
1377
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1378
|
+
# SDK populates this field. For more information about idempotency,
|
1379
|
+
# see [Making retries safe with idempotent APIs][1].
|
1343
1380
|
#
|
1344
1381
|
# **A suitable default value is auto-generated.** You should normally
|
1345
1382
|
# not need to pass this option.
|
1383
|
+
#
|
1384
|
+
#
|
1385
|
+
#
|
1386
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1346
1387
|
# @return [String]
|
1347
1388
|
#
|
1348
1389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModuleRequest AWS API Documentation
|
@@ -2111,10 +2152,16 @@ module Aws::Connect
|
|
2111
2152
|
#
|
2112
2153
|
# @!attribute [rw] client_token
|
2113
2154
|
# A unique, case-sensitive identifier that you provide to ensure the
|
2114
|
-
# idempotency of the request.
|
2155
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2156
|
+
# SDK populates this field. For more information about idempotency,
|
2157
|
+
# see [Making retries safe with idempotent APIs][1].
|
2115
2158
|
#
|
2116
2159
|
# **A suitable default value is auto-generated.** You should normally
|
2117
2160
|
# not need to pass this option.
|
2161
|
+
#
|
2162
|
+
#
|
2163
|
+
#
|
2164
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2118
2165
|
# @return [String]
|
2119
2166
|
#
|
2120
2167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateRequest AWS API Documentation
|
@@ -2150,6 +2197,85 @@ module Aws::Connect
|
|
2150
2197
|
include Aws::Structure
|
2151
2198
|
end
|
2152
2199
|
|
2200
|
+
# @note When making an API call, you may pass CreateTrafficDistributionGroupRequest
|
2201
|
+
# data as a hash:
|
2202
|
+
#
|
2203
|
+
# {
|
2204
|
+
# name: "Name128", # required
|
2205
|
+
# description: "Description250",
|
2206
|
+
# instance_id: "InstanceIdOrArn", # required
|
2207
|
+
# client_token: "ClientToken",
|
2208
|
+
# tags: {
|
2209
|
+
# "TagKey" => "TagValue",
|
2210
|
+
# },
|
2211
|
+
# }
|
2212
|
+
#
|
2213
|
+
# @!attribute [rw] name
|
2214
|
+
# The name for the traffic distribution group.
|
2215
|
+
# @return [String]
|
2216
|
+
#
|
2217
|
+
# @!attribute [rw] description
|
2218
|
+
# A description for the traffic distribution group.
|
2219
|
+
# @return [String]
|
2220
|
+
#
|
2221
|
+
# @!attribute [rw] instance_id
|
2222
|
+
# The identifier of the Amazon Connect instance that has been
|
2223
|
+
# replicated. You can find the `instanceId` in the ARN of the
|
2224
|
+
# instance.
|
2225
|
+
# @return [String]
|
2226
|
+
#
|
2227
|
+
# @!attribute [rw] client_token
|
2228
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2229
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2230
|
+
# SDK populates this field. For more information about idempotency,
|
2231
|
+
# see [Making retries safe with idempotent APIs][1].
|
2232
|
+
#
|
2233
|
+
# **A suitable default value is auto-generated.** You should normally
|
2234
|
+
# not need to pass this option.
|
2235
|
+
#
|
2236
|
+
#
|
2237
|
+
#
|
2238
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2239
|
+
# @return [String]
|
2240
|
+
#
|
2241
|
+
# @!attribute [rw] tags
|
2242
|
+
# The tags used to organize, track, or control access for this
|
2243
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
2244
|
+
# "key2":"value2"\\} \\}.
|
2245
|
+
# @return [Hash<String,String>]
|
2246
|
+
#
|
2247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTrafficDistributionGroupRequest AWS API Documentation
|
2248
|
+
#
|
2249
|
+
class CreateTrafficDistributionGroupRequest < Struct.new(
|
2250
|
+
:name,
|
2251
|
+
:description,
|
2252
|
+
:instance_id,
|
2253
|
+
:client_token,
|
2254
|
+
:tags)
|
2255
|
+
SENSITIVE = []
|
2256
|
+
include Aws::Structure
|
2257
|
+
end
|
2258
|
+
|
2259
|
+
# @!attribute [rw] id
|
2260
|
+
# The identifier of the traffic distribution group. This can be the ID
|
2261
|
+
# or the ARN if the API is being called in the Region where the
|
2262
|
+
# traffic distribution group was created. The ARN must be provided if
|
2263
|
+
# the call is from the replicated Region.
|
2264
|
+
# @return [String]
|
2265
|
+
#
|
2266
|
+
# @!attribute [rw] arn
|
2267
|
+
# The Amazon Resource Name (ARN) of the traffic distribution group.
|
2268
|
+
# @return [String]
|
2269
|
+
#
|
2270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTrafficDistributionGroupResponse AWS API Documentation
|
2271
|
+
#
|
2272
|
+
class CreateTrafficDistributionGroupResponse < Struct.new(
|
2273
|
+
:id,
|
2274
|
+
:arn)
|
2275
|
+
SENSITIVE = []
|
2276
|
+
include Aws::Structure
|
2277
|
+
end
|
2278
|
+
|
2153
2279
|
# @note When making an API call, you may pass CreateUseCaseRequest
|
2154
2280
|
# data as a hash:
|
2155
2281
|
#
|
@@ -2282,6 +2408,8 @@ module Aws::Connect
|
|
2282
2408
|
# first_name: "AgentFirstName",
|
2283
2409
|
# last_name: "AgentLastName",
|
2284
2410
|
# email: "Email",
|
2411
|
+
# secondary_email: "Email",
|
2412
|
+
# mobile: "PhoneNumber",
|
2285
2413
|
# },
|
2286
2414
|
# phone_config: { # required
|
2287
2415
|
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
@@ -2408,12 +2536,19 @@ module Aws::Connect
|
|
2408
2536
|
#
|
2409
2537
|
# @!attribute [rw] client_token
|
2410
2538
|
# A unique, case-sensitive identifier that you provide to ensure the
|
2411
|
-
# idempotency of the request. If
|
2412
|
-
#
|
2413
|
-
#
|
2539
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2540
|
+
# SDK populates this field. For more information about idempotency,
|
2541
|
+
# see [Making retries safe with idempotent APIs][1]. If a create
|
2542
|
+
# request is received more than once with same client token,
|
2543
|
+
# subsequent requests return the previous response without creating a
|
2544
|
+
# vocabulary again.
|
2414
2545
|
#
|
2415
2546
|
# **A suitable default value is auto-generated.** You should normally
|
2416
2547
|
# not need to pass this option.
|
2548
|
+
#
|
2549
|
+
#
|
2550
|
+
#
|
2551
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2417
2552
|
# @return [String]
|
2418
2553
|
#
|
2419
2554
|
# @!attribute [rw] instance_id
|
@@ -2858,6 +2993,32 @@ module Aws::Connect
|
|
2858
2993
|
#
|
2859
2994
|
class DeleteTaskTemplateResponse < Aws::EmptyStructure; end
|
2860
2995
|
|
2996
|
+
# @note When making an API call, you may pass DeleteTrafficDistributionGroupRequest
|
2997
|
+
# data as a hash:
|
2998
|
+
#
|
2999
|
+
# {
|
3000
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
3001
|
+
# }
|
3002
|
+
#
|
3003
|
+
# @!attribute [rw] traffic_distribution_group_id
|
3004
|
+
# The identifier of the traffic distribution group. This can be the ID
|
3005
|
+
# or the ARN if the API is being called in the Region where the
|
3006
|
+
# traffic distribution group was created. The ARN must be provided if
|
3007
|
+
# the call is from the replicated Region.
|
3008
|
+
# @return [String]
|
3009
|
+
#
|
3010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTrafficDistributionGroupRequest AWS API Documentation
|
3011
|
+
#
|
3012
|
+
class DeleteTrafficDistributionGroupRequest < Struct.new(
|
3013
|
+
:traffic_distribution_group_id)
|
3014
|
+
SENSITIVE = []
|
3015
|
+
include Aws::Structure
|
3016
|
+
end
|
3017
|
+
|
3018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTrafficDistributionGroupResponse AWS API Documentation
|
3019
|
+
#
|
3020
|
+
class DeleteTrafficDistributionGroupResponse < Aws::EmptyStructure; end
|
3021
|
+
|
2861
3022
|
# @note When making an API call, you may pass DeleteUseCaseRequest
|
2862
3023
|
# data as a hash:
|
2863
3024
|
#
|
@@ -3315,7 +3476,7 @@ module Aws::Connect
|
|
3315
3476
|
|
3316
3477
|
# @!attribute [rw] claimed_phone_number_summary
|
3317
3478
|
# Information about a phone number that's been claimed to your Amazon
|
3318
|
-
# Connect instance.
|
3479
|
+
# Connect instance or traffic distribution group.
|
3319
3480
|
# @return [Types::ClaimedPhoneNumberSummary]
|
3320
3481
|
#
|
3321
3482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumberResponse AWS API Documentation
|
@@ -3478,6 +3639,40 @@ module Aws::Connect
|
|
3478
3639
|
include Aws::Structure
|
3479
3640
|
end
|
3480
3641
|
|
3642
|
+
# @note When making an API call, you may pass DescribeTrafficDistributionGroupRequest
|
3643
|
+
# data as a hash:
|
3644
|
+
#
|
3645
|
+
# {
|
3646
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
3647
|
+
# }
|
3648
|
+
#
|
3649
|
+
# @!attribute [rw] traffic_distribution_group_id
|
3650
|
+
# The identifier of the traffic distribution group. This can be the ID
|
3651
|
+
# or the ARN if the API is being called in the Region where the
|
3652
|
+
# traffic distribution group was created. The ARN must be provided if
|
3653
|
+
# the call is from the replicated Region.
|
3654
|
+
# @return [String]
|
3655
|
+
#
|
3656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTrafficDistributionGroupRequest AWS API Documentation
|
3657
|
+
#
|
3658
|
+
class DescribeTrafficDistributionGroupRequest < Struct.new(
|
3659
|
+
:traffic_distribution_group_id)
|
3660
|
+
SENSITIVE = []
|
3661
|
+
include Aws::Structure
|
3662
|
+
end
|
3663
|
+
|
3664
|
+
# @!attribute [rw] traffic_distribution_group
|
3665
|
+
# Information about the traffic distribution group.
|
3666
|
+
# @return [Types::TrafficDistributionGroup]
|
3667
|
+
#
|
3668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTrafficDistributionGroupResponse AWS API Documentation
|
3669
|
+
#
|
3670
|
+
class DescribeTrafficDistributionGroupResponse < Struct.new(
|
3671
|
+
:traffic_distribution_group)
|
3672
|
+
SENSITIVE = []
|
3673
|
+
include Aws::Structure
|
3674
|
+
end
|
3675
|
+
|
3481
3676
|
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
3482
3677
|
# data as a hash:
|
3483
3678
|
#
|
@@ -3802,7 +3997,8 @@ module Aws::Connect
|
|
3802
3997
|
# @return [String]
|
3803
3998
|
#
|
3804
3999
|
# @!attribute [rw] lex_region
|
3805
|
-
# The Region in which the Amazon Lex bot has been
|
4000
|
+
# The Amazon Web Services Region in which the Amazon Lex bot has been
|
4001
|
+
# created.
|
3806
4002
|
# @return [String]
|
3807
4003
|
#
|
3808
4004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBotRequest AWS API Documentation
|
@@ -3937,6 +4133,34 @@ module Aws::Connect
|
|
3937
4133
|
include Aws::Structure
|
3938
4134
|
end
|
3939
4135
|
|
4136
|
+
# Information about a traffic distribution.
|
4137
|
+
#
|
4138
|
+
# @note When making an API call, you may pass Distribution
|
4139
|
+
# data as a hash:
|
4140
|
+
#
|
4141
|
+
# {
|
4142
|
+
# region: "AwsRegion", # required
|
4143
|
+
# percentage: 1, # required
|
4144
|
+
# }
|
4145
|
+
#
|
4146
|
+
# @!attribute [rw] region
|
4147
|
+
# The Amazon Web Services Region where the traffic is distributed.
|
4148
|
+
# @return [String]
|
4149
|
+
#
|
4150
|
+
# @!attribute [rw] percentage
|
4151
|
+
# The percentage of the traffic that is distributed, in increments of
|
4152
|
+
# 10.
|
4153
|
+
# @return [Integer]
|
4154
|
+
#
|
4155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Distribution AWS API Documentation
|
4156
|
+
#
|
4157
|
+
class Distribution < Struct.new(
|
4158
|
+
:region,
|
4159
|
+
:percentage)
|
4160
|
+
SENSITIVE = []
|
4161
|
+
include Aws::Structure
|
4162
|
+
end
|
4163
|
+
|
3940
4164
|
# A resource with the specified name already exists.
|
3941
4165
|
#
|
3942
4166
|
# @!attribute [rw] message
|
@@ -4788,6 +5012,50 @@ module Aws::Connect
|
|
4788
5012
|
include Aws::Structure
|
4789
5013
|
end
|
4790
5014
|
|
5015
|
+
# @note When making an API call, you may pass GetTrafficDistributionRequest
|
5016
|
+
# data as a hash:
|
5017
|
+
#
|
5018
|
+
# {
|
5019
|
+
# id: "TrafficDistributionGroupIdOrArn", # required
|
5020
|
+
# }
|
5021
|
+
#
|
5022
|
+
# @!attribute [rw] id
|
5023
|
+
# The identifier of the traffic distribution group.
|
5024
|
+
# @return [String]
|
5025
|
+
#
|
5026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTrafficDistributionRequest AWS API Documentation
|
5027
|
+
#
|
5028
|
+
class GetTrafficDistributionRequest < Struct.new(
|
5029
|
+
:id)
|
5030
|
+
SENSITIVE = []
|
5031
|
+
include Aws::Structure
|
5032
|
+
end
|
5033
|
+
|
5034
|
+
# @!attribute [rw] telephony_config
|
5035
|
+
# The distribution of traffic between the instance and its replicas.
|
5036
|
+
# @return [Types::TelephonyConfig]
|
5037
|
+
#
|
5038
|
+
# @!attribute [rw] id
|
5039
|
+
# The identifier of the traffic distribution group. This can be the ID
|
5040
|
+
# or the ARN if the API is being called in the Region where the
|
5041
|
+
# traffic distribution group was created. The ARN must be provided if
|
5042
|
+
# the call is from the replicated Region.
|
5043
|
+
# @return [String]
|
5044
|
+
#
|
5045
|
+
# @!attribute [rw] arn
|
5046
|
+
# The Amazon Resource Name (ARN) of the traffic distribution group.
|
5047
|
+
# @return [String]
|
5048
|
+
#
|
5049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTrafficDistributionResponse AWS API Documentation
|
5050
|
+
#
|
5051
|
+
class GetTrafficDistributionResponse < Struct.new(
|
5052
|
+
:telephony_config,
|
5053
|
+
:id,
|
5054
|
+
:arn)
|
5055
|
+
SENSITIVE = []
|
5056
|
+
include Aws::Structure
|
5057
|
+
end
|
5058
|
+
|
4791
5059
|
# Contains information about a hierarchy group.
|
4792
5060
|
#
|
4793
5061
|
# @!attribute [rw] id
|
@@ -5778,7 +6046,7 @@ module Aws::Connect
|
|
5778
6046
|
# @return [String]
|
5779
6047
|
#
|
5780
6048
|
# @!attribute [rw] lex_region
|
5781
|
-
# The Region
|
6049
|
+
# The Amazon Web Services Region where the Amazon Lex bot was created.
|
5782
6050
|
# @return [String]
|
5783
6051
|
#
|
5784
6052
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LexBot AWS API Documentation
|
@@ -5995,8 +6263,8 @@ module Aws::Connect
|
|
5995
6263
|
end
|
5996
6264
|
|
5997
6265
|
# @!attribute [rw] lex_bots
|
5998
|
-
# The names and Regions of the Amazon Lex or
|
5999
|
-
# associated with the specified instance.
|
6266
|
+
# The names and Amazon Web Services Regions of the Amazon Lex or
|
6267
|
+
# Amazon Lex V2 bots associated with the specified instance.
|
6000
6268
|
# @return [Array<Types::LexBotConfig>]
|
6001
6269
|
#
|
6002
6270
|
# @!attribute [rw] next_token
|
@@ -6611,8 +6879,8 @@ module Aws::Connect
|
|
6611
6879
|
end
|
6612
6880
|
|
6613
6881
|
# @!attribute [rw] lex_bots
|
6614
|
-
# The names and Regions of the Amazon Lex bots
|
6615
|
-
# specified instance.
|
6882
|
+
# The names and Amazon Web Services Regions of the Amazon Lex bots
|
6883
|
+
# associated with the specified instance.
|
6616
6884
|
# @return [Array<Types::LexBot>]
|
6617
6885
|
#
|
6618
6886
|
# @!attribute [rw] next_token
|
@@ -6695,7 +6963,7 @@ module Aws::Connect
|
|
6695
6963
|
end
|
6696
6964
|
|
6697
6965
|
# Information about phone numbers that have been claimed to your Amazon
|
6698
|
-
# Connect instance.
|
6966
|
+
# Connect instance or traffic distribution group.
|
6699
6967
|
#
|
6700
6968
|
# @!attribute [rw] phone_number_id
|
6701
6969
|
# A unique identifier for the phone number.
|
@@ -6719,8 +6987,8 @@ module Aws::Connect
|
|
6719
6987
|
# @return [String]
|
6720
6988
|
#
|
6721
6989
|
# @!attribute [rw] target_arn
|
6722
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
6723
|
-
# phone numbers are claimed to.
|
6990
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
6991
|
+
# traffic distribution groups that phone numbers are claimed to.
|
6724
6992
|
# @return [String]
|
6725
6993
|
#
|
6726
6994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersSummary AWS API Documentation
|
@@ -6749,10 +7017,11 @@ module Aws::Connect
|
|
6749
7017
|
# }
|
6750
7018
|
#
|
6751
7019
|
# @!attribute [rw] target_arn
|
6752
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
6753
|
-
# phone numbers are claimed to. If
|
6754
|
-
# this API lists numbers claimed to
|
6755
|
-
# belonging to your account
|
7020
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
7021
|
+
# traffic distribution groups that phone numbers are claimed to. If
|
7022
|
+
# `TargetArn` input is not provided, this API lists numbers claimed to
|
7023
|
+
# all the Amazon Connect instances belonging to your account in the
|
7024
|
+
# same Amazon Web Services Region as the request.
|
6756
7025
|
# @return [String]
|
6757
7026
|
#
|
6758
7027
|
# @!attribute [rw] max_results
|
@@ -6798,7 +7067,7 @@ module Aws::Connect
|
|
6798
7067
|
#
|
6799
7068
|
# @!attribute [rw] list_phone_numbers_summary_list
|
6800
7069
|
# Information about phone numbers that have been claimed to your
|
6801
|
-
# Amazon Connect instances.
|
7070
|
+
# Amazon Connect instances or traffic distribution groups.
|
6802
7071
|
# @return [Array<Types::ListPhoneNumbersSummary>]
|
6803
7072
|
#
|
6804
7073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2Response AWS API Documentation
|
@@ -7428,6 +7697,58 @@ module Aws::Connect
|
|
7428
7697
|
include Aws::Structure
|
7429
7698
|
end
|
7430
7699
|
|
7700
|
+
# @note When making an API call, you may pass ListTrafficDistributionGroupsRequest
|
7701
|
+
# data as a hash:
|
7702
|
+
#
|
7703
|
+
# {
|
7704
|
+
# max_results: 1,
|
7705
|
+
# next_token: "NextToken",
|
7706
|
+
# instance_id: "InstanceIdOrArn",
|
7707
|
+
# }
|
7708
|
+
#
|
7709
|
+
# @!attribute [rw] max_results
|
7710
|
+
# The maximum number of results to return per page.
|
7711
|
+
# @return [Integer]
|
7712
|
+
#
|
7713
|
+
# @!attribute [rw] next_token
|
7714
|
+
# The token for the next set of results. Use the value returned in the
|
7715
|
+
# previous response in the next request to retrieve the next set of
|
7716
|
+
# results.
|
7717
|
+
# @return [String]
|
7718
|
+
#
|
7719
|
+
# @!attribute [rw] instance_id
|
7720
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7721
|
+
# instanceId in the ARN of the instance.
|
7722
|
+
# @return [String]
|
7723
|
+
#
|
7724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroupsRequest AWS API Documentation
|
7725
|
+
#
|
7726
|
+
class ListTrafficDistributionGroupsRequest < Struct.new(
|
7727
|
+
:max_results,
|
7728
|
+
:next_token,
|
7729
|
+
:instance_id)
|
7730
|
+
SENSITIVE = []
|
7731
|
+
include Aws::Structure
|
7732
|
+
end
|
7733
|
+
|
7734
|
+
# @!attribute [rw] next_token
|
7735
|
+
# If there are additional results, this is the token for the next set
|
7736
|
+
# of results.
|
7737
|
+
# @return [String]
|
7738
|
+
#
|
7739
|
+
# @!attribute [rw] traffic_distribution_group_summary_list
|
7740
|
+
# A list of traffic distribution groups.
|
7741
|
+
# @return [Array<Types::TrafficDistributionGroupSummary>]
|
7742
|
+
#
|
7743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroupsResponse AWS API Documentation
|
7744
|
+
#
|
7745
|
+
class ListTrafficDistributionGroupsResponse < Struct.new(
|
7746
|
+
:next_token,
|
7747
|
+
:traffic_distribution_group_summary_list)
|
7748
|
+
SENSITIVE = []
|
7749
|
+
include Aws::Structure
|
7750
|
+
end
|
7751
|
+
|
7431
7752
|
# Provides summary information about the use cases for the specified
|
7432
7753
|
# integration association.
|
7433
7754
|
#
|
@@ -7742,6 +8063,30 @@ module Aws::Connect
|
|
7742
8063
|
|
7743
8064
|
# The status of the phone number.
|
7744
8065
|
#
|
8066
|
+
# * `CLAIMED` means the previous [ClaimedPhoneNumber][1] or
|
8067
|
+
# [UpdatePhoneNumber][2] operation succeeded.
|
8068
|
+
#
|
8069
|
+
# * `IN_PROGRESS` means a [ClaimedPhoneNumber][1] or
|
8070
|
+
# [UpdatePhoneNumber][2] operation is still in progress and has not
|
8071
|
+
# yet completed. You can call [DescribePhoneNumber][3] at a later time
|
8072
|
+
# to verify if the previous operation has completed.
|
8073
|
+
#
|
8074
|
+
# * `FAILED` indicates that the previous [ClaimedPhoneNumber][1] or
|
8075
|
+
# [UpdatePhoneNumber][2] operation has failed. It will include a
|
8076
|
+
# message indicating the failure reason. A common reason for a failure
|
8077
|
+
# may be that the `TargetArn` value you are claiming or updating a
|
8078
|
+
# phone number to has reached its limit of total claimed numbers. If
|
8079
|
+
# you received a `FAILED` status from a `ClaimPhoneNumber` API call,
|
8080
|
+
# you have one day to retry claiming the phone number before the
|
8081
|
+
# number is released back to the inventory for other customers to
|
8082
|
+
# claim.
|
8083
|
+
#
|
8084
|
+
#
|
8085
|
+
#
|
8086
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimedPhoneNumber.html
|
8087
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
|
8088
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
8089
|
+
#
|
7745
8090
|
# @!attribute [rw] status
|
7746
8091
|
# The status.
|
7747
8092
|
# @return [String]
|
@@ -7969,7 +8314,7 @@ module Aws::Connect
|
|
7969
8314
|
# If this contact was queued, this contains information about the queue.
|
7970
8315
|
#
|
7971
8316
|
# @!attribute [rw] id
|
7972
|
-
# The identifier
|
8317
|
+
# The unique identifier for the queue.
|
7973
8318
|
# @return [String]
|
7974
8319
|
#
|
7975
8320
|
# @!attribute [rw] enqueue_timestamp
|
@@ -8091,7 +8436,11 @@ module Aws::Connect
|
|
8091
8436
|
#
|
8092
8437
|
# @!attribute [rw] string_condition
|
8093
8438
|
# A leaf node condition which can be used to specify a string
|
8094
|
-
# condition
|
8439
|
+
# condition.
|
8440
|
+
#
|
8441
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
8442
|
+
#
|
8443
|
+
# </note>
|
8095
8444
|
# @return [Types::StringCondition]
|
8096
8445
|
#
|
8097
8446
|
# @!attribute [rw] queue_type_condition
|
@@ -8354,7 +8703,7 @@ module Aws::Connect
|
|
8354
8703
|
# @return [String]
|
8355
8704
|
#
|
8356
8705
|
# @!attribute [rw] type
|
8357
|
-
# The type of the reference.
|
8706
|
+
# The type of the reference. `DATE` must be of type Epoch timestamp.
|
8358
8707
|
# @return [String]
|
8359
8708
|
#
|
8360
8709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
@@ -8439,10 +8788,16 @@ module Aws::Connect
|
|
8439
8788
|
#
|
8440
8789
|
# @!attribute [rw] client_token
|
8441
8790
|
# A unique, case-sensitive identifier that you provide to ensure the
|
8442
|
-
# idempotency of the request.
|
8791
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
8792
|
+
# SDK populates this field. For more information about idempotency,
|
8793
|
+
# see [Making retries safe with idempotent APIs][1].
|
8443
8794
|
#
|
8444
8795
|
# **A suitable default value is auto-generated.** You should normally
|
8445
8796
|
# not need to pass this option.
|
8797
|
+
#
|
8798
|
+
#
|
8799
|
+
#
|
8800
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
8446
8801
|
# @return [String]
|
8447
8802
|
#
|
8448
8803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReleasePhoneNumberRequest AWS API Documentation
|
@@ -8454,6 +8809,75 @@ module Aws::Connect
|
|
8454
8809
|
include Aws::Structure
|
8455
8810
|
end
|
8456
8811
|
|
8812
|
+
# @note When making an API call, you may pass ReplicateInstanceRequest
|
8813
|
+
# data as a hash:
|
8814
|
+
#
|
8815
|
+
# {
|
8816
|
+
# instance_id: "InstanceIdOrArn", # required
|
8817
|
+
# replica_region: "AwsRegion", # required
|
8818
|
+
# client_token: "ClientToken",
|
8819
|
+
# replica_alias: "DirectoryAlias", # required
|
8820
|
+
# }
|
8821
|
+
#
|
8822
|
+
# @!attribute [rw] instance_id
|
8823
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8824
|
+
# instanceId in the ARN of the instance.
|
8825
|
+
# @return [String]
|
8826
|
+
#
|
8827
|
+
# @!attribute [rw] replica_region
|
8828
|
+
# The Amazon Web Services Region where to replicate the Amazon Connect
|
8829
|
+
# instance.
|
8830
|
+
# @return [String]
|
8831
|
+
#
|
8832
|
+
# @!attribute [rw] client_token
|
8833
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
8834
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
8835
|
+
# SDK populates this field. For more information about idempotency,
|
8836
|
+
# see [Making retries safe with idempotent APIs][1].
|
8837
|
+
#
|
8838
|
+
# **A suitable default value is auto-generated.** You should normally
|
8839
|
+
# not need to pass this option.
|
8840
|
+
#
|
8841
|
+
#
|
8842
|
+
#
|
8843
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
8844
|
+
# @return [String]
|
8845
|
+
#
|
8846
|
+
# @!attribute [rw] replica_alias
|
8847
|
+
# The alias for the replicated instance. The `ReplicaAlias` must be
|
8848
|
+
# unique.
|
8849
|
+
# @return [String]
|
8850
|
+
#
|
8851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicateInstanceRequest AWS API Documentation
|
8852
|
+
#
|
8853
|
+
class ReplicateInstanceRequest < Struct.new(
|
8854
|
+
:instance_id,
|
8855
|
+
:replica_region,
|
8856
|
+
:client_token,
|
8857
|
+
:replica_alias)
|
8858
|
+
SENSITIVE = [:replica_alias]
|
8859
|
+
include Aws::Structure
|
8860
|
+
end
|
8861
|
+
|
8862
|
+
# @!attribute [rw] id
|
8863
|
+
# The identifier of the replicated instance. You can find the
|
8864
|
+
# `instanceId` in the ARN of the instance. The replicated instance has
|
8865
|
+
# the same identifier as the instance it was replicated from.
|
8866
|
+
# @return [String]
|
8867
|
+
#
|
8868
|
+
# @!attribute [rw] arn
|
8869
|
+
# The Amazon Resource Name (ARN) of the replicated instance.
|
8870
|
+
# @return [String]
|
8871
|
+
#
|
8872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReplicateInstanceResponse AWS API Documentation
|
8873
|
+
#
|
8874
|
+
class ReplicateInstanceResponse < Struct.new(
|
8875
|
+
:id,
|
8876
|
+
:arn)
|
8877
|
+
SENSITIVE = []
|
8878
|
+
include Aws::Structure
|
8879
|
+
end
|
8880
|
+
|
8457
8881
|
# Information about a required field.
|
8458
8882
|
#
|
8459
8883
|
# @note When making an API call, you may pass RequiredFieldInfo
|
@@ -8527,6 +8951,19 @@ module Aws::Connect
|
|
8527
8951
|
include Aws::Structure
|
8528
8952
|
end
|
8529
8953
|
|
8954
|
+
# The resource is not ready.
|
8955
|
+
#
|
8956
|
+
# @!attribute [rw] message
|
8957
|
+
# @return [String]
|
8958
|
+
#
|
8959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceNotReadyException AWS API Documentation
|
8960
|
+
#
|
8961
|
+
class ResourceNotReadyException < Struct.new(
|
8962
|
+
:message)
|
8963
|
+
SENSITIVE = []
|
8964
|
+
include Aws::Structure
|
8965
|
+
end
|
8966
|
+
|
8530
8967
|
# @note When making an API call, you may pass ResumeContactRecordingRequest
|
8531
8968
|
# data as a hash:
|
8532
8969
|
#
|
@@ -8829,7 +9266,11 @@ module Aws::Connect
|
|
8829
9266
|
#
|
8830
9267
|
# @!attribute [rw] string_condition
|
8831
9268
|
# A leaf node condition which can be used to specify a string
|
8832
|
-
# condition
|
9269
|
+
# condition.
|
9270
|
+
#
|
9271
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
9272
|
+
#
|
9273
|
+
# </note>
|
8833
9274
|
# @return [Types::StringCondition]
|
8834
9275
|
#
|
8835
9276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileSearchCriteria AWS API Documentation
|
@@ -8964,8 +9405,8 @@ module Aws::Connect
|
|
8964
9405
|
# }
|
8965
9406
|
#
|
8966
9407
|
# @!attribute [rw] target_arn
|
8967
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
8968
|
-
# phone numbers are claimed to.
|
9408
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
9409
|
+
# traffic distribution groups that phone numbers are claimed to.
|
8969
9410
|
# @return [String]
|
8970
9411
|
#
|
8971
9412
|
# @!attribute [rw] phone_number_country_code
|
@@ -9010,8 +9451,8 @@ module Aws::Connect
|
|
9010
9451
|
# @return [String]
|
9011
9452
|
#
|
9012
9453
|
# @!attribute [rw] available_numbers_list
|
9013
|
-
# A list of available phone numbers that you can claim
|
9014
|
-
# Connect instance.
|
9454
|
+
# A list of available phone numbers that you can claim to your Amazon
|
9455
|
+
# Connect instance or traffic distribution group.
|
9015
9456
|
# @return [Array<Types::AvailableNumberSummary>]
|
9016
9457
|
#
|
9017
9458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbersResponse AWS API Documentation
|
@@ -9302,6 +9743,10 @@ module Aws::Connect
|
|
9302
9743
|
#
|
9303
9744
|
# @!attribute [rw] search_criteria
|
9304
9745
|
# The search criteria to be used to return security profiles.
|
9746
|
+
#
|
9747
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
9748
|
+
#
|
9749
|
+
# </note>
|
9305
9750
|
# @return [Types::SecurityProfileSearchCriteria]
|
9306
9751
|
#
|
9307
9752
|
# @!attribute [rw] search_filter
|
@@ -9658,7 +10103,11 @@ module Aws::Connect
|
|
9658
10103
|
#
|
9659
10104
|
# @!attribute [rw] string_condition
|
9660
10105
|
# A leaf node condition which can be used to specify a string
|
9661
|
-
# condition
|
10106
|
+
# condition.
|
10107
|
+
#
|
10108
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
10109
|
+
#
|
10110
|
+
# </note>
|
9662
10111
|
# @return [Types::StringCondition]
|
9663
10112
|
#
|
9664
10113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSearchCriteria AWS API Documentation
|
@@ -9854,10 +10303,16 @@ module Aws::Connect
|
|
9854
10303
|
#
|
9855
10304
|
# @!attribute [rw] client_token
|
9856
10305
|
# A unique, case-sensitive identifier that you provide to ensure the
|
9857
|
-
# idempotency of the request.
|
10306
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
10307
|
+
# SDK populates this field. For more information about idempotency,
|
10308
|
+
# see [Making retries safe with idempotent APIs][1].
|
9858
10309
|
#
|
9859
10310
|
# **A suitable default value is auto-generated.** You should normally
|
9860
10311
|
# not need to pass this option.
|
10312
|
+
#
|
10313
|
+
#
|
10314
|
+
#
|
10315
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
9861
10316
|
# @return [String]
|
9862
10317
|
#
|
9863
10318
|
# @!attribute [rw] chat_duration_in_minutes
|
@@ -9990,10 +10445,16 @@ module Aws::Connect
|
|
9990
10445
|
#
|
9991
10446
|
# @!attribute [rw] client_token
|
9992
10447
|
# A unique, case-sensitive identifier that you provide to ensure the
|
9993
|
-
# idempotency of the request.
|
10448
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
10449
|
+
# SDK populates this field. For more information about idempotency,
|
10450
|
+
# see [Making retries safe with idempotent APIs][1].
|
9994
10451
|
#
|
9995
10452
|
# **A suitable default value is auto-generated.** You should normally
|
9996
10453
|
# not need to pass this option.
|
10454
|
+
#
|
10455
|
+
#
|
10456
|
+
#
|
10457
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
9997
10458
|
# @return [String]
|
9998
10459
|
#
|
9999
10460
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreamingRequest AWS API Documentation
|
@@ -10062,12 +10523,18 @@ module Aws::Connect
|
|
10062
10523
|
#
|
10063
10524
|
# @!attribute [rw] client_token
|
10064
10525
|
# A unique, case-sensitive identifier that you provide to ensure the
|
10065
|
-
# idempotency of the request.
|
10066
|
-
#
|
10067
|
-
#
|
10526
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
10527
|
+
# SDK populates this field. For more information about idempotency,
|
10528
|
+
# see [Making retries safe with idempotent APIs][1]. The token is
|
10529
|
+
# valid for 7 days after creation. If a contact is already started,
|
10530
|
+
# the contact ID is returned.
|
10068
10531
|
#
|
10069
10532
|
# **A suitable default value is auto-generated.** You should normally
|
10070
10533
|
# not need to pass this option.
|
10534
|
+
#
|
10535
|
+
#
|
10536
|
+
#
|
10537
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
10071
10538
|
# @return [String]
|
10072
10539
|
#
|
10073
10540
|
# @!attribute [rw] source_phone_number
|
@@ -10209,10 +10676,16 @@ module Aws::Connect
|
|
10209
10676
|
#
|
10210
10677
|
# @!attribute [rw] client_token
|
10211
10678
|
# A unique, case-sensitive identifier that you provide to ensure the
|
10212
|
-
# idempotency of the request.
|
10679
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
10680
|
+
# SDK populates this field. For more information about idempotency,
|
10681
|
+
# see [Making retries safe with idempotent APIs][1].
|
10213
10682
|
#
|
10214
10683
|
# **A suitable default value is auto-generated.** You should normally
|
10215
10684
|
# not need to pass this option.
|
10685
|
+
#
|
10686
|
+
#
|
10687
|
+
#
|
10688
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
10216
10689
|
# @return [String]
|
10217
10690
|
#
|
10218
10691
|
# @!attribute [rw] scheduled_time
|
@@ -10364,8 +10837,11 @@ module Aws::Connect
|
|
10364
10837
|
#
|
10365
10838
|
class StopContactStreamingResponse < Aws::EmptyStructure; end
|
10366
10839
|
|
10367
|
-
# A leaf node condition which can be used to specify a string condition
|
10368
|
-
#
|
10840
|
+
# A leaf node condition which can be used to specify a string condition.
|
10841
|
+
#
|
10842
|
+
# <note markdown="1"> The currently supported value for `FieldName`\: `name`
|
10843
|
+
#
|
10844
|
+
# </note>
|
10369
10845
|
#
|
10370
10846
|
# @note When making an API call, you may pass StringCondition
|
10371
10847
|
# data as a hash:
|
@@ -10730,6 +11206,32 @@ module Aws::Connect
|
|
10730
11206
|
include Aws::Structure
|
10731
11207
|
end
|
10732
11208
|
|
11209
|
+
# The distribution of traffic between the instance and its replicas.
|
11210
|
+
#
|
11211
|
+
# @note When making an API call, you may pass TelephonyConfig
|
11212
|
+
# data as a hash:
|
11213
|
+
#
|
11214
|
+
# {
|
11215
|
+
# distributions: [ # required
|
11216
|
+
# {
|
11217
|
+
# region: "AwsRegion", # required
|
11218
|
+
# percentage: 1, # required
|
11219
|
+
# },
|
11220
|
+
# ],
|
11221
|
+
# }
|
11222
|
+
#
|
11223
|
+
# @!attribute [rw] distributions
|
11224
|
+
# Information about traffic distributions.
|
11225
|
+
# @return [Array<Types::Distribution>]
|
11226
|
+
#
|
11227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TelephonyConfig AWS API Documentation
|
11228
|
+
#
|
11229
|
+
class TelephonyConfig < Struct.new(
|
11230
|
+
:distributions)
|
11231
|
+
SENSITIVE = []
|
11232
|
+
include Aws::Structure
|
11233
|
+
end
|
11234
|
+
|
10733
11235
|
# Contains information about the threshold for service level metrics.
|
10734
11236
|
#
|
10735
11237
|
# @note When making an API call, you may pass Threshold
|
@@ -10771,6 +11273,146 @@ module Aws::Connect
|
|
10771
11273
|
include Aws::Structure
|
10772
11274
|
end
|
10773
11275
|
|
11276
|
+
# Information about a traffic distribution group.
|
11277
|
+
#
|
11278
|
+
# @!attribute [rw] id
|
11279
|
+
# The identifier of the traffic distribution group. This can be the ID
|
11280
|
+
# or the ARN if the API is being called in the Region where the
|
11281
|
+
# traffic distribution group was created. The ARN must be provided if
|
11282
|
+
# the call is from the replicated Region.
|
11283
|
+
# @return [String]
|
11284
|
+
#
|
11285
|
+
# @!attribute [rw] arn
|
11286
|
+
# The Amazon Resource Name (ARN) of the traffic distribution group.
|
11287
|
+
# @return [String]
|
11288
|
+
#
|
11289
|
+
# @!attribute [rw] name
|
11290
|
+
# The name of the traffic distribution group.
|
11291
|
+
# @return [String]
|
11292
|
+
#
|
11293
|
+
# @!attribute [rw] description
|
11294
|
+
# The description of the traffic distribution group.
|
11295
|
+
# @return [String]
|
11296
|
+
#
|
11297
|
+
# @!attribute [rw] instance_arn
|
11298
|
+
# The Amazon Resource Name (ARN).
|
11299
|
+
# @return [String]
|
11300
|
+
#
|
11301
|
+
# @!attribute [rw] status
|
11302
|
+
# The status of the traffic distribution group.
|
11303
|
+
#
|
11304
|
+
# * `CREATION_IN_PROGRESS` means the previous
|
11305
|
+
# [CreateTrafficDistributionGroup][1] operation is still in progress
|
11306
|
+
# and has not yet completed.
|
11307
|
+
#
|
11308
|
+
# * `ACTIVE` means the previous [CreateTrafficDistributionGroup][1]
|
11309
|
+
# operation has succeeded.
|
11310
|
+
#
|
11311
|
+
# * `CREATION_FAILED` indicates that the previous
|
11312
|
+
# [CreateTrafficDistributionGroup][1] operation has failed.
|
11313
|
+
#
|
11314
|
+
# * `PENDING_DELETION` means the previous
|
11315
|
+
# [DeleteTrafficDistributionGroup][2] operation is still in progress
|
11316
|
+
# and has not yet completed.
|
11317
|
+
#
|
11318
|
+
# * `DELETION_FAILED` means the previous
|
11319
|
+
# [DeleteTrafficDistributionGroup][2] operation has failed.
|
11320
|
+
#
|
11321
|
+
# * `UPDATE_IN_PROGRESS` means the previous
|
11322
|
+
# [UpdateTrafficDistributionGroup][3] operation is still in progress
|
11323
|
+
# and has not yet completed.
|
11324
|
+
#
|
11325
|
+
#
|
11326
|
+
#
|
11327
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html
|
11328
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html
|
11329
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html
|
11330
|
+
# @return [String]
|
11331
|
+
#
|
11332
|
+
# @!attribute [rw] tags
|
11333
|
+
# The tags used to organize, track, or control access for this
|
11334
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
11335
|
+
# "key2":"value2"\\} \\}.
|
11336
|
+
# @return [Hash<String,String>]
|
11337
|
+
#
|
11338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TrafficDistributionGroup AWS API Documentation
|
11339
|
+
#
|
11340
|
+
class TrafficDistributionGroup < Struct.new(
|
11341
|
+
:id,
|
11342
|
+
:arn,
|
11343
|
+
:name,
|
11344
|
+
:description,
|
11345
|
+
:instance_arn,
|
11346
|
+
:status,
|
11347
|
+
:tags)
|
11348
|
+
SENSITIVE = []
|
11349
|
+
include Aws::Structure
|
11350
|
+
end
|
11351
|
+
|
11352
|
+
# Information about traffic distribution groups.
|
11353
|
+
#
|
11354
|
+
# @!attribute [rw] id
|
11355
|
+
# The identifier of the traffic distribution group. This can be the ID
|
11356
|
+
# or the ARN if the API is being called in the Region where the
|
11357
|
+
# traffic distribution group was created. The ARN must be provided if
|
11358
|
+
# the call is from the replicated Region.
|
11359
|
+
# @return [String]
|
11360
|
+
#
|
11361
|
+
# @!attribute [rw] arn
|
11362
|
+
# The Amazon Resource Name (ARN) of the traffic distribution group.
|
11363
|
+
# @return [String]
|
11364
|
+
#
|
11365
|
+
# @!attribute [rw] name
|
11366
|
+
# The name of the traffic distribution group.
|
11367
|
+
# @return [String]
|
11368
|
+
#
|
11369
|
+
# @!attribute [rw] instance_arn
|
11370
|
+
# The Amazon Resource Name (ARN) of the traffic distribution group.
|
11371
|
+
# @return [String]
|
11372
|
+
#
|
11373
|
+
# @!attribute [rw] status
|
11374
|
+
# The status of the traffic distribution group.
|
11375
|
+
#
|
11376
|
+
# * `CREATION_IN_PROGRESS` means the previous
|
11377
|
+
# [CreateTrafficDistributionGroup][1] operation is still in progress
|
11378
|
+
# and has not yet completed.
|
11379
|
+
#
|
11380
|
+
# * `ACTIVE` means the previous [CreateTrafficDistributionGroup][1]
|
11381
|
+
# operation has succeeded.
|
11382
|
+
#
|
11383
|
+
# * `CREATION_FAILED` indicates that the previous
|
11384
|
+
# [CreateTrafficDistributionGroup][1] operation has failed.
|
11385
|
+
#
|
11386
|
+
# * `PENDING_DELETION` means the previous
|
11387
|
+
# [DeleteTrafficDistributionGroup][2] operation is still in progress
|
11388
|
+
# and has not yet completed.
|
11389
|
+
#
|
11390
|
+
# * `DELETION_FAILED` means the previous
|
11391
|
+
# [DeleteTrafficDistributionGroup][2] operation has failed.
|
11392
|
+
#
|
11393
|
+
# * `UPDATE_IN_PROGRESS` means the previous
|
11394
|
+
# [UpdateTrafficDistributionGroup][3] operation is still in progress
|
11395
|
+
# and has not yet completed.
|
11396
|
+
#
|
11397
|
+
#
|
11398
|
+
#
|
11399
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html
|
11400
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html
|
11401
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html
|
11402
|
+
# @return [String]
|
11403
|
+
#
|
11404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TrafficDistributionGroupSummary AWS API Documentation
|
11405
|
+
#
|
11406
|
+
class TrafficDistributionGroupSummary < Struct.new(
|
11407
|
+
:id,
|
11408
|
+
:arn,
|
11409
|
+
:name,
|
11410
|
+
:instance_arn,
|
11411
|
+
:status)
|
11412
|
+
SENSITIVE = []
|
11413
|
+
include Aws::Structure
|
11414
|
+
end
|
11415
|
+
|
10774
11416
|
# @note When making an API call, you may pass TransferContactRequest
|
10775
11417
|
# data as a hash:
|
10776
11418
|
#
|
@@ -10806,10 +11448,16 @@ module Aws::Connect
|
|
10806
11448
|
#
|
10807
11449
|
# @!attribute [rw] client_token
|
10808
11450
|
# A unique, case-sensitive identifier that you provide to ensure the
|
10809
|
-
# idempotency of the request.
|
11451
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
11452
|
+
# SDK populates this field. For more information about idempotency,
|
11453
|
+
# see [Making retries safe with idempotent APIs][1].
|
10810
11454
|
#
|
10811
11455
|
# **A suitable default value is auto-generated.** You should normally
|
10812
11456
|
# not need to pass this option.
|
11457
|
+
#
|
11458
|
+
#
|
11459
|
+
#
|
11460
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
10813
11461
|
# @return [String]
|
10814
11462
|
#
|
10815
11463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactRequest AWS API Documentation
|
@@ -11440,16 +12088,22 @@ module Aws::Connect
|
|
11440
12088
|
# @return [String]
|
11441
12089
|
#
|
11442
12090
|
# @!attribute [rw] target_arn
|
11443
|
-
# The Amazon Resource Name (ARN) for Amazon Connect instances
|
11444
|
-
# phone numbers are claimed to.
|
12091
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances or
|
12092
|
+
# traffic distribution groups that phone numbers are claimed to.
|
11445
12093
|
# @return [String]
|
11446
12094
|
#
|
11447
12095
|
# @!attribute [rw] client_token
|
11448
12096
|
# A unique, case-sensitive identifier that you provide to ensure the
|
11449
|
-
# idempotency of the request.
|
12097
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
12098
|
+
# SDK populates this field. For more information about idempotency,
|
12099
|
+
# see [Making retries safe with idempotent APIs][1].
|
11450
12100
|
#
|
11451
12101
|
# **A suitable default value is auto-generated.** You should normally
|
11452
12102
|
# not need to pass this option.
|
12103
|
+
#
|
12104
|
+
#
|
12105
|
+
#
|
12106
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
11453
12107
|
# @return [String]
|
11454
12108
|
#
|
11455
12109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberRequest AWS API Documentation
|
@@ -12115,6 +12769,45 @@ module Aws::Connect
|
|
12115
12769
|
include Aws::Structure
|
12116
12770
|
end
|
12117
12771
|
|
12772
|
+
# @note When making an API call, you may pass UpdateTrafficDistributionRequest
|
12773
|
+
# data as a hash:
|
12774
|
+
#
|
12775
|
+
# {
|
12776
|
+
# id: "TrafficDistributionGroupIdOrArn", # required
|
12777
|
+
# telephony_config: {
|
12778
|
+
# distributions: [ # required
|
12779
|
+
# {
|
12780
|
+
# region: "AwsRegion", # required
|
12781
|
+
# percentage: 1, # required
|
12782
|
+
# },
|
12783
|
+
# ],
|
12784
|
+
# },
|
12785
|
+
# }
|
12786
|
+
#
|
12787
|
+
# @!attribute [rw] id
|
12788
|
+
# The identifier of the traffic distribution group. This can be the ID
|
12789
|
+
# or the ARN if the API is being called in the Region where the
|
12790
|
+
# traffic distribution group was created. The ARN must be provided if
|
12791
|
+
# the call is from the replicated Region.
|
12792
|
+
# @return [String]
|
12793
|
+
#
|
12794
|
+
# @!attribute [rw] telephony_config
|
12795
|
+
# The distribution of traffic between the instance and its replica(s).
|
12796
|
+
# @return [Types::TelephonyConfig]
|
12797
|
+
#
|
12798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTrafficDistributionRequest AWS API Documentation
|
12799
|
+
#
|
12800
|
+
class UpdateTrafficDistributionRequest < Struct.new(
|
12801
|
+
:id,
|
12802
|
+
:telephony_config)
|
12803
|
+
SENSITIVE = []
|
12804
|
+
include Aws::Structure
|
12805
|
+
end
|
12806
|
+
|
12807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTrafficDistributionResponse AWS API Documentation
|
12808
|
+
#
|
12809
|
+
class UpdateTrafficDistributionResponse < Aws::EmptyStructure; end
|
12810
|
+
|
12118
12811
|
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
12119
12812
|
# data as a hash:
|
12120
12813
|
#
|
@@ -12230,6 +12923,8 @@ module Aws::Connect
|
|
12230
12923
|
# first_name: "AgentFirstName",
|
12231
12924
|
# last_name: "AgentLastName",
|
12232
12925
|
# email: "Email",
|
12926
|
+
# secondary_email: "Email",
|
12927
|
+
# mobile: "PhoneNumber",
|
12233
12928
|
# },
|
12234
12929
|
# user_id: "UserId", # required
|
12235
12930
|
# instance_id: "InstanceId", # required
|
@@ -12404,7 +13099,7 @@ module Aws::Connect
|
|
12404
13099
|
include Aws::Structure
|
12405
13100
|
end
|
12406
13101
|
|
12407
|
-
# Contains information about a user account for
|
13102
|
+
# Contains information about a user account for an Amazon Connect
|
12408
13103
|
# instance.
|
12409
13104
|
#
|
12410
13105
|
# @!attribute [rw] id
|
@@ -12469,7 +13164,7 @@ module Aws::Connect
|
|
12469
13164
|
#
|
12470
13165
|
# @!attribute [rw] user
|
12471
13166
|
# Information about the user for the data that is returned. It
|
12472
|
-
# contains resourceId and ARN of the user.
|
13167
|
+
# contains the `resourceId` and ARN of the user.
|
12473
13168
|
# @return [Types::UserReference]
|
12474
13169
|
#
|
12475
13170
|
# @!attribute [rw] routing_profile
|
@@ -12495,7 +13190,7 @@ module Aws::Connect
|
|
12495
13190
|
# @!attribute [rw] max_slots_by_channel
|
12496
13191
|
# A map of maximum slots by channel. The key is a channel name. The
|
12497
13192
|
# value is an integer: the maximum number of slots. This is calculated
|
12498
|
-
# from [MediaConcurrency][1] of the RoutingProfile assigned to the
|
13193
|
+
# from [MediaConcurrency][1] of the `RoutingProfile` assigned to the
|
12499
13194
|
# agent.
|
12500
13195
|
#
|
12501
13196
|
#
|
@@ -12567,6 +13262,8 @@ module Aws::Connect
|
|
12567
13262
|
# first_name: "AgentFirstName",
|
12568
13263
|
# last_name: "AgentLastName",
|
12569
13264
|
# email: "Email",
|
13265
|
+
# secondary_email: "Email",
|
13266
|
+
# mobile: "PhoneNumber",
|
12570
13267
|
# }
|
12571
13268
|
#
|
12572
13269
|
# @!attribute [rw] first_name
|
@@ -12584,12 +13281,28 @@ module Aws::Connect
|
|
12584
13281
|
# include this parameter, an error is returned.
|
12585
13282
|
# @return [String]
|
12586
13283
|
#
|
13284
|
+
# @!attribute [rw] secondary_email
|
13285
|
+
# The user's secondary email address. If you provide a secondary
|
13286
|
+
# email, the user receives email notifications - other than password
|
13287
|
+
# reset notifications - to this email address instead of to their
|
13288
|
+
# primary email address.
|
13289
|
+
#
|
13290
|
+
# Pattern:
|
13291
|
+
# `(?=^.\{0,265\}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]\{2,63\}`
|
13292
|
+
# @return [String]
|
13293
|
+
#
|
13294
|
+
# @!attribute [rw] mobile
|
13295
|
+
# The user's mobile number.
|
13296
|
+
# @return [String]
|
13297
|
+
#
|
12587
13298
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfo AWS API Documentation
|
12588
13299
|
#
|
12589
13300
|
class UserIdentityInfo < Struct.new(
|
12590
13301
|
:first_name,
|
12591
13302
|
:last_name,
|
12592
|
-
:email
|
13303
|
+
:email,
|
13304
|
+
:secondary_email,
|
13305
|
+
:mobile)
|
12593
13306
|
SENSITIVE = []
|
12594
13307
|
include Aws::Structure
|
12595
13308
|
end
|
@@ -12650,6 +13363,11 @@ module Aws::Connect
|
|
12650
13363
|
#
|
12651
13364
|
# @!attribute [rw] after_contact_work_time_limit
|
12652
13365
|
# The After Call Work (ACW) timeout setting, in seconds.
|
13366
|
+
#
|
13367
|
+
# <note markdown="1"> When returned by a `SearchUsers` call, `AfterContactWorkTimeLimit`
|
13368
|
+
# is returned in milliseconds.
|
13369
|
+
#
|
13370
|
+
# </note>
|
12653
13371
|
# @return [Integer]
|
12654
13372
|
#
|
12655
13373
|
# @!attribute [rw] desk_phone_number
|