CmdID / aws / aws ivs

aws ivs list-channels

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

3 examples 7 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To get summary information about all channels

The following list-channels example lists all channels for your AWS account.

aws ivs list-channelsIdentify

Its output

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "name": "channel-1",
            "latencyMode": "LOW",
            "authorized": false,
            "insecureIngest": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "tags": {},
            "type": "STANDARD"
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "name": "channel-2",
            "latencyMode": "LOW",
            "authorized": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "recordingConfigurationArn": "",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

For more information, see Create a Channel in the IVS Low-Latency User Guide.

Example 2: To get summary information about all channels, filtered by the specified RecordingConfiguration ARN

The following list-channels example lists all channels for your AWS account, that are associated with the specified RecordingConfiguration ARN.

aws ivs list-channels --filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh"

Identify

--filter-by-recording-configuration-arnFilters the channel list to match the specified recording-configuration ARN.

Its output

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
            "name": "channel-1",
            "latencyMode": "LOW",
            "authorized": false,
            "insecureIngest": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "",
            "recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

For more information, see Record to Amazon S3 in the IVS Low-Latency User Guide.

Example 3: To get summary information about all channels, filtered by the specified PlaybackRestrictionPolicy ARN

The following list-channels example lists all channels for your AWS account, that are associated with the specified PlaybackRestrictionPolicy ARN.

aws ivs list-channels --filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ"

Identify

--filter-by-playback-restriction-policy-arnFilters the channel list to match the specified policy.

Its output

{
    "channels": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
            "name": "channel-2",
            "latencyMode": "LOW",
            "authorized": false,
            "preset": "",
            "playbackRestrictionPolicyArn": "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ",
            "recordingConfigurationArn": "",
            "tags": {},
            "type": "STANDARD"
        }
    ]
}

For more information, see Undesired Content and Viewers in the IVS Low-Latency User Guide.

Options

7 in the AWS CLI reference

--filter-by-ad-configuration-arnFilters the channel list to match the specified ad configuration ARN.

--filter-by-failover-slate-configuration-arnFilters the channel list to match the specified failover-slate-configuration ARN.

--filter-by-nameFilters the channel list to match the specified name.

--filter-by-playback-restriction-policy-arnFilters the channel list to match the specified policy.

--filter-by-recording-configuration-arnFilters the channel list to match the specified recording-configuration ARN.

--max-resultsMaximum number of channels to return.

--next-tokenThe first channel to retrieve.