ParticipantSummary ¶

class ParticipantSummary(TypedDict, closed=True):
    participant_id: NotRequired["capo_ivs_realtime.types.participant_id.ParticipantId"]
    """<p>Unique identifier for this participant, assigned by IVS.</p>"""
    user_id: NotRequired["capo_ivs_realtime.types.user_id.UserId"]
    """<p>Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.</p>"""
    state: NotRequired["capo_ivs_realtime.types.participant_state.ParticipantState"]
    """<p>Whether the participant is connected to or disconnected from the stage.</p>"""
    first_join_time: NotRequired["capo_ivs_realtime.types.time.Time"]
    """<p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.</p>"""
    published: "capo_ivs_realtime.types.published.Published"
    """<p>Whether the participant ever published to the stage session.</p>"""
    recording_state: NotRequired[
        "capo_ivs_realtime.types.participant_recording_state.ParticipantRecordingState"
    ]
    """<p>The participant’s recording state.</p>"""
    replication_type: NotRequired[
        "capo_ivs_realtime.types.replication_type.ReplicationType"
    ]
    """<p>Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: <code>NONE</code>. </p>"""
    replication_state: NotRequired[
        "capo_ivs_realtime.types.replication_state.ReplicationState"
    ]
    """<p>The participant's replication state.</p>"""
    source_stage_arn: NotRequired["capo_ivs_realtime.types.stage_arn.StageArn"]
    """<p>Source stage ARN from which this participant is replicated, if <code>replicationType</code> is <code>REPLICA</code>.</p>"""
    source_session_id: NotRequired[
        "capo_ivs_realtime.types.stage_session_id.StageSessionId"
    ]
    """<p>ID of the session within the source stage, if <code>replicationType</code> is <code>REPLICA</code>.</p>"""
    redundant_ingest: "capo_ivs_realtime.types.redundant_ingest.RedundantIngest"
    """<p>Indicates whether redundant ingest is enabled for the participant.</p>"""
    ingest_configuration_arn: NotRequired[
        "capo_ivs_realtime.types.ingest_configuration_arn.IngestConfigurationArn"
    ]
    """<p>The participant’s ingest configuration.</p>"""