MediaPackage / Paginator / ListChannels

ListChannels

class MediaPackage.Paginator.ListChannels

paginator = client.get_paginator('list_channels')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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',
            'CreatedAt': 'string',
            'Description': 'string',
            'EgressAccessLogs': {
                'LogGroupName': 'string'
            },
            'HlsIngest': {
                'IngestEndpoints': [
                    {
                        'Id': 'string',
                        'Password': 'string',
                        'Url': 'string',
                        'Username': 'string'
                    },
                ]
            },
            'Id': 'string',
            'IngressAccessLogs': {
                'LogGroupName': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) – A collection of Channel records.

  • Channels (list) – A list of Channel records.

    • (dict) – A Channel resource configuration.

      • Arn (string) – The Amazon Resource Name (ARN) assigned to the Channel.

      • CreatedAt (string) – The date and time the Channel was created.

      • Description (string) – A short text description of the Channel.

      • EgressAccessLogs (dict) – Configure egress access logging.

        • LogGroupName (string) – Customize the log group name.

      • HlsIngest (dict) – An HTTP Live Streaming (HLS) ingest resource configuration.

        • IngestEndpoints (list) – A list of endpoints to which the source stream should be sent.

          • (dict) – An endpoint for ingesting source content for a Channel.

            • Id (string) – The system generated unique identifier for the IngestEndpoint

            • Password (string) – The system generated password for ingest authentication.

            • Url (string) – The ingest URL to which the source stream should be sent.

            • Username (string) – The system generated username for ingest authentication.

      • Id (string) – The ID of the Channel.

      • IngressAccessLogs (dict) – Configure ingress access logging.

        • LogGroupName (string) – Customize the log group name.

      • Tags (dict) – A collection of tags associated with a resource

        • (string) –

          • (string) –