IVS / Client / list_channels

list_channels#

IVS.Client.list_channels(**kwargs)#

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

Request Syntax

response = client.list_channels(
    filterByName='string',
    filterByRecordingConfigurationArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • filterByName (string) – Filters the channel list to match the specified name.

  • filterByRecordingConfigurationArn (string) – Filters the channel list to match the specified recording-configuration ARN.

  • maxResults (integer) – Maximum number of channels to return. Default: 100.

  • nextToken (string) – The first channel to retrieve. This is used for pagination; see the nextToken response field.

Return type:

dict

Returns:

Response Syntax

{
    'channels': [
        {
            'arn': 'string',
            'authorized': True|False,
            'insecureIngest': True|False,
            'latencyMode': 'NORMAL'|'LOW',
            'name': 'string',
            'preset': 'HIGHER_BANDWIDTH_DELIVERY'|'CONSTRAINED_BANDWIDTH_DELIVERY',
            'recordingConfigurationArn': 'string',
            'tags': {
                'string': 'string'
            },
            'type': 'BASIC'|'STANDARD'|'ADVANCED_SD'|'ADVANCED_HD'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • channels (list) –

      List of the matching channels.

      • (dict) –

        Summary information about a channel.

        • arn (string) –

          Channel ARN.

        • authorized (boolean) –

          Whether the channel is private (enabled for playback authorization). Default: false.

        • insecureIngest (boolean) –

          Whether the channel allows insecure RTMP ingest. Default: false.

        • latencyMode (string) –

          Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

        • name (string) –

          Channel name.

        • preset (string) –

          Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types ( BASIC and STANDARD), preset is the empty string ( "").

        • recordingConfigurationArn (string) –

          Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: “” (empty string, recording is disabled).

        • tags (dict) –

          Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

          • (string) –

            • (string) –

        • type (string) –

          Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values:

          • BASIC: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.

          • STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.

          • ADVANCED_SD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

          • ADVANCED_HD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.

          Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:

          • Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)

          • Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).

    • nextToken (string) –

      If there are more channels than maxResults, use nextToken in the request to get the next set.

Exceptions

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.ConflictException