Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ivs-realtime ]

create-stage¶

Description¶

Creates a new stage (and optionally participant tokens).

Synopsis¶

  create-stage
[--name <value>]
[--participant-token-configurations <value>]
[--tags <value>]
[--auto-participant-recording-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--name (string)

Optional name that can be specified for the stage being created.

--participant-token-configurations (list)

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

(structure)

Object specifying a participant token configuration in a stage.

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.

attributes -> (map)

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.

key -> (string)

value -> (string)

capabilities -> (list)

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

(string)

Shorthand Syntax:

duration=integer,userId=string,attributes={KeyName1=string,KeyName2=string},capabilities=string,string ...

JSON Syntax:

[
  {
    "duration": integer,
    "userId": "string",
    "attributes": {"string": "string"
      ...},
    "capabilities": ["PUBLISH"|"SUBSCRIBE", ...]
  }
  ...
]

--tags (map)

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.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--auto-participant-recording-configuration (structure)

Configuration object for individual participant recording, to attach to the new stage.

storageConfigurationArn -> (string)

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

mediaTypes -> (list)

Types of media to be recorded. Default: AUDIO_VIDEO .

(string)

Shorthand Syntax:

storageConfigurationArn=string,mediaTypes=string,string

JSON Syntax:

{
  "storageConfigurationArn": "string",
  "mediaTypes": ["AUDIO_VIDEO"|"AUDIO_ONLY", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a stage

The following create-stage example creates a stage and stage participant token for a specified user.

aws ivs-realtime create-stage \
    --name stage1 \
    --participant-token-configurations userId=alice

Output:

{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "name": "stage1",
        "tags": {}
    }
}

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon Interactive Video Service User Guide.

Output¶

stage -> (structure)

The stage that was created.

arn -> (string)

Stage ARN.

name -> (string)

Stage name.

activeSessionId -> (string)

ID of the active session within the stage.

tags -> (map)

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.

key -> (string)

value -> (string)

autoParticipantRecordingConfiguration -> (structure)

Configuration object for individual participant recording, attached to the stage.

storageConfigurationArn -> (string)

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

mediaTypes -> (list)

Types of media to be recorded. Default: AUDIO_VIDEO .

(string)

endpoints -> (structure)

Summary information about various endpoints for a stage.

events -> (string)

Events endpoint.

whip -> (string)

WHIP endpoint.

participantTokens -> (list)

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

(structure)

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.

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 -> (map)

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.

key -> (string)

value -> (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 -> (timestamp)

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

Table Of Contents

Feedback

User Guide

Note:

create-stage¶

Description¶

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶