ListParticipantsRequest ¶

class ListParticipantsRequest(TypedDict, closed=True):
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>Stage ARN.</p>"""
    session_id: "capo_ivs_realtime.types.stage_session_id.StageSessionId"
    """<p>ID of the session within the stage.</p>"""
    filter_by_user_id: NotRequired["capo_ivs_realtime.types.user_id.UserId"]
    """<p>Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request. A <code>userId</code> is a 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.</p>"""
    filter_by_published: "capo_ivs_realtime.types.published.Published"
    """<p>Filters the response list to only show participants who published during the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>"""
    filter_by_state: NotRequired[
        "capo_ivs_realtime.types.participant_state.ParticipantState"
    ]
    """<p>Filters the response list to only show participants in the specified state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>"""
    next_token: NotRequired["capo_ivs_realtime.types.pagination_token.PaginationToken"]
    """<p>The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>"""
    max_results: NotRequired[
        "capo_ivs_realtime.types.max_participant_results.MaxParticipantResults"
    ]
    """<p>Maximum number of results to return. Default: 50.</p>"""
    filter_by_recording_state: NotRequired[
        "capo_ivs_realtime.types.participant_recording_filter_by_recording_state.ParticipantRecordingFilterByRecordingState"
    ]
    """<p>Filters the response list to only show participants with the specified recording state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>"""