* 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.
*
*/
public class AmazonConnectParticipantClient extends AmazonWebServiceClient implements
AmazonConnectParticipant {
/**
* List of exception unmarshallers for all Amazon Connect Participant
* exceptions.
*/
protected List jsonErrorUnmarshallers;
/**
* 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.
*/
public AmazonConnectParticipantClient() {
this(new 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.
*
* @param clientConfiguration The client configuration options controlling
* how this client connects to AmazonConnectParticipant (ex:
* proxy settings, retry counts, etc.).
*/
public AmazonConnectParticipantClient(ClientConfiguration clientConfiguration) {
this(clientConfiguration, new UrlHttpClient(clientConfiguration));
}
/**
* 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.
*
* @param clientConfiguration The client configuration options controlling
* how this client connects to AmazonConnectParticipant (ex:
* proxy settings, retry counts, etc.).
* @param requestMetricCollector optional request metric collector
*/
public AmazonConnectParticipantClient(ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
init();
}
/**
* 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.
*
* @param clientConfiguration The client configuration options controlling
* how this client connects to AmazonConnectParticipant (ex:
* proxy settings, retry counts, etc.).
* @param httpClient A http client
*/
public AmazonConnectParticipantClient(ClientConfiguration clientConfiguration,
HttpClient httpClient) {
super(adjustClientConfiguration(clientConfiguration), httpClient);
init();
}
private void init() {
jsonErrorUnmarshallers = new ArrayList();
jsonErrorUnmarshallers.add(new AccessDeniedExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ConflictExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new InternalServerExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ServiceQuotaExceededExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ThrottlingExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new ValidationExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new JsonErrorUnmarshaller());
// calling this.setEndPoint(...) will also modify the signer accordingly
setServiceNameIntern("execute-api");
this.setEndpoint("participant.connect.us-east-1.amazonaws.com");
this.endpointPrefix = "participant.connect";
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain(
"/com/amazonaws/services/connectparticipant/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain(
"/com/amazonaws/services/connectparticipant/request.handler2s"));
}
private static ClientConfiguration adjustClientConfiguration(ClientConfiguration orig) {
ClientConfiguration config = orig;
return config;
}
/**
*
* 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.
*
*
* @param completeAttachmentUploadRequest
* @return completeAttachmentUploadResult The response from the
* CompleteAttachmentUpload service method, as returned by Amazon
* Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws ConflictException
* @throws 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.
* @throws 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 CompleteAttachmentUploadResult completeAttachmentUpload(
CompleteAttachmentUploadRequest completeAttachmentUploadRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(completeAttachmentUploadRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CompleteAttachmentUploadRequestMarshaller()
.marshall(completeAttachmentUploadRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new CompleteAttachmentUploadResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
*
* @param createParticipantConnectionRequest
* @return createParticipantConnectionResult The response from the
* CreateParticipantConnection service method, as returned by Amazon
* Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 CreateParticipantConnectionResult createParticipantConnection(
CreateParticipantConnectionRequest createParticipantConnectionRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(createParticipantConnectionRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateParticipantConnectionRequestMarshaller()
.marshall(createParticipantConnectionRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new CreateParticipantConnectionResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param disconnectParticipantRequest
* @return disconnectParticipantResult The response from the
* DisconnectParticipant service method, as returned by Amazon
* Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 DisconnectParticipantResult disconnectParticipant(
DisconnectParticipantRequest disconnectParticipantRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(disconnectParticipantRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DisconnectParticipantRequestMarshaller()
.marshall(disconnectParticipantRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new DisconnectParticipantResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param getAttachmentRequest
* @return getAttachmentResult The response from the GetAttachment service
* method, as returned by Amazon Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 GetAttachmentResult getAttachment(GetAttachmentRequest getAttachmentRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(getAttachmentRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetAttachmentRequestMarshaller().marshall(getAttachmentRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new GetAttachmentResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param getTranscriptRequest
* @return getTranscriptResult The response from the GetTranscript service
* method, as returned by Amazon Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 GetTranscriptResult getTranscript(GetTranscriptRequest getTranscriptRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(getTranscriptRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetTranscriptRequestMarshaller().marshall(getTranscriptRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new GetTranscriptResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param sendEventRequest
* @return sendEventResult The response from the SendEvent service method,
* as returned by Amazon Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 SendEventResult sendEvent(SendEventRequest sendEventRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(sendEventRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new SendEventRequestMarshaller().marshall(sendEventRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new SendEventResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param sendMessageRequest
* @return sendMessageResult The response from the SendMessage service
* method, as returned by Amazon Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws 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.
* @throws 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 SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(sendMessageRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new SendMessageRequestMarshaller().marshall(sendMessageRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new SendMessageResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* 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.
*
*
* @param startAttachmentUploadRequest
* @return startAttachmentUploadResult The response from the
* StartAttachmentUpload service method, as returned by Amazon
* Connect Participant.
* @throws AccessDeniedException
* @throws InternalServerException
* @throws ThrottlingException
* @throws ValidationException
* @throws ServiceQuotaExceededException
* @throws 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.
* @throws 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 StartAttachmentUploadResult startAttachmentUpload(
StartAttachmentUploadRequest startAttachmentUploadRequest)
throws AmazonServiceException, AmazonClientException {
ExecutionContext executionContext = createExecutionContext(startAttachmentUploadRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new StartAttachmentUploadRequestMarshaller()
.marshall(startAttachmentUploadRequest);
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller = new StartAttachmentUploadResultJsonUnmarshaller();
JsonResponseHandler responseHandler = new JsonResponseHandler(
unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
awsRequestMetrics.endEvent(Field.ClientExecuteTime);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
* 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.
*
* @param request The originally executed request
* @return The response metadata for the specified request, or null if none
* is available.
* @deprecated ResponseMetadata cache can hold up to 50 requests and
* responses in memory and will cause memory issue. This method
* now always returns null.
*/
@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
private Response invoke(Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
JsonErrorResponseHandler errorResponseHandler = new JsonErrorResponseHandler(
jsonErrorUnmarshallers);
Response result = client.execute(request, responseHandler,
errorResponseHandler, executionContext);
return result;
}
}