Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-channels
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: channels
list-channels
[--filter-by-name <value>]
[--filter-by-recording-configuration-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--filter-by-name
(string)
Filters the channel list to match the specified name.
--filter-by-recording-configuration-arn
(string)
Filters the channel list to match the specified recording-configuration ARN.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Example 1: To get summary information about all channels
The following list-channels
example lists all channels for your AWS account.
aws ivs list-channels
Output:
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "channel-1",
"latencyMode": "LOW",
"authorized": false,
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"tags": {}
},
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl",
"name": "channel-2",
"latencyMode": "LOW",
"authorized": false,
"recordingConfigurationArn": "",
"tags": {}
}
]
}
For more information, see Create a Channel in the Amazon Interactive Video Service 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"
Output:
{
"channels": [
{
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "channel-1",
"latencyMode": "LOW",
"authorized": false,
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh",
"tags": {}
}
]
}
For more information, see Record to Amazon S3 in the Amazon Interactive Video Service User Guide.
channels -> (list)
List of the matching channels.
(structure)
Summary information about a channel.
arn -> (string)
Channel ARN.
authorized -> (boolean)
Whether the channel is private (enabled for playback authorization). Default:
false
.latencyMode -> (string)
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
. (Note: In the Amazon IVS console,LOW
andNORMAL
correspond to Ultra-low and Standard, respectively.)name -> (string)
Channel name.
recordingConfigurationArn -> (string)
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: “” (empty string, recording is disabled).
tags -> (map)
Array of 1-50 maps, each of the form
string:string (key:value)
.key -> (string)
value -> (string)
nextToken -> (string)
If there are more channels than
maxResults
, usenextToken
in the request to get the next set.