Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account
Multiplexes - AWS Elemental MediaLive API Reference
URIHTTP methodsSchemasPropertiesSee also

Multiplexes

PDF

URI

/prod/multiplexes

HTTP methods

GET

Operation ID: ListMultiplexes

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse
maxResultsStringFalse
Responses
Status codeResponse modelDescription
200ListMultiplexesResultModel

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

POST

Operation ID: CreateMultiplex

Responses
Status codeResponse modelDescription
201CreateMultiplexResultModel

201 response

400InvalidRequest

400 response

403AccessDenied

403 response

409ResourceConflict

409 response

422MultiplexConfigurationValidationError

422 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

Schemas

Request bodies

{
  "availabilityZones": [
    "string"
  ],
  "multiplexSettings": {
    "maximumVideoBufferDelayMilliseconds": integer,
    "transportStreamBitrate": integer,
    "transportStreamId": integer,
    "transportStreamReservedBitrate": integer
  },
  "name": "string",
  "requestId": "string",
  "tags": {
  }
}

POST schema

{
  "availabilityZones": [
    "string"
  ],
  "multiplexSettings": {
    "maximumVideoBufferDelayMilliseconds": integer,
    "transportStreamBitrate": integer,
    "transportStreamId": integer,
    "transportStreamReservedBitrate": integer
  },
  "name": "string",
  "requestId": "string",
  "tags": {
  }
}

Response bodies

{
  "multiplexes": [
    {
      "arn": "string",
      "availabilityZones": [
        "string"
      ],
      "id": "string",
      "multiplexSettings": {
        "transportStreamBitrate": integer
      },
      "name": "string",
      "pipelinesRunningCount": integer,
      "programCount": integer,
      "state": enum,
      "tags": {
      }
    }
  ],
  "nextToken": "string"
}

ListMultiplexesResultModel schema

{
  "multiplexes": [
    {
      "arn": "string",
      "availabilityZones": [
        "string"
      ],
      "id": "string",
      "multiplexSettings": {
        "transportStreamBitrate": integer
      },
      "name": "string",
      "pipelinesRunningCount": integer,
      "programCount": integer,
      "state": enum,
      "tags": {
      }
    }
  ],
  "nextToken": "string"
}
{
  "multiplex": {
    "arn": "string",
    "availabilityZones": [
      "string"
    ],
    "destinations": [
      {
        "mediaConnectSettings": {
          "entitlementArn": "string"
        }
      }
    ],
    "id": "string",
    "multiplexSettings": {
      "maximumVideoBufferDelayMilliseconds": integer,
      "transportStreamBitrate": integer,
      "transportStreamId": integer,
      "transportStreamReservedBitrate": integer
    },
    "name": "string",
    "pipelinesRunningCount": integer,
    "programCount": integer,
    "state": enum,
    "tags": {
    }
  }
}

CreateMultiplexResultModel schema

{
  "multiplex": {
    "arn": "string",
    "availabilityZones": [
      "string"
    ],
    "destinations": [
      {
        "mediaConnectSettings": {
          "entitlementArn": "string"
        }
      }
    ],
    "id": "string",
    "multiplexSettings": {
      "maximumVideoBufferDelayMilliseconds": integer,
      "transportStreamBitrate": integer,
      "transportStreamId": integer,
      "transportStreamReservedBitrate": integer
    },
    "name": "string",
    "pipelinesRunningCount": integer,
    "programCount": integer,
    "state": enum,
    "tags": {
    }
  }
}
{
  "message": "string"
}

InvalidRequest schema

{
  "message": "string"
}
{
  "message": "string"
}

AccessDenied schema

{
  "message": "string"
}
{
  "message": "string"
}

ResourceConflict schema

{
  "message": "string"
}
{
  "message": "string",
  "validationErrors": [
    {
      "elementPath": "string",
      "errorMessage": "string"
    }
  ]
}

MultiplexConfigurationValidationError schema

{
  "message": "string",
  "validationErrors": [
    {
      "elementPath": "string",
      "errorMessage": "string"
    }
  ]
}
{
  "message": "string"
}

LimitExceeded schema

{
  "message": "string"
}
{
  "message": "string"
}

InternalServiceError schema

{
  "message": "string"
}
{
  "message": "string"
}

BadGatewayException schema

{
  "message": "string"
}
{
  "message": "string"
}

GatewayTimeoutException schema

{
  "message": "string"
}

Properties

AccessDenied

PropertyTypeRequiredDescription
message

string

False

BadGatewayException

PropertyTypeRequiredDescription
message

string

False

CreateMultiplex

PropertyTypeRequiredDescription
availabilityZones

Array of type string

True

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

multiplexSettings

MultiplexSettings

True

Configuration for a multiplex event.

name

string

True

Name of multiplex.

requestId

string

True

Unique request ID. This prevents retries from creating multiple resources.

tags

Tags

False

A collection of key-value pairs.

CreateMultiplexResultModel

PropertyTypeRequiredDescription
multiplex

Multiplex

False

The newly created multiplex.

GatewayTimeoutException

PropertyTypeRequiredDescription
message

string

False

InternalServiceError

PropertyTypeRequiredDescription
message

string

False

InvalidRequest

PropertyTypeRequiredDescription
message

string

False

LimitExceeded

PropertyTypeRequiredDescription
message

string

False

ListMultiplexesResultModel

PropertyTypeRequiredDescription
multiplexes

Array of type MultiplexSummary

False

List of multiplexes.

nextToken

string

False

Token for the next ListMultiplexes request.

Multiplex

The multiplex object.

PropertyTypeRequiredDescription
arn

string

False

The unique arn of the multiplex.

availabilityZones

Array of type string

False

A list of availability zones for the multiplex.

destinations

Array of type MultiplexOutputDestination

False

A list of the multiplex output destinations.

id

string

False

The unique id of the multiplex.

multiplexSettings

MultiplexSettings

False

Configuration for a multiplex event.

name

string

False

The name of the multiplex.

pipelinesRunningCount

integer

False

The number of currently healthy pipelines.

programCount

integer

False

The number of programs in the multiplex.

state

MultiplexState

False

The current state of the multiplex.

tags

Tags

False

A collection of key-value pairs.

MultiplexConfigurationValidationError

PropertyTypeRequiredDescription
message

string

False

The error message.

validationErrors

Array of type ValidationError

False

A collection of validation error responses.

MultiplexMediaConnectOutputDestinationSettings

Multiplex MediaConnect output destination settings.

PropertyTypeRequiredDescription
entitlementArn

string

MinLength: 1

False

The MediaConnect entitlement ARN available as a Flow source.

MultiplexOutputDestination

Multiplex output destination settings

PropertyTypeRequiredDescription
mediaConnectSettings

MultiplexMediaConnectOutputDestinationSettings

False

Multiplex MediaConnect output destination settings.

MultiplexSettings

Contains configuration for a Multiplex event

PropertyTypeRequiredDescription
maximumVideoBufferDelayMilliseconds

integer

Minimum: 800

Maximum: 3000

False

Maximum video buffer delay in milliseconds.

transportStreamBitrate

integer

Minimum: 1000000

Maximum: 100000000

True

Transport stream bit rate.

transportStreamId

integer

Minimum: 0

Maximum: 65535

True

Transport stream ID.

transportStreamReservedBitrate

integer

Minimum: 0

Maximum: 100000000

False

Transport stream reserved bit rate.

MultiplexSettingsSummary

Contains summary configuration for a Multiplex event.

PropertyTypeRequiredDescription
transportStreamBitrate

integer

Minimum: 1000000

Maximum: 100000000

False

Transport stream bit rate.

MultiplexState

The current state of the multiplex.

  • CREATING

  • CREATE_FAILED

  • IDLE

  • STARTING

  • RUNNING

  • RECOVERING

  • STOPPING

  • DELETING

  • DELETED

MultiplexSummary

PropertyTypeRequiredDescription
arn

string

False

The unique arn of the multiplex.

availabilityZones

Array of type string

False

A list of availability zones for the multiplex.

id

string

False

The unique id of the multiplex.

multiplexSettings

MultiplexSettingsSummary

False

Configuration for a multiplex event.

name

string

False

The name of the multiplex.

pipelinesRunningCount

integer

False

The number of currently healthy pipelines.

programCount

integer

False

The number of programs in the multiplex.

state

MultiplexState

False

The current state of the multiplex.

tags

Tags

False

A collection of key-value pairs.

ResourceConflict

PropertyTypeRequiredDescription
message

string

False

Tags

PropertyTypeRequiredDescription

*

string

False

ValidationError

PropertyTypeRequiredDescription
elementPath

string

False

Path to the source of the error.

errorMessage

string

False

The error message.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListMultiplexes

CreateMultiplex

Previous topic:

Multiplex: stop

Need help?

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.