DisconnectParticipant - Amazon Connect Participant Service

DisconnectParticipant

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Request Syntax

POST /participant/disconnect HTTP/1.1 X-Amz-Bearer: ConnectionToken Content-type: application/json { "ClientToken": "string" }

URI Request Parameters

The request requires the following URI parameters.

ConnectionToken

The authentication token associated with the participant's connection.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the Amazon Connect service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by Amazon Connect.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: