IVS / Paginator / ListChannels

ListChannels

class IVS.Paginator.ListChannels

paginator = client.get_paginator('list_channels')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IVS.Client.list_channels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filterByName='string',
    filterByRecordingConfigurationArn='string',
    filterByPlaybackRestrictionPolicyArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • channels (list) –

    List of the matching channels.

    • (dict) –

      Summary information about a channel.

      • arn (string) –

        Channel ARN.

      • name (string) –

        Channel name.

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

      • authorized (boolean) –

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

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

      • insecureIngest (boolean) –

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

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

      • 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 ( "").

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

  • NextToken (string) –

    A token to resume pagination.