Participant ¶

class Participant(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>"""
    attributes: NotRequired[
        "capo_ivs_realtime.types.participant_attributes.ParticipantAttributes"
    ]
    """<p>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information</i>.</p>"""
    published: "capo_ivs_realtime.types.published.Published"
    """<p>Whether the participant ever published to the stage session.</p>"""
    isp_name: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s Internet Service Provider.</p>"""
    os_name: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s operating system.</p>"""
    os_version: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s operating system version.</p>"""
    browser_name: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s browser.</p>"""
    browser_version: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s browser version.</p>"""
    sdk_version: NotRequired[
        "capo_ivs_realtime.types.participant_client_attribute.ParticipantClientAttribute"
    ]
    """<p>The participant’s SDK version.</p>"""
    recording_s3_bucket_name: NotRequired[
        "capo_ivs_realtime.types.participant_recording_s3_bucket_name.ParticipantRecordingS3BucketName"
    ]
    """<p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>"""
    recording_s3_prefix: NotRequired[
        "capo_ivs_realtime.types.participant_recording_s3_prefix.ParticipantRecordingS3Prefix"
    ]
    """<p>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled. If individual participant recording merge is enabled, and if a stage publisher disconnects from a stage and then reconnects, IVS tries to record to the same S3 prefix as the previous session. See <a href="/ivs/latest/RealTimeUserGuide/rt-individual-participant-recording.html#ind-part-rec-merge-frag"> Merge Fragmented Individual Participant Recordings</a>.</p>"""
    recording_state: NotRequired[
        "capo_ivs_realtime.types.participant_recording_state.ParticipantRecordingState"
    ]
    """<p>The participant’s recording state.</p>"""
    protocol: NotRequired[
        "capo_ivs_realtime.types.participant_protocol.ParticipantProtocol"
    ]
    """<p>Type of ingest protocol that the participant employs for broadcasting.</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>"""