ivschat / Client / disconnect_user
disconnect_user#
- ivschat.Client.disconnect_user(**kwargs)#
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
See also: AWS API Documentation
Request Syntax
response = client.disconnect_user( reason='string', roomIdentifier='string', userId='string' )
- Parameters:
reason (string) – Reason for disconnecting the user.
roomIdentifier (string) –
[REQUIRED]
Identifier of the room from which the user’s clients should be disconnected. Currently this must be an ARN.
userId (string) –
[REQUIRED]
ID of the user (connection) to disconnect from the room.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
ivschat.Client.exceptions.ThrottlingException
ivschat.Client.exceptions.AccessDeniedException
ivschat.Client.exceptions.ResourceNotFoundException
ivschat.Client.exceptions.PendingVerification
ivschat.Client.exceptions.ValidationException