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',
    filterByPlaybackRestrictionPolicyArn='string',
    filterByRecordingConfigurationArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

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

  • filterByPlaybackRestrictionPolicyArn (string) – Filters the channel list to match the specified policy.

  • 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',
            'playbackRestrictionPolicyArn': '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.

        • name (string) –

          Channel name.

        • playbackRestrictionPolicyArn (string) –

          Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: “” (empty string, no playback restriction policy is applied).

        • 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 valid ARN value here both specifies the ARN and enables recording. 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. Default: STANDARD. For details, see Channel Types.

    • 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