Skip to content

CreateParticipantTokenRequest

Source code in docs_src/capo_ivs_realtime/types/create_participant_token_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class CreateParticipantTokenRequest(TypedDict, closed=True):
    stage_arn: "capo_ivs_realtime.types.stage_arn.StageArn"
    """<p>ARN of the stage to which this token is scoped.</p>"""
    duration: NotRequired[
        "capo_ivs_realtime.types.participant_token_duration_minutes.ParticipantTokenDurationMinutes"
    ]
    """<p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>"""
    user_id: NotRequired[
        "capo_ivs_realtime.types.participant_token_user_id.ParticipantTokenUserId"
    ]
    """<p>Name that can be specified to help identify the token. 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>"""
    attributes: NotRequired[
        "capo_ivs_realtime.types.participant_token_attributes.ParticipantTokenAttributes"
    ]
    """<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>"""
    capabilities: NotRequired[
        "capo_ivs_realtime.types.participant_token_capabilities.ParticipantTokenCapabilities"
    ]
    """<p>Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.</p>"""

attributes instance-attribute 

attributes: NotRequired[ParticipantTokenAttributes]

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. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

capabilities instance-attribute 

capabilities: NotRequired[ParticipantTokenCapabilities]

Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

duration instance-attribute 

duration: NotRequired[ParticipantTokenDurationMinutes]

Duration (in minutes), after which the token expires. Default: 720 (12 hours).

stage_arn instance-attribute 

stage_arn: StageArn

ARN of the stage to which this token is scoped.

user_id instance-attribute 

user_id: NotRequired[ParticipantTokenUserId]

Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.