com.amazonaws.services.connectparticipant

Class AmazonConnectParticipantClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.connectparticipant.AmazonConnectParticipantClient

All Implemented Interfaces:

AmazonConnectParticipant

Direct Known Subclasses:

AmazonConnectParticipantAsyncClient

public class AmazonConnectParticipantClient
extends com.amazonaws.AmazonWebServiceClient
implements AmazonConnectParticipant

Client for accessing Amazon Connect Participant. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all Amazon Connect Participant exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonConnectParticipantClient() Constructs a new client to invoke service methods on AmazonConnectParticipant.
AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonConnectParticipant.
AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration, com.amazonaws.http.HttpClient httpClient) Constructs a new client to invoke service methods on AmazonConnectParticipant using the specified client configuration options and request metric collector.
AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonConnectParticipant using the specified client configuration options and request metric collector.

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.
DescribeViewResult	describeView(DescribeViewRequest describeViewRequest) Retrieves the view for the specified view token.
DisconnectParticipantResult	disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) Disconnects a participant.
GetAttachmentResult	getAttachment(GetAttachmentRequest getAttachmentRequest) Provides a pre-signed URL for download of a completed attachment.
com.amazonaws.ResponseMetadata	getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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.
StartAttachmentUploadResult	startAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest) Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected java.util.List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all Amazon Connect Participant exceptions.

Constructor Detail

AmazonConnectParticipantClient

public AmazonConnectParticipantClient()

Constructs a new client to invoke service methods on AmazonConnectParticipant.

All service calls made using this new client object are blocking, and will not return until the service call completes.

AmazonConnectParticipantClient

public AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonConnectParticipant. All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonConnectParticipant (ex: proxy settings, retry counts, etc.).

AmazonConnectParticipantClient

public AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration,
                                      com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonConnectParticipant using the specified client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonConnectParticipant (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonConnectParticipantClient

public AmazonConnectParticipantClient(com.amazonaws.ClientConfiguration clientConfiguration,
                                      com.amazonaws.http.HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonConnectParticipant using the specified client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonConnectParticipant (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

completeAttachmentUpload

public CompleteAttachmentUploadResult completeAttachmentUpload(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.

Specified by:

completeAttachmentUpload in interface AmazonConnectParticipant

Parameters:

completeAttachmentUploadRequest -

Returns:

completeAttachmentUploadResult The response from the CompleteAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

ServiceQuotaExceededException

ConflictException

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

createParticipantConnection

public CreateParticipantConnectionResult createParticipantConnection(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.

Specified by:

createParticipantConnection in interface AmazonConnectParticipant

Parameters:

createParticipantConnectionRequest -

Returns:

createParticipantConnectionResult The response from the CreateParticipantConnection service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

describeView

public DescribeViewResult describeView(DescribeViewRequest describeViewRequest)
                                throws com.amazonaws.AmazonServiceException,
                                       com.amazonaws.AmazonClientException

Retrieves the view for the specified view token.

Specified by:

describeView in interface AmazonConnectParticipant

Parameters:

describeViewRequest -

Returns:

describeViewResult The response from the DescribeView service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ResourceNotFoundException

ValidationException

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

disconnectParticipant

public DisconnectParticipantResult disconnectParticipant(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.

Specified by:

disconnectParticipant in interface AmazonConnectParticipant

Parameters:

disconnectParticipantRequest -

Returns:

disconnectParticipantResult The response from the DisconnectParticipant service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

getAttachment

public GetAttachmentResult getAttachment(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.

Specified by:

getAttachment in interface AmazonConnectParticipant

Parameters:

getAttachmentRequest -

Returns:

getAttachmentResult The response from the GetAttachment service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

getTranscript

public GetTranscriptResult getTranscript(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.

Specified by:

getTranscript in interface AmazonConnectParticipant

Parameters:

getTranscriptRequest -

Returns:

getTranscriptResult The response from the GetTranscript service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

sendEvent

public SendEventResult sendEvent(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.

Specified by:

sendEvent in interface AmazonConnectParticipant

Parameters:

sendEventRequest -

Returns:

sendEventResult The response from the SendEvent service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

sendMessage

public SendMessageResult sendMessage(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.

Specified by:

sendMessage in interface AmazonConnectParticipant

Parameters:

sendMessageRequest -

Returns:

sendMessageResult The response from the SendMessage service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

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

startAttachmentUpload

public StartAttachmentUploadResult startAttachmentUpload(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.

Specified by:

startAttachmentUpload in interface AmazonConnectParticipant

Parameters:

startAttachmentUploadRequest -

Returns:

startAttachmentUploadResult The response from the StartAttachmentUpload service method, as returned by Amazon Connect Participant.

Throws:

AccessDeniedException

InternalServerException

ThrottlingException

ValidationException

ServiceQuotaExceededException

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

getCachedResponseMetadata

@Deprecated
public com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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

Specified by:

getCachedResponseMetadata in interface AmazonConnectParticipant

Parameters:

request - The originally executed request

Returns:

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