Class: Aws::ConnectParticipant::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConnectParticipant::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb
Overview
An API client for ConnectParticipant. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ConnectParticipant::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#complete_attachment_upload(params = {}) ⇒ Struct
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
-
#create_participant_connection(params = {}) ⇒ Types::CreateParticipantConnectionResponse
Creates the participant's connection.
-
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified view token.
-
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a participant.
-
#get_attachment(params = {}) ⇒ Types::GetAttachmentResponse
Provides a pre-signed URL for download of a completed attachment.
-
#get_transcript(params = {}) ⇒ Types::GetTranscriptResponse
Retrieves a transcript of the session, including details about any attachments.
-
#send_event(params = {}) ⇒ Types::SendEventResponse
The application/vnd.amazonaws.connect.event.connection.acknowledged
ContentType will no longer be supported starting December 31, 2024. -
#send_message(params = {}) ⇒ Types::SendMessageResponse
Sends a message.
-
#start_attachment_upload(params = {}) ⇒ Types::StartAttachmentUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#complete_attachment_upload(params = {}) ⇒ Struct
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
467 468 469 470 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 467 def (params = {}, = {}) req = build_request(:complete_attachment_upload, params) req.send_request() end |
#create_participant_connection(params = {}) ⇒ Types::CreateParticipantConnectionResponse
Creates the participant's connection.
ParticipantToken
is used for invoking this API instead of
ConnectionToken
.
The participant token is valid for the lifetime of the participant – until they are part of a contact.
The response URL for WEBSOCKET
Type has a connect expiry timeout of
100s. Clients must manually connect to the returned websocket URL and
subscribe to the desired topic.
For chat, you need to publish the following on the established websocket connection:
\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.
Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.
562 563 564 565 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 562 def create_participant_connection(params = {}, = {}) req = build_request(:create_participant_connection, params) req.send_request() end |
#describe_view(params = {}) ⇒ Types::DescribeViewResponse
Retrieves the view for the specified view token.
602 603 604 605 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 602 def describe_view(params = {}, = {}) req = build_request(:describe_view, params) req.send_request() end |
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a participant.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
651 652 653 654 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 651 def disconnect_participant(params = {}, = {}) req = build_request(:disconnect_participant, params) req.send_request() end |
#get_attachment(params = {}) ⇒ Types::GetAttachmentResponse
Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
699 700 701 702 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 699 def (params = {}, = {}) req = build_request(:get_attachment, params) req.send_request() end |
#get_transcript(params = {}) ⇒ Types::GetTranscriptResponse
Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.
If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:
application/vnd.amazonaws.connect.event.participant.left
application/vnd.amazonaws.connect.event.participant.joined
application/vnd.amazonaws.connect.event.chat.ended
application/vnd.amazonaws.connect.event.transfer.succeeded
application/vnd.amazonaws.connect.event.transfer.failed
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
815 816 817 818 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 815 def get_transcript(params = {}, = {}) req = build_request(:get_transcript, params) req.send_request() end |
#send_event(params = {}) ⇒ Types::SendEventResponse
application/vnd.amazonaws.connect.event.connection.acknowledged
ContentType will no longer be supported starting December 31, 2024.
This event has been migrated to the CreateParticipantConnection
API using the ConnectParticipant
field.
Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
905 906 907 908 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 905 def send_event(params = {}, = {}) req = build_request(:send_event, params) req.send_request() end |
#send_message(params = {}) ⇒ Types::SendMessageResponse
Sends a message.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
981 982 983 984 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 981 def (params = {}, = {}) req = build_request(:send_message, params) req.send_request() end |
#start_attachment_upload(params = {}) ⇒ Types::StartAttachmentUploadResponse
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 1060 def (params = {}, = {}) req = build_request(:start_attachment_upload, params) req.send_request() end |