aws-sdk-connect 1.128.0 → 1.130.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 +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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ea0017a55ed2e3aaace982671f7b021bba3ce1382da6500a4031f91673593ba8
|
4
|
+
data.tar.gz: 031742ed5742c7a2173bc5f35aa14feb6d190175aa2f0ef6773d660418a51c06
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 323c2323d8f42ef79d96d57b79dc146b1006c726bb4bb8ae360a7038707ca1d859f1e53fd556925cfb9f0fb26c1bf3d09707a10e0139d17f202473da5e87c337
|
7
|
+
data.tar.gz: 32e7852c07d1ef57a84282d5befe452e86d4295ceb0e4734c3570391c9c95d709ac2f75dd98618acfb3eb2ea714ae2ddb42f353b7f879958dab7ed569abb7ac0
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.130.0 (2023-10-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for updating phone number metadata, such as phone number description.
|
8
|
+
|
9
|
+
1.129.0 (2023-10-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - GetMetricDataV2 API: Update to include new metrics CONTACTS_RESOLVED_IN_X , AVG_HOLD_TIME_ALL_CONTACTS , AVG_RESOLUTION_TIME , ABANDONMENT_RATE , AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS with added features: Interval Period, TimeZone, Negate MetricFilters, Extended date time range.
|
13
|
+
|
4
14
|
1.128.0 (2023-09-27)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.130.0
|
@@ -1111,7 +1111,14 @@ module Aws::Connect
|
|
1111
1111
|
# The description of the flow.
|
1112
1112
|
#
|
1113
1113
|
# @option params [required, String] :content
|
1114
|
-
# The content of the flow.
|
1114
|
+
# The JSON string that represents the content of the flow. For an
|
1115
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1116
|
+
#
|
1117
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
1118
|
+
#
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1115
1122
|
#
|
1116
1123
|
# @option params [Hash<String,String>] :tags
|
1117
1124
|
# The tags used to organize, track, or control access for this resource.
|
@@ -1167,7 +1174,12 @@ module Aws::Connect
|
|
1167
1174
|
# The description of the flow module.
|
1168
1175
|
#
|
1169
1176
|
# @option params [required, String] :content
|
1170
|
-
# The content of the flow
|
1177
|
+
# The JSON string that represents the content of the flow. For an
|
1178
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
1179
|
+
#
|
1180
|
+
#
|
1181
|
+
#
|
1182
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
1171
1183
|
#
|
1172
1184
|
# @option params [Hash<String,String>] :tags
|
1173
1185
|
# The tags used to organize, track, or control access for this resource.
|
@@ -2076,9 +2088,6 @@ module Aws::Connect
|
|
2076
2088
|
req.send_request(options)
|
2077
2089
|
end
|
2078
2090
|
|
2079
|
-
# This API is in preview release for Amazon Connect and is subject to
|
2080
|
-
# change.
|
2081
|
-
#
|
2082
2091
|
# Creates a security profile.
|
2083
2092
|
#
|
2084
2093
|
# @option params [required, String] :security_profile_name
|
@@ -2290,7 +2299,7 @@ module Aws::Connect
|
|
2290
2299
|
# Creates a traffic distribution group given an Amazon Connect instance
|
2291
2300
|
# that has been replicated.
|
2292
2301
|
#
|
2293
|
-
# <note markdown="1">
|
2302
|
+
# <note markdown="1"> The `SignInConfig` distribution is available only on a default
|
2294
2303
|
# `TrafficDistributionGroup` (see the `IsDefault` parameter in the
|
2295
2304
|
# [TrafficDistributionGroup][1] data type). If you call
|
2296
2305
|
# `UpdateTrafficDistribution` with a modified `SignInConfig` and a
|
@@ -2421,13 +2430,19 @@ module Aws::Connect
|
|
2421
2430
|
|
2422
2431
|
# Creates a user account for the specified Amazon Connect instance.
|
2423
2432
|
#
|
2433
|
+
# Certain [UserIdentityInfo][1] parameters are required in some
|
2434
|
+
# situations. For example, `Email` is required if you are using SAML for
|
2435
|
+
# identity management. `FirstName` and `LastName` are required if you
|
2436
|
+
# are using Amazon Connect or SAML for identity management.
|
2437
|
+
#
|
2424
2438
|
# For information about how to create user accounts using the Amazon
|
2425
|
-
# Connect console, see [Add Users][
|
2439
|
+
# Connect console, see [Add Users][2] in the *Amazon Connect
|
2426
2440
|
# Administrator Guide*.
|
2427
2441
|
#
|
2428
2442
|
#
|
2429
2443
|
#
|
2430
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
2444
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html
|
2445
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html
|
2431
2446
|
#
|
2432
2447
|
# @option params [required, String] :username
|
2433
2448
|
# The user name for the account. For instances not using SAML for
|
@@ -3268,9 +3283,6 @@ module Aws::Connect
|
|
3268
3283
|
req.send_request(options)
|
3269
3284
|
end
|
3270
3285
|
|
3271
|
-
# This API is in preview release for Amazon Connect and is subject to
|
3272
|
-
# change.
|
3273
|
-
#
|
3274
3286
|
# Deletes a security profile.
|
3275
3287
|
#
|
3276
3288
|
# @option params [required, String] :instance_id
|
@@ -4474,9 +4486,6 @@ module Aws::Connect
|
|
4474
4486
|
req.send_request(options)
|
4475
4487
|
end
|
4476
4488
|
|
4477
|
-
# This API is in preview release for Amazon Connect and is subject to
|
4478
|
-
# change.
|
4479
|
-
#
|
4480
4489
|
# Gets basic information about the security profle.
|
4481
4490
|
#
|
4482
4491
|
# @option params [required, String] :security_profile_id
|
@@ -5659,7 +5668,13 @@ module Aws::Connect
|
|
5659
5668
|
req.send_request(options)
|
5660
5669
|
end
|
5661
5670
|
|
5662
|
-
# Retrieves a token for
|
5671
|
+
# Supports SAML sign-in for Amazon Connect. Retrieves a token for
|
5672
|
+
# federation. The token is for the Amazon Connect user which corresponds
|
5673
|
+
# to the IAM credentials that were used to invoke this action.
|
5674
|
+
#
|
5675
|
+
# For more information about how SAML sign-in works in Amazon Connect,
|
5676
|
+
# see [Configure SAML with IAM for Amazon Connect in the *Amazon Connect
|
5677
|
+
# Administrator Guide*.][1]
|
5663
5678
|
#
|
5664
5679
|
# <note markdown="1"> This API doesn't support root users. If you try to invoke
|
5665
5680
|
# GetFederationToken with root credentials, an error message similar to
|
@@ -5670,6 +5685,10 @@ module Aws::Connect
|
|
5670
5685
|
#
|
5671
5686
|
# </note>
|
5672
5687
|
#
|
5688
|
+
#
|
5689
|
+
#
|
5690
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html
|
5691
|
+
#
|
5673
5692
|
# @option params [required, String] :instance_id
|
5674
5693
|
# The identifier of the Amazon Connect instance. You can [find the
|
5675
5694
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -5716,9 +5735,21 @@ module Aws::Connect
|
|
5716
5735
|
# For a description of each historical metric, see [Historical Metrics
|
5717
5736
|
# Definitions][1] in the *Amazon Connect Administrator Guide*.
|
5718
5737
|
#
|
5738
|
+
# <note markdown="1"> We recommend using the [GetMetricDataV2][2] API. It provides more
|
5739
|
+
# flexibility, features, and the ability to query longer time ranges
|
5740
|
+
# than `GetMetricData`. Use it to retrieve historical agent and contact
|
5741
|
+
# metrics for the last 3 months, at varying intervals. You can also use
|
5742
|
+
# it to build custom dashboards to measure historical queue and agent
|
5743
|
+
# performance. For example, you can track the number of incoming
|
5744
|
+
# contacts for the last 7 days, with data split by day, to see how
|
5745
|
+
# contact volume changed per day of the week.
|
5746
|
+
#
|
5747
|
+
# </note>
|
5748
|
+
#
|
5719
5749
|
#
|
5720
5750
|
#
|
5721
5751
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
5752
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html
|
5722
5753
|
#
|
5723
5754
|
# @option params [required, String] :instance_id
|
5724
5755
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -6012,8 +6043,8 @@ module Aws::Connect
|
|
6012
6043
|
# previous version of this API. It has new metrics, offers filtering at
|
6013
6044
|
# a metric level, and offers the ability to filter and group data by
|
6014
6045
|
# channels, queues, routing profiles, agents, and agent hierarchy
|
6015
|
-
# levels. It can retrieve historical data for the last
|
6016
|
-
#
|
6046
|
+
# levels. It can retrieve historical data for the last 3 months, at
|
6047
|
+
# varying intervals.
|
6017
6048
|
#
|
6018
6049
|
# For a description of the historical metrics that are supported by
|
6019
6050
|
# `GetMetricDataV2` and `GetMetricData`, see [Historical metrics
|
@@ -6031,10 +6062,10 @@ module Aws::Connect
|
|
6031
6062
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
6032
6063
|
# The timestamp, in UNIX Epoch time format, at which to start the
|
6033
6064
|
# reporting interval for the retrieval of historical metrics data. The
|
6034
|
-
# time must be before the end time timestamp. The
|
6035
|
-
#
|
6036
|
-
#
|
6037
|
-
#
|
6065
|
+
# time must be before the end time timestamp. The start and end time
|
6066
|
+
# depends on the `IntervalPeriod` selected. By default the time range
|
6067
|
+
# between start and end time is 35 days. Historical metrics are
|
6068
|
+
# available for 3 months.
|
6038
6069
|
#
|
6039
6070
|
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
6040
6071
|
# The timestamp, in UNIX Epoch time format, at which to end the
|
@@ -6042,8 +6073,41 @@ module Aws::Connect
|
|
6042
6073
|
# time must be later than the start time timestamp. It cannot be later
|
6043
6074
|
# than the current timestamp.
|
6044
6075
|
#
|
6045
|
-
#
|
6046
|
-
#
|
6076
|
+
# @option params [Types::IntervalDetails] :interval
|
6077
|
+
# The interval period and timezone to apply to returned metrics.
|
6078
|
+
#
|
6079
|
+
# * `IntervalPeriod`: An aggregated grouping applied to request metrics.
|
6080
|
+
# Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \| `THIRTY_MIN` \|
|
6081
|
+
# `HOUR` \| `DAY` \| `WEEK` \| `TOTAL`.
|
6082
|
+
#
|
6083
|
+
# For example, if `IntervalPeriod` is selected `THIRTY_MIN`,
|
6084
|
+
# `StartTime` and `EndTime` differs by 1 day, then Amazon Connect
|
6085
|
+
# returns 48 results in the response. Each result is aggregated by the
|
6086
|
+
# THIRTY\_MIN period. By default Amazon Connect aggregates results
|
6087
|
+
# based on the `TOTAL` interval period.
|
6088
|
+
#
|
6089
|
+
# The following list describes restrictions on `StartTime` and
|
6090
|
+
# `EndTime` based on which `IntervalPeriod` is requested.
|
6091
|
+
#
|
6092
|
+
# * `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime`
|
6093
|
+
# must be less than 3 days.
|
6094
|
+
#
|
6095
|
+
# * `THIRTY_MIN`: The difference between `StartTime` and `EndTime`
|
6096
|
+
# must be less than 3 days.
|
6097
|
+
#
|
6098
|
+
# * `HOUR`: The difference between `StartTime` and `EndTime` must be
|
6099
|
+
# less than 3 days.
|
6100
|
+
#
|
6101
|
+
# * `DAY`: The difference between `StartTime` and `EndTime` must be
|
6102
|
+
# less than 35 days.
|
6103
|
+
#
|
6104
|
+
# * `WEEK`: The difference between `StartTime` and `EndTime` must be
|
6105
|
+
# less than 35 days.
|
6106
|
+
#
|
6107
|
+
# * `TOTAL`: The difference between `StartTime` and `EndTime` must be
|
6108
|
+
# less than 35 days.
|
6109
|
+
#
|
6110
|
+
# * `TimeZone`: The timezone applied to requested metrics.
|
6047
6111
|
#
|
6048
6112
|
# @option params [required, Array<Types::FilterV2>] :filters
|
6049
6113
|
# The filters to apply to returned metrics. You can filter on the
|
@@ -6110,6 +6174,13 @@ module Aws::Connect
|
|
6110
6174
|
# description of each metric, see [Historical metrics definitions][1] in
|
6111
6175
|
# the *Amazon Connect Administrator's Guide*.
|
6112
6176
|
#
|
6177
|
+
# ABANDONMENT\_RATE
|
6178
|
+
#
|
6179
|
+
# : Unit: Percent
|
6180
|
+
#
|
6181
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6182
|
+
# Agent Hierarchy
|
6183
|
+
#
|
6113
6184
|
# AGENT\_ADHERENT\_TIME
|
6114
6185
|
#
|
6115
6186
|
# : This metric is available only in Amazon Web Services Regions where
|
@@ -6127,6 +6198,16 @@ module Aws::Connect
|
|
6127
6198
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6128
6199
|
# Agent Hierarchy
|
6129
6200
|
#
|
6201
|
+
# AGENT\_NON\_RESPONSE\_WITHOUT\_CUSTOMER\_ABANDONS
|
6202
|
+
#
|
6203
|
+
# : Unit: Count
|
6204
|
+
#
|
6205
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6206
|
+
# Agent Hierarchy
|
6207
|
+
#
|
6208
|
+
# Data for this metric is available starting from October 1, 2023
|
6209
|
+
# 0:00:00 GMT.
|
6210
|
+
#
|
6130
6211
|
# AGENT\_OCCUPANCY
|
6131
6212
|
#
|
6132
6213
|
# : Unit: Percentage
|
@@ -6182,16 +6263,10 @@ module Aws::Connect
|
|
6182
6263
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6183
6264
|
# Agent Hierarchy
|
6184
6265
|
#
|
6185
|
-
#
|
6186
|
-
#
|
6187
|
-
# : Unit: Seconds
|
6188
|
-
#
|
6189
|
-
# Valid metric filter key: `INITIATION_METHOD`. For now, this metric
|
6190
|
-
# only supports the following as `INITIATION_METHOD`: `INBOUND` \|
|
6191
|
-
# `OUTBOUND` \| `CALLBACK` \| `API`
|
6266
|
+
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
|
6267
|
+
# metric.
|
6192
6268
|
#
|
6193
|
-
#
|
6194
|
-
# Agent Hierarchy
|
6269
|
+
# </note>
|
6195
6270
|
#
|
6196
6271
|
# AVG\_CONTACT\_DURATION
|
6197
6272
|
#
|
@@ -6243,6 +6318,13 @@ module Aws::Connect
|
|
6243
6318
|
#
|
6244
6319
|
# </note>
|
6245
6320
|
#
|
6321
|
+
# AVG\_HOLD\_TIME\_ALL\_CONTACTS
|
6322
|
+
#
|
6323
|
+
# : Unit: Seconds
|
6324
|
+
#
|
6325
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6326
|
+
# Agent Hierarchy
|
6327
|
+
#
|
6246
6328
|
# AVG\_HOLDS
|
6247
6329
|
#
|
6248
6330
|
# : Unit: Count
|
@@ -6313,6 +6395,12 @@ module Aws::Connect
|
|
6313
6395
|
#
|
6314
6396
|
# </note>
|
6315
6397
|
#
|
6398
|
+
# AVG\_RESOLUTION\_TIME
|
6399
|
+
#
|
6400
|
+
# : Unit: Seconds
|
6401
|
+
#
|
6402
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6403
|
+
#
|
6316
6404
|
# AVG\_TALK\_TIME
|
6317
6405
|
#
|
6318
6406
|
# : This metric is available only for contacts analyzed by Contact Lens
|
@@ -6390,6 +6478,16 @@ module Aws::Connect
|
|
6390
6478
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6391
6479
|
# Agent Hierarchy
|
6392
6480
|
#
|
6481
|
+
# CONTACTS\_RESOLVED\_IN\_X
|
6482
|
+
#
|
6483
|
+
# : Unit: Count
|
6484
|
+
#
|
6485
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
6486
|
+
#
|
6487
|
+
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
6488
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
6489
|
+
# `LT` (for "Less than").
|
6490
|
+
#
|
6393
6491
|
# CONTACTS\_TRANSFERRED\_OUT
|
6394
6492
|
#
|
6395
6493
|
# : Unit: Count
|
@@ -6494,6 +6592,10 @@ module Aws::Connect
|
|
6494
6592
|
# resource_arn: "ARN", # required
|
6495
6593
|
# start_time: Time.now, # required
|
6496
6594
|
# end_time: Time.now, # required
|
6595
|
+
# interval: {
|
6596
|
+
# time_zone: "String",
|
6597
|
+
# interval_period: "FIFTEEN_MIN", # accepts FIFTEEN_MIN, THIRTY_MIN, HOUR, DAY, WEEK, TOTAL
|
6598
|
+
# },
|
6497
6599
|
# filters: [ # required
|
6498
6600
|
# {
|
6499
6601
|
# filter_key: "ResourceArnOrId",
|
@@ -6514,6 +6616,7 @@ module Aws::Connect
|
|
6514
6616
|
# {
|
6515
6617
|
# metric_filter_key: "String",
|
6516
6618
|
# metric_filter_values: ["String"],
|
6619
|
+
# negate: false,
|
6517
6620
|
# },
|
6518
6621
|
# ],
|
6519
6622
|
# },
|
@@ -6528,6 +6631,9 @@ module Aws::Connect
|
|
6528
6631
|
# resp.metric_results #=> Array
|
6529
6632
|
# resp.metric_results[0].dimensions #=> Hash
|
6530
6633
|
# resp.metric_results[0].dimensions["DimensionsV2Key"] #=> String
|
6634
|
+
# resp.metric_results[0].metric_interval.interval #=> String, one of "FIFTEEN_MIN", "THIRTY_MIN", "HOUR", "DAY", "WEEK", "TOTAL"
|
6635
|
+
# resp.metric_results[0].metric_interval.start_time #=> Time
|
6636
|
+
# resp.metric_results[0].metric_interval.end_time #=> Time
|
6531
6637
|
# resp.metric_results[0].collections #=> Array
|
6532
6638
|
# resp.metric_results[0].collections[0].metric.name #=> String
|
6533
6639
|
# resp.metric_results[0].collections[0].metric.threshold #=> Array
|
@@ -6537,6 +6643,7 @@ module Aws::Connect
|
|
6537
6643
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
|
6538
6644
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
|
6539
6645
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values[0] #=> String
|
6646
|
+
# resp.metric_results[0].collections[0].metric.metric_filters[0].negate #=> Boolean
|
6540
6647
|
# resp.metric_results[0].collections[0].value #=> Float
|
6541
6648
|
#
|
6542
6649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2 AWS API Documentation
|
@@ -8421,9 +8528,6 @@ module Aws::Connect
|
|
8421
8528
|
req.send_request(options)
|
8422
8529
|
end
|
8423
8530
|
|
8424
|
-
# This API is in preview release for Amazon Connect and is subject to
|
8425
|
-
# change.
|
8426
|
-
#
|
8427
8531
|
# Lists the permissions granted to a security profile.
|
8428
8532
|
#
|
8429
8533
|
# @option params [required, String] :security_profile_id
|
@@ -10101,6 +10205,11 @@ module Aws::Connect
|
|
10101
10205
|
# The identifier of the Amazon Connect instance. You can [find the
|
10102
10206
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
10103
10207
|
#
|
10208
|
+
# <note markdown="1"> InstanceID is a required field. The "Required: No" below is
|
10209
|
+
# incorrect.
|
10210
|
+
#
|
10211
|
+
# </note>
|
10212
|
+
#
|
10104
10213
|
#
|
10105
10214
|
#
|
10106
10215
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
@@ -10794,7 +10903,52 @@ module Aws::Connect
|
|
10794
10903
|
req.send_request(options)
|
10795
10904
|
end
|
10796
10905
|
|
10797
|
-
# Initiates a flow to start a new task.
|
10906
|
+
# Initiates a flow to start a new task contact. For more information
|
10907
|
+
# about task contacts, see [Concepts: Tasks in Amazon Connect][1] in the
|
10908
|
+
# *Amazon Connect Administrator Guide*.
|
10909
|
+
#
|
10910
|
+
# When using `PreviousContactId` and `RelatedContactId` input
|
10911
|
+
# parameters, note the following:
|
10912
|
+
#
|
10913
|
+
# * `PreviousContactId`
|
10914
|
+
#
|
10915
|
+
# * Any updates to user-defined task contact attributes on any contact
|
10916
|
+
# linked through the same `PreviousContactId` will affect every
|
10917
|
+
# contact in the chain.
|
10918
|
+
#
|
10919
|
+
# * There can be a maximum of 12 linked task contacts in a chain. That
|
10920
|
+
# is, 12 task contacts can be created that share the same
|
10921
|
+
# `PreviousContactId`.
|
10922
|
+
#
|
10923
|
+
# * `RelatedContactId`
|
10924
|
+
#
|
10925
|
+
# * Copies contact attributes from the related task contact to the new
|
10926
|
+
# contact.
|
10927
|
+
#
|
10928
|
+
# * Any update on attributes in a new task contact does not update
|
10929
|
+
# attributes on previous contact.
|
10930
|
+
#
|
10931
|
+
# * There’s no limit on the number of task contacts that can be
|
10932
|
+
# created that use the same `RelatedContactId`.
|
10933
|
+
#
|
10934
|
+
# In addition, when calling StartTaskContact include only one of these
|
10935
|
+
# parameters: `ContactFlowID`, `QuickConnectID`, or `TaskTemplateID`.
|
10936
|
+
# Only one parameter is required as long as the task template has a flow
|
10937
|
+
# configured to run it. If more than one parameter is specified, or only
|
10938
|
+
# the `TaskTemplateID` is specified but it does not have a flow
|
10939
|
+
# configured, the request returns an error because Amazon Connect cannot
|
10940
|
+
# identify the unique flow to run when the task is created.
|
10941
|
+
#
|
10942
|
+
# A `ServiceQuotaExceededException` occurs when the number of open tasks
|
10943
|
+
# exceeds the active tasks quota or there are already 12 tasks
|
10944
|
+
# referencing the same `PreviousContactId`. For more information about
|
10945
|
+
# service quotas for task contacts, see [Amazon Connect service
|
10946
|
+
# quotas][2] in the *Amazon Connect Administrator Guide*.
|
10947
|
+
#
|
10948
|
+
#
|
10949
|
+
#
|
10950
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html
|
10951
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
10798
10952
|
#
|
10799
10953
|
# @option params [required, String] :instance_id
|
10800
10954
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -10805,7 +10959,10 @@ module Aws::Connect
|
|
10805
10959
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
10806
10960
|
#
|
10807
10961
|
# @option params [String] :previous_contact_id
|
10808
|
-
# The identifier of the previous chat, voice, or task contact.
|
10962
|
+
# The identifier of the previous chat, voice, or task contact. Any
|
10963
|
+
# updates to user-defined attributes to task contacts linked using the
|
10964
|
+
# same `PreviousContactID` will affect every contact in the chain. There
|
10965
|
+
# can be a maximum of 12 linked task contacts in a chain.
|
10809
10966
|
#
|
10810
10967
|
# @option params [String] :contact_flow_id
|
10811
10968
|
# The identifier of the flow for initiating the tasks. To see the
|
@@ -10832,7 +10989,9 @@ module Aws::Connect
|
|
10832
10989
|
#
|
10833
10990
|
# @option params [Hash<String,Types::Reference>] :references
|
10834
10991
|
# A formatted URL that is shown to an agent in the Contact Control Panel
|
10835
|
-
# (CCP).
|
10992
|
+
# (CCP). Tasks can have the following reference types at the time of
|
10993
|
+
# creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \| `EMAIL`.
|
10994
|
+
# `ATTACHMENT` is not a supported reference type during task creation.
|
10836
10995
|
#
|
10837
10996
|
# @option params [String] :description
|
10838
10997
|
# A description of the task that is shown to an agent in the Contact
|
@@ -10857,13 +11016,32 @@ module Aws::Connect
|
|
10857
11016
|
# within up to 6 days in future.
|
10858
11017
|
#
|
10859
11018
|
# @option params [String] :task_template_id
|
10860
|
-
# A unique identifier for the task template.
|
11019
|
+
# A unique identifier for the task template. For more information about
|
11020
|
+
# task templates, see [Create task templates][1] in the *Amazon Connect
|
11021
|
+
# Administrator Guide*.
|
11022
|
+
#
|
11023
|
+
#
|
11024
|
+
#
|
11025
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html
|
10861
11026
|
#
|
10862
11027
|
# @option params [String] :quick_connect_id
|
10863
|
-
# The identifier for the quick connect.
|
11028
|
+
# The identifier for the quick connect. Tasks that are created by using
|
11029
|
+
# `QuickConnectId` will use the flow that is defined on agent or queue
|
11030
|
+
# quick connect. For more information about quick connects, see [Create
|
11031
|
+
# quick connects][1].
|
11032
|
+
#
|
11033
|
+
#
|
11034
|
+
#
|
11035
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html
|
10864
11036
|
#
|
10865
11037
|
# @option params [String] :related_contact_id
|
10866
|
-
# The contactId that is [related][1] to this contact.
|
11038
|
+
# The contactId that is [related][1] to this contact. Linking tasks
|
11039
|
+
# together by using `RelatedContactID` copies over contact attributes
|
11040
|
+
# from the related task contact to the new task contact. All updates to
|
11041
|
+
# user-defined attributes in the new task contact are limited to the
|
11042
|
+
# individual contact ID, unlike what happens when tasks are linked by
|
11043
|
+
# using `PreviousContactID`. There are no limits to the number of
|
11044
|
+
# contacts that can be linked by using `RelatedContactId`.
|
10867
11045
|
#
|
10868
11046
|
#
|
10869
11047
|
#
|
@@ -11555,8 +11733,10 @@ module Aws::Connect
|
|
11555
11733
|
# The identifier of the flow.
|
11556
11734
|
#
|
11557
11735
|
# @option params [required, String] :content
|
11558
|
-
# The JSON string that represents
|
11559
|
-
# [Example
|
11736
|
+
# The JSON string that represents the content of the flow. For an
|
11737
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
11738
|
+
#
|
11739
|
+
# Length Constraints: Minimum length of 1. Maximum length of 256000.
|
11560
11740
|
#
|
11561
11741
|
#
|
11562
11742
|
#
|
@@ -11639,7 +11819,12 @@ module Aws::Connect
|
|
11639
11819
|
# The identifier of the flow module.
|
11640
11820
|
#
|
11641
11821
|
# @option params [required, String] :content
|
11642
|
-
# The content of the flow
|
11822
|
+
# The JSON string that represents the content of the flow. For an
|
11823
|
+
# example, see [Example flow in Amazon Connect Flow language][1].
|
11824
|
+
#
|
11825
|
+
#
|
11826
|
+
#
|
11827
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
11643
11828
|
#
|
11644
11829
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
11645
11830
|
#
|
@@ -12239,6 +12424,53 @@ module Aws::Connect
|
|
12239
12424
|
req.send_request(options)
|
12240
12425
|
end
|
12241
12426
|
|
12427
|
+
# Updates a phone number’s metadata.
|
12428
|
+
#
|
12429
|
+
# To verify the status of a previous UpdatePhoneNumberMetadata
|
12430
|
+
# operation, call the [DescribePhoneNumber][1] API.
|
12431
|
+
#
|
12432
|
+
#
|
12433
|
+
#
|
12434
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
12435
|
+
#
|
12436
|
+
# @option params [required, String] :phone_number_id
|
12437
|
+
# The Amazon Resource Name (ARN) or resource ID of the phone number.
|
12438
|
+
#
|
12439
|
+
# @option params [String] :phone_number_description
|
12440
|
+
# The description of the phone number.
|
12441
|
+
#
|
12442
|
+
# @option params [String] :client_token
|
12443
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
12444
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
12445
|
+
# SDK populates this field. For more information about idempotency, see
|
12446
|
+
# [Making retries safe with idempotent APIs][1].
|
12447
|
+
#
|
12448
|
+
# **A suitable default value is auto-generated.** You should normally
|
12449
|
+
# not need to pass this option.**
|
12450
|
+
#
|
12451
|
+
#
|
12452
|
+
#
|
12453
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
12454
|
+
#
|
12455
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12456
|
+
#
|
12457
|
+
# @example Request syntax with placeholder values
|
12458
|
+
#
|
12459
|
+
# resp = client.update_phone_number_metadata({
|
12460
|
+
# phone_number_id: "PhoneNumberId", # required
|
12461
|
+
# phone_number_description: "PhoneNumberDescription",
|
12462
|
+
# client_token: "ClientToken",
|
12463
|
+
# })
|
12464
|
+
#
|
12465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberMetadata AWS API Documentation
|
12466
|
+
#
|
12467
|
+
# @overload update_phone_number_metadata(params = {})
|
12468
|
+
# @param [Hash] params ({})
|
12469
|
+
def update_phone_number_metadata(params = {}, options = {})
|
12470
|
+
req = build_request(:update_phone_number_metadata, params)
|
12471
|
+
req.send_request(options)
|
12472
|
+
end
|
12473
|
+
|
12242
12474
|
# Updates a prompt.
|
12243
12475
|
#
|
12244
12476
|
# @option params [required, String] :instance_id
|
@@ -12904,9 +13136,6 @@ module Aws::Connect
|
|
12904
13136
|
req.send_request(options)
|
12905
13137
|
end
|
12906
13138
|
|
12907
|
-
# This API is in preview release for Amazon Connect and is subject to
|
12908
|
-
# change.
|
12909
|
-
#
|
12910
13139
|
# Updates a security profile.
|
12911
13140
|
#
|
12912
13141
|
# @option params [String] :description
|
@@ -13124,7 +13353,7 @@ module Aws::Connect
|
|
13124
13353
|
# Updates the traffic distribution for a given traffic distribution
|
13125
13354
|
# group.
|
13126
13355
|
#
|
13127
|
-
# <note markdown="1">
|
13356
|
+
# <note markdown="1"> The `SignInConfig` distribution is available only on a default
|
13128
13357
|
# `TrafficDistributionGroup` (see the `IsDefault` parameter in the
|
13129
13358
|
# [TrafficDistributionGroup][1] data type). If you call
|
13130
13359
|
# `UpdateTrafficDistribution` with a modified `SignInConfig` and a
|
@@ -13152,7 +13381,8 @@ module Aws::Connect
|
|
13152
13381
|
# The distribution of traffic between the instance and its replica(s).
|
13153
13382
|
#
|
13154
13383
|
# @option params [Types::SignInConfig] :sign_in_config
|
13155
|
-
# The distribution
|
13384
|
+
# The distribution that determines which Amazon Web Services Regions
|
13385
|
+
# should be used to sign in agents in to both the instance and its
|
13156
13386
|
# replica(s).
|
13157
13387
|
#
|
13158
13388
|
# @option params [Types::AgentConfig] :agent_config
|
@@ -13600,7 +13830,7 @@ module Aws::Connect
|
|
13600
13830
|
params: params,
|
13601
13831
|
config: config)
|
13602
13832
|
context[:gem_name] = 'aws-sdk-connect'
|
13603
|
-
context[:gem_version] = '1.
|
13833
|
+
context[:gem_version] = '1.130.0'
|
13604
13834
|
Seahorse::Client::Request.new(handlers, context)
|
13605
13835
|
end
|
13606
13836
|
|