update_multiplex

update_multiplex(**kwargs)

Updates a multiplex.

See also: AWS API Documentation

Request Syntax

response = client.update_multiplex(
    MultiplexId='string',
    MultiplexSettings={
        'MaximumVideoBufferDelayMilliseconds': 123,
        'TransportStreamBitrate': 123,
        'TransportStreamId': 123,
        'TransportStreamReservedBitrate': 123
    },
    Name='string'
)

Parameters

• MultiplexId (string) -- [REQUIRED] ID of the multiplex to update.
• MultiplexSettings (dict) --

  The new settings for a multiplex.

  • MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
  • TransportStreamBitrate (integer) -- [REQUIRED] Transport stream bit rate.
  • TransportStreamId (integer) -- [REQUIRED] Transport stream ID.
  • TransportStreamReservedBitrate (integer) -- Transport stream reserved bit rate.
• Name (string) -- Name of the multiplex.

Return type

dict

Returns

Response Syntax

{
    'Multiplex': {
        'Arn': 'string',
        'AvailabilityZones': [
            'string',
        ],
        'Destinations': [
            {
                'MediaConnectSettings': {
                    'EntitlementArn': 'string'
                }
            },
        ],
        'Id': 'string',
        'MultiplexSettings': {
            'MaximumVideoBufferDelayMilliseconds': 123,
            'TransportStreamBitrate': 123,
            'TransportStreamId': 123,
            'TransportStreamReservedBitrate': 123
        },
        'Name': 'string',
        'PipelinesRunningCount': 123,
        'ProgramCount': 123,
        'State': 'CREATING'|'CREATE_FAILED'|'IDLE'|'STARTING'|'RUNNING'|'RECOVERING'|'STOPPING'|'DELETING'|'DELETED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) -- The update to the multiplex has succeeded.
  • Multiplex (dict) -- The updated multiplex.
    • Arn (string) -- The unique arn of the multiplex.
    • AvailabilityZones (list) -- A list of availability zones for the multiplex.
      • (string) -- Placeholder documentation for __string
    • Destinations (list) -- A list of the multiplex output destinations.
      • (dict) -- Multiplex output destination settings
        • MediaConnectSettings (dict) -- Multiplex MediaConnect output destination settings.
          • EntitlementArn (string) -- The MediaConnect entitlement ARN available as a Flow source.
    • Id (string) -- The unique id of the multiplex.
    • MultiplexSettings (dict) -- Configuration for a multiplex event.
      • MaximumVideoBufferDelayMilliseconds (integer) -- Maximum video buffer delay in milliseconds.
      • TransportStreamBitrate (integer) -- Transport stream bit rate.
      • TransportStreamId (integer) -- Transport stream ID.
      • TransportStreamReservedBitrate (integer) -- Transport stream reserved 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

Exceptions

• MediaLive.Client.exceptions.BadRequestException
• MediaLive.Client.exceptions.UnprocessableEntityException
• MediaLive.Client.exceptions.InternalServerErrorException
• MediaLive.Client.exceptions.ForbiddenException
• MediaLive.Client.exceptions.BadGatewayException
• MediaLive.Client.exceptions.NotFoundException
• MediaLive.Client.exceptions.GatewayTimeoutException
• MediaLive.Client.exceptions.ConflictException