connectparticipant/aws.sdk.kotlin.services.connectparticipant/ConnectParticipantClient

ConnectParticipantClient

interface ConnectParticipantClient : SdkClient

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.

Properties

Link copied to clipboard
abstract override val config: ConnectParticipantClient.Config

ConnectParticipantClient's configuration

Functions

Link copied to clipboard
abstract suspend fun completeAttachmentUpload(input: CompleteAttachmentUploadRequest): CompleteAttachmentUploadResponse

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.

Link copied to clipboard
abstract suspend fun createParticipantConnection(input: CreateParticipantConnectionRequest): CreateParticipantConnectionResponse

Creates the participant's connection.

Link copied to clipboard
abstract suspend fun describeView(input: DescribeViewRequest): DescribeViewResponse

Retrieves the view for the specified view token.

Link copied to clipboard
abstract suspend fun disconnectParticipant(input: DisconnectParticipantRequest): DisconnectParticipantResponse

Disconnects a participant.

Link copied to clipboard
abstract suspend fun getAttachment(input: GetAttachmentRequest): GetAttachmentResponse

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

Link copied to clipboard
abstract suspend fun getTranscript(input: GetTranscriptRequest): GetTranscriptResponse

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.

Link copied to clipboard
abstract suspend fun sendEvent(input: SendEventRequest): SendEventResponse

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.

Link copied to clipboard
abstract suspend fun sendMessage(input: SendMessageRequest): SendMessageResponse

Sends a message.

Link copied to clipboard
abstract suspend fun startAttachmentUpload(input: StartAttachmentUploadRequest): StartAttachmentUploadResponse

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ConnectParticipantClient.completeAttachmentUpload(crossinline block: CompleteAttachmentUploadRequest.Builder.() -> Unit): CompleteAttachmentUploadResponse

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.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.createParticipantConnection(crossinline block: CreateParticipantConnectionRequest.Builder.() -> Unit): CreateParticipantConnectionResponse

Creates the participant's connection.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.describeView(crossinline block: DescribeViewRequest.Builder.() -> Unit): DescribeViewResponse

Retrieves the view for the specified view token.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.disconnectParticipant(crossinline block: DisconnectParticipantRequest.Builder.() -> Unit): DisconnectParticipantResponse

Disconnects a participant.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.getAttachment(crossinline block: GetAttachmentRequest.Builder.() -> Unit): GetAttachmentResponse

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.getTranscript(crossinline block: GetTranscriptRequest.Builder.() -> Unit): GetTranscriptResponse

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.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ConnectParticipantClient.sendEvent(crossinline block: SendEventRequest.Builder.() -> Unit): SendEventResponse

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.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.sendMessage(crossinline block: SendMessageRequest.Builder.() -> Unit): SendMessageResponse

Sends a message.

Link copied to clipboard
inline suspend fun ConnectParticipantClient.startAttachmentUpload(crossinline block: StartAttachmentUploadRequest.Builder.() -> Unit): StartAttachmentUploadResponse

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Link copied to clipboard
fun ConnectParticipantClient.withConfig(block: ConnectParticipantClient.Config.Builder.() -> Unit): ConnectParticipantClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.