ivsrealtime / Client / disconnect_participant

disconnect_participant#

ivsrealtime.Client.disconnect_participant(**kwargs)#

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

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. IVS assigns this; it is returned by CreateParticipantToken (for streams using WebRTC ingest) or CreateIngestConfiguration (for streams using RTMP ingest).

  • reason (string) – Description of why this participant is being disconnected.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException

  • ivsrealtime.Client.exceptions.PendingVerification