aws ivs-realtime list-compositions

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get a list of compositions

The following list-compositions example lists all compositions for your AWS account, in the AWS region where the API request is processed.

aws ivs-realtime list-compositionsIdentify

Its output, shortened

{
    "compositions": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:composition/abcdABCDefgh",
            "destinations": [
                {
                    "id": "AabBCcdDEefF",
                    "startTime": "2023-10-16T23:25:23+00:00",
                    "state": "ACTIVE"
                }
            ],
            "stageArn": "arn:aws:ivs:us-west-2:123456789012:stage/defgABCDabcd",
            "startTime": "2023-10-16T23:25:21+00:00",
            "state": "ACTIVE",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:composition/ABcdabCDefgh",
            "destinations": [
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "aABbcCDdeEFf",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
                },
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "deEFfaABbcCD",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
… 10 more lines

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

Options

4 in the AWS CLI reference

--filter-by-encoder-configuration-arnFilters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

--filter-by-stage-arnFilters the Composition list to match the specified Stage ARN.

--max-resultsMaximum number of results to return.

--next-tokenThe first Composition to retrieve.