aws-sdk-connect 1.164.0 → 1.166.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 +373 -125
- data/lib/aws-sdk-connect/client_api.rb +127 -1
- data/lib/aws-sdk-connect/endpoints.rb +42 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-connect/types.rb +490 -124
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +36 -0
- data/sig/types.rbs +72 -0
- metadata +2 -2
@@ -1528,7 +1528,7 @@ module Aws::Connect
|
|
1528
1528
|
# the pre-signed URL provided in the StartAttachedFileUpload API.
|
1529
1529
|
#
|
1530
1530
|
# @option params [required, String] :instance_id
|
1531
|
-
# The unique identifier of the Connect instance.
|
1531
|
+
# The unique identifier of the Amazon Connect instance.
|
1532
1532
|
#
|
1533
1533
|
# @option params [required, String] :file_id
|
1534
1534
|
# The unique identifier of the attached file resource.
|
@@ -4508,6 +4508,60 @@ module Aws::Connect
|
|
4508
4508
|
req.send_request(options)
|
4509
4509
|
end
|
4510
4510
|
|
4511
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4512
|
+
# change. To request access to this API, contact Amazon Web Services
|
4513
|
+
# Support.
|
4514
|
+
#
|
4515
|
+
# Describes the target authentication profile.
|
4516
|
+
#
|
4517
|
+
# @option params [required, String] :authentication_profile_id
|
4518
|
+
# A unique identifier for the authentication profile.
|
4519
|
+
#
|
4520
|
+
# @option params [required, String] :instance_id
|
4521
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
4522
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
4523
|
+
#
|
4524
|
+
#
|
4525
|
+
#
|
4526
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
4527
|
+
#
|
4528
|
+
# @return [Types::DescribeAuthenticationProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4529
|
+
#
|
4530
|
+
# * {Types::DescribeAuthenticationProfileResponse#authentication_profile #authentication_profile} => Types::AuthenticationProfile
|
4531
|
+
#
|
4532
|
+
# @example Request syntax with placeholder values
|
4533
|
+
#
|
4534
|
+
# resp = client.describe_authentication_profile({
|
4535
|
+
# authentication_profile_id: "AuthenticationProfileId", # required
|
4536
|
+
# instance_id: "InstanceId", # required
|
4537
|
+
# })
|
4538
|
+
#
|
4539
|
+
# @example Response structure
|
4540
|
+
#
|
4541
|
+
# resp.authentication_profile.id #=> String
|
4542
|
+
# resp.authentication_profile.arn #=> String
|
4543
|
+
# resp.authentication_profile.name #=> String
|
4544
|
+
# resp.authentication_profile.description #=> String
|
4545
|
+
# resp.authentication_profile.allowed_ips #=> Array
|
4546
|
+
# resp.authentication_profile.allowed_ips[0] #=> String
|
4547
|
+
# resp.authentication_profile.blocked_ips #=> Array
|
4548
|
+
# resp.authentication_profile.blocked_ips[0] #=> String
|
4549
|
+
# resp.authentication_profile.is_default #=> Boolean
|
4550
|
+
# resp.authentication_profile.created_time #=> Time
|
4551
|
+
# resp.authentication_profile.last_modified_time #=> Time
|
4552
|
+
# resp.authentication_profile.last_modified_region #=> String
|
4553
|
+
# resp.authentication_profile.periodic_session_duration #=> Integer
|
4554
|
+
# resp.authentication_profile.max_session_duration #=> Integer
|
4555
|
+
#
|
4556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAuthenticationProfile AWS API Documentation
|
4557
|
+
#
|
4558
|
+
# @overload describe_authentication_profile(params = {})
|
4559
|
+
# @param [Hash] params ({})
|
4560
|
+
def describe_authentication_profile(params = {}, options = {})
|
4561
|
+
req = build_request(:describe_authentication_profile, params)
|
4562
|
+
req.send_request(options)
|
4563
|
+
end
|
4564
|
+
|
4511
4565
|
# This API is in preview release for Amazon Connect and is subject to
|
4512
4566
|
# change.
|
4513
4567
|
#
|
@@ -4585,6 +4639,8 @@ module Aws::Connect
|
|
4585
4639
|
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.name #=> String
|
4586
4640
|
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.value #=> String
|
4587
4641
|
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.proficiency_level #=> Float
|
4642
|
+
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
|
4643
|
+
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
|
4588
4644
|
# resp.contact.routing_criteria.steps[0].expression.attribute_condition.comparison_operator #=> String
|
4589
4645
|
# resp.contact.routing_criteria.steps[0].expression.and_expression #=> Array
|
4590
4646
|
# resp.contact.routing_criteria.steps[0].expression.and_expression[0] #=> Types::Expression
|
@@ -7913,49 +7969,6 @@ module Aws::Connect
|
|
7913
7969
|
#
|
7914
7970
|
# UI name: [Cases created][37]
|
7915
7971
|
#
|
7916
|
-
# CONTACTS\_ABANDONED
|
7917
|
-
#
|
7918
|
-
# : Unit: Count
|
7919
|
-
#
|
7920
|
-
# Metric filter:
|
7921
|
-
#
|
7922
|
-
# * Valid values: `API`\| `Incoming` \| `Outbound` \| `Transfer` \|
|
7923
|
-
# `Callback` \| `Queue_Transfer`\| `Disconnect`
|
7924
|
-
#
|
7925
|
-
# ^
|
7926
|
-
#
|
7927
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7928
|
-
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
|
7929
|
-
# RoutingStepExpression, Q in Connect
|
7930
|
-
#
|
7931
|
-
# UI name: [Contact abandoned][38]
|
7932
|
-
#
|
7933
|
-
# CONTACTS\_ABANDONED\_IN\_X
|
7934
|
-
#
|
7935
|
-
# : Unit: Count
|
7936
|
-
#
|
7937
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7938
|
-
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
7939
|
-
#
|
7940
|
-
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
7941
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
7942
|
-
# `LT` (for "Less than").
|
7943
|
-
#
|
7944
|
-
# UI name: [Contacts abandoned in X seconds][39]
|
7945
|
-
#
|
7946
|
-
# CONTACTS\_ANSWERED\_IN\_X
|
7947
|
-
#
|
7948
|
-
# : Unit: Count
|
7949
|
-
#
|
7950
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7951
|
-
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
7952
|
-
#
|
7953
|
-
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
7954
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
7955
|
-
# `LT` (for "Less than").
|
7956
|
-
#
|
7957
|
-
# UI name: [Contacts answered in X seconds][40]
|
7958
|
-
#
|
7959
7972
|
# CONTACTS\_CREATED
|
7960
7973
|
#
|
7961
7974
|
# : Unit: Count
|
@@ -7965,7 +7978,7 @@ module Aws::Connect
|
|
7965
7978
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7966
7979
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
7967
7980
|
#
|
7968
|
-
# UI name: [Contacts created][
|
7981
|
+
# UI name: [Contacts created][38]
|
7969
7982
|
#
|
7970
7983
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7971
7984
|
#
|
@@ -7981,7 +7994,7 @@ module Aws::Connect
|
|
7981
7994
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
7982
7995
|
# RoutingStepExpression, Q in Connect
|
7983
7996
|
#
|
7984
|
-
# UI name: [API contacts handled][
|
7997
|
+
# UI name: [API contacts handled][39]
|
7985
7998
|
#
|
7986
7999
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7987
8000
|
#
|
@@ -7996,7 +8009,7 @@ module Aws::Connect
|
|
7996
8009
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
7997
8010
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
7998
8011
|
#
|
7999
|
-
# UI name: [Contacts handled (connected to agent timestamp)][
|
8012
|
+
# UI name: [Contacts handled (connected to agent timestamp)][40]
|
8000
8013
|
#
|
8001
8014
|
# CONTACTS\_HOLD\_ABANDONS
|
8002
8015
|
#
|
@@ -8006,7 +8019,7 @@ module Aws::Connect
|
|
8006
8019
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8007
8020
|
# Connect
|
8008
8021
|
#
|
8009
|
-
# UI name: [Contacts hold disconnect][
|
8022
|
+
# UI name: [Contacts hold disconnect][40]
|
8010
8023
|
#
|
8011
8024
|
# CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
|
8012
8025
|
#
|
@@ -8015,7 +8028,7 @@ module Aws::Connect
|
|
8015
8028
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8016
8029
|
# Agent Hierarchy, Q in Connect
|
8017
8030
|
#
|
8018
|
-
# UI name: [Contacts hold agent disconnect][
|
8031
|
+
# UI name: [Contacts hold agent disconnect][41]
|
8019
8032
|
#
|
8020
8033
|
# CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
|
8021
8034
|
#
|
@@ -8024,7 +8037,7 @@ module Aws::Connect
|
|
8024
8037
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8025
8038
|
# Agent Hierarchy, Q in Connect
|
8026
8039
|
#
|
8027
|
-
# UI name: [Contacts hold customer disconnect][
|
8040
|
+
# UI name: [Contacts hold customer disconnect][42]
|
8028
8041
|
#
|
8029
8042
|
# CONTACTS\_PUT\_ON\_HOLD
|
8030
8043
|
#
|
@@ -8033,7 +8046,7 @@ module Aws::Connect
|
|
8033
8046
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8034
8047
|
# Agent Hierarchy, Q in Connect
|
8035
8048
|
#
|
8036
|
-
# UI name: [Contacts put on hold][
|
8049
|
+
# UI name: [Contacts put on hold][42]
|
8037
8050
|
#
|
8038
8051
|
# CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
|
8039
8052
|
#
|
@@ -8042,7 +8055,7 @@ module Aws::Connect
|
|
8042
8055
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8043
8056
|
# Agent Hierarchy, Q in Connect
|
8044
8057
|
#
|
8045
|
-
# UI name: [Contacts transferred out external][
|
8058
|
+
# UI name: [Contacts transferred out external][43]
|
8046
8059
|
#
|
8047
8060
|
# CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
|
8048
8061
|
#
|
@@ -8051,7 +8064,7 @@ module Aws::Connect
|
|
8051
8064
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8052
8065
|
# Agent Hierarchy, Q in Connect
|
8053
8066
|
#
|
8054
|
-
# UI name: [Contacts transferred out internal][
|
8067
|
+
# UI name: [Contacts transferred out internal][44]
|
8055
8068
|
#
|
8056
8069
|
# CONTACTS\_QUEUED
|
8057
8070
|
#
|
@@ -8061,7 +8074,7 @@ module Aws::Connect
|
|
8061
8074
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8062
8075
|
# Connect
|
8063
8076
|
#
|
8064
|
-
# UI name: [Contacts queued][
|
8077
|
+
# UI name: [Contacts queued][45]
|
8065
8078
|
#
|
8066
8079
|
# CONTACTS\_QUEUED\_BY\_ENQUEUE
|
8067
8080
|
#
|
@@ -8070,7 +8083,21 @@ module Aws::Connect
|
|
8070
8083
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
8071
8084
|
# contact/segmentAttributes/connect:Subtype
|
8072
8085
|
#
|
8073
|
-
# UI name: [Contacts queued (enqueue timestamp)][
|
8086
|
+
# UI name: [Contacts queued (enqueue timestamp)][46]
|
8087
|
+
#
|
8088
|
+
# CONTACTS\_REMOVED\_FROM\_QUEUE\_IN\_X
|
8089
|
+
#
|
8090
|
+
# : Unit: Count
|
8091
|
+
#
|
8092
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Q in
|
8093
|
+
# Connect
|
8094
|
+
#
|
8095
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8096
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8097
|
+
# `LT` (for "Less than").
|
8098
|
+
#
|
8099
|
+
# UI name: This metric is not available in Amazon Connect admin
|
8100
|
+
# website.
|
8074
8101
|
#
|
8075
8102
|
# CONTACTS\_RESOLVED\_IN\_X
|
8076
8103
|
#
|
@@ -8083,7 +8110,7 @@ module Aws::Connect
|
|
8083
8110
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8084
8111
|
# `LT` (for "Less than").
|
8085
8112
|
#
|
8086
|
-
# UI name: [Contacts resolved in X][
|
8113
|
+
# UI name: [Contacts resolved in X][47]
|
8087
8114
|
#
|
8088
8115
|
# CONTACTS\_TRANSFERRED\_OUT
|
8089
8116
|
#
|
@@ -8093,7 +8120,7 @@ module Aws::Connect
|
|
8093
8120
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
8094
8121
|
# Q in Connect
|
8095
8122
|
#
|
8096
|
-
# UI name: [Contacts transferred out][
|
8123
|
+
# UI name: [Contacts transferred out][48]
|
8097
8124
|
#
|
8098
8125
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8099
8126
|
#
|
@@ -8107,7 +8134,7 @@ module Aws::Connect
|
|
8107
8134
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8108
8135
|
# Connect
|
8109
8136
|
#
|
8110
|
-
# UI name: [Contacts transferred out by agent][
|
8137
|
+
# UI name: [Contacts transferred out by agent][49]
|
8111
8138
|
#
|
8112
8139
|
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
8113
8140
|
#
|
@@ -8117,7 +8144,7 @@ module Aws::Connect
|
|
8117
8144
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8118
8145
|
# Connect
|
8119
8146
|
#
|
8120
|
-
# UI name: [Contacts transferred out queue][
|
8147
|
+
# UI name: [Contacts transferred out queue][49]
|
8121
8148
|
#
|
8122
8149
|
# CURRENT\_CASES
|
8123
8150
|
#
|
@@ -8127,7 +8154,7 @@ module Aws::Connect
|
|
8127
8154
|
#
|
8128
8155
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8129
8156
|
#
|
8130
|
-
# UI name: [Current cases][
|
8157
|
+
# UI name: [Current cases][50]
|
8131
8158
|
#
|
8132
8159
|
# FLOWS\_OUTCOME
|
8133
8160
|
#
|
@@ -8139,7 +8166,7 @@ module Aws::Connect
|
|
8139
8166
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8140
8167
|
# published timestamp
|
8141
8168
|
#
|
8142
|
-
# UI name: [Flows outcome][
|
8169
|
+
# UI name: [Flows outcome][51]
|
8143
8170
|
#
|
8144
8171
|
# FLOWS\_STARTED
|
8145
8172
|
#
|
@@ -8150,7 +8177,7 @@ module Aws::Connect
|
|
8150
8177
|
# resource ID, Flows resource ID, Initiation method, Resource
|
8151
8178
|
# published timestamp
|
8152
8179
|
#
|
8153
|
-
# UI name: [Flows started][
|
8180
|
+
# UI name: [Flows started][52]
|
8154
8181
|
#
|
8155
8182
|
# MAX\_FLOW\_TIME
|
8156
8183
|
#
|
@@ -8162,7 +8189,7 @@ module Aws::Connect
|
|
8162
8189
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8163
8190
|
# published timestamp
|
8164
8191
|
#
|
8165
|
-
# UI name: [Maximum flow time][
|
8192
|
+
# UI name: [Maximum flow time][53]
|
8166
8193
|
#
|
8167
8194
|
# MAX\_QUEUED\_TIME
|
8168
8195
|
#
|
@@ -8172,7 +8199,7 @@ module Aws::Connect
|
|
8172
8199
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8173
8200
|
# Connect
|
8174
8201
|
#
|
8175
|
-
# UI name: [Maximum queued time][
|
8202
|
+
# UI name: [Maximum queued time][54]
|
8176
8203
|
#
|
8177
8204
|
# MIN\_FLOW\_TIME
|
8178
8205
|
#
|
@@ -8184,7 +8211,7 @@ module Aws::Connect
|
|
8184
8211
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8185
8212
|
# published timestamp
|
8186
8213
|
#
|
8187
|
-
# UI name: [Minimum flow time][
|
8214
|
+
# UI name: [Minimum flow time][55]
|
8188
8215
|
#
|
8189
8216
|
# PERCENT\_CASES\_FIRST\_CONTACT\_RESOLVED
|
8190
8217
|
#
|
@@ -8194,7 +8221,7 @@ module Aws::Connect
|
|
8194
8221
|
#
|
8195
8222
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8196
8223
|
#
|
8197
|
-
# UI name: [Cases resolved on first contact][
|
8224
|
+
# UI name: [Cases resolved on first contact][56]
|
8198
8225
|
#
|
8199
8226
|
# PERCENT\_CONTACTS\_STEP\_EXPIRED
|
8200
8227
|
#
|
@@ -8202,7 +8229,8 @@ module Aws::Connect
|
|
8202
8229
|
#
|
8203
8230
|
# Valid groupings and filters: Queue, RoutingStepExpression
|
8204
8231
|
#
|
8205
|
-
# UI name:
|
8232
|
+
# UI name: This metric is available in Real-time Metrics UI but not on
|
8233
|
+
# the Historical Metrics UI.
|
8206
8234
|
#
|
8207
8235
|
# PERCENT\_CONTACTS\_STEP\_JOINED
|
8208
8236
|
#
|
@@ -8210,7 +8238,8 @@ module Aws::Connect
|
|
8210
8238
|
#
|
8211
8239
|
# Valid groupings and filters: Queue, RoutingStepExpression
|
8212
8240
|
#
|
8213
|
-
# UI name:
|
8241
|
+
# UI name: This metric is available in Real-time Metrics UI but not on
|
8242
|
+
# the Historical Metrics UI.
|
8214
8243
|
#
|
8215
8244
|
# PERCENT\_FLOWS\_OUTCOME
|
8216
8245
|
#
|
@@ -8224,7 +8253,7 @@ module Aws::Connect
|
|
8224
8253
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8225
8254
|
# published timestamp
|
8226
8255
|
#
|
8227
|
-
# UI name: [Flows outcome percentage][
|
8256
|
+
# UI name: [Flows outcome percentage][57].
|
8228
8257
|
#
|
8229
8258
|
# <note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
|
8230
8259
|
#
|
@@ -8241,7 +8270,7 @@ module Aws::Connect
|
|
8241
8270
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8242
8271
|
# Connect
|
8243
8272
|
#
|
8244
|
-
# UI name: [Non-talk time percent][
|
8273
|
+
# UI name: [Non-talk time percent][58]
|
8245
8274
|
#
|
8246
8275
|
# PERCENT\_TALK\_TIME
|
8247
8276
|
#
|
@@ -8254,7 +8283,7 @@ module Aws::Connect
|
|
8254
8283
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8255
8284
|
# Connect
|
8256
8285
|
#
|
8257
|
-
# UI name: [Talk time percent][
|
8286
|
+
# UI name: [Talk time percent][59]
|
8258
8287
|
#
|
8259
8288
|
# PERCENT\_TALK\_TIME\_AGENT
|
8260
8289
|
#
|
@@ -8267,7 +8296,7 @@ module Aws::Connect
|
|
8267
8296
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8268
8297
|
# Connect
|
8269
8298
|
#
|
8270
|
-
# UI name: [Agent talk time percent][
|
8299
|
+
# UI name: [Agent talk time percent][60]
|
8271
8300
|
#
|
8272
8301
|
# PERCENT\_TALK\_TIME\_CUSTOMER
|
8273
8302
|
#
|
@@ -8280,7 +8309,7 @@ module Aws::Connect
|
|
8280
8309
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8281
8310
|
# Connect
|
8282
8311
|
#
|
8283
|
-
# UI name: [Customer talk time percent][
|
8312
|
+
# UI name: [Customer talk time percent][61]
|
8284
8313
|
#
|
8285
8314
|
# REOPENED\_CASE\_ACTIONS
|
8286
8315
|
#
|
@@ -8290,7 +8319,7 @@ module Aws::Connect
|
|
8290
8319
|
#
|
8291
8320
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8292
8321
|
#
|
8293
|
-
# UI name: [Cases reopened][
|
8322
|
+
# UI name: [Cases reopened][62]
|
8294
8323
|
#
|
8295
8324
|
# RESOLVED\_CASE\_ACTIONS
|
8296
8325
|
#
|
@@ -8300,7 +8329,7 @@ module Aws::Connect
|
|
8300
8329
|
#
|
8301
8330
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8302
8331
|
#
|
8303
|
-
# UI name: [Cases resolved][
|
8332
|
+
# UI name: [Cases resolved][63]
|
8304
8333
|
#
|
8305
8334
|
# SERVICE\_LEVEL
|
8306
8335
|
#
|
@@ -8315,7 +8344,7 @@ module Aws::Connect
|
|
8315
8344
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8316
8345
|
# `LT` (for "Less than").
|
8317
8346
|
#
|
8318
|
-
# UI name: [Service level X][
|
8347
|
+
# UI name: [Service level X][64]
|
8319
8348
|
#
|
8320
8349
|
# STEP\_CONTACTS\_QUEUED
|
8321
8350
|
#
|
@@ -8323,7 +8352,8 @@ module Aws::Connect
|
|
8323
8352
|
#
|
8324
8353
|
# Valid groupings and filters: Queue, RoutingStepExpression
|
8325
8354
|
#
|
8326
|
-
# UI name:
|
8355
|
+
# UI name: This metric is available in Real-time Metrics UI but not on
|
8356
|
+
# the Historical Metrics UI.
|
8327
8357
|
#
|
8328
8358
|
# SUM\_AFTER\_CONTACT\_WORK\_TIME
|
8329
8359
|
#
|
@@ -8332,7 +8362,7 @@ module Aws::Connect
|
|
8332
8362
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8333
8363
|
# Agent Hierarchy, Q in Connect
|
8334
8364
|
#
|
8335
|
-
# UI name: [After contact work time][
|
8365
|
+
# UI name: [After contact work time][65]
|
8336
8366
|
#
|
8337
8367
|
# SUM\_CONNECTING\_TIME\_AGENT
|
8338
8368
|
#
|
@@ -8345,13 +8375,56 @@ module Aws::Connect
|
|
8345
8375
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8346
8376
|
# Agent Hierarchy
|
8347
8377
|
#
|
8348
|
-
# UI name: [Agent API connecting time][
|
8378
|
+
# UI name: [Agent API connecting time][66]
|
8349
8379
|
#
|
8350
8380
|
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
|
8351
8381
|
# metric.
|
8352
8382
|
#
|
8353
8383
|
# </note>
|
8354
8384
|
#
|
8385
|
+
# SUM\_CONTACTS\_ABANDONED
|
8386
|
+
#
|
8387
|
+
# : Unit: Count
|
8388
|
+
#
|
8389
|
+
# Metric filter:
|
8390
|
+
#
|
8391
|
+
# * Valid values: `API`\| `Incoming` \| `Outbound` \| `Transfer` \|
|
8392
|
+
# `Callback` \| `Queue_Transfer`\| `Disconnect`
|
8393
|
+
#
|
8394
|
+
# ^
|
8395
|
+
#
|
8396
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8397
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
|
8398
|
+
# RoutingStepExpression, Q in Connect
|
8399
|
+
#
|
8400
|
+
# UI name: [Contact abandoned][67]
|
8401
|
+
#
|
8402
|
+
# SUM\_CONTACTS\_ABANDONED\_IN\_X
|
8403
|
+
#
|
8404
|
+
# : Unit: Count
|
8405
|
+
#
|
8406
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8407
|
+
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8408
|
+
#
|
8409
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8410
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8411
|
+
# `LT` (for "Less than").
|
8412
|
+
#
|
8413
|
+
# UI name: [Contacts abandoned in X seconds][68]
|
8414
|
+
#
|
8415
|
+
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
8416
|
+
#
|
8417
|
+
# : Unit: Count
|
8418
|
+
#
|
8419
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8420
|
+
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8421
|
+
#
|
8422
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8423
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8424
|
+
# `LT` (for "Less than").
|
8425
|
+
#
|
8426
|
+
# UI name: [Contacts answered in X seconds][69]
|
8427
|
+
#
|
8355
8428
|
# SUM\_CONTACT\_FLOW\_TIME
|
8356
8429
|
#
|
8357
8430
|
# : Unit: Seconds
|
@@ -8365,8 +8438,7 @@ module Aws::Connect
|
|
8365
8438
|
#
|
8366
8439
|
# : Unit: Seconds
|
8367
8440
|
#
|
8368
|
-
# Valid groupings and filters:
|
8369
|
-
# Agent Hierarchy
|
8441
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8370
8442
|
#
|
8371
8443
|
# UI name: [Agent on contact time][71]
|
8372
8444
|
#
|
@@ -8386,8 +8458,7 @@ module Aws::Connect
|
|
8386
8458
|
#
|
8387
8459
|
# : Unit: Seconds
|
8388
8460
|
#
|
8389
|
-
# Valid groupings and filters:
|
8390
|
-
# Agent Hierarchy
|
8461
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8391
8462
|
#
|
8392
8463
|
# UI name: [Error status time][73]
|
8393
8464
|
#
|
@@ -8499,38 +8570,38 @@ module Aws::Connect
|
|
8499
8570
|
# [35]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical
|
8500
8571
|
# [36]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical
|
8501
8572
|
# [37]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##cases-created-historical
|
8502
|
-
# [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8503
|
-
# [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8504
|
-
# [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8505
|
-
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8506
|
-
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8507
|
-
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8508
|
-
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8509
|
-
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8510
|
-
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8511
|
-
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8512
|
-
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8513
|
-
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8514
|
-
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8515
|
-
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8516
|
-
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8517
|
-
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8518
|
-
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8519
|
-
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8520
|
-
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8521
|
-
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8522
|
-
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8523
|
-
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8524
|
-
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8525
|
-
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8526
|
-
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8527
|
-
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8528
|
-
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8529
|
-
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8530
|
-
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8531
|
-
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8532
|
-
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8533
|
-
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8573
|
+
# [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical
|
8574
|
+
# [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical
|
8575
|
+
# [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical
|
8576
|
+
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical
|
8577
|
+
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical
|
8578
|
+
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical
|
8579
|
+
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical
|
8580
|
+
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical
|
8581
|
+
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical
|
8582
|
+
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical
|
8583
|
+
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
|
8584
|
+
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical
|
8585
|
+
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical
|
8586
|
+
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
|
8587
|
+
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical
|
8588
|
+
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical
|
8589
|
+
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical
|
8590
|
+
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical
|
8591
|
+
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical
|
8592
|
+
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical
|
8593
|
+
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical
|
8594
|
+
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical
|
8595
|
+
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical
|
8596
|
+
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical
|
8597
|
+
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical
|
8598
|
+
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical
|
8599
|
+
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical
|
8600
|
+
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical
|
8601
|
+
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time
|
8602
|
+
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical
|
8603
|
+
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical
|
8604
|
+
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical
|
8534
8605
|
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical
|
8535
8606
|
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical
|
8536
8607
|
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical
|
@@ -8800,6 +8871,32 @@ module Aws::Connect
|
|
8800
8871
|
# API only in the same Amazon Web Services Region where the Amazon
|
8801
8872
|
# Connect instance was created.
|
8802
8873
|
#
|
8874
|
+
# Call the [DescribePhoneNumber][1] API to verify the status of a
|
8875
|
+
# previous `ImportPhoneNumber` operation.
|
8876
|
+
#
|
8877
|
+
# If you plan to claim or import numbers and then release numbers
|
8878
|
+
# frequently, contact us for a service quota exception. Otherwise, it is
|
8879
|
+
# possible you will be blocked from claiming and releasing any more
|
8880
|
+
# numbers until up to 180 days past the oldest number released has
|
8881
|
+
# expired.
|
8882
|
+
#
|
8883
|
+
# By default you can claim or import and then release up to 200% of your
|
8884
|
+
# maximum number of active phone numbers. If you claim or import and
|
8885
|
+
# then release phone numbers using the UI or API during a rolling 180
|
8886
|
+
# day cycle that exceeds 200% of your phone number service level quota,
|
8887
|
+
# you will be blocked from claiming or importing any more numbers until
|
8888
|
+
# 180 days past the oldest number released has expired.
|
8889
|
+
#
|
8890
|
+
# For example, if you already have 99 claimed or imported numbers and a
|
8891
|
+
# service level quota of 99 phone numbers, and in any 180 day period you
|
8892
|
+
# release 99, claim 99, and then release 99, you will have exceeded the
|
8893
|
+
# 200% limit. At that point you are blocked from claiming any more
|
8894
|
+
# numbers until you open an Amazon Web Services Support ticket.
|
8895
|
+
#
|
8896
|
+
#
|
8897
|
+
#
|
8898
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
8899
|
+
#
|
8803
8900
|
# @option params [required, String] :instance_id
|
8804
8901
|
# The identifier of the Amazon Connect instance. You can [find the
|
8805
8902
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -9034,6 +9131,64 @@ module Aws::Connect
|
|
9034
9131
|
req.send_request(options)
|
9035
9132
|
end
|
9036
9133
|
|
9134
|
+
# This API is in preview release for Amazon Connect and is subject to
|
9135
|
+
# change. To request access to this API, contact Amazon Web Services
|
9136
|
+
# Support.
|
9137
|
+
#
|
9138
|
+
# Provides summary information about the authentication profiles in a
|
9139
|
+
# specified Amazon Connect instance.
|
9140
|
+
#
|
9141
|
+
# @option params [required, String] :instance_id
|
9142
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
9143
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
9144
|
+
#
|
9145
|
+
#
|
9146
|
+
#
|
9147
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
9148
|
+
#
|
9149
|
+
# @option params [Integer] :max_results
|
9150
|
+
# The maximum number of results to return per page.
|
9151
|
+
#
|
9152
|
+
# @option params [String] :next_token
|
9153
|
+
# The token for the next set of results. Use the value returned in the
|
9154
|
+
# previous response in the next request to retrieve the next set of
|
9155
|
+
# results.
|
9156
|
+
#
|
9157
|
+
# @return [Types::ListAuthenticationProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9158
|
+
#
|
9159
|
+
# * {Types::ListAuthenticationProfilesResponse#authentication_profile_summary_list #authentication_profile_summary_list} => Array<Types::AuthenticationProfileSummary>
|
9160
|
+
# * {Types::ListAuthenticationProfilesResponse#next_token #next_token} => String
|
9161
|
+
#
|
9162
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9163
|
+
#
|
9164
|
+
# @example Request syntax with placeholder values
|
9165
|
+
#
|
9166
|
+
# resp = client.list_authentication_profiles({
|
9167
|
+
# instance_id: "InstanceId", # required
|
9168
|
+
# max_results: 1,
|
9169
|
+
# next_token: "NextToken",
|
9170
|
+
# })
|
9171
|
+
#
|
9172
|
+
# @example Response structure
|
9173
|
+
#
|
9174
|
+
# resp.authentication_profile_summary_list #=> Array
|
9175
|
+
# resp.authentication_profile_summary_list[0].id #=> String
|
9176
|
+
# resp.authentication_profile_summary_list[0].arn #=> String
|
9177
|
+
# resp.authentication_profile_summary_list[0].name #=> String
|
9178
|
+
# resp.authentication_profile_summary_list[0].is_default #=> Boolean
|
9179
|
+
# resp.authentication_profile_summary_list[0].last_modified_time #=> Time
|
9180
|
+
# resp.authentication_profile_summary_list[0].last_modified_region #=> String
|
9181
|
+
# resp.next_token #=> String
|
9182
|
+
#
|
9183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAuthenticationProfiles AWS API Documentation
|
9184
|
+
#
|
9185
|
+
# @overload list_authentication_profiles(params = {})
|
9186
|
+
# @param [Hash] params ({})
|
9187
|
+
def list_authentication_profiles(params = {}, options = {})
|
9188
|
+
req = build_request(:list_authentication_profiles, params)
|
9189
|
+
req.send_request(options)
|
9190
|
+
end
|
9191
|
+
|
9037
9192
|
# This API is in preview release for Amazon Connect and is subject to
|
9038
9193
|
# change.
|
9039
9194
|
#
|
@@ -13440,7 +13595,7 @@ module Aws::Connect
|
|
13440
13595
|
# Provides a pre-signed Amazon S3 URL in response for uploading your
|
13441
13596
|
# content.
|
13442
13597
|
#
|
13443
|
-
# You may only use this API to upload attachments to
|
13598
|
+
# You may only use this API to upload attachments to an [Amazon Connect
|
13444
13599
|
# Case][1].
|
13445
13600
|
#
|
13446
13601
|
#
|
@@ -13461,7 +13616,7 @@ module Aws::Connect
|
|
13461
13616
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
13462
13617
|
#
|
13463
13618
|
# @option params [required, String] :instance_id
|
13464
|
-
# The unique identifier of the Connect instance.
|
13619
|
+
# The unique identifier of the Amazon Connect instance.
|
13465
13620
|
#
|
13466
13621
|
# @option params [required, String] :file_name
|
13467
13622
|
# A case-sensitive name of the attached file being uploaded.
|
@@ -13569,14 +13724,20 @@ module Aws::Connect
|
|
13569
13724
|
# chat durations. For more information, contact Amazon Web Services
|
13570
13725
|
# Support.
|
13571
13726
|
#
|
13572
|
-
# For more information about chat, see
|
13573
|
-
# Administrator Guide
|
13727
|
+
# For more information about chat, see the following topics in the
|
13728
|
+
# *Amazon Connect Administrator Guide*:
|
13729
|
+
#
|
13730
|
+
# * [Concepts: Web and mobile messaging capabilities in Amazon
|
13731
|
+
# Connect][3]
|
13732
|
+
#
|
13733
|
+
# * [Amazon Connect Chat security best practices][4]
|
13574
13734
|
#
|
13575
13735
|
#
|
13576
13736
|
#
|
13577
13737
|
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
13578
13738
|
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
13579
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/chat.html
|
13739
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html
|
13740
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
|
13580
13741
|
#
|
13581
13742
|
# @option params [required, String] :instance_id
|
13582
13743
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -13878,9 +14039,19 @@ module Aws::Connect
|
|
13878
14039
|
# chat message streaming][1] in the *Amazon Connect Administrator
|
13879
14040
|
# Guide*.
|
13880
14041
|
#
|
14042
|
+
# For more information about chat, see the following topics in the
|
14043
|
+
# *Amazon Connect Administrator Guide*:
|
14044
|
+
#
|
14045
|
+
# * [Concepts: Web and mobile messaging capabilities in Amazon
|
14046
|
+
# Connect][2]
|
14047
|
+
#
|
14048
|
+
# * [Amazon Connect Chat security best practices][3]
|
14049
|
+
#
|
13881
14050
|
#
|
13882
14051
|
#
|
13883
14052
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
|
14053
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html
|
14054
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
|
13884
14055
|
#
|
13885
14056
|
# @option params [required, String] :instance_id
|
13886
14057
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -14325,10 +14496,9 @@ module Aws::Connect
|
|
14325
14496
|
# @option params [required, String] :contact_flow_id
|
14326
14497
|
# The identifier of the flow for the call. To see the ContactFlowId in
|
14327
14498
|
# the Amazon Connect admin website, on the navigation menu go to
|
14328
|
-
# **Routing**, **
|
14329
|
-
#
|
14330
|
-
#
|
14331
|
-
# here in bold:
|
14499
|
+
# **Routing**, **Flows**. Choose the flow. On the flow page, under the
|
14500
|
+
# name of the flow, choose **Show additional flow information**. The
|
14501
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
14332
14502
|
#
|
14333
14503
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
14334
14504
|
#
|
@@ -14971,6 +15141,84 @@ module Aws::Connect
|
|
14971
15141
|
req.send_request(options)
|
14972
15142
|
end
|
14973
15143
|
|
15144
|
+
# This API is in preview release for Amazon Connect and is subject to
|
15145
|
+
# change. To request access to this API, contact Amazon Web Services
|
15146
|
+
# Support.
|
15147
|
+
#
|
15148
|
+
# Updates the selected authentication profile.
|
15149
|
+
#
|
15150
|
+
# @option params [required, String] :authentication_profile_id
|
15151
|
+
# A unique identifier for the authentication profile.
|
15152
|
+
#
|
15153
|
+
# @option params [required, String] :instance_id
|
15154
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
15155
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
15156
|
+
#
|
15157
|
+
#
|
15158
|
+
#
|
15159
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
15160
|
+
#
|
15161
|
+
# @option params [String] :name
|
15162
|
+
# The name for the authentication profile.
|
15163
|
+
#
|
15164
|
+
# @option params [String] :description
|
15165
|
+
# The description for the authentication profile.
|
15166
|
+
#
|
15167
|
+
# @option params [Array<String>] :allowed_ips
|
15168
|
+
# A list of IP address range strings that are allowed to access the
|
15169
|
+
# instance. For more information on how to configure IP addresses,
|
15170
|
+
# see[Configure session timeouts][1] in the *Amazon Connect
|
15171
|
+
# Administrator Guide*.
|
15172
|
+
#
|
15173
|
+
#
|
15174
|
+
#
|
15175
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
|
15176
|
+
#
|
15177
|
+
# @option params [Array<String>] :blocked_ips
|
15178
|
+
# A list of IP address range strings that are blocked from accessing the
|
15179
|
+
# instance. For more information on how to configure IP addresses, For
|
15180
|
+
# more information on how to configure IP addresses, see [Configure
|
15181
|
+
# IP-based access control][1] in the *Amazon Connect Administrator
|
15182
|
+
# Guide*.
|
15183
|
+
#
|
15184
|
+
#
|
15185
|
+
#
|
15186
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac
|
15187
|
+
#
|
15188
|
+
# @option params [Integer] :periodic_session_duration
|
15189
|
+
# The short lived session duration configuration for users logged in to
|
15190
|
+
# Amazon Connect, in minutes. This value determines the maximum possible
|
15191
|
+
# time before an agent is authenticated. For more information, For more
|
15192
|
+
# information on how to configure IP addresses, see [Configure session
|
15193
|
+
# timeouts][1] in the *Amazon Connect Administrator Guide*.
|
15194
|
+
#
|
15195
|
+
#
|
15196
|
+
#
|
15197
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts
|
15198
|
+
#
|
15199
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
15200
|
+
#
|
15201
|
+
# @example Request syntax with placeholder values
|
15202
|
+
#
|
15203
|
+
# resp = client.update_authentication_profile({
|
15204
|
+
# authentication_profile_id: "AuthenticationProfileId", # required
|
15205
|
+
# instance_id: "InstanceId", # required
|
15206
|
+
# name: "AuthenticationProfileName",
|
15207
|
+
# description: "AuthenticationProfileDescription",
|
15208
|
+
# allowed_ips: ["IpCidr"],
|
15209
|
+
# blocked_ips: ["IpCidr"],
|
15210
|
+
# periodic_session_duration: 1,
|
15211
|
+
# })
|
15212
|
+
#
|
15213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateAuthenticationProfile AWS API Documentation
|
15214
|
+
#
|
15215
|
+
# @overload update_authentication_profile(params = {})
|
15216
|
+
# @param [Hash] params ({})
|
15217
|
+
def update_authentication_profile(params = {}, options = {})
|
15218
|
+
req = build_request(:update_authentication_profile, params)
|
15219
|
+
req.send_request(options)
|
15220
|
+
end
|
15221
|
+
|
14974
15222
|
# This API is in preview release for Amazon Connect and is subject to
|
14975
15223
|
# change.
|
14976
15224
|
#
|
@@ -17493,7 +17741,7 @@ module Aws::Connect
|
|
17493
17741
|
params: params,
|
17494
17742
|
config: config)
|
17495
17743
|
context[:gem_name] = 'aws-sdk-connect'
|
17496
|
-
context[:gem_version] = '1.
|
17744
|
+
context[:gem_version] = '1.166.0'
|
17497
17745
|
Seahorse::Client::Request.new(handlers, context)
|
17498
17746
|
end
|
17499
17747
|
|