com.amazonaws.services.connectparticipant

Interface AmazonConnectParticipantAsync

All Superinterfaces:

AmazonConnectParticipant

All Known Implementing Classes:

AmazonConnectParticipantAsyncClient

public interface AmazonConnectParticipantAsync
extends AmazonConnectParticipant

Interface for accessing Amazon Connect Participant asynchronously.

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.

Method Summary

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.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.
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.

Methods inherited from interface com.amazonaws.services.connectparticipant.AmazonConnectParticipant

completeAttachmentUpload, createParticipantConnection, disconnectParticipant, getAttachment, getCachedResponseMetadata, getTranscript, sendEvent, sendMessage, setEndpoint, setRegion, shutdown, startAttachmentUpload

Method Detail

completeAttachmentUploadAsync

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.

Parameters:

completeAttachmentUploadRequest -

Returns:

A Java Future object containing the response from the CompleteAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

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.

completeAttachmentUploadAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the CompleteAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

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.

createParticipantConnectionAsync

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.

Parameters:

createParticipantConnectionRequest -

Returns:

A Java Future object containing the response from the CreateParticipantConnection service method, as returned by Amazon Connect Participant.

Throws:

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.

createParticipantConnectionAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the CreateParticipantConnection service method, as returned by Amazon Connect Participant.

Throws:

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.

disconnectParticipantAsync

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.

Parameters:

disconnectParticipantRequest -

Returns:

A Java Future object containing the response from the DisconnectParticipant service method, as returned by Amazon Connect Participant.

Throws:

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.

disconnectParticipantAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the DisconnectParticipant service method, as returned by Amazon Connect Participant.

Throws:

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.

getAttachmentAsync

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.

Parameters:

getAttachmentRequest -

Returns:

A Java Future object containing the response from the GetAttachment service method, as returned by Amazon Connect Participant.

Throws:

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.

getAttachmentAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the GetAttachment service method, as returned by Amazon Connect Participant.

Throws:

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.

getTranscriptAsync

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.

Parameters:

getTranscriptRequest -

Returns:

A Java Future object containing the response from the GetTranscript service method, as returned by Amazon Connect Participant.

Throws:

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.

getTranscriptAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the GetTranscript service method, as returned by Amazon Connect Participant.

Throws:

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.

sendEventAsync

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.

Parameters:

sendEventRequest -

Returns:

A Java Future object containing the response from the SendEvent service method, as returned by Amazon Connect Participant.

Throws:

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.

sendEventAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the SendEvent service method, as returned by Amazon Connect Participant.

Throws:

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.

sendMessageAsync

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.

Parameters:

sendMessageRequest -

Returns:

A Java Future object containing the response from the SendMessage service method, as returned by Amazon Connect Participant.

Throws:

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.

sendMessageAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the SendMessage service method, as returned by Amazon Connect Participant.

Throws:

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.

startAttachmentUploadAsync

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.

Parameters:

startAttachmentUploadRequest -

Returns:

A Java Future object containing the response from the StartAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

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.

startAttachmentUploadAsync

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.

Parameters:

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.

Returns:

A Java Future object containing the response from the StartAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

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.