AmazonConnectParticipantClient (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonConnectParticipantClient
extends 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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.connectparticipant.AmazonConnectParticipant
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`static AmazonConnectParticipantClientBuilder`	`builder ()`
`CompleteAttachmentUploadResult`	`completeAttachmentUpload (CompleteAttachmentUploadRequest request)` Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
`CreateParticipantConnectionResult`	`createParticipantConnection (CreateParticipantConnectionRequest request)` Creates the participant's connection.
`DescribeViewResult`	`describeView (DescribeViewRequest request)` Retrieves the view for the specified view token.
`DisconnectParticipantResult`	`disconnectParticipant (DisconnectParticipantRequest request)` Disconnects a participant.
`GetAttachmentResult`	`getAttachment (GetAttachmentRequest request)` Provides a pre-signed URL for download of a completed attachment.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetTranscriptResult`	`getTranscript (GetTranscriptRequest request)` Retrieves a transcript of the session, including details about any attachments.
`SendEventResult`	`sendEvent (SendEventRequest request)`
`SendMessageResult`	`sendMessage (SendMessageRequest request)` Sends a message.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`StartAttachmentUploadResult`	`startAttachmentUpload (StartAttachmentUploadRequest request)` 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, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonConnectParticipantClientBuilder builder()
```
  - completeAttachmentUpload
```
public CompleteAttachmentUploadResult completeAttachmentUpload(CompleteAttachmentUploadRequest request)
```
    Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.
    
    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:
    
    Result of the CompleteAttachmentUpload operation returned by the service.
    
    Throws:
    
    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.
    
    ServiceQuotaExceededException - The number of attachments per contact exceeds the quota.
    
    ConflictException - The requested operation conflicts with the current state of a service resource associated with the request.
    
    See Also:
    
    AWS API Documentation
  - createParticipantConnection
```
public CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest 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.
    
    Specified by:
    
    createParticipantConnection in interface AmazonConnectParticipant
    
    Parameters:
    
    createParticipantConnectionRequest -
    
    Returns:
    
    Result of the CreateParticipantConnection operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeView
```
public DescribeViewResult describeView(DescribeViewRequest request)
```
    Retrieves the view for the specified view token.
    
    Specified by:
    
    describeView in interface AmazonConnectParticipant
    
    Parameters:
    
    describeViewRequest -
    
    Returns:
    
    Result of the DescribeView operation returned by the service.
    
    Throws:
    
    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.
    
    ResourceNotFoundException - The resource was not found.
    
    ValidationException - The input fails to satisfy the constraints specified by Amazon Connect.
    
    See Also:
    
    AWS API Documentation
  - disconnectParticipant
```
public DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest request)
```
    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:
    
    Result of the DisconnectParticipant operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getAttachment
```
public GetAttachmentResult getAttachment(GetAttachmentRequest 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.
    
    Specified by:
    
    getAttachment in interface AmazonConnectParticipant
    
    Parameters:
    
    getAttachmentRequest -
    
    Returns:
    
    Result of the GetAttachment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getTranscript
```
public GetTranscriptResult getTranscript(GetTranscriptRequest 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.
    
    If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:
    - application/vnd.amazonaws.connect.event.participant.left
    - application/vnd.amazonaws.connect.event.participant.joined
    - application/vnd.amazonaws.connect.event.chat.ended
    - application/vnd.amazonaws.connect.event.transfer.succeeded
    - application/vnd.amazonaws.connect.event.transfer.failed
    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:
    
    Result of the GetTranscript operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - sendEvent
```
public SendEventResult sendEvent(SendEventRequest request)
```
    The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType will no longer be supported starting December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field.
    
    Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.
    
    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:
    
    Result of the SendEvent operation returned by the service.
    
    Throws:
    
    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.
    
    ConflictException - The requested operation conflicts with the current state of a service resource associated with the request.
    
    See Also:
    
    AWS API Documentation
  - sendMessage
```
public SendMessageResult sendMessage(SendMessageRequest 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.
    
    Specified by:
    
    sendMessage in interface AmazonConnectParticipant
    
    Parameters:
    
    sendMessageRequest -
    
    Returns:
    
    Result of the SendMessage operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startAttachmentUpload
```
public StartAttachmentUploadResult startAttachmentUpload(StartAttachmentUploadRequest 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.
    
    Specified by:
    
    startAttachmentUpload in interface AmazonConnectParticipant
    
    Parameters:
    
    startAttachmentUploadRequest -
    
    Returns:
    
    Result of the StartAttachmentUpload operation returned by the service.
    
    Throws:
    
    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.
    
    ServiceQuotaExceededException - The number of attachments per contact exceeds the quota.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonConnectParticipant
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class AmazonConnectParticipantClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

completeAttachmentUpload

createParticipantConnection

describeView

disconnectParticipant

getAttachment

getTranscript

sendEvent

sendMessage

startAttachmentUpload

getCachedResponseMetadata

shutdown