ivsrealtime / Client / create_participant_token

create_participant_token#

ivsrealtime.Client.create_participant_token(**kwargs)#

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

See also: AWS API Documentation

Request Syntax

response = client.create_participant_token(
    stageArn='string',
    duration=123,
    userId='string',
    attributes={
        'string': 'string'
    },
    capabilities=[
        'PUBLISH'|'SUBSCRIBE',
    ]
)
Parameters:

  • stageArn (string) –

    [REQUIRED]

    ARN of the stage to which this token is scoped.

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

  • userId (string) – 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.

  • attributes (dict) –

    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.

    • (string) –

      • (string) –

  • capabilities (list) –

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'participantToken': {
        'participantId': 'string',
        'token': 'string',
        'userId': 'string',
        'attributes': {
            'string': 'string'
        },
        'duration': 123,
        'capabilities': [
            'PUBLISH'|'SUBSCRIBE',
        ],
        'expirationTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • participantToken (dict) –

      The participant token that was created.

      • participantId (string) –

        Unique identifier for this participant token, assigned by IVS.

      • token (string) –

        The issued client token, encrypted.

      • userId (string) –

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

      • attributes (dict) –

        Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

        • (string) –

          • (string) –

      • duration (integer) –

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

      • capabilities (list) –

        Set of capabilities that the user is allowed to perform in the stage.

        • (string) –

      • expirationTime (datetime) –

        ISO 8601 timestamp (returned as a string) for when this token expires.

Exceptions

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException

  • ivsrealtime.Client.exceptions.ServiceQuotaExceededException

  • ivsrealtime.Client.exceptions.PendingVerification