ConnectParticipant / Client / disconnect_participant
disconnect_participant#
- ConnectParticipant.Client.disconnect_participant(**kwargs)#
Disconnects a participant.
Note
ConnectionToken
is used for invoking this API instead ofParticipantToken
.The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
See also: AWS API Documentation
Request Syntax
response = client.disconnect_participant( ClientToken='string', ConnectionToken='string' )
- Parameters:
ClientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
ConnectionToken (string) –
[REQUIRED]
The authentication token associated with the participant’s connection.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
ConnectParticipant.Client.exceptions.AccessDeniedException
ConnectParticipant.Client.exceptions.InternalServerException
ConnectParticipant.Client.exceptions.ThrottlingException
ConnectParticipant.Client.exceptions.ValidationException