@Generated(value="software.amazon.awssdk:codegen") public interface ConnectParticipantClient extends SdkClient
builder()
method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static ConnectParticipantClient create()
ConnectParticipantClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ConnectParticipantClientBuilder builder()
ConnectParticipantClient.default CreateParticipantConnectionResponse createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
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 the 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.
createParticipantConnectionRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateParticipantConnectionResponse createParticipantConnection(Consumer<CreateParticipantConnectionRequest.Builder> createParticipantConnectionRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
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 the 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.
This is a convenience which creates an instance of the CreateParticipantConnectionRequest.Builder
avoiding the need to create one manually via CreateParticipantConnectionRequest.builder()
createParticipantConnectionRequest - A Consumer that will call methods on CreateParticipantConnectionRequest.Builder to create
a request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisconnectParticipantResponse disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
disconnectParticipantRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisconnectParticipantResponse disconnectParticipant(Consumer<DisconnectParticipantRequest.Builder> disconnectParticipantRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a convenience which creates an instance of the DisconnectParticipantRequest.Builder avoiding the
need to create one manually via DisconnectParticipantRequest.builder()
disconnectParticipantRequest - A Consumer that will call methods on DisconnectParticipantRequest.Builder to create a
request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTranscriptResponse getTranscript(GetTranscriptRequest getTranscriptRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
getTranscriptRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTranscriptResponse getTranscript(Consumer<GetTranscriptRequest.Builder> getTranscriptRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a convenience which creates an instance of the GetTranscriptRequest.Builder avoiding the need to
create one manually via GetTranscriptRequest.builder()
getTranscriptRequest - A Consumer that will call methods on GetTranscriptRequest.Builder to create a request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTranscriptIterable getTranscriptPaginator(GetTranscriptRequest getTranscriptRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a variant of
getTranscript(software.amazon.awssdk.services.connectparticipant.model.GetTranscriptRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client.getTranscriptPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client
.getTranscriptPaginator(request);
for (software.amazon.awssdk.services.connectparticipant.model.GetTranscriptResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client.getTranscriptPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTranscript(software.amazon.awssdk.services.connectparticipant.model.GetTranscriptRequest)
operation.
getTranscriptRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetTranscriptIterable getTranscriptPaginator(Consumer<GetTranscriptRequest.Builder> getTranscriptRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a variant of
getTranscript(software.amazon.awssdk.services.connectparticipant.model.GetTranscriptRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client.getTranscriptPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client
.getTranscriptPaginator(request);
for (software.amazon.awssdk.services.connectparticipant.model.GetTranscriptResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.connectparticipant.paginators.GetTranscriptIterable responses = client.getTranscriptPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTranscript(software.amazon.awssdk.services.connectparticipant.model.GetTranscriptRequest)
operation.
This is a convenience which creates an instance of the GetTranscriptRequest.Builder avoiding the need to
create one manually via GetTranscriptRequest.builder()
getTranscriptRequest - A Consumer that will call methods on GetTranscriptRequest.Builder to create a request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendEventResponse sendEvent(SendEventRequest sendEventRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendEventRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendEventResponse sendEvent(Consumer<SendEventRequest.Builder> sendEventRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a convenience which creates an instance of the SendEventRequest.Builder avoiding the need to
create one manually via SendEventRequest.builder()
sendEventRequest - A Consumer that will call methods on SendEventRequest.Builder to create a request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
sendMessageRequest - AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendMessageResponse sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, ConnectParticipantException
Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.
This is a convenience which creates an instance of the SendMessageRequest.Builder avoiding the need to
create one manually via SendMessageRequest.builder()
sendMessageRequest - A Consumer that will call methods on SendMessageRequest.Builder to create a request.AccessDeniedException - You do not have sufficient access to perform this action.InternalServerException - This exception occurs when there is an internal failure in the Amazon Connect service.ThrottlingException - The request was denied due to request throttling.ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConnectParticipantException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.