public class AmazonConnectParticipantAsyncClient extends AmazonConnectParticipantClient implements AmazonConnectParticipantAsync
Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect enables customer contacts through voice or chat.
The APIs described here are used by chat participants, such as agents and customers.
LOGGING_AWS_REQUEST_METRIC
Constructor and Description |
---|
AmazonConnectParticipantAsyncClient()
Constructs a new asynchronous client to invoke service methods on Amazon
Connect Participant.
|
AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon
Connect Participant.
|
AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration,
java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Connect Participant using the specified executor service and client
configuration options.
|
AmazonConnectParticipantAsyncClient(java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Connect Participant using the specified executor service.
|
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,
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,
AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler)
Creates the participant's connection.
|
java.util.concurrent.Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a participant.
|
java.util.concurrent.Future<DisconnectParticipantResult> |
disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest,
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,
AsyncHandler<GetAttachmentRequest,GetAttachmentResult> asyncHandler)
Provides a pre-signed URL for download of a completed attachment.
|
java.util.concurrent.ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
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,
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,
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,
AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler)
Sends a message.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
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,
AsyncHandler<StartAttachmentUploadRequest,StartAttachmentUploadResult> asyncHandler)
Provides a pre-signed Amazon S3 URL in response for uploading the file
directly to S3.
|
completeAttachmentUpload, createParticipantConnection, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, startAttachmentUpload
addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
completeAttachmentUpload, createParticipantConnection, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, setEndpoint, setRegion, startAttachmentUpload
public AmazonConnectParticipantAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
public AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling
how this client connects to Amazon Connect Participant (ex:
proxy settings, retry counts, etc.).public AmazonConnectParticipantAsyncClient(java.util.concurrent.ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
executorService
- The executor service by which all asynchronous
requests will be executed.public AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
clientConfiguration
- Client configuration options (ex: max retry
limit, proxy settings, etc).executorService
- The executor service by which all asynchronous
requests will be executed.public java.util.concurrent.ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface AmazonConnectParticipant
shutdown
in class AmazonWebServiceClient
public java.util.concurrent.Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest) throws AmazonServiceException, AmazonClientException
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
completeAttachmentUploadAsync
in interface AmazonConnectParticipantAsync
completeAttachmentUploadRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
ServiceQuotaExceededException
ConflictException
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.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.public java.util.concurrent.Future<CompleteAttachmentUploadResult> completeAttachmentUploadAsync(CompleteAttachmentUploadRequest completeAttachmentUploadRequest, AsyncHandler<CompleteAttachmentUploadRequest,CompleteAttachmentUploadResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
completeAttachmentUploadAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
ServiceQuotaExceededException
ConflictException
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.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.public java.util.concurrent.Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest) throws AmazonServiceException, AmazonClientException
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionAsync
in interface AmazonConnectParticipantAsync
createParticipantConnectionRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<CreateParticipantConnectionResult> createParticipantConnectionAsync(CreateParticipantConnectionRequest createParticipantConnectionRequest, AsyncHandler<CreateParticipantConnectionRequest,CreateParticipantConnectionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest) throws AmazonServiceException, AmazonClientException
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.
disconnectParticipantAsync
in interface AmazonConnectParticipantAsync
disconnectParticipantRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<DisconnectParticipantResult> disconnectParticipantAsync(DisconnectParticipantRequest disconnectParticipantRequest, AsyncHandler<DisconnectParticipantRequest,DisconnectParticipantResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
disconnectParticipantAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest getAttachmentRequest) throws AmazonServiceException, AmazonClientException
Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
getAttachmentAsync
in interface AmazonConnectParticipantAsync
getAttachmentRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<GetAttachmentResult> getAttachmentAsync(GetAttachmentRequest getAttachmentRequest, AsyncHandler<GetAttachmentRequest,GetAttachmentResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
getAttachmentAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest) throws AmazonServiceException, AmazonClientException
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.
getTranscriptAsync
in interface AmazonConnectParticipantAsync
getTranscriptRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<GetTranscriptResult> getTranscriptAsync(GetTranscriptRequest getTranscriptRequest, AsyncHandler<GetTranscriptRequest,GetTranscriptResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
getTranscriptAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest) throws AmazonServiceException, AmazonClientException
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.
sendEventAsync
in interface AmazonConnectParticipantAsync
sendEventRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<SendEventResult> sendEventAsync(SendEventRequest sendEventRequest, AsyncHandler<SendEventRequest,SendEventResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.
sendEventAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest) throws AmazonServiceException, AmazonClientException
Sends a message. 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.
sendMessageAsync
in interface AmazonConnectParticipantAsync
sendMessageRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<SendMessageResult> sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler<SendMessageRequest,SendMessageResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Sends a message. 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.
sendMessageAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
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.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.public java.util.concurrent.Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest) throws AmazonServiceException, AmazonClientException
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
startAttachmentUploadAsync
in interface AmazonConnectParticipantAsync
startAttachmentUploadRequest
- AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
ServiceQuotaExceededException
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.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.public java.util.concurrent.Future<StartAttachmentUploadResult> startAttachmentUploadAsync(StartAttachmentUploadRequest startAttachmentUploadRequest, AsyncHandler<StartAttachmentUploadRequest,StartAttachmentUploadResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
startAttachmentUploadAsync
in interface AmazonConnectParticipantAsync
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.AccessDeniedException
InternalServerException
ThrottlingException
ValidationException
ServiceQuotaExceededException
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.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.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.