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.
-
#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
Sends an event.
-
#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.
324 325 326 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 324 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.
361 362 363 364 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 361 def (params = {}, = {}) req = build_request(:complete_attachment_upload, params) req.send_request() end |
#create_participant_connection(params = {}) ⇒ Types::CreateParticipantConnectionResponse
Creates the participant's connection. Note that 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.
430 431 432 433 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 430 def create_participant_connection(params = {}, = {}) req = build_request(:create_participant_connection, params) req.send_request() end |
#disconnect_participant(params = {}) ⇒ Struct
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
469 470 471 472 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 469 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.
505 506 507 508 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 505 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. Note that 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.
594 595 596 597 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 594 def get_transcript(params = {}, = {}) req = build_request(:get_transcript, params) req.send_request() end |
#send_event(params = {}) ⇒ Types::SendEventResponse
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
654 655 656 657 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 654 def send_event(params = {}, = {}) req = build_request(:send_event, params) req.send_request() end |
#send_message(params = {}) ⇒ Types::SendMessageResponse
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
710 711 712 713 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 710 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.
770 771 772 773 |
# File 'gems/aws-sdk-connectparticipant/lib/aws-sdk-connectparticipant/client.rb', line 770 def (params = {}, = {}) req = build_request(:start_attachment_upload, params) req.send_request() end |