public interface AmazonConnectParticipantAsync extends AmazonConnectParticipant
Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.
Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.
| Modifier and Type | Method and Description |
|---|---|
java.util.concurrent.Future<CompleteAttachmentUploadResult> |
completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest)
Allows you to confirm that the attachment has been uploaded using the
pre-signed URL provided in StartAttachmentUpload API.
|
java.util.concurrent.Future<CompleteAttachmentUploadResult> |
completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest,
com.amazonaws.handlers.AsyncHandler<CompleteAttachmentUploadRequest,CompleteAttachmentUploadResult> asyncHandler)
Allows you to confirm that the attachment has been uploaded using the
pre-signed URL provided in StartAttachmentUpload API.
|
java.util.concurrent.Future<CreateParticipantConnectionResult> |
createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest)
Creates the participant's connection.
|
java.util.concurrent.Future<CreateParticipantConnectionResult> |
createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest,
com.amazonaws.handlers.AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler)
Creates the participant's connection.
|
java.util.concurrent.Future<DescribeViewResult> |
describeViewAsync(DescribeViewRequest describeViewRequest)
Retrieves the view for the specified view token.
|
java.util.concurrent.Future<DescribeViewResult> |
describeViewAsync(DescribeViewRequest describeViewRequest,
com.amazonaws.handlers.AsyncHandler<DescribeViewRequest,DescribeViewResult> asyncHandler)
Retrieves the view for the specified view token.
|
java.util.concurrent.Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a participant.
|
java.util.concurrent.Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest,
com.amazonaws.handlers.AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler)
Disconnects a participant.
|
java.util.concurrent.Future<GetAttachmentResult> |
getAttachmentAsync(GetAttachmentRequest getAttachmentRequest)
Provides a pre-signed URL for download of a completed attachment.
|
java.util.concurrent.Future<GetAttachmentResult> |
getAttachmentAsync(GetAttachmentRequest getAttachmentRequest,
com.amazonaws.handlers.AsyncHandler<GetAttachmentRequest,GetAttachmentResult> asyncHandler)
Provides a pre-signed URL for download of a completed attachment.
|
java.util.concurrent.Future<GetTranscriptResult> |
getTranscriptAsync(GetTranscriptRequest getTranscriptRequest)
Retrieves a transcript of the session, including details about any
attachments.
|
java.util.concurrent.Future<GetTranscriptResult> |
getTranscriptAsync(GetTranscriptRequest getTranscriptRequest,
com.amazonaws.handlers.AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler)
Retrieves a transcript of the session, including details about any
attachments.
|
java.util.concurrent.Future<SendEventResult> |
sendEventAsync(SendEventRequest sendEventRequest)
Sends an event.
|
java.util.concurrent.Future<SendEventResult> |
sendEventAsync(SendEventRequest sendEventRequest,
com.amazonaws.handlers.AsyncHandler<SendEventRequest,SendEventResult> asyncHandler)
Sends an event.
|
java.util.concurrent.Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest)
Sends a message.
|
java.util.concurrent.Future<SendMessageResult> |
sendMessageAsync(SendMessageRequest sendMessageRequest,
com.amazonaws.handlers.AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
Sends a message.
|
java.util.concurrent.Future<StartAttachmentUploadResult> |
startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest)
Provides a pre-signed Amazon S3 URL in response for uploading the file
directly to S3.
|
java.util.concurrent.Future<StartAttachmentUploadResult> |
startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest,
com.amazonaws.handlers.AsyncHandler<StartAttachmentUploadRequest,StartAttachmentUploadResult> asyncHandler)
Provides a pre-signed Amazon S3 URL in response for uploading the file
directly to S3.
|
completeAttachmentUpload, createParticipantConnection, describeView, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, setEndpoint, setRegion, shutdown, startAttachmentUploadjava.util.concurrent.Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
completeAttachmentUploadRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest, com.amazonaws.handlers.AsyncHandler<CompleteAttachmentUploadRequest,CompleteAttachmentUploadResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
completeAttachmentUploadRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptionServiceQuotaExceededExceptionConflictExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest, com.amazonaws.handlers.AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<DescribeViewResult> describeViewAsync(DescribeViewRequest describeViewRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Retrieves the view for the specified view token.
describeViewRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionResourceNotFoundExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<DescribeViewResult> describeViewAsync(DescribeViewRequest describeViewRequest, com.amazonaws.handlers.AsyncHandler<DescribeViewRequest,DescribeViewResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Retrieves the view for the specified view token.
describeViewRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionResourceNotFoundExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
disconnectParticipantRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest, com.amazonaws.handlers.AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
disconnectParticipantRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest getAttachmentRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getAttachmentRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest getAttachmentRequest, com.amazonaws.handlers.AsyncHandler<GetAttachmentRequest,GetAttachmentResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
getAttachmentRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getTranscriptRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest, com.amazonaws.handlers.AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getTranscriptRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Sends an event.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendEventRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest, com.amazonaws.handlers.AsyncHandler<SendEventRequest,SendEventResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
Sends an event.
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendEventRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
sendMessageRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest, com.amazonaws.handlers.AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
sendMessageRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
startAttachmentUploadRequest - AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptionServiceQuotaExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.java.util.concurrent.Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest, com.amazonaws.handlers.AsyncHandler<StartAttachmentUploadRequest,StartAttachmentUploadResult> asyncHandler) throws com.amazonaws.AmazonServiceException, com.amazonaws.AmazonClientException
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.
startAttachmentUploadRequest - asyncHandler - Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the
implementation of the four callback methods in this interface
to process the operation result or handle the exception.AccessDeniedExceptionInternalServerExceptionThrottlingExceptionValidationExceptionServiceQuotaExceededExceptioncom.amazonaws.AmazonClientException - If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.com.amazonaws.AmazonServiceException - If an error response is returned by Amazon
Connect Participant indicating either a problem with the data
in the request, or a server side issue.