CmdID

CmdID / aws / aws ivs-realtime

aws ivs-realtime start-composition

Starts a Composition from a stage based on the configuration provided in the request. AWS CLI reference

4 examples 5 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 start a composition with default layout settings

The following start-composition example starts a composition for the specified stage to be streamed to the specified locations.

aws ivs-realtime start-composition --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/defgABCDabcd --destinations '[{"channel": {"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",Identify
--stage-arnARN of the stage to be used for compositing.
--destinationsArray of destination configuration.
"encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"}},
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"],
"recordingConfiguration": {"hlsConfiguration": {"targetSegmentDurationSeconds": 5}},
"storageConfigurationArn":"arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE"}}]'
Its output, shortened
{
    "composition": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 5
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE"
                    }
… 26 more lines

For more information, see IVS Composite Recording | Real-Time Streaming in the Amazon Interactive Video Service User Guide.

Example 2: To start a composition with PiP layout

The following start-composition example starts a composition for the specified stage to be streamed to the specified locations using PiP layout.

aws ivs-realtime start-composition --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/defgABCDabcd --destinations '[{"channel": {"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",Identify
--stage-arnARN of the stage to be used for compositing.
--destinationsArray of destination configuration.
"encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"}},
{"s3":{"encoderConfigurationArns":["arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"],
"storageConfigurationArn":"arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE"}}]' --layout pip='{featuredParticipantAttribute="abcdefg"}'
Its output, shortened
{
    "composition": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 2
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE"
                    }
… 29 more lines

For more information, see IVS Composite Recording | Real-Time Streaming in the Amazon Interactive Video Service User Guide.

Example 3: To start a composition with thumbnail recording enabled

The following start-composition example starts a composition for the specified stage to be streamed to the specified locations with thumbnail recording enabled.

aws ivs-realtime start-composition --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/defgABCDabcd --destinations '[{"channel": {"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",Identify
--stage-arnARN of the stage to be used for compositing.
--destinationsArray of destination configuration.
"encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"}},
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]'
Its output, shortened
{
    "composition": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 2
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE",
                        "thumbnailConfigurations": [
… 34 more lines

For more information, see Composite Recording (Real-Time Streaming) in the Amazon Interactive Video Service User Guide.

Example 4: To start a composition using grid layout with custom participant ordering

The following start-composition example starts a composition for the specified stage to be streamed to the specified locations using grid layout with custom participant ordering.

aws ivs-realtime start-composition --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/defgABCDabcd --destinations '[{"channel": {"channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",Identify
--stage-arnARN of the stage to be used for compositing.
--destinationsArray of destination configuration.
"encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"}},
{"s3": {"encoderConfigurationArns": ["arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"],
"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [{"storage": ["SEQUENTIAL"],"targetIntervalSeconds": 60}]}}]' --layout grid='{participantOrderAttribute="abcdefg"}'
Its output, shortened
{
    "composition": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:us-west-2:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS",
                            "hlsConfiguration": {
                                "targetSegmentDurationSeconds": 2
                            }
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:us-west-2:123456789012:storage-configuration/FefABabCDcdE",
                        "thumbnailConfigurations": [
… 34 more lines

For more information, see IVS Composite Recording | Real-Time Streaming in the Amazon Interactive Video Service User Guide.

Options

5 in the AWS CLI reference
--destinationsArray of destination configuration.
--idempotency-tokenIdempotency token.
--layoutLayout object to configure composition parameters.
--stage-arnARN of the stage to be used for compositing.
--tagsTags attached to the resource.