/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connectparticipant; import java.util.concurrent.Future; import com.amazonaws.AmazonClientException; import com.amazonaws.AmazonServiceException; import com.amazonaws.handlers.AsyncHandler; import com.amazonaws.services.connectparticipant.model.*; /** * Interface for accessing Amazon Connect Participant asynchronously. *

* 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 interface AmazonConnectParticipantAsync extends AmazonConnectParticipant { /** *

* 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 A Java Future object containing 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. */ Future 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. *

* *

* 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 * @param 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. * @return A Java Future object containing 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. */ Future completeAttachmentUploadAsync( CompleteAttachmentUploadRequest completeAttachmentUploadRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

*
* * @param createParticipantConnectionRequest * @return A Java Future object containing 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. */ Future createParticipantConnectionAsync( CreateParticipantConnectionRequest createParticipantConnectionRequest) throws AmazonServiceException, 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. *

*
* * @param createParticipantConnectionRequest * @param 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. * @return A Java Future object containing 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. */ Future createParticipantConnectionAsync( CreateParticipantConnectionRequest createParticipantConnectionRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

* * @param disconnectParticipantRequest * @return A Java Future object containing 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. */ Future disconnectParticipantAsync( DisconnectParticipantRequest disconnectParticipantRequest) throws AmazonServiceException, 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. *

* * @param disconnectParticipantRequest * @param 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. * @return A Java Future object containing 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. */ Future disconnectParticipantAsync( DisconnectParticipantRequest disconnectParticipantRequest, AsyncHandler 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. *

* *

* 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 A Java Future object containing 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. */ Future 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. *

* *

* 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 * @param 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. * @return A Java Future object containing 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. */ Future getAttachmentAsync(GetAttachmentRequest getAttachmentRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

* * @param getTranscriptRequest * @return A Java Future object containing 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. */ Future getTranscriptAsync(GetTranscriptRequest getTranscriptRequest) throws AmazonServiceException, 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. *

* * @param getTranscriptRequest * @param 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. * @return A Java Future object containing 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. */ Future getTranscriptAsync(GetTranscriptRequest getTranscriptRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

* * @param sendEventRequest * @return A Java Future object containing 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. */ Future sendEventAsync(SendEventRequest sendEventRequest) throws AmazonServiceException, 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. *

* * @param sendEventRequest * @param 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. * @return A Java Future object containing 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. */ Future sendEventAsync(SendEventRequest sendEventRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

* * @param sendMessageRequest * @return A Java Future object containing 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. */ Future sendMessageAsync(SendMessageRequest sendMessageRequest) throws AmazonServiceException, 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. *

* * @param sendMessageRequest * @param 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. * @return A Java Future object containing 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. */ Future sendMessageAsync(SendMessageRequest sendMessageRequest, AsyncHandler asyncHandler) throws AmazonServiceException, 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. *

* * @param startAttachmentUploadRequest * @return A Java Future object containing 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. */ Future startAttachmentUploadAsync( StartAttachmentUploadRequest startAttachmentUploadRequest) throws AmazonServiceException, 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. *

* * @param startAttachmentUploadRequest * @param 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. * @return A Java Future object containing 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. */ Future startAttachmentUploadAsync( StartAttachmentUploadRequest startAttachmentUploadRequest, AsyncHandler asyncHandler) throws AmazonServiceException, AmazonClientException; }