ivsrealtime / Client / disconnect_participant
disconnect_participant¶
- ivsrealtime.Client.disconnect_participant(**kwargs)¶
Disconnects a specified participant and revokes the participant permanently from a specified stage.
See also: AWS API Documentation
Request Syntax
response = client.disconnect_participant( stageArn='string', participantId='string', reason='string' )
- Parameters:
stageArn (string) –
[REQUIRED]
ARN of the stage to which the participant is attached.
participantId (string) –
[REQUIRED]
Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
reason (string) – Description of why this participant is being disconnected.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions