aws-sdk-connect 1.128.0 → 1.130.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +280 -50
- data/lib/aws-sdk-connect/client_api.rb +41 -4
- data/lib/aws-sdk-connect/endpoint_provider.rb +2 -2
- data/lib/aws-sdk-connect/endpoints.rb +14 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-connect/types.rb +318 -61
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -899,15 +899,16 @@ module Aws::Connect
|
|
899
899
|
# @!attribute [rw] phone_number_status
|
900
900
|
# The status of the phone number.
|
901
901
|
#
|
902
|
-
# * `CLAIMED` means the previous [
|
902
|
+
# * `CLAIMED` means the previous [ClaimPhoneNumber][1] or
|
903
903
|
# [UpdatePhoneNumber][2] operation succeeded.
|
904
904
|
#
|
905
|
-
# * `IN_PROGRESS` means a [
|
906
|
-
# [UpdatePhoneNumber][2]
|
907
|
-
# yet completed. You can
|
908
|
-
# time to verify if the
|
905
|
+
# * `IN_PROGRESS` means a [ClaimPhoneNumber][1],
|
906
|
+
# [UpdatePhoneNumber][2], or [UpdatePhoneNumberMetadata][3]
|
907
|
+
# operation is still in progress and has not yet completed. You can
|
908
|
+
# call [DescribePhoneNumber][4] at a later time to verify if the
|
909
|
+
# previous operation has completed.
|
909
910
|
#
|
910
|
-
# * `FAILED` indicates that the previous [
|
911
|
+
# * `FAILED` indicates that the previous [ClaimPhoneNumber][1] or
|
911
912
|
# [UpdatePhoneNumber][2] operation has failed. It will include a
|
912
913
|
# message indicating the failure reason. A common reason for a
|
913
914
|
# failure may be that the `TargetArn` value you are claiming or
|
@@ -924,9 +925,10 @@ module Aws::Connect
|
|
924
925
|
#
|
925
926
|
#
|
926
927
|
#
|
927
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
928
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
|
928
929
|
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
|
929
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
930
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html
|
931
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
930
932
|
# @return [Types::PhoneNumberStatus]
|
931
933
|
#
|
932
934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimedPhoneNumberSummary AWS API Documentation
|
@@ -1105,7 +1107,14 @@ module Aws::Connect
|
|
1105
1107
|
# @return [String]
|
1106
1108
|
#
|
1107
1109
|
# @!attribute [rw] content
|
1108
|
-
# The content of the flow.
|
1110
|
+
# The JSON string that represents the content of the flow. For an
|
1111
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1112
|
+
#
|
1113
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1114
|
+
#
|
1115
|
+
#
|
1116
|
+
#
|
1117
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1109
1118
|
# @return [String]
|
1110
1119
|
#
|
1111
1120
|
# @!attribute [rw] tags
|
@@ -1144,7 +1153,12 @@ module Aws::Connect
|
|
1144
1153
|
# @return [String]
|
1145
1154
|
#
|
1146
1155
|
# @!attribute [rw] content
|
1147
|
-
# The content of the flow
|
1156
|
+
# The JSON string that represents the content of the flow. For an
|
1157
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1158
|
+
#
|
1159
|
+
#
|
1160
|
+
#
|
1161
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1148
1162
|
# @return [String]
|
1149
1163
|
#
|
1150
1164
|
# @!attribute [rw] description
|
@@ -1391,7 +1405,12 @@ module Aws::Connect
|
|
1391
1405
|
# @return [String]
|
1392
1406
|
#
|
1393
1407
|
# @!attribute [rw] content
|
1394
|
-
# The content of the flow
|
1408
|
+
# The JSON string that represents the content of the flow. For an
|
1409
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1410
|
+
#
|
1411
|
+
#
|
1412
|
+
#
|
1413
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1395
1414
|
# @return [String]
|
1396
1415
|
#
|
1397
1416
|
# @!attribute [rw] tags
|
@@ -1466,7 +1485,14 @@ module Aws::Connect
|
|
1466
1485
|
# @return [String]
|
1467
1486
|
#
|
1468
1487
|
# @!attribute [rw] content
|
1469
|
-
# The content of the flow.
|
1488
|
+
# The JSON string that represents the content of the flow. For an
|
1489
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1490
|
+
#
|
1491
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
#
|
1495
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1470
1496
|
# @return [String]
|
1471
1497
|
#
|
1472
1498
|
# @!attribute [rw] tags
|
@@ -6339,10 +6365,10 @@ module Aws::Connect
|
|
6339
6365
|
# @!attribute [rw] start_time
|
6340
6366
|
# The timestamp, in UNIX Epoch time format, at which to start the
|
6341
6367
|
# reporting interval for the retrieval of historical metrics data. The
|
6342
|
-
# time must be before the end time timestamp. The
|
6343
|
-
#
|
6344
|
-
#
|
6345
|
-
#
|
6368
|
+
# time must be before the end time timestamp. The start and end time
|
6369
|
+
# depends on the `IntervalPeriod` selected. By default the time range
|
6370
|
+
# between start and end time is 35 days. Historical metrics are
|
6371
|
+
# available for 3 months.
|
6346
6372
|
# @return [Time]
|
6347
6373
|
#
|
6348
6374
|
# @!attribute [rw] end_time
|
@@ -6350,11 +6376,45 @@ module Aws::Connect
|
|
6350
6376
|
# reporting interval for the retrieval of historical metrics data. The
|
6351
6377
|
# time must be later than the start time timestamp. It cannot be later
|
6352
6378
|
# than the current timestamp.
|
6353
|
-
#
|
6354
|
-
# The time range between the start and end time must be less than 24
|
6355
|
-
# hours.
|
6356
6379
|
# @return [Time]
|
6357
6380
|
#
|
6381
|
+
# @!attribute [rw] interval
|
6382
|
+
# The interval period and timezone to apply to returned metrics.
|
6383
|
+
#
|
6384
|
+
# * `IntervalPeriod`: An aggregated grouping applied to request
|
6385
|
+
# metrics. Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \|
|
6386
|
+
# `THIRTY_MIN` \| `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
6387
|
+
#
|
6388
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
6389
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
6390
|
+
# returns 48 results in the response. Each result is aggregated by
|
6391
|
+
# the THIRTY\_MIN period. By default Amazon Connect aggregates
|
6392
|
+
# results based on the `TOTAL` interval period.
|
6393
|
+
#
|
6394
|
+
# The following list describes restrictions on `StartTime` and
|
6395
|
+
# `EndTime` based on which `IntervalPeriod` is requested.
|
6396
|
+
#
|
6397
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
6398
|
+
# must be less than 3 days.
|
6399
|
+
#
|
6400
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
6401
|
+
# must be less than 3 days.
|
6402
|
+
#
|
6403
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
6404
|
+
# less than 3 days.
|
6405
|
+
#
|
6406
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
6407
|
+
# less than 35 days.
|
6408
|
+
#
|
6409
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
6410
|
+
# less than 35 days.
|
6411
|
+
#
|
6412
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must
|
6413
|
+
# be less than 35 days.
|
6414
|
+
#
|
6415
|
+
# * `TimeZone`: The timezone applied to requested metrics.
|
6416
|
+
# @return [Types::IntervalDetails]
|
6417
|
+
#
|
6358
6418
|
# @!attribute [rw] filters
|
6359
6419
|
# The filters to apply to returned metrics. You can filter on the
|
6360
6420
|
# following resources:
|
@@ -6422,6 +6482,13 @@ module Aws::Connect
|
|
6422
6482
|
# a description of each metric, see [Historical metrics
|
6423
6483
|
# definitions][1] in the *Amazon Connect Administrator's Guide*.
|
6424
6484
|
#
|
6485
|
+
# ABANDONMENT\_RATE
|
6486
|
+
#
|
6487
|
+
# : Unit: Percent
|
6488
|
+
#
|
6489
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6490
|
+
# Agent, Agent Hierarchy
|
6491
|
+
#
|
6425
6492
|
# AGENT\_ADHERENT\_TIME
|
6426
6493
|
#
|
6427
6494
|
# : This metric is available only in Amazon Web Services Regions where
|
@@ -6439,6 +6506,16 @@ module Aws::Connect
|
|
6439
6506
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6440
6507
|
# Agent, Agent Hierarchy
|
6441
6508
|
#
|
6509
|
+
# AGENT\_NON\_RESPONSE\_WITHOUT\_CUSTOMER\_ABANDONS
|
6510
|
+
#
|
6511
|
+
# : Unit: Count
|
6512
|
+
#
|
6513
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6514
|
+
# Agent, Agent Hierarchy
|
6515
|
+
#
|
6516
|
+
# Data for this metric is available starting from October 1, 2023
|
6517
|
+
# 0:00:00 GMT.
|
6518
|
+
#
|
6442
6519
|
# AGENT\_OCCUPANCY
|
6443
6520
|
#
|
6444
6521
|
# : Unit: Percentage
|
@@ -6495,16 +6572,10 @@ module Aws::Connect
|
|
6495
6572
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6496
6573
|
# Agent, Agent Hierarchy
|
6497
6574
|
#
|
6498
|
-
#
|
6499
|
-
#
|
6500
|
-
# : Unit: Seconds
|
6575
|
+
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
|
6576
|
+
# this metric.
|
6501
6577
|
#
|
6502
|
-
#
|
6503
|
-
# only supports the following as `INITIATION_METHOD`: `INBOUND` \|
|
6504
|
-
# `OUTBOUND` \| `CALLBACK` \| `API`
|
6505
|
-
#
|
6506
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6507
|
-
# Agent, Agent Hierarchy
|
6578
|
+
# </note>
|
6508
6579
|
#
|
6509
6580
|
# AVG\_CONTACT\_DURATION
|
6510
6581
|
#
|
@@ -6556,6 +6627,13 @@ module Aws::Connect
|
|
6556
6627
|
#
|
6557
6628
|
# </note>
|
6558
6629
|
#
|
6630
|
+
# AVG\_HOLD\_TIME\_ALL\_CONTACTS
|
6631
|
+
#
|
6632
|
+
# : Unit: Seconds
|
6633
|
+
#
|
6634
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6635
|
+
# Agent, Agent Hierarchy
|
6636
|
+
#
|
6559
6637
|
# AVG\_HOLDS
|
6560
6638
|
#
|
6561
6639
|
# : Unit: Count
|
@@ -6626,6 +6704,12 @@ module Aws::Connect
|
|
6626
6704
|
#
|
6627
6705
|
# </note>
|
6628
6706
|
#
|
6707
|
+
# AVG\_RESOLUTION\_TIME
|
6708
|
+
#
|
6709
|
+
# : Unit: Seconds
|
6710
|
+
#
|
6711
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6712
|
+
#
|
6629
6713
|
# AVG\_TALK\_TIME
|
6630
6714
|
#
|
6631
6715
|
# : This metric is available only for contacts analyzed by Contact
|
@@ -6703,6 +6787,16 @@ module Aws::Connect
|
|
6703
6787
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6704
6788
|
# Agent, Agent Hierarchy
|
6705
6789
|
#
|
6790
|
+
# CONTACTS\_RESOLVED\_IN\_X
|
6791
|
+
#
|
6792
|
+
# : Unit: Count
|
6793
|
+
#
|
6794
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6795
|
+
#
|
6796
|
+
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
6797
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
6798
|
+
# `LT` (for "Less than").
|
6799
|
+
#
|
6706
6800
|
# CONTACTS\_TRANSFERRED\_OUT
|
6707
6801
|
#
|
6708
6802
|
# : Unit: Count
|
@@ -6803,6 +6897,7 @@ module Aws::Connect
|
|
6803
6897
|
:resource_arn,
|
6804
6898
|
:start_time,
|
6805
6899
|
:end_time,
|
6900
|
+
:interval,
|
6806
6901
|
:filters,
|
6807
6902
|
:groupings,
|
6808
6903
|
:metrics,
|
@@ -7006,7 +7101,8 @@ module Aws::Connect
|
|
7006
7101
|
# @return [String]
|
7007
7102
|
#
|
7008
7103
|
# @!attribute [rw] sign_in_config
|
7009
|
-
# The distribution
|
7104
|
+
# The distribution that determines which Amazon Web Services Regions
|
7105
|
+
# should be used to sign in agents in to both the instance and its
|
7010
7106
|
# replica(s).
|
7011
7107
|
# @return [Types::SignInConfig]
|
7012
7108
|
#
|
@@ -7812,6 +7908,54 @@ module Aws::Connect
|
|
7812
7908
|
include Aws::Structure
|
7813
7909
|
end
|
7814
7910
|
|
7911
|
+
# Information about the interval period to use for returning results.
|
7912
|
+
#
|
7913
|
+
# @!attribute [rw] time_zone
|
7914
|
+
# The timezone applied to requested metrics.
|
7915
|
+
# @return [String]
|
7916
|
+
#
|
7917
|
+
# @!attribute [rw] interval_period
|
7918
|
+
# `IntervalPeriod`: An aggregated grouping applied to request metrics.
|
7919
|
+
# Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \| `THIRTY_MIN` \|
|
7920
|
+
# `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
7921
|
+
#
|
7922
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
7923
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
7924
|
+
# returns 48 results in the response. Each result is aggregated by the
|
7925
|
+
# THIRTY\_MIN period. By default Amazon Connect aggregates results
|
7926
|
+
# based on the `TOTAL` interval period.
|
7927
|
+
#
|
7928
|
+
# The following list describes restrictions on `StartTime` and
|
7929
|
+
# `EndTime` based on what `IntervalPeriod` is requested.
|
7930
|
+
#
|
7931
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
7932
|
+
# must be less than 3 days.
|
7933
|
+
#
|
7934
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
7935
|
+
# must be less than 3 days.
|
7936
|
+
#
|
7937
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
7938
|
+
# less than 3 days.
|
7939
|
+
#
|
7940
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
7941
|
+
# less than 35 days.
|
7942
|
+
#
|
7943
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
7944
|
+
# less than 35 days.
|
7945
|
+
#
|
7946
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must be
|
7947
|
+
# less than 35 days.
|
7948
|
+
# @return [String]
|
7949
|
+
#
|
7950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/IntervalDetails AWS API Documentation
|
7951
|
+
#
|
7952
|
+
class IntervalDetails < Struct.new(
|
7953
|
+
:time_zone,
|
7954
|
+
:interval_period)
|
7955
|
+
SENSITIVE = []
|
7956
|
+
include Aws::Structure
|
7957
|
+
end
|
7958
|
+
|
7815
7959
|
# The flow is not valid.
|
7816
7960
|
#
|
7817
7961
|
# @!attribute [rw] problems
|
@@ -9476,6 +9620,9 @@ module Aws::Connect
|
|
9476
9620
|
end
|
9477
9621
|
|
9478
9622
|
# @!attribute [rw] applications
|
9623
|
+
# This API is in preview release for Amazon Connect and is subject to
|
9624
|
+
# change.
|
9625
|
+
#
|
9479
9626
|
# A list of the third party application's metadata.
|
9480
9627
|
# @return [Array<Types::Application>]
|
9481
9628
|
#
|
@@ -10142,11 +10289,49 @@ module Aws::Connect
|
|
10142
10289
|
# `CONTACT_FLOW_DISCONNECT` \| `OTHER` \| `EXPIRED` \| `API`
|
10143
10290
|
# @return [Array<String>]
|
10144
10291
|
#
|
10292
|
+
# @!attribute [rw] negate
|
10293
|
+
# The flag to use to filter on requested metric filter values or to
|
10294
|
+
# not filter on requested metric filter values. By default the negate
|
10295
|
+
# is `false`, which indicates to filter on the requested metric
|
10296
|
+
# filter.
|
10297
|
+
# @return [Boolean]
|
10298
|
+
#
|
10145
10299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricFilterV2 AWS API Documentation
|
10146
10300
|
#
|
10147
10301
|
class MetricFilterV2 < Struct.new(
|
10148
10302
|
:metric_filter_key,
|
10149
|
-
:metric_filter_values
|
10303
|
+
:metric_filter_values,
|
10304
|
+
:negate)
|
10305
|
+
SENSITIVE = []
|
10306
|
+
include Aws::Structure
|
10307
|
+
end
|
10308
|
+
|
10309
|
+
# The interval period with the start and end time for the metrics.
|
10310
|
+
#
|
10311
|
+
# @!attribute [rw] interval
|
10312
|
+
# The interval period provided in the API request.
|
10313
|
+
# @return [String]
|
10314
|
+
#
|
10315
|
+
# @!attribute [rw] start_time
|
10316
|
+
# The timestamp, in UNIX Epoch time format. Start time is based on the
|
10317
|
+
# interval period selected.
|
10318
|
+
# @return [Time]
|
10319
|
+
#
|
10320
|
+
# @!attribute [rw] end_time
|
10321
|
+
# The timestamp, in UNIX Epoch time format. End time is based on the
|
10322
|
+
# interval period selected. For example, If `IntervalPeriod` is
|
10323
|
+
# selected `THIRTY_MIN`, `StartTime` and `EndTime` in the API request
|
10324
|
+
# differs by 1 day, then 48 results are returned in the response. Each
|
10325
|
+
# result is aggregated by the 30 minutes period, with each `StartTime`
|
10326
|
+
# and `EndTime` differing by 30 minutes.
|
10327
|
+
# @return [Time]
|
10328
|
+
#
|
10329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricInterval AWS API Documentation
|
10330
|
+
#
|
10331
|
+
class MetricInterval < Struct.new(
|
10332
|
+
:interval,
|
10333
|
+
:start_time,
|
10334
|
+
:end_time)
|
10150
10335
|
SENSITIVE = []
|
10151
10336
|
include Aws::Structure
|
10152
10337
|
end
|
@@ -10157,6 +10342,10 @@ module Aws::Connect
|
|
10157
10342
|
# The dimension for the metrics.
|
10158
10343
|
# @return [Hash<String,String>]
|
10159
10344
|
#
|
10345
|
+
# @!attribute [rw] metric_interval
|
10346
|
+
# The interval period with the start and end time for the metrics.
|
10347
|
+
# @return [Types::MetricInterval]
|
10348
|
+
#
|
10160
10349
|
# @!attribute [rw] collections
|
10161
10350
|
# The set of metrics.
|
10162
10351
|
# @return [Array<Types::MetricDataV2>]
|
@@ -10165,6 +10354,7 @@ module Aws::Connect
|
|
10165
10354
|
#
|
10166
10355
|
class MetricResultV2 < Struct.new(
|
10167
10356
|
:dimensions,
|
10357
|
+
:metric_interval,
|
10168
10358
|
:collections)
|
10169
10359
|
SENSITIVE = []
|
10170
10360
|
include Aws::Structure
|
@@ -10556,15 +10746,15 @@ module Aws::Connect
|
|
10556
10746
|
|
10557
10747
|
# The status of the phone number.
|
10558
10748
|
#
|
10559
|
-
# * `CLAIMED` means the previous [
|
10749
|
+
# * `CLAIMED` means the previous [ClaimPhoneNumber][1] or
|
10560
10750
|
# [UpdatePhoneNumber][2] operation succeeded.
|
10561
10751
|
#
|
10562
|
-
# * `IN_PROGRESS` means a [
|
10563
|
-
# [
|
10564
|
-
# yet completed. You can call [DescribePhoneNumber][
|
10565
|
-
# to verify if the previous operation has completed.
|
10752
|
+
# * `IN_PROGRESS` means a [ClaimPhoneNumber][1], [UpdatePhoneNumber][2],
|
10753
|
+
# or [UpdatePhoneNumberMetadata][3] operation is still in progress and
|
10754
|
+
# has not yet completed. You can call [DescribePhoneNumber][4] at a
|
10755
|
+
# later time to verify if the previous operation has completed.
|
10566
10756
|
#
|
10567
|
-
# * `FAILED` indicates that the previous [
|
10757
|
+
# * `FAILED` indicates that the previous [ClaimPhoneNumber][1] or
|
10568
10758
|
# [UpdatePhoneNumber][2] operation has failed. It will include a
|
10569
10759
|
# message indicating the failure reason. A common reason for a failure
|
10570
10760
|
# may be that the `TargetArn` value you are claiming or updating a
|
@@ -10576,9 +10766,10 @@ module Aws::Connect
|
|
10576
10766
|
#
|
10577
10767
|
#
|
10578
10768
|
#
|
10579
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
10769
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
|
10580
10770
|
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html
|
10581
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
10771
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html
|
10772
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
10582
10773
|
#
|
10583
10774
|
# @!attribute [rw] status
|
10584
10775
|
# The status.
|
@@ -12535,6 +12726,11 @@ module Aws::Connect
|
|
12535
12726
|
# The identifier of the Amazon Connect instance. You can [find the
|
12536
12727
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12537
12728
|
#
|
12729
|
+
# <note markdown="1"> InstanceID is a required field. The "Required: No" below is
|
12730
|
+
# incorrect.
|
12731
|
+
#
|
12732
|
+
# </note>
|
12733
|
+
#
|
12538
12734
|
#
|
12539
12735
|
#
|
12540
12736
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
@@ -12925,7 +13121,8 @@ module Aws::Connect
|
|
12925
13121
|
include Aws::Structure
|
12926
13122
|
end
|
12927
13123
|
|
12928
|
-
# The distribution
|
13124
|
+
# The distribution that determines which Amazon Web Services Regions
|
13125
|
+
# should be used to sign in agents in to both the instance and its
|
12929
13126
|
# replica(s).
|
12930
13127
|
#
|
12931
13128
|
# @!attribute [rw] distributions
|
@@ -13413,7 +13610,10 @@ module Aws::Connect
|
|
13413
13610
|
# @return [String]
|
13414
13611
|
#
|
13415
13612
|
# @!attribute [rw] previous_contact_id
|
13416
|
-
# The identifier of the previous chat, voice, or task contact.
|
13613
|
+
# The identifier of the previous chat, voice, or task contact. Any
|
13614
|
+
# updates to user-defined attributes to task contacts linked using the
|
13615
|
+
# same `PreviousContactID` will affect every contact in the chain.
|
13616
|
+
# There can be a maximum of 12 linked task contacts in a chain.
|
13417
13617
|
# @return [String]
|
13418
13618
|
#
|
13419
13619
|
# @!attribute [rw] contact_flow_id
|
@@ -13444,7 +13644,10 @@ module Aws::Connect
|
|
13444
13644
|
#
|
13445
13645
|
# @!attribute [rw] references
|
13446
13646
|
# A formatted URL that is shown to an agent in the Contact Control
|
13447
|
-
# Panel (CCP).
|
13647
|
+
# Panel (CCP). Tasks can have the following reference types at the
|
13648
|
+
# time of creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \|
|
13649
|
+
# `EMAIL`. `ATTACHMENT` is not a supported reference type during task
|
13650
|
+
# creation.
|
13448
13651
|
# @return [Hash<String,Types::Reference>]
|
13449
13652
|
#
|
13450
13653
|
# @!attribute [rw] description
|
@@ -13473,15 +13676,34 @@ module Aws::Connect
|
|
13473
13676
|
# @return [Time]
|
13474
13677
|
#
|
13475
13678
|
# @!attribute [rw] task_template_id
|
13476
|
-
# A unique identifier for the task template.
|
13679
|
+
# A unique identifier for the task template. For more information
|
13680
|
+
# about task templates, see [Create task templates][1] in the *Amazon
|
13681
|
+
# Connect Administrator Guide*.
|
13682
|
+
#
|
13683
|
+
#
|
13684
|
+
#
|
13685
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html
|
13477
13686
|
# @return [String]
|
13478
13687
|
#
|
13479
13688
|
# @!attribute [rw] quick_connect_id
|
13480
|
-
# The identifier for the quick connect.
|
13689
|
+
# The identifier for the quick connect. Tasks that are created by
|
13690
|
+
# using `QuickConnectId` will use the flow that is defined on agent or
|
13691
|
+
# queue quick connect. For more information about quick connects, see
|
13692
|
+
# [Create quick connects][1].
|
13693
|
+
#
|
13694
|
+
#
|
13695
|
+
#
|
13696
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html
|
13481
13697
|
# @return [String]
|
13482
13698
|
#
|
13483
13699
|
# @!attribute [rw] related_contact_id
|
13484
|
-
# The contactId that is [related][1] to this contact.
|
13700
|
+
# The contactId that is [related][1] to this contact. Linking tasks
|
13701
|
+
# together by using `RelatedContactID` copies over contact attributes
|
13702
|
+
# from the related task contact to the new task contact. All updates
|
13703
|
+
# to user-defined attributes in the new task contact are limited to
|
13704
|
+
# the individual contact ID, unlike what happens when tasks are linked
|
13705
|
+
# by using `PreviousContactID`. There are no limits to the number of
|
13706
|
+
# contacts that can be linked by using `RelatedContactId`.
|
13485
13707
|
#
|
13486
13708
|
#
|
13487
13709
|
#
|
@@ -14140,14 +14362,14 @@ module Aws::Connect
|
|
14140
14362
|
# [DeleteTrafficDistributionGroup][2] operation has failed.
|
14141
14363
|
#
|
14142
14364
|
# * `UPDATE_IN_PROGRESS` means the previous
|
14143
|
-
# [
|
14144
|
-
#
|
14365
|
+
# [UpdateTrafficDistribution][3] operation is still in progress and
|
14366
|
+
# has not yet completed.
|
14145
14367
|
#
|
14146
14368
|
#
|
14147
14369
|
#
|
14148
14370
|
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html
|
14149
14371
|
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html
|
14150
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
14372
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html
|
14151
14373
|
# @return [String]
|
14152
14374
|
#
|
14153
14375
|
# @!attribute [rw] tags
|
@@ -14163,18 +14385,13 @@ module Aws::Connect
|
|
14163
14385
|
# default traffic distribution group is deleted as part of the process
|
14164
14386
|
# for deleting a replica.
|
14165
14387
|
#
|
14166
|
-
# <note markdown="1">
|
14167
|
-
# `TrafficDistributionGroup
|
14168
|
-
#
|
14169
|
-
# `
|
14170
|
-
#
|
14171
|
-
# is returned.
|
14388
|
+
# <note markdown="1"> The `SignInConfig` distribution is available only on the default
|
14389
|
+
# `TrafficDistributionGroup`. If you call `UpdateTrafficDistribution`
|
14390
|
+
# with a modified `SignInConfig` and a non-default
|
14391
|
+
# `TrafficDistributionGroup`, an `InvalidRequestException` is
|
14392
|
+
# returned.
|
14172
14393
|
#
|
14173
14394
|
# </note>
|
14174
|
-
#
|
14175
|
-
#
|
14176
|
-
#
|
14177
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html
|
14178
14395
|
# @return [Boolean]
|
14179
14396
|
#
|
14180
14397
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TrafficDistributionGroup AWS API Documentation
|
@@ -14509,8 +14726,10 @@ module Aws::Connect
|
|
14509
14726
|
# @return [String]
|
14510
14727
|
#
|
14511
14728
|
# @!attribute [rw] content
|
14512
|
-
# The JSON string that represents
|
14513
|
-
# [Example
|
14729
|
+
# The JSON string that represents the content of the flow. For an
|
14730
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
14731
|
+
#
|
14732
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
14514
14733
|
#
|
14515
14734
|
#
|
14516
14735
|
#
|
@@ -14586,7 +14805,12 @@ module Aws::Connect
|
|
14586
14805
|
# @return [String]
|
14587
14806
|
#
|
14588
14807
|
# @!attribute [rw] content
|
14589
|
-
# The content of the flow
|
14808
|
+
# The JSON string that represents the content of the flow. For an
|
14809
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
14810
|
+
#
|
14811
|
+
#
|
14812
|
+
#
|
14813
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
14590
14814
|
# @return [String]
|
14591
14815
|
#
|
14592
14816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContentRequest AWS API Documentation
|
@@ -15002,6 +15226,38 @@ module Aws::Connect
|
|
15002
15226
|
#
|
15003
15227
|
class UpdateParticipantRoleConfigResponse < Aws::EmptyStructure; end
|
15004
15228
|
|
15229
|
+
# @!attribute [rw] phone_number_id
|
15230
|
+
# The Amazon Resource Name (ARN) or resource ID of the phone number.
|
15231
|
+
# @return [String]
|
15232
|
+
#
|
15233
|
+
# @!attribute [rw] phone_number_description
|
15234
|
+
# The description of the phone number.
|
15235
|
+
# @return [String]
|
15236
|
+
#
|
15237
|
+
# @!attribute [rw] client_token
|
15238
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
15239
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
15240
|
+
# SDK populates this field. For more information about idempotency,
|
15241
|
+
# see [Making retries safe with idempotent APIs][1].
|
15242
|
+
#
|
15243
|
+
# **A suitable default value is auto-generated.** You should normally
|
15244
|
+
# not need to pass this option.
|
15245
|
+
#
|
15246
|
+
#
|
15247
|
+
#
|
15248
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
15249
|
+
# @return [String]
|
15250
|
+
#
|
15251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberMetadataRequest AWS API Documentation
|
15252
|
+
#
|
15253
|
+
class UpdatePhoneNumberMetadataRequest < Struct.new(
|
15254
|
+
:phone_number_id,
|
15255
|
+
:phone_number_description,
|
15256
|
+
:client_token)
|
15257
|
+
SENSITIVE = []
|
15258
|
+
include Aws::Structure
|
15259
|
+
end
|
15260
|
+
|
15005
15261
|
# @!attribute [rw] phone_number_id
|
15006
15262
|
# A unique identifier for the phone number.
|
15007
15263
|
# @return [String]
|
@@ -15706,7 +15962,8 @@ module Aws::Connect
|
|
15706
15962
|
# @return [Types::TelephonyConfig]
|
15707
15963
|
#
|
15708
15964
|
# @!attribute [rw] sign_in_config
|
15709
|
-
# The distribution
|
15965
|
+
# The distribution that determines which Amazon Web Services Regions
|
15966
|
+
# should be used to sign in agents in to both the instance and its
|
15710
15967
|
# replica(s).
|
15711
15968
|
# @return [Types::SignInConfig]
|
15712
15969
|
#
|
data/lib/aws-sdk-connect.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.130.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-10-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|