Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

create_multiplex

create_multiplex(**kwargs)

Create a new multiplex.

See also: AWS API Documentation

Request Syntax

response = client.create_multiplex(
    AvailabilityZones=[
        'string',
    ],
    MultiplexSettings={
        'MaximumVideoBufferDelayMilliseconds': 123,
        'TransportStreamBitrate': 123,
        'TransportStreamId': 123,
        'TransportStreamReservedBitrate': 123
    },
    Name='string',
    RequestId='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • AvailabilityZones (list) --

    [REQUIRED] A list of availability zones for the multiplex. You must specify exactly two.

    • (string) -- Placeholder documentation for __string
  • MultiplexSettings (dict) --

    [REQUIRED] Configuration for a multiplex event.

    • 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) -- [REQUIRED] Name of multiplex.
  • RequestId (string) -- [REQUIRED] Unique request ID. This prevents retries from creating multiple resources. This field is autopopulated if not provided.
  • Tags (dict) --

    A collection of key-value pairs.

    • (string) -- Placeholder documentation for __string
      • (string) -- Placeholder documentation for __string
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) -- Creation of the multiplex is in progress.
    • Multiplex (dict) -- The newly created 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.GatewayTimeoutException
  • MediaLive.Client.exceptions.TooManyRequestsException
  • MediaLive.Client.exceptions.ConflictException