MediaLive / Client / list_multiplexes

list_multiplexes#

MediaLive.Client.list_multiplexes(**kwargs)#

Retrieve a list of the existing multiplexes.

Request Syntax

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

Parameters:

MaxResults (integer) – The maximum number of items to return.
NextToken (string) – The token to retrieve the next page of results.

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'
            }
        },
    ],
    'NextToken': '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
- NextToken (string) – Token for the next ListMultiplexes request.

Exceptions

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