aws-sdk-connect 1.133.0 → 1.135.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 +225 -1
- data/lib/aws-sdk-connect/client_api.rb +99 -0
- data/lib/aws-sdk-connect/endpoints.rb +28 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-connect/types.rb +318 -1
- 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: adf5027a3aeccade3bee20ce436851ca1f1c994ea5a16092deb9fbc5401933c8
|
4
|
+
data.tar.gz: 9b793550200b4c2d4af2251dd149753b40d1bee62bd667acacd08b248db910f4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 552f89e0cd0bd0fb389c467f00d5aa01a352c95e1001ecd18443eee1cced7279bddea0885b24ab1d8d07c8fc5bb86743fac106bb9da600297435262b67d3e32f
|
7
|
+
data.tar.gz: c4c5cfa56c128315825c39b1b636fed90b8437588d006564a23758c5d374f213ef90dd0a8eed8ab7c6e05102f04b50b6d65b19a74d3fb89f71bafb318ee66081
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.135.0 (2023-11-06)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added new API that allows Amazon Connect Outbound Campaigns to create contacts in Amazon Connect when ingesting your dial requests.
|
8
|
+
|
9
|
+
1.134.0 (2023-11-03)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Connect Chat introduces Create Persistent Contact Association API, allowing customers to choose when to resume previous conversations from previous chats, eliminating the need to repeat themselves and allowing agents to provide personalized service with access to entire conversation history.
|
13
|
+
|
4
14
|
1.133.0 (2023-11-02)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.135.0
|
@@ -963,6 +963,98 @@ module Aws::Connect
|
|
963
963
|
req.send_request(options)
|
964
964
|
end
|
965
965
|
|
966
|
+
# <note markdown="1"> Only the Amazon Connect outbound campaigns service principal is
|
967
|
+
# allowed to assume a role in your account and call this API.
|
968
|
+
#
|
969
|
+
# </note>
|
970
|
+
#
|
971
|
+
# Allows you to create a batch of contacts in Amazon Connect. The
|
972
|
+
# outbound campaigns capability ingests dial requests via the
|
973
|
+
# [PutDialRequestBatch][1] API. It then uses BatchPutContact to create
|
974
|
+
# contacts corresponding to those dial requests. If agents are
|
975
|
+
# available, the dial requests are dialed out, which results in a voice
|
976
|
+
# call. The resulting voice call uses the same contactId that was
|
977
|
+
# created by BatchPutContact.
|
978
|
+
#
|
979
|
+
#
|
980
|
+
#
|
981
|
+
# [1]: https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html
|
982
|
+
#
|
983
|
+
# @option params [String] :client_token
|
984
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
985
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
986
|
+
# SDK populates this field. For more information about idempotency, see
|
987
|
+
# [Making retries safe with idempotent APIs][1].
|
988
|
+
#
|
989
|
+
# **A suitable default value is auto-generated.** You should normally
|
990
|
+
# not need to pass this option.**
|
991
|
+
#
|
992
|
+
#
|
993
|
+
#
|
994
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
995
|
+
#
|
996
|
+
# @option params [required, String] :instance_id
|
997
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
998
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
999
|
+
#
|
1000
|
+
#
|
1001
|
+
#
|
1002
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1003
|
+
#
|
1004
|
+
# @option params [required, Array<Types::ContactDataRequest>] :contact_data_request_list
|
1005
|
+
# List of individual contact requests.
|
1006
|
+
#
|
1007
|
+
# @return [Types::BatchPutContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
|
+
#
|
1009
|
+
# * {Types::BatchPutContactResponse#successful_request_list #successful_request_list} => Array<Types::SuccessfulRequest>
|
1010
|
+
# * {Types::BatchPutContactResponse#failed_request_list #failed_request_list} => Array<Types::FailedRequest>
|
1011
|
+
#
|
1012
|
+
# @example Request syntax with placeholder values
|
1013
|
+
#
|
1014
|
+
# resp = client.batch_put_contact({
|
1015
|
+
# client_token: "ClientToken",
|
1016
|
+
# instance_id: "InstanceId", # required
|
1017
|
+
# contact_data_request_list: [ # required
|
1018
|
+
# {
|
1019
|
+
# system_endpoint: {
|
1020
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
|
1021
|
+
# address: "EndpointAddress",
|
1022
|
+
# },
|
1023
|
+
# customer_endpoint: {
|
1024
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
|
1025
|
+
# address: "EndpointAddress",
|
1026
|
+
# },
|
1027
|
+
# request_identifier: "RequestIdentifier",
|
1028
|
+
# queue_id: "QueueId",
|
1029
|
+
# attributes: {
|
1030
|
+
# "AttributeName" => "AttributeValue",
|
1031
|
+
# },
|
1032
|
+
# campaign: {
|
1033
|
+
# campaign_id: "CampaignId",
|
1034
|
+
# },
|
1035
|
+
# },
|
1036
|
+
# ],
|
1037
|
+
# })
|
1038
|
+
#
|
1039
|
+
# @example Response structure
|
1040
|
+
#
|
1041
|
+
# resp.successful_request_list #=> Array
|
1042
|
+
# resp.successful_request_list[0].request_identifier #=> String
|
1043
|
+
# resp.successful_request_list[0].contact_id #=> String
|
1044
|
+
# resp.failed_request_list #=> Array
|
1045
|
+
# resp.failed_request_list[0].request_identifier #=> String
|
1046
|
+
# resp.failed_request_list[0].failure_reason_code #=> String, one of "INVALID_ATTRIBUTE_KEY", "INVALID_CUSTOMER_ENDPOINT", "INVALID_SYSTEM_ENDPOINT", "INVALID_QUEUE", "MISSING_CAMPAIGN", "MISSING_CUSTOMER_ENDPOINT", "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT", "REQUEST_THROTTLED", "IDEMPOTENCY_EXCEPTION", "INTERNAL_ERROR"
|
1047
|
+
# resp.failed_request_list[0].failure_reason_message #=> String
|
1048
|
+
#
|
1049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContact AWS API Documentation
|
1050
|
+
#
|
1051
|
+
# @overload batch_put_contact(params = {})
|
1052
|
+
# @param [Hash] params ({})
|
1053
|
+
def batch_put_contact(params = {}, options = {})
|
1054
|
+
req = build_request(:batch_put_contact, params)
|
1055
|
+
req.send_request(options)
|
1056
|
+
end
|
1057
|
+
|
966
1058
|
# Claims an available phone number to your Amazon Connect instance or
|
967
1059
|
# traffic distribution group. You can call this API only in the same
|
968
1060
|
# Amazon Web Services Region where the Amazon Connect instance or
|
@@ -1704,6 +1796,131 @@ module Aws::Connect
|
|
1704
1796
|
req.send_request(options)
|
1705
1797
|
end
|
1706
1798
|
|
1799
|
+
# Enables rehydration of chats for the lifespan of a contact. For more
|
1800
|
+
# information about chat rehydration, see [Enable persistent chat][1] in
|
1801
|
+
# the *Amazon Connect Administrator Guide*.
|
1802
|
+
#
|
1803
|
+
#
|
1804
|
+
#
|
1805
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
|
1806
|
+
#
|
1807
|
+
# @option params [required, String] :instance_id
|
1808
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
1809
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
1810
|
+
#
|
1811
|
+
#
|
1812
|
+
#
|
1813
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1814
|
+
#
|
1815
|
+
# @option params [required, String] :initial_contact_id
|
1816
|
+
# This is the contactId of the current contact that the
|
1817
|
+
# `CreatePersistentContactAssociation` API is being called from.
|
1818
|
+
#
|
1819
|
+
# @option params [required, String] :rehydration_type
|
1820
|
+
# The contactId chosen for rehydration depends on the type chosen.
|
1821
|
+
#
|
1822
|
+
# * `ENTIRE_PAST_SESSION`: Rehydrates a chat from the most recently
|
1823
|
+
# terminated past chat contact of the specified past ended chat
|
1824
|
+
# session. To use this type, provide the `initialContactId` of the
|
1825
|
+
# past ended chat session in the `sourceContactId` field. In this
|
1826
|
+
# type, Amazon Connect determines what the most recent chat contact on
|
1827
|
+
# the past ended chat session and uses it to start a persistent chat.
|
1828
|
+
#
|
1829
|
+
# * `FROM_SEGMENT`: Rehydrates a chat from the specified past chat
|
1830
|
+
# contact provided in the `sourceContactId` field.
|
1831
|
+
#
|
1832
|
+
# The actual contactId used for rehydration is provided in the response
|
1833
|
+
# of this API.
|
1834
|
+
#
|
1835
|
+
# To illustrate how to use rehydration type, consider the following
|
1836
|
+
# example: A customer starts a chat session. Agent a1 accepts the chat
|
1837
|
+
# and a conversation starts between the customer and Agent a1. This
|
1838
|
+
# first contact creates a contact ID **C1**. Agent a1 then transfers the
|
1839
|
+
# chat to Agent a2. This creates another contact ID **C2**. At this
|
1840
|
+
# point Agent a2 ends the chat. The customer is forwarded to the
|
1841
|
+
# disconnect flow for a post chat survey that creates another contact ID
|
1842
|
+
# **C3**. After the chat survey, the chat session ends. Later, the
|
1843
|
+
# customer returns and wants to resume their past chat session. At this
|
1844
|
+
# point, the customer can have following use cases:
|
1845
|
+
#
|
1846
|
+
# * **Use Case 1**: The customer wants to continue the past chat session
|
1847
|
+
# but they want to hide the post chat survey. For this they will use
|
1848
|
+
# the following configuration:
|
1849
|
+
#
|
1850
|
+
# * **Configuration**
|
1851
|
+
#
|
1852
|
+
# * SourceContactId = "C2"
|
1853
|
+
#
|
1854
|
+
# * RehydrationType = "FROM\_SEGMENT"
|
1855
|
+
#
|
1856
|
+
# * **Expected behavior**
|
1857
|
+
#
|
1858
|
+
# * This starts a persistent chat session from the specified past
|
1859
|
+
# ended contact (C2). Transcripts of past chat sessions C2 and C1
|
1860
|
+
# are accessible in the current persistent chat session. Note that
|
1861
|
+
# chat segment C3 is dropped from the persistent chat session.
|
1862
|
+
#
|
1863
|
+
# ^
|
1864
|
+
#
|
1865
|
+
# * **Use Case 2**: The customer wants to continue the past chat session
|
1866
|
+
# and see the transcript of the entire past engagement, including the
|
1867
|
+
# post chat survey. For this they will use the following
|
1868
|
+
# configuration:
|
1869
|
+
#
|
1870
|
+
# * **Configuration**
|
1871
|
+
#
|
1872
|
+
# * SourceContactId = "C1"
|
1873
|
+
#
|
1874
|
+
# * RehydrationType = "ENTIRE\_PAST\_SESSION"
|
1875
|
+
#
|
1876
|
+
# * **Expected behavior**
|
1877
|
+
#
|
1878
|
+
# * This starts a persistent chat session from the most recently
|
1879
|
+
# ended chat contact (C3). Transcripts of past chat sessions C3,
|
1880
|
+
# C2 and C1 are accessible in the current persistent chat session.
|
1881
|
+
#
|
1882
|
+
# ^
|
1883
|
+
#
|
1884
|
+
# @option params [required, String] :source_contact_id
|
1885
|
+
# The contactId from which a persistent chat session must be started.
|
1886
|
+
#
|
1887
|
+
# @option params [String] :client_token
|
1888
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1889
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1890
|
+
# SDK populates this field. For more information about idempotency, see
|
1891
|
+
# [Making retries safe with idempotent APIs][1].
|
1892
|
+
#
|
1893
|
+
#
|
1894
|
+
#
|
1895
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1896
|
+
#
|
1897
|
+
# @return [Types::CreatePersistentContactAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1898
|
+
#
|
1899
|
+
# * {Types::CreatePersistentContactAssociationResponse#continued_from_contact_id #continued_from_contact_id} => String
|
1900
|
+
#
|
1901
|
+
# @example Request syntax with placeholder values
|
1902
|
+
#
|
1903
|
+
# resp = client.create_persistent_contact_association({
|
1904
|
+
# instance_id: "InstanceId", # required
|
1905
|
+
# initial_contact_id: "ContactId", # required
|
1906
|
+
# rehydration_type: "ENTIRE_PAST_SESSION", # required, accepts ENTIRE_PAST_SESSION, FROM_SEGMENT
|
1907
|
+
# source_contact_id: "ContactId", # required
|
1908
|
+
# client_token: "ClientToken",
|
1909
|
+
# })
|
1910
|
+
#
|
1911
|
+
# @example Response structure
|
1912
|
+
#
|
1913
|
+
# resp.continued_from_contact_id #=> String
|
1914
|
+
#
|
1915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePersistentContactAssociation AWS API Documentation
|
1916
|
+
#
|
1917
|
+
# @overload create_persistent_contact_association(params = {})
|
1918
|
+
# @param [Hash] params ({})
|
1919
|
+
def create_persistent_contact_association(params = {}, options = {})
|
1920
|
+
req = build_request(:create_persistent_contact_association, params)
|
1921
|
+
req.send_request(options)
|
1922
|
+
end
|
1923
|
+
|
1707
1924
|
# Creates a prompt. For more information about prompts, such as
|
1708
1925
|
# supported file types and maximum length, see [Create prompts][1] in
|
1709
1926
|
# the *Amazon Connect Administrator's Guide*.
|
@@ -11339,6 +11556,10 @@ module Aws::Connect
|
|
11339
11556
|
#
|
11340
11557
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
11341
11558
|
#
|
11559
|
+
# @option params [Types::DisconnectReason] :disconnect_reason
|
11560
|
+
# The reason a contact can be disconnected. Only Amazon Connect outbound
|
11561
|
+
# campaigns can provide this field.
|
11562
|
+
#
|
11342
11563
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
11343
11564
|
#
|
11344
11565
|
# @example Request syntax with placeholder values
|
@@ -11346,6 +11567,9 @@ module Aws::Connect
|
|
11346
11567
|
# resp = client.stop_contact({
|
11347
11568
|
# contact_id: "ContactId", # required
|
11348
11569
|
# instance_id: "InstanceId", # required
|
11570
|
+
# disconnect_reason: {
|
11571
|
+
# code: "DisconnectReasonCode",
|
11572
|
+
# },
|
11349
11573
|
# })
|
11350
11574
|
#
|
11351
11575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation
|
@@ -14078,7 +14302,7 @@ module Aws::Connect
|
|
14078
14302
|
params: params,
|
14079
14303
|
config: config)
|
14080
14304
|
context[:gem_name] = 'aws-sdk-connect'
|
14081
|
-
context[:gem_version] = '1.
|
14305
|
+
context[:gem_version] = '1.135.0'
|
14082
14306
|
Seahorse::Client::Request.new(handlers, context)
|
14083
14307
|
end
|
14084
14308
|
|
@@ -79,11 +79,14 @@ module Aws::Connect
|
|
79
79
|
AwsRegion = Shapes::StringShape.new(name: 'AwsRegion')
|
80
80
|
BatchGetFlowAssociationRequest = Shapes::StructureShape.new(name: 'BatchGetFlowAssociationRequest')
|
81
81
|
BatchGetFlowAssociationResponse = Shapes::StructureShape.new(name: 'BatchGetFlowAssociationResponse')
|
82
|
+
BatchPutContactRequest = Shapes::StructureShape.new(name: 'BatchPutContactRequest')
|
83
|
+
BatchPutContactResponse = Shapes::StructureShape.new(name: 'BatchPutContactResponse')
|
82
84
|
BehaviorType = Shapes::StringShape.new(name: 'BehaviorType')
|
83
85
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
84
86
|
BotName = Shapes::StringShape.new(name: 'BotName')
|
85
87
|
BoxedBoolean = Shapes::BooleanShape.new(name: 'BoxedBoolean')
|
86
88
|
BucketName = Shapes::StringShape.new(name: 'BucketName')
|
89
|
+
Campaign = Shapes::StructureShape.new(name: 'Campaign')
|
87
90
|
CampaignId = Shapes::StringShape.new(name: 'CampaignId')
|
88
91
|
Channel = Shapes::StringShape.new(name: 'Channel')
|
89
92
|
ChannelToCountMap = Shapes::MapShape.new(name: 'ChannelToCountMap')
|
@@ -103,6 +106,8 @@ module Aws::Connect
|
|
103
106
|
Comparison = Shapes::StringShape.new(name: 'Comparison')
|
104
107
|
Concurrency = Shapes::IntegerShape.new(name: 'Concurrency')
|
105
108
|
Contact = Shapes::StructureShape.new(name: 'Contact')
|
109
|
+
ContactDataRequest = Shapes::StructureShape.new(name: 'ContactDataRequest')
|
110
|
+
ContactDataRequestList = Shapes::ListShape.new(name: 'ContactDataRequestList')
|
106
111
|
ContactFilter = Shapes::StructureShape.new(name: 'ContactFilter')
|
107
112
|
ContactFlow = Shapes::StructureShape.new(name: 'ContactFlow')
|
108
113
|
ContactFlowContent = Shapes::StringShape.new(name: 'ContactFlowContent')
|
@@ -148,6 +153,8 @@ module Aws::Connect
|
|
148
153
|
CreateIntegrationAssociationResponse = Shapes::StructureShape.new(name: 'CreateIntegrationAssociationResponse')
|
149
154
|
CreateParticipantRequest = Shapes::StructureShape.new(name: 'CreateParticipantRequest')
|
150
155
|
CreateParticipantResponse = Shapes::StructureShape.new(name: 'CreateParticipantResponse')
|
156
|
+
CreatePersistentContactAssociationRequest = Shapes::StructureShape.new(name: 'CreatePersistentContactAssociationRequest')
|
157
|
+
CreatePersistentContactAssociationResponse = Shapes::StructureShape.new(name: 'CreatePersistentContactAssociationResponse')
|
151
158
|
CreatePromptRequest = Shapes::StructureShape.new(name: 'CreatePromptRequest')
|
152
159
|
CreatePromptResponse = Shapes::StructureShape.new(name: 'CreatePromptResponse')
|
153
160
|
CreateQueueRequest = Shapes::StructureShape.new(name: 'CreateQueueRequest')
|
@@ -290,6 +297,8 @@ module Aws::Connect
|
|
290
297
|
DisassociateSecurityKeyRequest = Shapes::StructureShape.new(name: 'DisassociateSecurityKeyRequest')
|
291
298
|
DisassociateTrafficDistributionGroupUserRequest = Shapes::StructureShape.new(name: 'DisassociateTrafficDistributionGroupUserRequest')
|
292
299
|
DisassociateTrafficDistributionGroupUserResponse = Shapes::StructureShape.new(name: 'DisassociateTrafficDistributionGroupUserResponse')
|
300
|
+
DisconnectReason = Shapes::StructureShape.new(name: 'DisconnectReason')
|
301
|
+
DisconnectReasonCode = Shapes::StringShape.new(name: 'DisconnectReasonCode')
|
293
302
|
DismissUserContactRequest = Shapes::StructureShape.new(name: 'DismissUserContactRequest')
|
294
303
|
DismissUserContactResponse = Shapes::StructureShape.new(name: 'DismissUserContactResponse')
|
295
304
|
DisplayName = Shapes::StringShape.new(name: 'DisplayName')
|
@@ -300,6 +309,9 @@ module Aws::Connect
|
|
300
309
|
EmailReference = Shapes::StructureShape.new(name: 'EmailReference')
|
301
310
|
EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
|
302
311
|
EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
|
312
|
+
Endpoint = Shapes::StructureShape.new(name: 'Endpoint')
|
313
|
+
EndpointAddress = Shapes::StringShape.new(name: 'EndpointAddress')
|
314
|
+
EndpointType = Shapes::StringShape.new(name: 'EndpointType')
|
303
315
|
Evaluation = Shapes::StructureShape.new(name: 'Evaluation')
|
304
316
|
EvaluationAnswerData = Shapes::UnionShape.new(name: 'EvaluationAnswerData')
|
305
317
|
EvaluationAnswerDataNumericValue = Shapes::FloatShape.new(name: 'EvaluationAnswerDataNumericValue')
|
@@ -357,6 +369,9 @@ module Aws::Connect
|
|
357
369
|
EventBridgeActionDefinition = Shapes::StructureShape.new(name: 'EventBridgeActionDefinition')
|
358
370
|
EventBridgeActionName = Shapes::StringShape.new(name: 'EventBridgeActionName')
|
359
371
|
EventSourceName = Shapes::StringShape.new(name: 'EventSourceName')
|
372
|
+
FailedRequest = Shapes::StructureShape.new(name: 'FailedRequest')
|
373
|
+
FailedRequestList = Shapes::ListShape.new(name: 'FailedRequestList')
|
374
|
+
FailureReasonCode = Shapes::StringShape.new(name: 'FailureReasonCode')
|
360
375
|
FilterV2 = Shapes::StructureShape.new(name: 'FilterV2')
|
361
376
|
FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
|
362
377
|
Filters = Shapes::StructureShape.new(name: 'Filters')
|
@@ -699,6 +714,7 @@ module Aws::Connect
|
|
699
714
|
ReleasePhoneNumberRequest = Shapes::StructureShape.new(name: 'ReleasePhoneNumberRequest')
|
700
715
|
ReplicateInstanceRequest = Shapes::StructureShape.new(name: 'ReplicateInstanceRequest')
|
701
716
|
ReplicateInstanceResponse = Shapes::StructureShape.new(name: 'ReplicateInstanceResponse')
|
717
|
+
RequestIdentifier = Shapes::StringShape.new(name: 'RequestIdentifier')
|
702
718
|
RequiredFieldInfo = Shapes::StructureShape.new(name: 'RequiredFieldInfo')
|
703
719
|
RequiredTaskTemplateFields = Shapes::ListShape.new(name: 'RequiredTaskTemplateFields')
|
704
720
|
ResourceArnOrId = Shapes::StringShape.new(name: 'ResourceArnOrId')
|
@@ -822,6 +838,8 @@ module Aws::Connect
|
|
822
838
|
Subject = Shapes::StringShape.new(name: 'Subject')
|
823
839
|
SubmitContactEvaluationRequest = Shapes::StructureShape.new(name: 'SubmitContactEvaluationRequest')
|
824
840
|
SubmitContactEvaluationResponse = Shapes::StructureShape.new(name: 'SubmitContactEvaluationResponse')
|
841
|
+
SuccessfulRequest = Shapes::StructureShape.new(name: 'SuccessfulRequest')
|
842
|
+
SuccessfulRequestList = Shapes::ListShape.new(name: 'SuccessfulRequestList')
|
825
843
|
SupportedMessagingContentType = Shapes::StringShape.new(name: 'SupportedMessagingContentType')
|
826
844
|
SupportedMessagingContentTypes = Shapes::ListShape.new(name: 'SupportedMessagingContentTypes')
|
827
845
|
SuspendContactRecordingRequest = Shapes::StructureShape.new(name: 'SuspendContactRecordingRequest')
|
@@ -1195,6 +1213,18 @@ module Aws::Connect
|
|
1195
1213
|
BatchGetFlowAssociationResponse.add_member(:flow_association_summary_list, Shapes::ShapeRef.new(shape: FlowAssociationSummaryList, location_name: "FlowAssociationSummaryList"))
|
1196
1214
|
BatchGetFlowAssociationResponse.struct_class = Types::BatchGetFlowAssociationResponse
|
1197
1215
|
|
1216
|
+
BatchPutContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
1217
|
+
BatchPutContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1218
|
+
BatchPutContactRequest.add_member(:contact_data_request_list, Shapes::ShapeRef.new(shape: ContactDataRequestList, required: true, location_name: "ContactDataRequestList"))
|
1219
|
+
BatchPutContactRequest.struct_class = Types::BatchPutContactRequest
|
1220
|
+
|
1221
|
+
BatchPutContactResponse.add_member(:successful_request_list, Shapes::ShapeRef.new(shape: SuccessfulRequestList, location_name: "SuccessfulRequestList"))
|
1222
|
+
BatchPutContactResponse.add_member(:failed_request_list, Shapes::ShapeRef.new(shape: FailedRequestList, location_name: "FailedRequestList"))
|
1223
|
+
BatchPutContactResponse.struct_class = Types::BatchPutContactResponse
|
1224
|
+
|
1225
|
+
Campaign.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, location_name: "CampaignId"))
|
1226
|
+
Campaign.struct_class = Types::Campaign
|
1227
|
+
|
1198
1228
|
ChannelToCountMap.key = Shapes::ShapeRef.new(shape: Channel)
|
1199
1229
|
ChannelToCountMap.value = Shapes::ShapeRef.new(shape: IntegerCount)
|
1200
1230
|
|
@@ -1252,6 +1282,16 @@ module Aws::Connect
|
|
1252
1282
|
Contact.add_member(:wisdom_info, Shapes::ShapeRef.new(shape: WisdomInfo, location_name: "WisdomInfo"))
|
1253
1283
|
Contact.struct_class = Types::Contact
|
1254
1284
|
|
1285
|
+
ContactDataRequest.add_member(:system_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "SystemEndpoint"))
|
1286
|
+
ContactDataRequest.add_member(:customer_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "CustomerEndpoint"))
|
1287
|
+
ContactDataRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
|
1288
|
+
ContactDataRequest.add_member(:queue_id, Shapes::ShapeRef.new(shape: QueueId, location_name: "QueueId"))
|
1289
|
+
ContactDataRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
1290
|
+
ContactDataRequest.add_member(:campaign, Shapes::ShapeRef.new(shape: Campaign, location_name: "Campaign"))
|
1291
|
+
ContactDataRequest.struct_class = Types::ContactDataRequest
|
1292
|
+
|
1293
|
+
ContactDataRequestList.member = Shapes::ShapeRef.new(shape: ContactDataRequest)
|
1294
|
+
|
1255
1295
|
ContactFilter.add_member(:contact_states, Shapes::ShapeRef.new(shape: ContactStates, location_name: "ContactStates"))
|
1256
1296
|
ContactFilter.struct_class = Types::ContactFilter
|
1257
1297
|
|
@@ -1405,6 +1445,16 @@ module Aws::Connect
|
|
1405
1445
|
CreateParticipantResponse.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
1406
1446
|
CreateParticipantResponse.struct_class = Types::CreateParticipantResponse
|
1407
1447
|
|
1448
|
+
CreatePersistentContactAssociationRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1449
|
+
CreatePersistentContactAssociationRequest.add_member(:initial_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location: "uri", location_name: "InitialContactId"))
|
1450
|
+
CreatePersistentContactAssociationRequest.add_member(:rehydration_type, Shapes::ShapeRef.new(shape: RehydrationType, required: true, location_name: "RehydrationType"))
|
1451
|
+
CreatePersistentContactAssociationRequest.add_member(:source_contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "SourceContactId"))
|
1452
|
+
CreatePersistentContactAssociationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken"))
|
1453
|
+
CreatePersistentContactAssociationRequest.struct_class = Types::CreatePersistentContactAssociationRequest
|
1454
|
+
|
1455
|
+
CreatePersistentContactAssociationResponse.add_member(:continued_from_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContinuedFromContactId"))
|
1456
|
+
CreatePersistentContactAssociationResponse.struct_class = Types::CreatePersistentContactAssociationResponse
|
1457
|
+
|
1408
1458
|
CreatePromptRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1409
1459
|
CreatePromptRequest.add_member(:name, Shapes::ShapeRef.new(shape: CommonNameLength127, required: true, location_name: "Name"))
|
1410
1460
|
CreatePromptRequest.add_member(:description, Shapes::ShapeRef.new(shape: PromptDescription, location_name: "Description"))
|
@@ -1954,6 +2004,9 @@ module Aws::Connect
|
|
1954
2004
|
|
1955
2005
|
DisassociateTrafficDistributionGroupUserResponse.struct_class = Types::DisassociateTrafficDistributionGroupUserResponse
|
1956
2006
|
|
2007
|
+
DisconnectReason.add_member(:code, Shapes::ShapeRef.new(shape: DisconnectReasonCode, location_name: "Code"))
|
2008
|
+
DisconnectReason.struct_class = Types::DisconnectReason
|
2009
|
+
|
1957
2010
|
DismissUserContactRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, required: true, location: "uri", location_name: "UserId"))
|
1958
2011
|
DismissUserContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
1959
2012
|
DismissUserContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
|
@@ -1978,6 +2031,10 @@ module Aws::Connect
|
|
1978
2031
|
EncryptionConfig.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyId, required: true, location_name: "KeyId"))
|
1979
2032
|
EncryptionConfig.struct_class = Types::EncryptionConfig
|
1980
2033
|
|
2034
|
+
Endpoint.add_member(:type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "Type"))
|
2035
|
+
Endpoint.add_member(:address, Shapes::ShapeRef.new(shape: EndpointAddress, location_name: "Address"))
|
2036
|
+
Endpoint.struct_class = Types::Endpoint
|
2037
|
+
|
1981
2038
|
Evaluation.add_member(:evaluation_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "EvaluationId"))
|
1982
2039
|
Evaluation.add_member(:evaluation_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "EvaluationArn"))
|
1983
2040
|
Evaluation.add_member(:metadata, Shapes::ShapeRef.new(shape: EvaluationMetadata, required: true, location_name: "Metadata"))
|
@@ -2185,6 +2242,13 @@ module Aws::Connect
|
|
2185
2242
|
EventBridgeActionDefinition.add_member(:name, Shapes::ShapeRef.new(shape: EventBridgeActionName, required: true, location_name: "Name"))
|
2186
2243
|
EventBridgeActionDefinition.struct_class = Types::EventBridgeActionDefinition
|
2187
2244
|
|
2245
|
+
FailedRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
|
2246
|
+
FailedRequest.add_member(:failure_reason_code, Shapes::ShapeRef.new(shape: FailureReasonCode, location_name: "FailureReasonCode"))
|
2247
|
+
FailedRequest.add_member(:failure_reason_message, Shapes::ShapeRef.new(shape: String, location_name: "FailureReasonMessage"))
|
2248
|
+
FailedRequest.struct_class = Types::FailedRequest
|
2249
|
+
|
2250
|
+
FailedRequestList.member = Shapes::ShapeRef.new(shape: FailedRequest)
|
2251
|
+
|
2188
2252
|
FilterV2.add_member(:filter_key, Shapes::ShapeRef.new(shape: ResourceArnOrId, location_name: "FilterKey"))
|
2189
2253
|
FilterV2.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValueList, location_name: "FilterValues"))
|
2190
2254
|
FilterV2.struct_class = Types::FilterV2
|
@@ -3691,6 +3755,7 @@ module Aws::Connect
|
|
3691
3755
|
|
3692
3756
|
StopContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
|
3693
3757
|
StopContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
3758
|
+
StopContactRequest.add_member(:disconnect_reason, Shapes::ShapeRef.new(shape: DisconnectReason, location_name: "DisconnectReason"))
|
3694
3759
|
StopContactRequest.struct_class = Types::StopContactRequest
|
3695
3760
|
|
3696
3761
|
StopContactResponse.struct_class = Types::StopContactResponse
|
@@ -3721,6 +3786,12 @@ module Aws::Connect
|
|
3721
3786
|
SubmitContactEvaluationResponse.add_member(:evaluation_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "EvaluationArn"))
|
3722
3787
|
SubmitContactEvaluationResponse.struct_class = Types::SubmitContactEvaluationResponse
|
3723
3788
|
|
3789
|
+
SuccessfulRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
|
3790
|
+
SuccessfulRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
3791
|
+
SuccessfulRequest.struct_class = Types::SuccessfulRequest
|
3792
|
+
|
3793
|
+
SuccessfulRequestList.member = Shapes::ShapeRef.new(shape: SuccessfulRequest)
|
3794
|
+
|
3724
3795
|
SupportedMessagingContentTypes.member = Shapes::ShapeRef.new(shape: SupportedMessagingContentType)
|
3725
3796
|
|
3726
3797
|
SuspendContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
@@ -4576,6 +4647,20 @@ module Aws::Connect
|
|
4576
4647
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
4577
4648
|
end)
|
4578
4649
|
|
4650
|
+
api.add_operation(:batch_put_contact, Seahorse::Model::Operation.new.tap do |o|
|
4651
|
+
o.name = "BatchPutContact"
|
4652
|
+
o.http_method = "PUT"
|
4653
|
+
o.http_request_uri = "/contact/batch/{InstanceId}"
|
4654
|
+
o.input = Shapes::ShapeRef.new(shape: BatchPutContactRequest)
|
4655
|
+
o.output = Shapes::ShapeRef.new(shape: BatchPutContactResponse)
|
4656
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
4657
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
4658
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
4659
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
4660
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
4661
|
+
o.errors << Shapes::ShapeRef.new(shape: IdempotencyException)
|
4662
|
+
end)
|
4663
|
+
|
4579
4664
|
api.add_operation(:claim_phone_number, Seahorse::Model::Operation.new.tap do |o|
|
4580
4665
|
o.name = "ClaimPhoneNumber"
|
4581
4666
|
o.http_method = "POST"
|
@@ -4707,6 +4792,20 @@ module Aws::Connect
|
|
4707
4792
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
4708
4793
|
end)
|
4709
4794
|
|
4795
|
+
api.add_operation(:create_persistent_contact_association, Seahorse::Model::Operation.new.tap do |o|
|
4796
|
+
o.name = "CreatePersistentContactAssociation"
|
4797
|
+
o.http_method = "POST"
|
4798
|
+
o.http_request_uri = "/contact/persistent-contact-association/{InstanceId}/{InitialContactId}"
|
4799
|
+
o.input = Shapes::ShapeRef.new(shape: CreatePersistentContactAssociationRequest)
|
4800
|
+
o.output = Shapes::ShapeRef.new(shape: CreatePersistentContactAssociationResponse)
|
4801
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
4802
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
4803
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
4804
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
4805
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
4806
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
4807
|
+
end)
|
4808
|
+
|
4710
4809
|
api.add_operation(:create_prompt, Seahorse::Model::Operation.new.tap do |o|
|
4711
4810
|
o.name = "CreatePrompt"
|
4712
4811
|
o.http_method = "PUT"
|
@@ -194,6 +194,20 @@ module Aws::Connect
|
|
194
194
|
end
|
195
195
|
end
|
196
196
|
|
197
|
+
class BatchPutContact
|
198
|
+
def self.build(context)
|
199
|
+
unless context.config.regional_endpoint
|
200
|
+
endpoint = context.config.endpoint.to_s
|
201
|
+
end
|
202
|
+
Aws::Connect::EndpointParameters.new(
|
203
|
+
region: context.config.region,
|
204
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
205
|
+
use_fips: context.config.use_fips_endpoint,
|
206
|
+
endpoint: endpoint,
|
207
|
+
)
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
197
211
|
class ClaimPhoneNumber
|
198
212
|
def self.build(context)
|
199
213
|
unless context.config.regional_endpoint
|
@@ -320,6 +334,20 @@ module Aws::Connect
|
|
320
334
|
end
|
321
335
|
end
|
322
336
|
|
337
|
+
class CreatePersistentContactAssociation
|
338
|
+
def self.build(context)
|
339
|
+
unless context.config.regional_endpoint
|
340
|
+
endpoint = context.config.endpoint.to_s
|
341
|
+
end
|
342
|
+
Aws::Connect::EndpointParameters.new(
|
343
|
+
region: context.config.region,
|
344
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
345
|
+
use_fips: context.config.use_fips_endpoint,
|
346
|
+
endpoint: endpoint,
|
347
|
+
)
|
348
|
+
end
|
349
|
+
end
|
350
|
+
|
323
351
|
class CreatePrompt
|
324
352
|
def self.build(context)
|
325
353
|
unless context.config.regional_endpoint
|
@@ -82,6 +82,8 @@ module Aws::Connect
|
|
82
82
|
Aws::Connect::Endpoints::AssociateTrafficDistributionGroupUser.build(context)
|
83
83
|
when :batch_get_flow_association
|
84
84
|
Aws::Connect::Endpoints::BatchGetFlowAssociation.build(context)
|
85
|
+
when :batch_put_contact
|
86
|
+
Aws::Connect::Endpoints::BatchPutContact.build(context)
|
85
87
|
when :claim_phone_number
|
86
88
|
Aws::Connect::Endpoints::ClaimPhoneNumber.build(context)
|
87
89
|
when :create_agent_status
|
@@ -100,6 +102,8 @@ module Aws::Connect
|
|
100
102
|
Aws::Connect::Endpoints::CreateIntegrationAssociation.build(context)
|
101
103
|
when :create_participant
|
102
104
|
Aws::Connect::Endpoints::CreateParticipant.build(context)
|
105
|
+
when :create_persistent_contact_association
|
106
|
+
Aws::Connect::Endpoints::CreatePersistentContactAssociation.build(context)
|
103
107
|
when :create_prompt
|
104
108
|
Aws::Connect::Endpoints::CreatePrompt.build(context)
|
105
109
|
when :create_queue
|
@@ -788,6 +788,74 @@ module Aws::Connect
|
|
788
788
|
include Aws::Structure
|
789
789
|
end
|
790
790
|
|
791
|
+
# @!attribute [rw] client_token
|
792
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
793
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
794
|
+
# SDK populates this field. For more information about idempotency,
|
795
|
+
# see [Making retries safe with idempotent APIs][1].
|
796
|
+
#
|
797
|
+
# **A suitable default value is auto-generated.** You should normally
|
798
|
+
# not need to pass this option.
|
799
|
+
#
|
800
|
+
#
|
801
|
+
#
|
802
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
803
|
+
# @return [String]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] instance_id
|
806
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
807
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
808
|
+
#
|
809
|
+
#
|
810
|
+
#
|
811
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
812
|
+
# @return [String]
|
813
|
+
#
|
814
|
+
# @!attribute [rw] contact_data_request_list
|
815
|
+
# List of individual contact requests.
|
816
|
+
# @return [Array<Types::ContactDataRequest>]
|
817
|
+
#
|
818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContactRequest AWS API Documentation
|
819
|
+
#
|
820
|
+
class BatchPutContactRequest < Struct.new(
|
821
|
+
:client_token,
|
822
|
+
:instance_id,
|
823
|
+
:contact_data_request_list)
|
824
|
+
SENSITIVE = []
|
825
|
+
include Aws::Structure
|
826
|
+
end
|
827
|
+
|
828
|
+
# @!attribute [rw] successful_request_list
|
829
|
+
# List of requests for which contact was successfully created.
|
830
|
+
# @return [Array<Types::SuccessfulRequest>]
|
831
|
+
#
|
832
|
+
# @!attribute [rw] failed_request_list
|
833
|
+
# List of requests for which contact creation failed.
|
834
|
+
# @return [Array<Types::FailedRequest>]
|
835
|
+
#
|
836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContactResponse AWS API Documentation
|
837
|
+
#
|
838
|
+
class BatchPutContactResponse < Struct.new(
|
839
|
+
:successful_request_list,
|
840
|
+
:failed_request_list)
|
841
|
+
SENSITIVE = []
|
842
|
+
include Aws::Structure
|
843
|
+
end
|
844
|
+
|
845
|
+
# Information associated with a campaign.
|
846
|
+
#
|
847
|
+
# @!attribute [rw] campaign_id
|
848
|
+
# A unique identifier for a campaign.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Campaign AWS API Documentation
|
852
|
+
#
|
853
|
+
class Campaign < Struct.new(
|
854
|
+
:campaign_id)
|
855
|
+
SENSITIVE = []
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
791
859
|
# A chat message.
|
792
860
|
#
|
793
861
|
# @!attribute [rw] content_type
|
@@ -1138,6 +1206,47 @@ module Aws::Connect
|
|
1138
1206
|
include Aws::Structure
|
1139
1207
|
end
|
1140
1208
|
|
1209
|
+
# Request object with information to create a contact.
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] system_endpoint
|
1212
|
+
# Endpoint associated with the Amazon Connect instance from which
|
1213
|
+
# outbound contact will be initiated for the campaign.
|
1214
|
+
# @return [Types::Endpoint]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] customer_endpoint
|
1217
|
+
# Endpoint of the customer for which contact will be initiated.
|
1218
|
+
# @return [Types::Endpoint]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] request_identifier
|
1221
|
+
# Identifier to uniquely identify individual requests in the batch.
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] queue_id
|
1225
|
+
# The identifier of the queue associated with the Amazon Connect
|
1226
|
+
# instance in which contacts that are created will be queued.
|
1227
|
+
# @return [String]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] attributes
|
1230
|
+
# List of attributes to be stored in a contact.
|
1231
|
+
# @return [Hash<String,String>]
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] campaign
|
1234
|
+
# Structure to store information associated with a campaign.
|
1235
|
+
# @return [Types::Campaign]
|
1236
|
+
#
|
1237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactDataRequest AWS API Documentation
|
1238
|
+
#
|
1239
|
+
class ContactDataRequest < Struct.new(
|
1240
|
+
:system_endpoint,
|
1241
|
+
:customer_endpoint,
|
1242
|
+
:request_identifier,
|
1243
|
+
:queue_id,
|
1244
|
+
:attributes,
|
1245
|
+
:campaign)
|
1246
|
+
SENSITIVE = []
|
1247
|
+
include Aws::Structure
|
1248
|
+
end
|
1249
|
+
|
1141
1250
|
# Filters user data based on the contact information that is associated
|
1142
1251
|
# to the users. It contains a list of [contact states][1].
|
1143
1252
|
#
|
@@ -1945,6 +2054,129 @@ module Aws::Connect
|
|
1945
2054
|
include Aws::Structure
|
1946
2055
|
end
|
1947
2056
|
|
2057
|
+
# @!attribute [rw] instance_id
|
2058
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2059
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2060
|
+
#
|
2061
|
+
#
|
2062
|
+
#
|
2063
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2064
|
+
# @return [String]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] initial_contact_id
|
2067
|
+
# This is the contactId of the current contact that the
|
2068
|
+
# `CreatePersistentContactAssociation` API is being called from.
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] rehydration_type
|
2072
|
+
# The contactId chosen for rehydration depends on the type chosen.
|
2073
|
+
#
|
2074
|
+
# * `ENTIRE_PAST_SESSION`: Rehydrates a chat from the most recently
|
2075
|
+
# terminated past chat contact of the specified past ended chat
|
2076
|
+
# session. To use this type, provide the `initialContactId` of the
|
2077
|
+
# past ended chat session in the `sourceContactId` field. In this
|
2078
|
+
# type, Amazon Connect determines what the most recent chat contact
|
2079
|
+
# on the past ended chat session and uses it to start a persistent
|
2080
|
+
# chat.
|
2081
|
+
#
|
2082
|
+
# * `FROM_SEGMENT`: Rehydrates a chat from the specified past chat
|
2083
|
+
# contact provided in the `sourceContactId` field.
|
2084
|
+
#
|
2085
|
+
# The actual contactId used for rehydration is provided in the
|
2086
|
+
# response of this API.
|
2087
|
+
#
|
2088
|
+
# To illustrate how to use rehydration type, consider the following
|
2089
|
+
# example: A customer starts a chat session. Agent a1 accepts the chat
|
2090
|
+
# and a conversation starts between the customer and Agent a1. This
|
2091
|
+
# first contact creates a contact ID **C1**. Agent a1 then transfers
|
2092
|
+
# the chat to Agent a2. This creates another contact ID **C2**. At
|
2093
|
+
# this point Agent a2 ends the chat. The customer is forwarded to the
|
2094
|
+
# disconnect flow for a post chat survey that creates another contact
|
2095
|
+
# ID **C3**. After the chat survey, the chat session ends. Later, the
|
2096
|
+
# customer returns and wants to resume their past chat session. At
|
2097
|
+
# this point, the customer can have following use cases:
|
2098
|
+
#
|
2099
|
+
# * **Use Case 1**: The customer wants to continue the past chat
|
2100
|
+
# session but they want to hide the post chat survey. For this they
|
2101
|
+
# will use the following configuration:
|
2102
|
+
#
|
2103
|
+
# * **Configuration**
|
2104
|
+
#
|
2105
|
+
# * SourceContactId = "C2"
|
2106
|
+
#
|
2107
|
+
# * RehydrationType = "FROM\_SEGMENT"
|
2108
|
+
#
|
2109
|
+
# * **Expected behavior**
|
2110
|
+
#
|
2111
|
+
# * This starts a persistent chat session from the specified past
|
2112
|
+
# ended contact (C2). Transcripts of past chat sessions C2 and
|
2113
|
+
# C1 are accessible in the current persistent chat session. Note
|
2114
|
+
# that chat segment C3 is dropped from the persistent chat
|
2115
|
+
# session.
|
2116
|
+
#
|
2117
|
+
# ^
|
2118
|
+
#
|
2119
|
+
# * **Use Case 2**: The customer wants to continue the past chat
|
2120
|
+
# session and see the transcript of the entire past engagement,
|
2121
|
+
# including the post chat survey. For this they will use the
|
2122
|
+
# following configuration:
|
2123
|
+
#
|
2124
|
+
# * **Configuration**
|
2125
|
+
#
|
2126
|
+
# * SourceContactId = "C1"
|
2127
|
+
#
|
2128
|
+
# * RehydrationType = "ENTIRE\_PAST\_SESSION"
|
2129
|
+
#
|
2130
|
+
# * **Expected behavior**
|
2131
|
+
#
|
2132
|
+
# * This starts a persistent chat session from the most recently
|
2133
|
+
# ended chat contact (C3). Transcripts of past chat sessions C3,
|
2134
|
+
# C2 and C1 are accessible in the current persistent chat
|
2135
|
+
# session.
|
2136
|
+
#
|
2137
|
+
# ^
|
2138
|
+
# @return [String]
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] source_contact_id
|
2141
|
+
# The contactId from which a persistent chat session must be started.
|
2142
|
+
# @return [String]
|
2143
|
+
#
|
2144
|
+
# @!attribute [rw] client_token
|
2145
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2146
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2147
|
+
# SDK populates this field. For more information about idempotency,
|
2148
|
+
# see [Making retries safe with idempotent APIs][1].
|
2149
|
+
#
|
2150
|
+
#
|
2151
|
+
#
|
2152
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2153
|
+
# @return [String]
|
2154
|
+
#
|
2155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePersistentContactAssociationRequest AWS API Documentation
|
2156
|
+
#
|
2157
|
+
class CreatePersistentContactAssociationRequest < Struct.new(
|
2158
|
+
:instance_id,
|
2159
|
+
:initial_contact_id,
|
2160
|
+
:rehydration_type,
|
2161
|
+
:source_contact_id,
|
2162
|
+
:client_token)
|
2163
|
+
SENSITIVE = []
|
2164
|
+
include Aws::Structure
|
2165
|
+
end
|
2166
|
+
|
2167
|
+
# @!attribute [rw] continued_from_contact_id
|
2168
|
+
# The contactId from which a persistent chat session is started. This
|
2169
|
+
# field is populated only for persistent chat.
|
2170
|
+
# @return [String]
|
2171
|
+
#
|
2172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePersistentContactAssociationResponse AWS API Documentation
|
2173
|
+
#
|
2174
|
+
class CreatePersistentContactAssociationResponse < Struct.new(
|
2175
|
+
:continued_from_contact_id)
|
2176
|
+
SENSITIVE = []
|
2177
|
+
include Aws::Structure
|
2178
|
+
end
|
2179
|
+
|
1948
2180
|
# @!attribute [rw] instance_id
|
1949
2181
|
# The identifier of the Amazon Connect instance. You can [find the
|
1950
2182
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -4751,6 +4983,21 @@ module Aws::Connect
|
|
4751
4983
|
#
|
4752
4984
|
class DisassociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
|
4753
4985
|
|
4986
|
+
# Contains details about why a contact was disconnected. Only Amazon
|
4987
|
+
# Connect outbound campaigns can provide this field.
|
4988
|
+
#
|
4989
|
+
# @!attribute [rw] code
|
4990
|
+
# A code that indicates how the contact was terminated.
|
4991
|
+
# @return [String]
|
4992
|
+
#
|
4993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisconnectReason AWS API Documentation
|
4994
|
+
#
|
4995
|
+
class DisconnectReason < Struct.new(
|
4996
|
+
:code)
|
4997
|
+
SENSITIVE = []
|
4998
|
+
include Aws::Structure
|
4999
|
+
end
|
5000
|
+
|
4754
5001
|
# @!attribute [rw] user_id
|
4755
5002
|
# The identifier of the user account.
|
4756
5003
|
# @return [String]
|
@@ -4862,6 +5109,25 @@ module Aws::Connect
|
|
4862
5109
|
include Aws::Structure
|
4863
5110
|
end
|
4864
5111
|
|
5112
|
+
# Information about the endpoint.
|
5113
|
+
#
|
5114
|
+
# @!attribute [rw] type
|
5115
|
+
# Type of the endpoint.
|
5116
|
+
# @return [String]
|
5117
|
+
#
|
5118
|
+
# @!attribute [rw] address
|
5119
|
+
# Address of the endpoint.
|
5120
|
+
# @return [String]
|
5121
|
+
#
|
5122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Endpoint AWS API Documentation
|
5123
|
+
#
|
5124
|
+
class Endpoint < Struct.new(
|
5125
|
+
:type,
|
5126
|
+
:address)
|
5127
|
+
SENSITIVE = []
|
5128
|
+
include Aws::Structure
|
5129
|
+
end
|
5130
|
+
|
4865
5131
|
# Information about a contact evaluation.
|
4866
5132
|
#
|
4867
5133
|
# @!attribute [rw] evaluation_id
|
@@ -5737,6 +6003,31 @@ module Aws::Connect
|
|
5737
6003
|
include Aws::Structure
|
5738
6004
|
end
|
5739
6005
|
|
6006
|
+
# Request for which contact failed to be generated.
|
6007
|
+
#
|
6008
|
+
# @!attribute [rw] request_identifier
|
6009
|
+
# Request identifier provided in the API call in the
|
6010
|
+
# ContactDataRequest to create a contact.
|
6011
|
+
# @return [String]
|
6012
|
+
#
|
6013
|
+
# @!attribute [rw] failure_reason_code
|
6014
|
+
# Reason code for the failure.
|
6015
|
+
# @return [String]
|
6016
|
+
#
|
6017
|
+
# @!attribute [rw] failure_reason_message
|
6018
|
+
# Why the request to create a contact failed.
|
6019
|
+
# @return [String]
|
6020
|
+
#
|
6021
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/FailedRequest AWS API Documentation
|
6022
|
+
#
|
6023
|
+
class FailedRequest < Struct.new(
|
6024
|
+
:request_identifier,
|
6025
|
+
:failure_reason_code,
|
6026
|
+
:failure_reason_message)
|
6027
|
+
SENSITIVE = []
|
6028
|
+
include Aws::Structure
|
6029
|
+
end
|
6030
|
+
|
5740
6031
|
# Contains the filter to apply when retrieving metrics with the
|
5741
6032
|
# [GetMetricDataV2][1] API.
|
5742
6033
|
#
|
@@ -14211,11 +14502,17 @@ module Aws::Connect
|
|
14211
14502
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
14212
14503
|
# @return [String]
|
14213
14504
|
#
|
14505
|
+
# @!attribute [rw] disconnect_reason
|
14506
|
+
# The reason a contact can be disconnected. Only Amazon Connect
|
14507
|
+
# outbound campaigns can provide this field.
|
14508
|
+
# @return [Types::DisconnectReason]
|
14509
|
+
#
|
14214
14510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
|
14215
14511
|
#
|
14216
14512
|
class StopContactRequest < Struct.new(
|
14217
14513
|
:contact_id,
|
14218
|
-
:instance_id
|
14514
|
+
:instance_id,
|
14515
|
+
:disconnect_reason)
|
14219
14516
|
SENSITIVE = []
|
14220
14517
|
include Aws::Structure
|
14221
14518
|
end
|
@@ -14351,6 +14648,26 @@ module Aws::Connect
|
|
14351
14648
|
include Aws::Structure
|
14352
14649
|
end
|
14353
14650
|
|
14651
|
+
# Request for which contact was successfully created.
|
14652
|
+
#
|
14653
|
+
# @!attribute [rw] request_identifier
|
14654
|
+
# Request identifier provided in the API call in the
|
14655
|
+
# ContactDataRequest to create a contact.
|
14656
|
+
# @return [String]
|
14657
|
+
#
|
14658
|
+
# @!attribute [rw] contact_id
|
14659
|
+
# The contactId of the contact that was created successfully.
|
14660
|
+
# @return [String]
|
14661
|
+
#
|
14662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuccessfulRequest AWS API Documentation
|
14663
|
+
#
|
14664
|
+
class SuccessfulRequest < Struct.new(
|
14665
|
+
:request_identifier,
|
14666
|
+
:contact_id)
|
14667
|
+
SENSITIVE = []
|
14668
|
+
include Aws::Structure
|
14669
|
+
end
|
14670
|
+
|
14354
14671
|
# @!attribute [rw] instance_id
|
14355
14672
|
# The identifier of the Amazon Connect instance. You can [find the
|
14356
14673
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
data/lib/aws-sdk-connect.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.135.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-11-
|
11
|
+
date: 2023-11-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|