Skip to content

DisconnectParticipantRequest

Source code in docs_src/capo_ivs_realtime/types/disconnect_participant_request.py 
15
16
17
18
19
20
21
22
23
class DisconnectParticipantRequest(TypedDict, closed=True):
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the stage to which the participant is attached.</p>"""
    participant_id: "capo_ivs_realtime.types.participant_token_id.ParticipantTokenId"
    """<p>Identifier of the participant to be disconnected. IVS assigns this; it is returned by <a>CreateParticipantToken</a> (for streams using WebRTC ingest) or <a>CreateIngestConfiguration</a> (for streams using RTMP ingest).</p>"""
    reason: NotRequired[
        "capo_ivs_realtime.types.disconnect_participant_reason.DisconnectParticipantReason"
    ]
    """<p>Description of why this participant is being disconnected.</p>"""

participant_id instance-attribute 

participant_id: ParticipantTokenId

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 instance-attribute 

reason: NotRequired[DisconnectParticipantReason]

Description of why this participant is being disconnected.

stage_arn instance-attribute 

stage_arn: StageArn

ARN of the stage to which the participant is attached.