CmdID

CmdID / aws / aws ivs-realtime

aws ivs-realtime get-composition

Get information about the specified Composition resource. AWS CLI reference

3 examples 1 option 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 get a composition with default layout settings

The following get-composition example gets the composition for the ARN (Amazon Resource Name) specified.

aws ivs-realtime get-composition --arn "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh"Identify
--arnARN of the Composition resource.
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",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "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"
… 28 more lines

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

Example 2: To get a composition with PiP layout

The following get-composition example gets the composition for the ARN (Amazon Resource Name) specified, which uses PiP layout.

aws ivs-realtime get-composition --arn "arn:aws:ivs:us-west-2:123456789012:composition/wxyzWXYZpqrs"Identify
--arnARN of the Composition resource.
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",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "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"
… 31 more lines

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

Example 3: To get a composition with thumbnail recording enabled

The following get-composition example gets the composition for the ARN (Amazon Resource Name) specified, which has thumbnail recording enabled with default settings.

aws ivs-realtime get-composition --arn "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh"Identify
--arnARN of the Composition resource.
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",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "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",
… 36 more lines

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

Options

1 in the AWS CLI reference
--arnARN of the Composition resource.