MediaLive / Client / list_multiplex_programs

list_multiplex_programs#

MediaLive.Client.list_multiplex_programs(**kwargs)#

List the programs that currently exist for a specific multiplex.

Request Syntax

response = client.list_multiplex_programs(
    MaxResults=123,
    MultiplexId='string',
    NextToken='string'
)

Parameters:

MaxResults (integer) – The maximum number of items to return.
MultiplexId (string) – [REQUIRED] The ID of the multiplex that the programs belong to.
NextToken (string) – The token to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'MultiplexPrograms': [
        {
            'ChannelId': 'string',
            'ProgramName': 'string'
        },
    ],
    'NextToken': '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.
- NextToken (string) – Token for the next ListMultiplexProgram request.

Exceptions

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException