com.amazonaws.services.connectparticipant

Interface AmazonConnectParticipant

All Known Subinterfaces:

AmazonConnectParticipantAsync

All Known Implementing Classes:

AmazonConnectParticipantAsyncClient, AmazonConnectParticipantClient

public interface AmazonConnectParticipant

Interface for accessing Amazon Connect Participant

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
CompleteAttachmentUploadResult	completeAttachmentUpload(CompleteAttachmentUploadRequest completeAttachmentUploadRequest) Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
CreateParticipantConnectionResult	createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest) Creates the participant's connection.
DisconnectParticipantResult	disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) Disconnects a participant.
GetAttachmentResult	getAttachment(GetAttachmentRequest getAttachmentRequest) Provides a pre-signed URL for download of a completed attachment.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetTranscriptResult	getTranscript(GetTranscriptRequest getTranscriptRequest) Retrieves a transcript of the session, including details about any attachments.
SendEventResult	sendEvent(SendEventRequest sendEventRequest) Sends an event.
SendMessageResult	sendMessage(SendMessageRequest sendMessageRequest) Sends a message.
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://participant.connect.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAttachmentUploadResult	startAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest) Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://participant.connect.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "participant.connect.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://participant.connect.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "participant.connect.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://participant.connect.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

completeAttachmentUpload

CompleteAttachmentUploadResult completeAttachmentUpload(CompleteAttachmentUploadRequest completeAttachmentUploadRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

Parameters:

completeAttachmentUploadRequest -

Returns:

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

createParticipantConnection

CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest)
                                                       throws AmazonClientException,
                                                              AmazonServiceException

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:

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

disconnectParticipant

DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

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:

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

getAttachment

GetAttachmentResult getAttachment(GetAttachmentRequest getAttachmentRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

Parameters:

getAttachmentRequest -

Returns:

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

getTranscript

GetTranscriptResult getTranscript(GetTranscriptRequest getTranscriptRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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:

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

sendEvent

SendEventResult sendEvent(SendEventRequest sendEventRequest)
                   throws AmazonClientException,
                          AmazonServiceException

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:

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

sendMessage

SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
                       throws AmazonClientException,
                              AmazonServiceException

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:

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

startAttachmentUpload

StartAttachmentUploadResult startAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Parameters:

startAttachmentUploadRequest -

Returns:

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.