*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonConnectParticipantClient extends AmazonWebServiceClient implements AmazonConnectParticipant { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonConnectParticipant.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "execute-api"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.ConflictExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceQuotaExceededException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.ServiceQuotaExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller( com.amazonaws.services.connectparticipant.model.transform.ThrottlingExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.connectparticipant.model.AmazonConnectParticipantException.class)); public static AmazonConnectParticipantClientBuilder builder() { return AmazonConnectParticipantClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon Connect Participant using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonConnectParticipantClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon Connect Participant using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonConnectParticipantClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("participant.connect.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/connectparticipant/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/connectparticipant/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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 Result of the CompleteAttachmentUpload operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @throws ServiceQuotaExceededException * The number of attachments per contact exceeds the quota. * @throws ConflictException * An attachment with that identifier is already being uploaded. * @sample AmazonConnectParticipant.CompleteAttachmentUpload * @see AWS API Documentation */ @Override public CompleteAttachmentUploadResult completeAttachmentUpload(CompleteAttachmentUploadRequest request) { request = beforeClientExecution(request); return executeCompleteAttachmentUpload(request); } @SdkInternalApi final CompleteAttachmentUploadResult executeCompleteAttachmentUpload(CompleteAttachmentUploadRequest completeAttachmentUploadRequest) { ExecutionContext executionContext = createExecutionContext(completeAttachmentUploadRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
** 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 Result of the DisconnectParticipant operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @sample AmazonConnectParticipant.DisconnectParticipant * @see AWS API Documentation */ @Override public DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request) { request = beforeClientExecution(request); return executeDisconnectParticipant(request); } @SdkInternalApi final DisconnectParticipantResult executeDisconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) { ExecutionContext executionContext = createExecutionContext(disconnectParticipantRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 Result of the GetAttachment operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @sample AmazonConnectParticipant.GetAttachment * @see AWS API Documentation */ @Override public GetAttachmentResult getAttachment(GetAttachmentRequest request) { request = beforeClientExecution(request); return executeGetAttachment(request); } @SdkInternalApi final GetAttachmentResult executeGetAttachment(GetAttachmentRequest getAttachmentRequest) { ExecutionContext executionContext = createExecutionContext(getAttachmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 Result of the GetTranscript operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @sample AmazonConnectParticipant.GetTranscript * @see AWS API Documentation */ @Override public GetTranscriptResult getTranscript(GetTranscriptRequest request) { request = beforeClientExecution(request); return executeGetTranscript(request); } @SdkInternalApi final GetTranscriptResult executeGetTranscript(GetTranscriptRequest getTranscriptRequest) { ExecutionContext executionContext = createExecutionContext(getTranscriptRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 Result of the SendEvent operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @sample AmazonConnectParticipant.SendEvent * @see AWS * API Documentation */ @Override public SendEventResult sendEvent(SendEventRequest request) { request = beforeClientExecution(request); return executeSendEvent(request); } @SdkInternalApi final SendEventResult executeSendEvent(SendEventRequest sendEventRequest) { ExecutionContext executionContext = createExecutionContext(sendEventRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 Result of the SendMessage operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @sample AmazonConnectParticipant.SendMessage * @see AWS * API Documentation */ @Override public SendMessageResult sendMessage(SendMessageRequest request) { request = beforeClientExecution(request); return executeSendMessage(request); } @SdkInternalApi final SendMessageResult executeSendMessage(SendMessageRequest sendMessageRequest) { ExecutionContext executionContext = createExecutionContext(sendMessageRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 Result of the StartAttachmentUpload operation returned by the service. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @throws InternalServerException * This exception occurs when there is an internal failure in the Amazon Connect service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the constraints specified by Amazon Connect. * @throws ServiceQuotaExceededException * The number of attachments per contact exceeds the quota. * @sample AmazonConnectParticipant.StartAttachmentUpload * @see AWS API Documentation */ @Override public StartAttachmentUploadResult startAttachmentUpload(StartAttachmentUploadRequest request) { request = beforeClientExecution(request); return executeStartAttachmentUpload(request); } @SdkInternalApi final StartAttachmentUploadResult executeStartAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest) { ExecutionContext executionContext = createExecutionContext(startAttachmentUploadRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private