connectparticipant/aws.sdk.kotlin.services.connectparticipant

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

cancelParticipantAuthentication

inline suspend fun ConnectParticipantClient.cancelParticipantAuthentication(crossinline block: CancelParticipantAuthenticationRequest.Builder.() -> Unit): CancelParticipantAuthenticationResponse

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

completeAttachmentUpload

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.

createParticipantConnection

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

Creates the participant's connection.

describeView

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

Retrieves the view for the specified view token.

disconnectParticipant

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

Disconnects a participant.

getAttachment

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.

getAuthenticationUrl

inline suspend fun ConnectParticipantClient.getAuthenticationUrl(crossinline block: GetAuthenticationUrlRequest.Builder.() -> Unit): GetAuthenticationUrlResponse

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

getTranscript

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.

sendEvent

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.

sendMessage

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

Sends a message.

startAttachmentUpload

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.

withConfig

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.