CmdID

CmdID / aws / aws ivs-realtime

aws ivs-realtime create-stage

Creates a new stage (and optionally participant tokens). AWS CLI reference

3 examples 4 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

Example 1: 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=aliceIdentify
--nameOptional name that can be specified for the stage being created.
--participant-token-configurationsArray of participant token configuration objects to attach to the new stage.
Its output, shortened
{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "DISABLED"
            },
            "recordingReconnectWindowSeconds": 0,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 6
            },
            "recordParticipantReplicas": true
        },
        "endpoints": {
… 9 more lines

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Example 2: To create a stage and configure individual participant recording

The following create-stage example creates a stage and configures individual participant recording.

aws ivs-realtime create-stage --name stage1 --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh", "recordingReconnectWindowSeconds": 100,Identify
--nameOptional name that can be specified for the stage being created.
--auto-participant-recording-configurationConfiguration object for individual participant recording, to attach to the new stage.
"hlsConfiguration": {"targetSegmentDurationSeconds": 5}}'
Its output, shortened
{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "DISABLED"
            },
            "recordingReconnectWindowSeconds": 100,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 5
            },
            "recordParticipantReplicas": true
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
… 2 more lines

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Example 3: To create a stage and configure individual participant recording with thumbnail recording enabled

The following create-stage example creates a stage and configures individual participant recording with thumbnail recording enabled.

aws ivs-realtime create-stage --name stage1 --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",Identify
--nameOptional name that can be specified for the stage being created.
--auto-participant-recording-configurationConfiguration object for individual participant recording, to attach to the new stage.
"thumbnailConfiguration": {"recordingMode": "INTERVAL","storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}}'
Its output, shortened
{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "INTERVAL"
            },
            "recordingReconnectWindowSeconds": 0,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 6
            },
            "recordParticipantReplicas": true
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
… 2 more lines

For more information, see Enabling Multiple Hosts on an Amazon IVS Stream in the Amazon IVS Low-Latency Streaming User Guide.

Options

4 in the AWS CLI reference
--auto-participant-recording-configurationConfiguration object for individual participant recording, to attach to the new stage.
--nameOptional name that can be specified for the stage being created.
--participant-token-configurationsArray of participant token configuration objects to attach to the new stage.
--tagsTags attached to the resource.