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,
            'latencyMode': 'NORMAL'|'LOW',
            'name': 'string',
            'recordingConfigurationArn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    '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 .

      • 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.

      • 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) --

  • 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