aws-sdk-connect 1.214.0 → 1.216.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 +227 -47
- data/lib/aws-sdk-connect/client_api.rb +37 -1
- data/lib/aws-sdk-connect/types.rb +164 -19
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +45 -11
- data/sig/types.rbs +30 -3
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f7ed8ace334e08f00b6707940a6769168630f90c2cef75196078549ea97c5860
|
4
|
+
data.tar.gz: 252fd84f609f82043d5da26ae897bfa2048c4484ac2f0d673b75171dc80bc84e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '090afef8ddb9d683196eefab1fe427344cea0604f8aee543950d7d14d82286876991dfcf5358abf9bfbd565afa6392fe4b1fb2584b5ed4fced5feb2277c4eb14'
|
7
|
+
data.tar.gz: 101245afc14ce431358f7434bbe78675173e3570dd7012bdddf1ac25ac5a16cf96eb9cf7655c1e3c346090d1e556243eaba8fe96472588e8285bb2f24388eec1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.216.0 (2025-09-09)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - SDK release for user defined predefined attributes.
|
8
|
+
|
9
|
+
1.215.0 (2025-08-28)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - AgentStatusDrillDown feature in GetCurrentMetricData API. Adding AGENT_STATUS as filter and grouping in GetCurrentMetricData API
|
13
|
+
|
4
14
|
1.214.0 (2025-08-26)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.216.0
|
@@ -1938,6 +1938,12 @@ module Aws::Connect
|
|
1938
1938
|
# },
|
1939
1939
|
# },
|
1940
1940
|
# value_integer: 1,
|
1941
|
+
# value_list: [
|
1942
|
+
# {
|
1943
|
+
# # recursive SegmentAttributeValue
|
1944
|
+
# },
|
1945
|
+
# ],
|
1946
|
+
# value_arn: "SegmentAttributeValueString",
|
1941
1947
|
# },
|
1942
1948
|
# },
|
1943
1949
|
# previous_contact_id: "ContactId",
|
@@ -2872,14 +2878,34 @@ module Aws::Connect
|
|
2872
2878
|
end
|
2873
2879
|
|
2874
2880
|
# Creates a new predefined attribute for the specified Amazon Connect
|
2875
|
-
# instance. *
|
2876
|
-
# instance that can be used to route contacts to an agent or pools of
|
2877
|
-
# agents within a queue. For more information, see [Create predefined
|
2878
|
-
# attributes for routing contacts to agents][1].
|
2881
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
2879
2882
|
#
|
2883
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
2884
|
+
# quotas][1].
|
2880
2885
|
#
|
2886
|
+
# **Use cases**
|
2881
2887
|
#
|
2882
|
-
#
|
2888
|
+
# Following are common uses cases for this API:
|
2889
|
+
#
|
2890
|
+
# * Create an attribute for routing proficiency (for example, agent
|
2891
|
+
# certification) that has predefined values (for example, a list of
|
2892
|
+
# possible certifications). For more information, see [Create
|
2893
|
+
# predefined attributes for routing contacts to agents][2].
|
2894
|
+
#
|
2895
|
+
# * Create an attribute for business unit name that has a list of
|
2896
|
+
# predefined business unit names used in your organization. This is a
|
2897
|
+
# use case where information for a contact varies between transfers or
|
2898
|
+
# conferences. For more information, see [Use contact segment
|
2899
|
+
# attributes][3].
|
2900
|
+
#
|
2901
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
2902
|
+
#
|
2903
|
+
#
|
2904
|
+
#
|
2905
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
2906
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
2907
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
2908
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
2883
2909
|
#
|
2884
2910
|
# @option params [required, String] :instance_id
|
2885
2911
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -2888,9 +2914,19 @@ module Aws::Connect
|
|
2888
2914
|
# @option params [required, String] :name
|
2889
2915
|
# The name of the predefined attribute.
|
2890
2916
|
#
|
2891
|
-
# @option params [
|
2917
|
+
# @option params [Types::PredefinedAttributeValues] :values
|
2892
2918
|
# The values of the predefined attribute.
|
2893
2919
|
#
|
2920
|
+
# @option params [Array<String>] :purposes
|
2921
|
+
# Values that enable you to categorize your predefined attributes. You
|
2922
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
2923
|
+
# website.
|
2924
|
+
#
|
2925
|
+
# @option params [Types::InputPredefinedAttributeConfiguration] :attribute_configuration
|
2926
|
+
# Custom metadata that is associated to predefined attributes to control
|
2927
|
+
# behavior in upstream services, such as controlling how a predefined
|
2928
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
2929
|
+
#
|
2894
2930
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2895
2931
|
#
|
2896
2932
|
# @example Request syntax with placeholder values
|
@@ -2898,9 +2934,13 @@ module Aws::Connect
|
|
2898
2934
|
# resp = client.create_predefined_attribute({
|
2899
2935
|
# instance_id: "InstanceId", # required
|
2900
2936
|
# name: "PredefinedAttributeName", # required
|
2901
|
-
# values: {
|
2937
|
+
# values: {
|
2902
2938
|
# string_list: ["PredefinedAttributeStringValue"],
|
2903
2939
|
# },
|
2940
|
+
# purposes: ["PredefinedAttributePurposeName"],
|
2941
|
+
# attribute_configuration: {
|
2942
|
+
# enable_value_validation_on_association: false,
|
2943
|
+
# },
|
2904
2944
|
# })
|
2905
2945
|
#
|
2906
2946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePredefinedAttribute AWS API Documentation
|
@@ -5320,8 +5360,8 @@ module Aws::Connect
|
|
5320
5360
|
end
|
5321
5361
|
|
5322
5362
|
# This API is in preview release for Amazon Connect and is subject to
|
5323
|
-
# change. To request access to this API, contact Amazon Web
|
5324
|
-
#
|
5363
|
+
# change. To request access to this API, contact Amazon Web Services
|
5364
|
+
# Support.
|
5325
5365
|
#
|
5326
5366
|
# Describes the target authentication profile.
|
5327
5367
|
#
|
@@ -5543,6 +5583,9 @@ module Aws::Connect
|
|
5543
5583
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_map #=> Hash
|
5544
5584
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"] #=> Types::SegmentAttributeValue
|
5545
5585
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_integer #=> Integer
|
5586
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_list #=> Array
|
5587
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_list[0] #=> Types::SegmentAttributeValue
|
5588
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_arn #=> String
|
5546
5589
|
# resp.contact.recordings #=> Array
|
5547
5590
|
# resp.contact.recordings[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
5548
5591
|
# resp.contact.recordings[0].location #=> String
|
@@ -6246,14 +6289,29 @@ module Aws::Connect
|
|
6246
6289
|
end
|
6247
6290
|
|
6248
6291
|
# Describes a predefined attribute for the specified Amazon Connect
|
6249
|
-
# instance. *
|
6250
|
-
#
|
6251
|
-
#
|
6252
|
-
#
|
6292
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
6293
|
+
# You can use predefined attributes for:
|
6294
|
+
#
|
6295
|
+
# * Routing proficiency (for example, agent certification) that has
|
6296
|
+
# predefined values (for example, a list of possible certifications).
|
6297
|
+
# For more information, see [Create predefined attributes for routing
|
6298
|
+
# contacts to agents][1].
|
6299
|
+
#
|
6300
|
+
# * Contact information that varies between transfers or conferences,
|
6301
|
+
# such as the name of the business unit handling the contact. For more
|
6302
|
+
# information, see [Use contact segment attributes][2].
|
6303
|
+
#
|
6304
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
6305
|
+
# quotas][3].
|
6306
|
+
#
|
6307
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
6253
6308
|
#
|
6254
6309
|
#
|
6255
6310
|
#
|
6256
6311
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
6312
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
6313
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
6314
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
6257
6315
|
#
|
6258
6316
|
# @option params [required, String] :instance_id
|
6259
6317
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -6278,6 +6336,10 @@ module Aws::Connect
|
|
6278
6336
|
# resp.predefined_attribute.name #=> String
|
6279
6337
|
# resp.predefined_attribute.values.string_list #=> Array
|
6280
6338
|
# resp.predefined_attribute.values.string_list[0] #=> String
|
6339
|
+
# resp.predefined_attribute.purposes #=> Array
|
6340
|
+
# resp.predefined_attribute.purposes[0] #=> String
|
6341
|
+
# resp.predefined_attribute.attribute_configuration.enable_value_validation_on_association #=> Boolean
|
6342
|
+
# resp.predefined_attribute.attribute_configuration.is_read_only #=> Boolean
|
6281
6343
|
# resp.predefined_attribute.last_modified_time #=> Time
|
6282
6344
|
# resp.predefined_attribute.last_modified_region #=> String
|
6283
6345
|
#
|
@@ -7847,11 +7909,16 @@ module Aws::Connect
|
|
7847
7909
|
#
|
7848
7910
|
# * RoutingStepExpressions: 50
|
7849
7911
|
#
|
7912
|
+
# * AgentStatuses: 50
|
7913
|
+
#
|
7850
7914
|
# Metric data is retrieved only for the resources associated with the
|
7851
7915
|
# queues or routing profiles, and by any channels included in the
|
7852
7916
|
# filter. (You cannot filter by both queue AND routing profile.) You can
|
7853
7917
|
# include both resource IDs and resource ARNs in the same request.
|
7854
7918
|
#
|
7919
|
+
# When using `AgentStatuses` as filter make sure Queues is added as
|
7920
|
+
# primary filter.
|
7921
|
+
#
|
7855
7922
|
# When using the `RoutingStepExpression` filter, you need to pass
|
7856
7923
|
# exactly one `QueueId`. The filter is also case sensitive so when using
|
7857
7924
|
# the `RoutingStepExpression` filter, grouping by
|
@@ -7861,21 +7928,29 @@ module Aws::Connect
|
|
7861
7928
|
# in the filter.
|
7862
7929
|
#
|
7863
7930
|
# @option params [Array<String>] :groupings
|
7864
|
-
#
|
7865
|
-
#
|
7866
|
-
#
|
7931
|
+
# Defines the level of aggregation for metrics data by a dimension(s).
|
7932
|
+
# Its similar to sorting items into buckets based on a common
|
7933
|
+
# characteristic, then counting or calculating something for each
|
7934
|
+
# bucket. For example, when grouped by `QUEUE`, the metrics returned
|
7935
|
+
# apply to each queue rather than aggregated for all queues.
|
7936
|
+
#
|
7937
|
+
# The grouping list is an ordered list, with the first item in the list
|
7938
|
+
# defined as the primary grouping. If no grouping is included in the
|
7939
|
+
# request, the aggregation happens at the instance-level.
|
7867
7940
|
#
|
7868
7941
|
# * If you group by `CHANNEL`, you should include a Channels filter.
|
7869
7942
|
# VOICE, CHAT, and TASK channels are supported.
|
7870
7943
|
#
|
7944
|
+
# * If you group by `AGENT_STATUS`, you must include the `QUEUE` as the
|
7945
|
+
# primary grouping and use queue filter. When you group by
|
7946
|
+
# `AGENT_STATUS`, the only metric available is the `AGENTS_ONLINE`
|
7947
|
+
# metric.
|
7948
|
+
#
|
7871
7949
|
# * If you group by `ROUTING_PROFILE`, you must include either a queue
|
7872
7950
|
# or routing profile filter. In addition, a routing profile filter is
|
7873
7951
|
# required for metrics `CONTACTS_SCHEDULED`, `CONTACTS_IN_QUEUE`, and
|
7874
7952
|
# ` OLDEST_CONTACT_AGE`.
|
7875
7953
|
#
|
7876
|
-
# * If no `Grouping` is included in the request, a summary of metrics is
|
7877
|
-
# returned.
|
7878
|
-
#
|
7879
7954
|
# * When using the `RoutingStepExpression` filter, group by
|
7880
7955
|
# `ROUTING_STEP_EXPRESSION` is required.
|
7881
7956
|
#
|
@@ -8039,8 +8114,9 @@ module Aws::Connect
|
|
8039
8114
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
8040
8115
|
# routing_profiles: ["RoutingProfileId"],
|
8041
8116
|
# routing_step_expressions: ["RoutingExpression"],
|
8117
|
+
# agent_statuses: ["AgentStatusId"],
|
8042
8118
|
# },
|
8043
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION
|
8119
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS
|
8044
8120
|
# current_metrics: [ # required
|
8045
8121
|
# {
|
8046
8122
|
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
@@ -8067,6 +8143,8 @@ module Aws::Connect
|
|
8067
8143
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
8068
8144
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
8069
8145
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
8146
|
+
# resp.metric_results[0].dimensions.agent_status.arn #=> String
|
8147
|
+
# resp.metric_results[0].dimensions.agent_status.id #=> String
|
8070
8148
|
# resp.metric_results[0].collections #=> Array
|
8071
8149
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
8072
8150
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
@@ -8701,8 +8779,9 @@ module Aws::Connect
|
|
8701
8779
|
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK, EMAIL
|
8702
8780
|
# routing_profiles: ["RoutingProfileId"],
|
8703
8781
|
# routing_step_expressions: ["RoutingExpression"],
|
8782
|
+
# agent_statuses: ["AgentStatusId"],
|
8704
8783
|
# },
|
8705
|
-
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION
|
8784
|
+
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS
|
8706
8785
|
# historical_metrics: [ # required
|
8707
8786
|
# {
|
8708
8787
|
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
@@ -8728,6 +8807,8 @@ module Aws::Connect
|
|
8728
8807
|
# resp.metric_results[0].dimensions.routing_profile.id #=> String
|
8729
8808
|
# resp.metric_results[0].dimensions.routing_profile.arn #=> String
|
8730
8809
|
# resp.metric_results[0].dimensions.routing_step_expression #=> String
|
8810
|
+
# resp.metric_results[0].dimensions.agent_status.arn #=> String
|
8811
|
+
# resp.metric_results[0].dimensions.agent_status.id #=> String
|
8731
8812
|
# resp.metric_results[0].collections #=> Array
|
8732
8813
|
# resp.metric_results[0].collections[0].metric.name #=> String, one of "CONTACTS_QUEUED", "CONTACTS_HANDLED", "CONTACTS_ABANDONED", "CONTACTS_CONSULTED", "CONTACTS_AGENT_HUNG_UP_FIRST", "CONTACTS_HANDLED_INCOMING", "CONTACTS_HANDLED_OUTBOUND", "CONTACTS_HOLD_ABANDONS", "CONTACTS_TRANSFERRED_IN", "CONTACTS_TRANSFERRED_OUT", "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", "CONTACTS_MISSED", "CALLBACK_CONTACTS_HANDLED", "API_CONTACTS_HANDLED", "OCCUPANCY", "HANDLE_TIME", "AFTER_CONTACT_WORK_TIME", "QUEUED_TIME", "ABANDON_TIME", "QUEUE_ANSWER_TIME", "HOLD_TIME", "INTERACTION_TIME", "INTERACTION_AND_HOLD_TIME", "SERVICE_LEVEL"
|
8733
8814
|
# resp.metric_results[0].collections[0].metric.threshold.comparison #=> String, one of "LT"
|
@@ -10791,7 +10872,7 @@ module Aws::Connect
|
|
10791
10872
|
# service level quota of 99 phone numbers, and in any 180 day period you
|
10792
10873
|
# release 99, claim 99, and then release 99, you will have exceeded the
|
10793
10874
|
# 200% limit. At that point you are blocked from claiming any more
|
10794
|
-
# numbers until you open an Amazon Web
|
10875
|
+
# numbers until you open an Amazon Web Services Support ticket.
|
10795
10876
|
#
|
10796
10877
|
#
|
10797
10878
|
#
|
@@ -11135,8 +11216,8 @@ module Aws::Connect
|
|
11135
11216
|
end
|
11136
11217
|
|
11137
11218
|
# This API is in preview release for Amazon Connect and is subject to
|
11138
|
-
# change. To request access to this API, contact Amazon Web
|
11139
|
-
#
|
11219
|
+
# change. To request access to this API, contact Amazon Web Services
|
11220
|
+
# Support.
|
11140
11221
|
#
|
11141
11222
|
# Provides summary information about the authentication profiles in a
|
11142
11223
|
# specified Amazon Connect instance.
|
@@ -12470,14 +12551,29 @@ module Aws::Connect
|
|
12470
12551
|
end
|
12471
12552
|
|
12472
12553
|
# Lists predefined attributes for the specified Amazon Connect instance.
|
12473
|
-
# *
|
12474
|
-
#
|
12475
|
-
#
|
12476
|
-
#
|
12554
|
+
# A *predefined attribute* is made up of a name and a value. You can use
|
12555
|
+
# predefined attributes for:
|
12556
|
+
#
|
12557
|
+
# * Routing proficiency (for example, agent certification) that has
|
12558
|
+
# predefined values (for example, a list of possible certifications).
|
12559
|
+
# For more information, see [Create predefined attributes for routing
|
12560
|
+
# contacts to agents][1].
|
12561
|
+
#
|
12562
|
+
# * Contact information that varies between transfers or conferences,
|
12563
|
+
# such as the name of the business unit handling the contact. For more
|
12564
|
+
# information, see [Use contact segment attributes][2].
|
12565
|
+
#
|
12566
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
12567
|
+
# quotas][3].
|
12568
|
+
#
|
12569
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
12477
12570
|
#
|
12478
12571
|
#
|
12479
12572
|
#
|
12480
12573
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
12574
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
12575
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
12576
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
12481
12577
|
#
|
12482
12578
|
# @option params [required, String] :instance_id
|
12483
12579
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -14008,7 +14104,7 @@ module Aws::Connect
|
|
14008
14104
|
# After releasing a phone number, the phone number enters into a
|
14009
14105
|
# cooldown period for up to 180 days. It cannot be searched for or
|
14010
14106
|
# claimed again until the period has ended. If you accidentally release
|
14011
|
-
# a phone number, contact Amazon Web
|
14107
|
+
# a phone number, contact Amazon Web Services Support.
|
14012
14108
|
#
|
14013
14109
|
# If you plan to claim and release numbers frequently, contact us for a
|
14014
14110
|
# service quota exception. Otherwise, it is possible you will be blocked
|
@@ -15051,15 +15147,30 @@ module Aws::Connect
|
|
15051
15147
|
req.send_request(options)
|
15052
15148
|
end
|
15053
15149
|
|
15054
|
-
# Searches predefined attributes that meet certain criteria.
|
15055
|
-
#
|
15056
|
-
#
|
15057
|
-
#
|
15058
|
-
#
|
15150
|
+
# Searches predefined attributes that meet certain criteria. A
|
15151
|
+
# *predefined attribute* is made up of a name and a value. You can use
|
15152
|
+
# predefined attributes for:
|
15153
|
+
#
|
15154
|
+
# * Routing proficiency (for example, agent certification) that has
|
15155
|
+
# predefined values (for example, a list of possible certifications).
|
15156
|
+
# For more information, see [Create predefined attributes for routing
|
15157
|
+
# contacts to agents][1].
|
15158
|
+
#
|
15159
|
+
# * Contact information that varies between transfers or conferences,
|
15160
|
+
# such as the name of the business unit handling the contact. For more
|
15161
|
+
# information, see [Use contact segment attributes][2].
|
15162
|
+
#
|
15163
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
15164
|
+
# quotas][3].
|
15165
|
+
#
|
15166
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
15059
15167
|
#
|
15060
15168
|
#
|
15061
15169
|
#
|
15062
15170
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
15171
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
15172
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
15173
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
15063
15174
|
#
|
15064
15175
|
# @option params [required, String] :instance_id
|
15065
15176
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -15115,6 +15226,10 @@ module Aws::Connect
|
|
15115
15226
|
# resp.predefined_attributes[0].name #=> String
|
15116
15227
|
# resp.predefined_attributes[0].values.string_list #=> Array
|
15117
15228
|
# resp.predefined_attributes[0].values.string_list[0] #=> String
|
15229
|
+
# resp.predefined_attributes[0].purposes #=> Array
|
15230
|
+
# resp.predefined_attributes[0].purposes[0] #=> String
|
15231
|
+
# resp.predefined_attributes[0].attribute_configuration.enable_value_validation_on_association #=> Boolean
|
15232
|
+
# resp.predefined_attributes[0].attribute_configuration.is_read_only #=> Boolean
|
15118
15233
|
# resp.predefined_attributes[0].last_modified_time #=> Time
|
15119
15234
|
# resp.predefined_attributes[0].last_modified_region #=> String
|
15120
15235
|
# resp.next_token #=> String
|
@@ -16513,8 +16628,8 @@ module Aws::Connect
|
|
16513
16628
|
#
|
16514
16629
|
# If you use the `ChatDurationInMinutes` parameter and receive a 400
|
16515
16630
|
# error, your account may not support the ability to configure custom
|
16516
|
-
# chat durations. For more information, contact Amazon Web
|
16517
|
-
#
|
16631
|
+
# chat durations. For more information, contact Amazon Web Services
|
16632
|
+
# Support.
|
16518
16633
|
#
|
16519
16634
|
# For more information about chat, see the following topics in the
|
16520
16635
|
# *Amazon Connect Administrator Guide*:
|
@@ -16683,6 +16798,12 @@ module Aws::Connect
|
|
16683
16798
|
# },
|
16684
16799
|
# },
|
16685
16800
|
# value_integer: 1,
|
16801
|
+
# value_list: [
|
16802
|
+
# {
|
16803
|
+
# # recursive SegmentAttributeValue
|
16804
|
+
# },
|
16805
|
+
# ],
|
16806
|
+
# value_arn: "SegmentAttributeValueString",
|
16686
16807
|
# },
|
16687
16808
|
# },
|
16688
16809
|
# customer_id: "CustomerIdNonEmpty",
|
@@ -17079,6 +17200,12 @@ module Aws::Connect
|
|
17079
17200
|
# },
|
17080
17201
|
# },
|
17081
17202
|
# value_integer: 1,
|
17203
|
+
# value_list: [
|
17204
|
+
# {
|
17205
|
+
# # recursive SegmentAttributeValue
|
17206
|
+
# },
|
17207
|
+
# ],
|
17208
|
+
# value_arn: "SegmentAttributeValueString",
|
17082
17209
|
# },
|
17083
17210
|
# },
|
17084
17211
|
# client_token: "ClientToken",
|
@@ -17239,6 +17366,12 @@ module Aws::Connect
|
|
17239
17366
|
# },
|
17240
17367
|
# },
|
17241
17368
|
# value_integer: 1,
|
17369
|
+
# value_list: [
|
17370
|
+
# {
|
17371
|
+
# # recursive SegmentAttributeValue
|
17372
|
+
# },
|
17373
|
+
# ],
|
17374
|
+
# value_arn: "SegmentAttributeValueString",
|
17242
17375
|
# },
|
17243
17376
|
# },
|
17244
17377
|
# attributes: {
|
@@ -17800,6 +17933,12 @@ module Aws::Connect
|
|
17800
17933
|
# },
|
17801
17934
|
# },
|
17802
17935
|
# value_integer: 1,
|
17936
|
+
# value_list: [
|
17937
|
+
# {
|
17938
|
+
# # recursive SegmentAttributeValue
|
17939
|
+
# },
|
17940
|
+
# ],
|
17941
|
+
# value_arn: "SegmentAttributeValueString",
|
17803
17942
|
# },
|
17804
17943
|
# },
|
17805
17944
|
# })
|
@@ -18511,8 +18650,8 @@ module Aws::Connect
|
|
18511
18650
|
end
|
18512
18651
|
|
18513
18652
|
# This API is in preview release for Amazon Connect and is subject to
|
18514
|
-
# change. To request access to this API, contact Amazon Web
|
18515
|
-
#
|
18653
|
+
# change. To request access to this API, contact Amazon Web Services
|
18654
|
+
# Support.
|
18516
18655
|
#
|
18517
18656
|
# Updates the selected authentication profile.
|
18518
18657
|
#
|
@@ -18630,8 +18769,9 @@ module Aws::Connect
|
|
18630
18769
|
# This field can be used to show channel subtype, such as
|
18631
18770
|
# `connect:Guide`.
|
18632
18771
|
#
|
18633
|
-
#
|
18634
|
-
# updated by using the
|
18772
|
+
# Contact Expiry, and user-defined attributes (String - String) that are
|
18773
|
+
# defined in predefined attributes, can be updated by using the
|
18774
|
+
# UpdateContact API.
|
18635
18775
|
#
|
18636
18776
|
# @option params [Types::QueueInfoInput] :queue_info
|
18637
18777
|
# Information about the queue associated with a contact. This parameter
|
@@ -18704,6 +18844,12 @@ module Aws::Connect
|
|
18704
18844
|
# },
|
18705
18845
|
# },
|
18706
18846
|
# value_integer: 1,
|
18847
|
+
# value_list: [
|
18848
|
+
# {
|
18849
|
+
# # recursive SegmentAttributeValue
|
18850
|
+
# },
|
18851
|
+
# ],
|
18852
|
+
# value_arn: "SegmentAttributeValueString",
|
18707
18853
|
# },
|
18708
18854
|
# },
|
18709
18855
|
# queue_info: {
|
@@ -19608,7 +19754,7 @@ module Aws::Connect
|
|
19608
19754
|
# The type of attribute.
|
19609
19755
|
#
|
19610
19756
|
# <note markdown="1"> Only allowlisted customers can consume USE\_CUSTOM\_TTS\_VOICES. To
|
19611
|
-
# access this feature, contact Amazon Web
|
19757
|
+
# access this feature, contact Amazon Web Services Support for
|
19612
19758
|
# allowlisting.
|
19613
19759
|
#
|
19614
19760
|
# </note>
|
@@ -19987,14 +20133,34 @@ module Aws::Connect
|
|
19987
20133
|
end
|
19988
20134
|
|
19989
20135
|
# Updates a predefined attribute for the specified Amazon Connect
|
19990
|
-
# instance. *
|
19991
|
-
# instance that can be used to route contacts to an agent or pools of
|
19992
|
-
# agents within a queue. For more information, see [Create predefined
|
19993
|
-
# attributes for routing contacts to agents][1].
|
20136
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
19994
20137
|
#
|
20138
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
20139
|
+
# quotas][1].
|
19995
20140
|
#
|
20141
|
+
# **Use cases**
|
19996
20142
|
#
|
19997
|
-
#
|
20143
|
+
# Following are common uses cases for this API:
|
20144
|
+
#
|
20145
|
+
# * Update routing proficiency (for example, agent certification) that
|
20146
|
+
# has predefined values (for example, a list of possible
|
20147
|
+
# certifications). For more information, see [Create predefined
|
20148
|
+
# attributes for routing contacts to agents][2].
|
20149
|
+
#
|
20150
|
+
# * Update an attribute for business unit name that has a list of
|
20151
|
+
# predefined business unit names used in your organization. This is a
|
20152
|
+
# use case where information for a contact varies between transfers or
|
20153
|
+
# conferences. For more information, see [Use contact segment
|
20154
|
+
# attributes][3].
|
20155
|
+
#
|
20156
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
20157
|
+
#
|
20158
|
+
#
|
20159
|
+
#
|
20160
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
20161
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
20162
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
20163
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
19998
20164
|
#
|
19999
20165
|
# @option params [required, String] :instance_id
|
20000
20166
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -20006,6 +20172,16 @@ module Aws::Connect
|
|
20006
20172
|
# @option params [Types::PredefinedAttributeValues] :values
|
20007
20173
|
# The values of the predefined attribute.
|
20008
20174
|
#
|
20175
|
+
# @option params [Array<String>] :purposes
|
20176
|
+
# Values that enable you to categorize your predefined attributes. You
|
20177
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
20178
|
+
# website.
|
20179
|
+
#
|
20180
|
+
# @option params [Types::InputPredefinedAttributeConfiguration] :attribute_configuration
|
20181
|
+
# Custom metadata that is associated to predefined attributes to control
|
20182
|
+
# behavior in upstream services, such as controlling how a predefined
|
20183
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
20184
|
+
#
|
20009
20185
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
20010
20186
|
#
|
20011
20187
|
# @example Request syntax with placeholder values
|
@@ -20016,6 +20192,10 @@ module Aws::Connect
|
|
20016
20192
|
# values: {
|
20017
20193
|
# string_list: ["PredefinedAttributeStringValue"],
|
20018
20194
|
# },
|
20195
|
+
# purposes: ["PredefinedAttributePurposeName"],
|
20196
|
+
# attribute_configuration: {
|
20197
|
+
# enable_value_validation_on_association: false,
|
20198
|
+
# },
|
20019
20199
|
# })
|
20020
20200
|
#
|
20021
20201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePredefinedAttribute AWS API Documentation
|
@@ -21543,7 +21723,7 @@ module Aws::Connect
|
|
21543
21723
|
tracer: tracer
|
21544
21724
|
)
|
21545
21725
|
context[:gem_name] = 'aws-sdk-connect'
|
21546
|
-
context[:gem_version] = '1.
|
21726
|
+
context[:gem_version] = '1.216.0'
|
21547
21727
|
Seahorse::Client::Request.new(handlers, context)
|
21548
21728
|
end
|
21549
21729
|
|