ivsrealtime / Client / disconnect_participant

disconnect_participant#

ivsrealtime.Client.disconnect_participant(**kwargs)#

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Request Syntax

response = client.disconnect_participant(
    participantId='string',
    reason='string',
    stageArn='string'
)

Parameters:

participantId (string) –
[REQUIRED]

Identifier of the participant to be disconnected. This is returned by CreateParticipantToken.
reason (string) – Description of why this participant is being disconnected.
stageArn (string) –
[REQUIRED]

ARN of the stage to which the participant is attached.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

Exceptions