MediaLive / Paginator / ListMultiplexPrograms

ListMultiplexPrograms#

class MediaLive.Paginator.ListMultiplexPrograms#
paginator = client.get_paginator('list_multiplex_programs')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • MultiplexId (string) – [REQUIRED] The ID of the multiplex that the programs belong to.

  • 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

{
    'MultiplexPrograms': [
        {
            'ChannelId': 'string',
            'ProgramName': 'string'
        },
    ],

}

Response Structure

  • (dict) – An array of the programs for one multiplex.

    • MultiplexPrograms (list) – List of multiplex programs.

      • (dict) – Placeholder documentation for MultiplexProgramSummary

        • ChannelId (string) – The MediaLive Channel associated with the program.

        • ProgramName (string) – The name of the multiplex program.