ListMultiplexes

class MediaLive.Paginator.ListMultiplexes
paginator = client.get_paginator('list_multiplexes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaLive.Client.list_multiplexes().

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
{
    'Multiplexes': [
        {
            'Arn': 'string',
            'AvailabilityZones': [
                'string',
            ],
            'Id': 'string',
            'MultiplexSettings': {
                'TransportStreamBitrate': 123
            },
            'Name': 'string',
            'PipelinesRunningCount': 123,
            'ProgramCount': 123,
            'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

  • (dict) -- An array of multiplexes.
    • Multiplexes (list) -- List of multiplexes.
      • (dict) -- Placeholder documentation for MultiplexSummary
        • Arn (string) -- The unique arn of the multiplex.
        • AvailabilityZones (list) -- A list of availability zones for the multiplex.
          • (string) -- Placeholder documentation for __string
        • Id (string) -- The unique id of the multiplex.
        • MultiplexSettings (dict) -- Configuration for a multiplex event.
          • TransportStreamBitrate (integer) -- Transport stream bit rate.
        • Name (string) -- The name of the multiplex.
        • PipelinesRunningCount (integer) -- The number of currently healthy pipelines.
        • ProgramCount (integer) -- The number of programs in the multiplex.
        • State (string) -- The current state of the multiplex.
        • Tags (dict) -- A collection of key-value pairs.
          • (string) -- Placeholder documentation for __string
            • (string) -- Placeholder documentation for __string