MediaLive / Client / update_multiplex

update_multiplex#

MediaLive.Client.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',
    PacketIdentifiersMapping={
        'string': {
            'AudioPids': [
                123,
            ],
            'DvbSubPids': [
                123,
            ],
            'DvbTeletextPid': 123,
            'EtvPlatformPid': 123,
            'EtvSignalPid': 123,
            'KlvDataPids': [
                123,
            ],
            'PcrPid': 123,
            'PmtPid': 123,
            'PrivateMetadataPid': 123,
            'Scte27Pids': [
                123,
            ],
            'Scte35Pid': 123,
            'TimedMetadataPid': 123,
            'VideoPid': 123,
            'AribCaptionsPid': 123,
            'DvbTeletextPids': [
                123,
            ],
            'EcmPid': 123,
            'Smpte2038Pid': 123
        }
    }
)
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.

  • PacketIdentifiersMapping (dict) –

    Placeholder documentation for MultiplexPacketIdentifiersMapping

    • (string) – Placeholder documentation for __string

      • (dict) – Packet identifiers map for a given Multiplex program.

        • AudioPids (list) – Placeholder documentation for __listOf__integer

          • (integer) – Placeholder documentation for __integer

        • DvbSubPids (list) – Placeholder documentation for __listOf__integer

          • (integer) – Placeholder documentation for __integer

        • DvbTeletextPid (integer) – Placeholder documentation for __integer

        • EtvPlatformPid (integer) – Placeholder documentation for __integer

        • EtvSignalPid (integer) – Placeholder documentation for __integer

        • KlvDataPids (list) – Placeholder documentation for __listOf__integer

          • (integer) – Placeholder documentation for __integer

        • PcrPid (integer) – Placeholder documentation for __integer

        • PmtPid (integer) – Placeholder documentation for __integer

        • PrivateMetadataPid (integer) – Placeholder documentation for __integer

        • Scte27Pids (list) – Placeholder documentation for __listOf__integer

          • (integer) – Placeholder documentation for __integer

        • Scte35Pid (integer) – Placeholder documentation for __integer

        • TimedMetadataPid (integer) – Placeholder documentation for __integer

        • VideoPid (integer) – Placeholder documentation for __integer

        • AribCaptionsPid (integer) – Placeholder documentation for __integer

        • DvbTeletextPids (list) – Placeholder documentation for __listOf__integer

          • (integer) – Placeholder documentation for __integer

        • EcmPid (integer) – Placeholder documentation for __integer

        • Smpte2038Pid (integer) – Placeholder documentation for __integer

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