ivsrealtime / Client / create_stage

create_stage#

ivsrealtime.Client.create_stage(**kwargs)#

Creates a new stage (and optionally participant tokens).

See also: AWS API Documentation

Request Syntax

response = client.create_stage(
    name='string',
    participantTokenConfigurations=[
        {
            'attributes': {
                'string': 'string'
            },
            'capabilities': [
                'PUBLISH'|'SUBSCRIBE',
            ],
            'duration': 123,
            'userId': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)
Parameters:
  • name (string) – Optional name that can be specified for the stage being created.

  • participantTokenConfigurations (list) –

    Array of participant token configuration objects to attach to the new stage.

    • (dict) –

      Object specifying a participant token configuration in a stage.

      • attributes (dict) –

        Application-provided attributes to encode into the corresponding participant 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.

        • (string) –

      • duration (integer) –

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

      • 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.

  • tags (dict) –

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'participantTokens': [
        {
            'attributes': {
                'string': 'string'
            },
            'capabilities': [
                'PUBLISH'|'SUBSCRIBE',
            ],
            'duration': 123,
            'expirationTime': datetime(2015, 1, 1),
            'participantId': 'string',
            'token': 'string',
            'userId': 'string'
        },
    ],
    'stage': {
        'activeSessionId': 'string',
        'arn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • participantTokens (list) –

      Participant tokens attached to the stage. These correspond to the participants in the request.

      • (dict) –

        Object specifying a participant token in a stage.

        Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.

        • 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) –

        • capabilities (list) –

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

          • (string) –

        • duration (integer) –

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

        • expirationTime (datetime) –

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

        • 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.

    • stage (dict) –

      The stage that was created.

      • activeSessionId (string) –

        ID of the active session within the stage.

      • arn (string) –

        Stage ARN.

      • name (string) –

        Stage name.

      • tags (dict) –

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

        • (string) –

          • (string) –

Exceptions