aws-sdk-connect 1.270.0 → 1.271.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +151 -3
- data/lib/aws-sdk-connect/client_api.rb +38 -0
- data/lib/aws-sdk-connect/types.rb +146 -5
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +32 -1
- data/sig/types.rbs +26 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4151ed6a1ce93fbb407962b68a89378f92512e1494edb65c4da114fdcb9674a8
|
|
4
|
+
data.tar.gz: c23b253c8108a659a2d2c7ce180184bb8bac2cdfcc3a444d7769895d1a37cc8b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6d73b0b9f82627dec9310ab8ecf253966a2764408fa442ccd5decc4bcd460cb55666fbb544901793052eada624a1b049a49d9138893a8afaea60f4366de1a966
|
|
7
|
+
data.tar.gz: ae484effe1a5ba9318fcd5b33f9a2767424327575ff37ae6f99d4eb3dd15bcc856abc20ca4b95a3eb9f7fa33a47ad17baf1f70fa41a80e6873524e47914bd177
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.271.0 (2026-08-13)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds the StartAssistantContact API to start chat contacts handled by an AI agent. Adds SegmentAttributes to StartWebRTCContact, and corrects its error response to now receive AccessDeniedException (previously returned as an internal server error due to a missing error declaration).
|
|
8
|
+
|
|
4
9
|
1.270.0 (2026-08-11)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.271.0
|
|
@@ -23869,6 +23869,129 @@ module Aws::Connect
|
|
|
23869
23869
|
req.send_request(options)
|
|
23870
23870
|
end
|
|
23871
23871
|
|
|
23872
|
+
# Starts a chat contact with an AI agent.
|
|
23873
|
+
#
|
|
23874
|
+
# Use the returned `ParticipantToken` to call the
|
|
23875
|
+
# [CreateParticipantConnection][1] API.
|
|
23876
|
+
#
|
|
23877
|
+
# For more information about chat, see the following topics in the
|
|
23878
|
+
# *Connect Customer Administrator Guide*:
|
|
23879
|
+
#
|
|
23880
|
+
# * [Concepts: Web and mobile messaging capabilities in Connect
|
|
23881
|
+
# Customer][2]
|
|
23882
|
+
#
|
|
23883
|
+
# * [Connect Customer Chat security best practices][3]
|
|
23884
|
+
#
|
|
23885
|
+
#
|
|
23886
|
+
#
|
|
23887
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
23888
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html
|
|
23889
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat
|
|
23890
|
+
#
|
|
23891
|
+
# @option params [required, String] :instance_id
|
|
23892
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
23893
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
23894
|
+
#
|
|
23895
|
+
#
|
|
23896
|
+
#
|
|
23897
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
23898
|
+
#
|
|
23899
|
+
# @option params [required, Types::AiAgentInput] :ai_agent
|
|
23900
|
+
# The AI agent that participates in the contact.
|
|
23901
|
+
#
|
|
23902
|
+
# @option params [required, Types::ParticipantDetails] :participant_details
|
|
23903
|
+
# The display name and other details that identify the chat participant.
|
|
23904
|
+
#
|
|
23905
|
+
# @option params [Types::ChatMessage] :initial_message
|
|
23906
|
+
# The initial message to send to the newly created chat.
|
|
23907
|
+
#
|
|
23908
|
+
# @option params [Hash<String,String>] :attributes
|
|
23909
|
+
# A map of key-value pairs to associate with the contact. Amazon Connect
|
|
23910
|
+
# makes these attributes available to flows as standard contact
|
|
23911
|
+
# attributes.
|
|
23912
|
+
#
|
|
23913
|
+
# You can provide up to 32,768 UTF-8 bytes across all key-value pairs
|
|
23914
|
+
# per contact. Attribute keys can contain only alphanumeric characters,
|
|
23915
|
+
# dashes, and underscores.
|
|
23916
|
+
#
|
|
23917
|
+
# @option params [String] :client_token
|
|
23918
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
23919
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
23920
|
+
# SDK populates this field. For more information about idempotency, see
|
|
23921
|
+
# [Making retries safe with idempotent APIs][1].
|
|
23922
|
+
#
|
|
23923
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
23924
|
+
# not need to pass this option.**
|
|
23925
|
+
#
|
|
23926
|
+
#
|
|
23927
|
+
#
|
|
23928
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
23929
|
+
#
|
|
23930
|
+
# @option params [Types::PersistentChat] :persistent_chat
|
|
23931
|
+
# The configuration that enables persistent chat. For more information
|
|
23932
|
+
# about persistent chat and its use cases, see [Enable persistent
|
|
23933
|
+
# chat][1].
|
|
23934
|
+
#
|
|
23935
|
+
#
|
|
23936
|
+
#
|
|
23937
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
|
|
23938
|
+
#
|
|
23939
|
+
# @option params [String] :related_contact_id
|
|
23940
|
+
# The identifier of an Connect Customer contact related to the new
|
|
23941
|
+
# assistant contact.
|
|
23942
|
+
#
|
|
23943
|
+
# <note markdown="1"> You cannot provide both `RelatedContactId` and `PersistentChat`.
|
|
23944
|
+
#
|
|
23945
|
+
# </note>
|
|
23946
|
+
#
|
|
23947
|
+
# @return [Types::StartAssistantContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23948
|
+
#
|
|
23949
|
+
# * {Types::StartAssistantContactResponse#contact_id #contact_id} => String
|
|
23950
|
+
# * {Types::StartAssistantContactResponse#participant_id #participant_id} => String
|
|
23951
|
+
# * {Types::StartAssistantContactResponse#participant_token #participant_token} => String
|
|
23952
|
+
# * {Types::StartAssistantContactResponse#continued_from_contact_id #continued_from_contact_id} => String
|
|
23953
|
+
#
|
|
23954
|
+
# @example Request syntax with placeholder values
|
|
23955
|
+
#
|
|
23956
|
+
# resp = client.start_assistant_contact({
|
|
23957
|
+
# instance_id: "InstanceId", # required
|
|
23958
|
+
# ai_agent: { # required
|
|
23959
|
+
# ai_agent_id: "AiAgentId", # required
|
|
23960
|
+
# },
|
|
23961
|
+
# participant_details: { # required
|
|
23962
|
+
# display_name: "DisplayName", # required
|
|
23963
|
+
# },
|
|
23964
|
+
# initial_message: {
|
|
23965
|
+
# content_type: "ChatContentType", # required
|
|
23966
|
+
# content: "ChatContent", # required
|
|
23967
|
+
# },
|
|
23968
|
+
# attributes: {
|
|
23969
|
+
# "AttributeName" => "AttributeValue",
|
|
23970
|
+
# },
|
|
23971
|
+
# client_token: "ClientToken",
|
|
23972
|
+
# persistent_chat: {
|
|
23973
|
+
# rehydration_type: "ENTIRE_PAST_SESSION", # accepts ENTIRE_PAST_SESSION, FROM_SEGMENT
|
|
23974
|
+
# source_contact_id: "ContactId",
|
|
23975
|
+
# },
|
|
23976
|
+
# related_contact_id: "ContactId",
|
|
23977
|
+
# })
|
|
23978
|
+
#
|
|
23979
|
+
# @example Response structure
|
|
23980
|
+
#
|
|
23981
|
+
# resp.contact_id #=> String
|
|
23982
|
+
# resp.participant_id #=> String
|
|
23983
|
+
# resp.participant_token #=> String
|
|
23984
|
+
# resp.continued_from_contact_id #=> String
|
|
23985
|
+
#
|
|
23986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartAssistantContact AWS API Documentation
|
|
23987
|
+
#
|
|
23988
|
+
# @overload start_assistant_contact(params = {})
|
|
23989
|
+
# @param [Hash] params ({})
|
|
23990
|
+
def start_assistant_contact(params = {}, options = {})
|
|
23991
|
+
req = build_request(:start_assistant_contact, params)
|
|
23992
|
+
req.send_request(options)
|
|
23993
|
+
end
|
|
23994
|
+
|
|
23872
23995
|
# Provides a pre-signed Amazon S3 URL in response for uploading your
|
|
23873
23996
|
# content.
|
|
23874
23997
|
#
|
|
@@ -24892,7 +25015,7 @@ module Aws::Connect
|
|
|
24892
25015
|
# 10,080 minutes (7 days).
|
|
24893
25016
|
#
|
|
24894
25017
|
# @option params [Types::ParticipantDetails] :participant_details
|
|
24895
|
-
# The
|
|
25018
|
+
# The details of the participant, including their display name.
|
|
24896
25019
|
#
|
|
24897
25020
|
# @option params [Types::ChatMessage] :initial_system_message
|
|
24898
25021
|
# A chat message.
|
|
@@ -25709,7 +25832,7 @@ module Aws::Connect
|
|
|
25709
25832
|
# (customer, agent).
|
|
25710
25833
|
#
|
|
25711
25834
|
# @option params [required, Types::ParticipantDetails] :participant_details
|
|
25712
|
-
# The
|
|
25835
|
+
# The details of the participant, including their display name.
|
|
25713
25836
|
#
|
|
25714
25837
|
# @option params [String] :related_contact_id
|
|
25715
25838
|
# The unique identifier for an Connect Customer contact. This identifier
|
|
@@ -25725,6 +25848,14 @@ module Aws::Connect
|
|
|
25725
25848
|
# A description of the task that is shown to an agent in the Contact
|
|
25726
25849
|
# Control Panel (CCP).
|
|
25727
25850
|
#
|
|
25851
|
+
# @option params [Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
|
25852
|
+
# Use this map to specify system-defined attributes for the WebRTC
|
|
25853
|
+
# contact segment. Use the `connect:Subtype` attribute to specify the
|
|
25854
|
+
# channel subtype, such as `connect:WebRTC`.
|
|
25855
|
+
#
|
|
25856
|
+
# Attribute keys can contain only alphanumeric characters, hyphens, and
|
|
25857
|
+
# underscores.
|
|
25858
|
+
#
|
|
25728
25859
|
# @return [Types::StartWebRTCContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
25729
25860
|
#
|
|
25730
25861
|
# * {Types::StartWebRTCContactResponse#connection_data #connection_data} => Types::ConnectionData
|
|
@@ -25765,6 +25896,23 @@ module Aws::Connect
|
|
|
25765
25896
|
# },
|
|
25766
25897
|
# },
|
|
25767
25898
|
# description: "Description",
|
|
25899
|
+
# segment_attributes: {
|
|
25900
|
+
# "SegmentAttributeName" => {
|
|
25901
|
+
# value_string: "SegmentAttributeValueString",
|
|
25902
|
+
# value_map: {
|
|
25903
|
+
# "SegmentAttributeName" => {
|
|
25904
|
+
# # recursive SegmentAttributeValue
|
|
25905
|
+
# },
|
|
25906
|
+
# },
|
|
25907
|
+
# value_integer: 1,
|
|
25908
|
+
# value_list: [
|
|
25909
|
+
# {
|
|
25910
|
+
# # recursive SegmentAttributeValue
|
|
25911
|
+
# },
|
|
25912
|
+
# ],
|
|
25913
|
+
# value_arn: "SegmentAttributeValueString",
|
|
25914
|
+
# },
|
|
25915
|
+
# },
|
|
25768
25916
|
# })
|
|
25769
25917
|
#
|
|
25770
25918
|
# @example Response structure
|
|
@@ -30851,7 +30999,7 @@ module Aws::Connect
|
|
|
30851
30999
|
tracer: tracer
|
|
30852
31000
|
)
|
|
30853
31001
|
context[:gem_name] = 'aws-sdk-connect'
|
|
30854
|
-
context[:gem_version] = '1.
|
|
31002
|
+
context[:gem_version] = '1.271.0'
|
|
30855
31003
|
Seahorse::Client::Request.new(handlers, context)
|
|
30856
31004
|
end
|
|
30857
31005
|
|
|
@@ -70,6 +70,7 @@ module Aws::Connect
|
|
|
70
70
|
AgentsMinOneMaxHundred = Shapes::ListShape.new(name: 'AgentsMinOneMaxHundred')
|
|
71
71
|
AiAgentId = Shapes::StringShape.new(name: 'AiAgentId')
|
|
72
72
|
AiAgentInfo = Shapes::StructureShape.new(name: 'AiAgentInfo')
|
|
73
|
+
AiAgentInput = Shapes::StructureShape.new(name: 'AiAgentInput')
|
|
73
74
|
AiAgentSearchCriteria = Shapes::StructureShape.new(name: 'AiAgentSearchCriteria')
|
|
74
75
|
AiAgentSearchCriteriaList = Shapes::ListShape.new(name: 'AiAgentSearchCriteriaList')
|
|
75
76
|
AiAgentVersionId = Shapes::StringShape.new(name: 'AiAgentVersionId')
|
|
@@ -1882,6 +1883,8 @@ module Aws::Connect
|
|
|
1882
1883
|
SourceCampaign = Shapes::StructureShape.new(name: 'SourceCampaign')
|
|
1883
1884
|
SourceId = Shapes::StringShape.new(name: 'SourceId')
|
|
1884
1885
|
SourceType = Shapes::StringShape.new(name: 'SourceType')
|
|
1886
|
+
StartAssistantContactRequest = Shapes::StructureShape.new(name: 'StartAssistantContactRequest')
|
|
1887
|
+
StartAssistantContactResponse = Shapes::StructureShape.new(name: 'StartAssistantContactResponse')
|
|
1885
1888
|
StartAttachedFileUploadRequest = Shapes::StructureShape.new(name: 'StartAttachedFileUploadRequest')
|
|
1886
1889
|
StartAttachedFileUploadResponse = Shapes::StructureShape.new(name: 'StartAttachedFileUploadResponse')
|
|
1887
1890
|
StartChatContactRequest = Shapes::StructureShape.new(name: 'StartChatContactRequest')
|
|
@@ -2450,6 +2453,9 @@ module Aws::Connect
|
|
|
2450
2453
|
AiAgentInfo.add_member(:ai_agent_escalated, Shapes::ShapeRef.new(shape: Boolean, location_name: "AiAgentEscalated"))
|
|
2451
2454
|
AiAgentInfo.struct_class = Types::AiAgentInfo
|
|
2452
2455
|
|
|
2456
|
+
AiAgentInput.add_member(:ai_agent_id, Shapes::ShapeRef.new(shape: AiAgentId, required: true, location_name: "AiAgentId"))
|
|
2457
|
+
AiAgentInput.struct_class = Types::AiAgentInput
|
|
2458
|
+
|
|
2453
2459
|
AiAgentSearchCriteria.add_member(:id, Shapes::ShapeRef.new(shape: AiAgentId, location_name: "Id"))
|
|
2454
2460
|
AiAgentSearchCriteria.add_member(:version_number, Shapes::ShapeRef.new(shape: AiAgentVersionNumber, location_name: "VersionNumber", metadata: {"box" => true}))
|
|
2455
2461
|
AiAgentSearchCriteria.add_member(:ai_agent_escalated, Shapes::ShapeRef.new(shape: Boolean, location_name: "AiAgentEscalated", metadata: {"box" => true}))
|
|
@@ -8514,6 +8520,22 @@ module Aws::Connect
|
|
|
8514
8520
|
SourceCampaign.add_member(:outbound_request_id, Shapes::ShapeRef.new(shape: OutboundRequestId, location_name: "OutboundRequestId"))
|
|
8515
8521
|
SourceCampaign.struct_class = Types::SourceCampaign
|
|
8516
8522
|
|
|
8523
|
+
StartAssistantContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
|
8524
|
+
StartAssistantContactRequest.add_member(:ai_agent, Shapes::ShapeRef.new(shape: AiAgentInput, required: true, location_name: "AiAgent"))
|
|
8525
|
+
StartAssistantContactRequest.add_member(:participant_details, Shapes::ShapeRef.new(shape: ParticipantDetails, required: true, location_name: "ParticipantDetails"))
|
|
8526
|
+
StartAssistantContactRequest.add_member(:initial_message, Shapes::ShapeRef.new(shape: ChatMessage, location_name: "InitialMessage"))
|
|
8527
|
+
StartAssistantContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
|
8528
|
+
StartAssistantContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken" => true}))
|
|
8529
|
+
StartAssistantContactRequest.add_member(:persistent_chat, Shapes::ShapeRef.new(shape: PersistentChat, location_name: "PersistentChat"))
|
|
8530
|
+
StartAssistantContactRequest.add_member(:related_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "RelatedContactId"))
|
|
8531
|
+
StartAssistantContactRequest.struct_class = Types::StartAssistantContactRequest
|
|
8532
|
+
|
|
8533
|
+
StartAssistantContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
|
8534
|
+
StartAssistantContactResponse.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, location_name: "ParticipantId"))
|
|
8535
|
+
StartAssistantContactResponse.add_member(:participant_token, Shapes::ShapeRef.new(shape: ParticipantToken, location_name: "ParticipantToken"))
|
|
8536
|
+
StartAssistantContactResponse.add_member(:continued_from_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContinuedFromContactId"))
|
|
8537
|
+
StartAssistantContactResponse.struct_class = Types::StartAssistantContactResponse
|
|
8538
|
+
|
|
8517
8539
|
StartAttachedFileUploadRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken" => true}))
|
|
8518
8540
|
StartAttachedFileUploadRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
|
8519
8541
|
StartAttachedFileUploadRequest.add_member(:file_name, Shapes::ShapeRef.new(shape: FileName, required: true, location_name: "FileName"))
|
|
@@ -8728,6 +8750,7 @@ module Aws::Connect
|
|
|
8728
8750
|
StartWebRTCContactRequest.add_member(:related_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "RelatedContactId"))
|
|
8729
8751
|
StartWebRTCContactRequest.add_member(:references, Shapes::ShapeRef.new(shape: ContactReferences, location_name: "References"))
|
|
8730
8752
|
StartWebRTCContactRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
|
8753
|
+
StartWebRTCContactRequest.add_member(:segment_attributes, Shapes::ShapeRef.new(shape: SegmentAttributes, location_name: "SegmentAttributes"))
|
|
8731
8754
|
StartWebRTCContactRequest.struct_class = Types::StartWebRTCContactRequest
|
|
8732
8755
|
|
|
8733
8756
|
StartWebRTCContactResponse.add_member(:connection_data, Shapes::ShapeRef.new(shape: ConnectionData, location_name: "ConnectionData"))
|
|
@@ -14610,6 +14633,20 @@ module Aws::Connect
|
|
|
14610
14633
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
14611
14634
|
end)
|
|
14612
14635
|
|
|
14636
|
+
api.add_operation(:start_assistant_contact, Seahorse::Model::Operation.new.tap do |o|
|
|
14637
|
+
o.name = "StartAssistantContact"
|
|
14638
|
+
o.http_method = "PUT"
|
|
14639
|
+
o.http_request_uri = "/contact/assistant"
|
|
14640
|
+
o.input = Shapes::ShapeRef.new(shape: StartAssistantContactRequest)
|
|
14641
|
+
o.output = Shapes::ShapeRef.new(shape: StartAssistantContactResponse)
|
|
14642
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
|
14643
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
14644
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
14645
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
14646
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
|
14647
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
|
14648
|
+
end)
|
|
14649
|
+
|
|
14613
14650
|
api.add_operation(:start_attached_file_upload, Seahorse::Model::Operation.new.tap do |o|
|
|
14614
14651
|
o.name = "StartAttachedFileUpload"
|
|
14615
14652
|
o.http_method = "PUT"
|
|
@@ -14834,6 +14871,7 @@ module Aws::Connect
|
|
|
14834
14871
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
|
14835
14872
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
|
14836
14873
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
|
14874
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
|
14837
14875
|
end)
|
|
14838
14876
|
|
|
14839
14877
|
api.add_operation(:stop_contact, Seahorse::Model::Operation.new.tap do |o|
|
|
@@ -649,6 +649,21 @@ module Aws::Connect
|
|
|
649
649
|
include Aws::Structure
|
|
650
650
|
end
|
|
651
651
|
|
|
652
|
+
# The AI agent that participates in the contact, including its
|
|
653
|
+
# identifier.
|
|
654
|
+
#
|
|
655
|
+
# @!attribute [rw] ai_agent_id
|
|
656
|
+
# The identifier of the AI agent that participates in the contact.
|
|
657
|
+
# @return [String]
|
|
658
|
+
#
|
|
659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AiAgentInput AWS API Documentation
|
|
660
|
+
#
|
|
661
|
+
class AiAgentInput < Struct.new(
|
|
662
|
+
:ai_agent_id)
|
|
663
|
+
SENSITIVE = []
|
|
664
|
+
include Aws::Structure
|
|
665
|
+
end
|
|
666
|
+
|
|
652
667
|
# The search criteria based on AI Agents metadata.
|
|
653
668
|
#
|
|
654
669
|
# @!attribute [rw] id
|
|
@@ -25914,7 +25929,7 @@ module Aws::Connect
|
|
|
25914
25929
|
# @return [Array<String>]
|
|
25915
25930
|
#
|
|
25916
25931
|
# @!attribute [rw] participant_details
|
|
25917
|
-
# The
|
|
25932
|
+
# The details of the participant, including their display name.
|
|
25918
25933
|
# @return [Types::ParticipantDetails]
|
|
25919
25934
|
#
|
|
25920
25935
|
# @!attribute [rw] attributes
|
|
@@ -26705,7 +26720,7 @@ module Aws::Connect
|
|
|
26705
26720
|
include Aws::Structure
|
|
26706
26721
|
end
|
|
26707
26722
|
|
|
26708
|
-
# The
|
|
26723
|
+
# The details of the participant, including their display name.
|
|
26709
26724
|
#
|
|
26710
26725
|
# @!attribute [rw] display_name
|
|
26711
26726
|
# Display name of the participant.
|
|
@@ -33133,6 +33148,122 @@ module Aws::Connect
|
|
|
33133
33148
|
include Aws::Structure
|
|
33134
33149
|
end
|
|
33135
33150
|
|
|
33151
|
+
# @!attribute [rw] instance_id
|
|
33152
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
33153
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
33154
|
+
#
|
|
33155
|
+
#
|
|
33156
|
+
#
|
|
33157
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
33158
|
+
# @return [String]
|
|
33159
|
+
#
|
|
33160
|
+
# @!attribute [rw] ai_agent
|
|
33161
|
+
# The AI agent that participates in the contact.
|
|
33162
|
+
# @return [Types::AiAgentInput]
|
|
33163
|
+
#
|
|
33164
|
+
# @!attribute [rw] participant_details
|
|
33165
|
+
# The display name and other details that identify the chat
|
|
33166
|
+
# participant.
|
|
33167
|
+
# @return [Types::ParticipantDetails]
|
|
33168
|
+
#
|
|
33169
|
+
# @!attribute [rw] initial_message
|
|
33170
|
+
# The initial message to send to the newly created chat.
|
|
33171
|
+
# @return [Types::ChatMessage]
|
|
33172
|
+
#
|
|
33173
|
+
# @!attribute [rw] attributes
|
|
33174
|
+
# A map of key-value pairs to associate with the contact. Amazon
|
|
33175
|
+
# Connect makes these attributes available to flows as standard
|
|
33176
|
+
# contact attributes.
|
|
33177
|
+
#
|
|
33178
|
+
# You can provide up to 32,768 UTF-8 bytes across all key-value pairs
|
|
33179
|
+
# per contact. Attribute keys can contain only alphanumeric
|
|
33180
|
+
# characters, dashes, and underscores.
|
|
33181
|
+
# @return [Hash<String,String>]
|
|
33182
|
+
#
|
|
33183
|
+
# @!attribute [rw] client_token
|
|
33184
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
33185
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
33186
|
+
# SDK populates this field. For more information about idempotency,
|
|
33187
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
33188
|
+
#
|
|
33189
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
33190
|
+
# not need to pass this option.
|
|
33191
|
+
#
|
|
33192
|
+
#
|
|
33193
|
+
#
|
|
33194
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
33195
|
+
# @return [String]
|
|
33196
|
+
#
|
|
33197
|
+
# @!attribute [rw] persistent_chat
|
|
33198
|
+
# The configuration that enables persistent chat. For more information
|
|
33199
|
+
# about persistent chat and its use cases, see [Enable persistent
|
|
33200
|
+
# chat][1].
|
|
33201
|
+
#
|
|
33202
|
+
#
|
|
33203
|
+
#
|
|
33204
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
|
|
33205
|
+
# @return [Types::PersistentChat]
|
|
33206
|
+
#
|
|
33207
|
+
# @!attribute [rw] related_contact_id
|
|
33208
|
+
# The identifier of an Connect Customer contact related to the new
|
|
33209
|
+
# assistant contact.
|
|
33210
|
+
#
|
|
33211
|
+
# <note markdown="1"> You cannot provide both `RelatedContactId` and `PersistentChat`.
|
|
33212
|
+
#
|
|
33213
|
+
# </note>
|
|
33214
|
+
# @return [String]
|
|
33215
|
+
#
|
|
33216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartAssistantContactRequest AWS API Documentation
|
|
33217
|
+
#
|
|
33218
|
+
class StartAssistantContactRequest < Struct.new(
|
|
33219
|
+
:instance_id,
|
|
33220
|
+
:ai_agent,
|
|
33221
|
+
:participant_details,
|
|
33222
|
+
:initial_message,
|
|
33223
|
+
:attributes,
|
|
33224
|
+
:client_token,
|
|
33225
|
+
:persistent_chat,
|
|
33226
|
+
:related_contact_id)
|
|
33227
|
+
SENSITIVE = []
|
|
33228
|
+
include Aws::Structure
|
|
33229
|
+
end
|
|
33230
|
+
|
|
33231
|
+
# @!attribute [rw] contact_id
|
|
33232
|
+
# The identifier of the contact within the Connect Customer instance.
|
|
33233
|
+
# @return [String]
|
|
33234
|
+
#
|
|
33235
|
+
# @!attribute [rw] participant_id
|
|
33236
|
+
# The identifier of the chat participant. The participant identifier
|
|
33237
|
+
# remains the same throughout the chat lifecycle.
|
|
33238
|
+
# @return [String]
|
|
33239
|
+
#
|
|
33240
|
+
# @!attribute [rw] participant_token
|
|
33241
|
+
# The token that the chat participant uses to call the
|
|
33242
|
+
# [CreateParticipantConnection][1] API. The token remains valid for
|
|
33243
|
+
# the lifetime of the chat participant.
|
|
33244
|
+
#
|
|
33245
|
+
#
|
|
33246
|
+
#
|
|
33247
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
|
33248
|
+
# @return [String]
|
|
33249
|
+
#
|
|
33250
|
+
# @!attribute [rw] continued_from_contact_id
|
|
33251
|
+
# For a persistent chat, the identifier of the contact from which the
|
|
33252
|
+
# chat continues. Amazon Connect returns this field only for
|
|
33253
|
+
# persistent chats.
|
|
33254
|
+
# @return [String]
|
|
33255
|
+
#
|
|
33256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartAssistantContactResponse AWS API Documentation
|
|
33257
|
+
#
|
|
33258
|
+
class StartAssistantContactResponse < Struct.new(
|
|
33259
|
+
:contact_id,
|
|
33260
|
+
:participant_id,
|
|
33261
|
+
:participant_token,
|
|
33262
|
+
:continued_from_contact_id)
|
|
33263
|
+
SENSITIVE = []
|
|
33264
|
+
include Aws::Structure
|
|
33265
|
+
end
|
|
33266
|
+
|
|
33136
33267
|
# @!attribute [rw] client_token
|
|
33137
33268
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
33138
33269
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -33949,7 +34080,7 @@ module Aws::Connect
|
|
|
33949
34080
|
# @return [Integer]
|
|
33950
34081
|
#
|
|
33951
34082
|
# @!attribute [rw] participant_details
|
|
33952
|
-
# The
|
|
34083
|
+
# The details of the participant, including their display name.
|
|
33953
34084
|
# @return [Types::ParticipantDetails]
|
|
33954
34085
|
#
|
|
33955
34086
|
# @!attribute [rw] initial_system_message
|
|
@@ -34582,7 +34713,7 @@ module Aws::Connect
|
|
|
34582
34713
|
# @return [Types::AllowedCapabilities]
|
|
34583
34714
|
#
|
|
34584
34715
|
# @!attribute [rw] participant_details
|
|
34585
|
-
# The
|
|
34716
|
+
# The details of the participant, including their display name.
|
|
34586
34717
|
# @return [Types::ParticipantDetails]
|
|
34587
34718
|
#
|
|
34588
34719
|
# @!attribute [rw] related_contact_id
|
|
@@ -34603,6 +34734,15 @@ module Aws::Connect
|
|
|
34603
34734
|
# Control Panel (CCP).
|
|
34604
34735
|
# @return [String]
|
|
34605
34736
|
#
|
|
34737
|
+
# @!attribute [rw] segment_attributes
|
|
34738
|
+
# Use this map to specify system-defined attributes for the WebRTC
|
|
34739
|
+
# contact segment. Use the `connect:Subtype` attribute to specify the
|
|
34740
|
+
# channel subtype, such as `connect:WebRTC`.
|
|
34741
|
+
#
|
|
34742
|
+
# Attribute keys can contain only alphanumeric characters, hyphens,
|
|
34743
|
+
# and underscores.
|
|
34744
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
|
34745
|
+
#
|
|
34606
34746
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContactRequest AWS API Documentation
|
|
34607
34747
|
#
|
|
34608
34748
|
class StartWebRTCContactRequest < Struct.new(
|
|
@@ -34614,7 +34754,8 @@ module Aws::Connect
|
|
|
34614
34754
|
:participant_details,
|
|
34615
34755
|
:related_contact_id,
|
|
34616
34756
|
:references,
|
|
34617
|
-
:description
|
|
34757
|
+
:description,
|
|
34758
|
+
:segment_attributes)
|
|
34618
34759
|
SENSITIVE = [:description]
|
|
34619
34760
|
include Aws::Structure
|
|
34620
34761
|
end
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -4495,6 +4495,36 @@ module Aws
|
|
|
4495
4495
|
) -> _SendOutboundWebNotificationResponseSuccess
|
|
4496
4496
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendOutboundWebNotificationResponseSuccess
|
|
4497
4497
|
|
|
4498
|
+
interface _StartAssistantContactResponseSuccess
|
|
4499
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartAssistantContactResponse]
|
|
4500
|
+
def contact_id: () -> ::String
|
|
4501
|
+
def participant_id: () -> ::String
|
|
4502
|
+
def participant_token: () -> ::String
|
|
4503
|
+
def continued_from_contact_id: () -> ::String
|
|
4504
|
+
end
|
|
4505
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#start_assistant_contact-instance_method
|
|
4506
|
+
def start_assistant_contact: (
|
|
4507
|
+
instance_id: ::String,
|
|
4508
|
+
ai_agent: {
|
|
4509
|
+
ai_agent_id: ::String
|
|
4510
|
+
},
|
|
4511
|
+
participant_details: {
|
|
4512
|
+
display_name: ::String
|
|
4513
|
+
},
|
|
4514
|
+
?initial_message: {
|
|
4515
|
+
content_type: ::String,
|
|
4516
|
+
content: ::String
|
|
4517
|
+
},
|
|
4518
|
+
?attributes: Hash[::String, ::String],
|
|
4519
|
+
?client_token: ::String,
|
|
4520
|
+
?persistent_chat: {
|
|
4521
|
+
rehydration_type: ("ENTIRE_PAST_SESSION" | "FROM_SEGMENT")?,
|
|
4522
|
+
source_contact_id: ::String?
|
|
4523
|
+
},
|
|
4524
|
+
?related_contact_id: ::String
|
|
4525
|
+
) -> _StartAssistantContactResponseSuccess
|
|
4526
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartAssistantContactResponseSuccess
|
|
4527
|
+
|
|
4498
4528
|
interface _StartAttachedFileUploadResponseSuccess
|
|
4499
4529
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartAttachedFileUploadResponse]
|
|
4500
4530
|
def file_arn: () -> ::String
|
|
@@ -4912,7 +4942,8 @@ module Aws
|
|
|
4912
4942
|
arn: ::String?,
|
|
4913
4943
|
status_reason: ::String?
|
|
4914
4944
|
}],
|
|
4915
|
-
?description: ::String
|
|
4945
|
+
?description: ::String,
|
|
4946
|
+
?segment_attributes: Hash[::String, Params::segment_attribute_value]
|
|
4916
4947
|
) -> _StartWebRTCContactResponseSuccess
|
|
4917
4948
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartWebRTCContactResponseSuccess
|
|
4918
4949
|
|
data/sig/types.rbs
CHANGED
|
@@ -169,6 +169,11 @@ module Aws::Connect
|
|
|
169
169
|
SENSITIVE: []
|
|
170
170
|
end
|
|
171
171
|
|
|
172
|
+
class AiAgentInput
|
|
173
|
+
attr_accessor ai_agent_id: ::String
|
|
174
|
+
SENSITIVE: []
|
|
175
|
+
end
|
|
176
|
+
|
|
172
177
|
class AiAgentSearchCriteria
|
|
173
178
|
attr_accessor id: ::String
|
|
174
179
|
attr_accessor version_number: ::Integer
|
|
@@ -7749,6 +7754,26 @@ module Aws::Connect
|
|
|
7749
7754
|
SENSITIVE: []
|
|
7750
7755
|
end
|
|
7751
7756
|
|
|
7757
|
+
class StartAssistantContactRequest
|
|
7758
|
+
attr_accessor instance_id: ::String
|
|
7759
|
+
attr_accessor ai_agent: Types::AiAgentInput
|
|
7760
|
+
attr_accessor participant_details: Types::ParticipantDetails
|
|
7761
|
+
attr_accessor initial_message: Types::ChatMessage
|
|
7762
|
+
attr_accessor attributes: ::Hash[::String, ::String]
|
|
7763
|
+
attr_accessor client_token: ::String
|
|
7764
|
+
attr_accessor persistent_chat: Types::PersistentChat
|
|
7765
|
+
attr_accessor related_contact_id: ::String
|
|
7766
|
+
SENSITIVE: []
|
|
7767
|
+
end
|
|
7768
|
+
|
|
7769
|
+
class StartAssistantContactResponse
|
|
7770
|
+
attr_accessor contact_id: ::String
|
|
7771
|
+
attr_accessor participant_id: ::String
|
|
7772
|
+
attr_accessor participant_token: ::String
|
|
7773
|
+
attr_accessor continued_from_contact_id: ::String
|
|
7774
|
+
SENSITIVE: []
|
|
7775
|
+
end
|
|
7776
|
+
|
|
7752
7777
|
class StartAttachedFileUploadRequest
|
|
7753
7778
|
attr_accessor client_token: ::String
|
|
7754
7779
|
attr_accessor instance_id: ::String
|
|
@@ -8021,6 +8046,7 @@ module Aws::Connect
|
|
|
8021
8046
|
attr_accessor related_contact_id: ::String
|
|
8022
8047
|
attr_accessor references: ::Hash[::String, Types::Reference]
|
|
8023
8048
|
attr_accessor description: ::String
|
|
8049
|
+
attr_accessor segment_attributes: ::Hash[::String, Types::SegmentAttributeValue]
|
|
8024
8050
|
SENSITIVE: [:description]
|
|
8025
8051
|
end
|
|
8026
8052
|
|