Multiplexes multiplexId Start - AWS Elemental MediaLive API Reference

Multiplexes multiplexId Start

URI

/prod/multiplexes/multiplexId/start

HTTP Methods

POST

Operation ID: StartMultiplex

Start the Multiplex.

Path Parameters
Name Type Required Description
multiplexId String True
Responses
Status Code Response Model Description
202 Multiplex

202 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

404 ResourceNotFound

404 response.

409 ResourceConflict

409 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

Schemas

Response Bodies

Example Multiplex

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

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

{ "message": "string" }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AccessDenied

Property Type Required Description
message

string

False

BadGatewayException

Property Type Required Description
message

string

False

GatewayTimeoutException

Property Type Required Description
message

string

False

InternalServiceError

Property Type Required Description
message

string

False

InvalidRequest

Property Type Required Description
message

string

False

LimitExceeded

Property Type Required Description
message

string

False

Multiplex

The multiplex object. This element belongs to Create Multiplex, CreateMultiplexResultModel, UpdateMultiplex, and UpdateMultiplexResultModel

Property Type Required Description
name

string

False

The name of the multiplex.

id

string

False

The unique id of the multiplex.

arn

string

False

The unique arn of the multiplex.

availabilityZones

Array of type string

False

A list of availability zones for the multiplex.

state

MultiplexState

False

The current state of the multiplex.

pipelinesRunningCount

integer

False

The number of currently healthy pipelines.

multiplexSettings

MultiplexSettings

False

Configuration for a multiplex event.

tags

Tags

False

A collection of key-value pairs.

programCount

integer

False

The number of programs in the multiplex.

destinations

Array of type MultiplexOutputDestination

False

A list of the multiplex output destinations.

MultiplexMediaConnectOutputDestinationSettings

Multiplex MediaConnect output destination settings. This element belongs to MultiplexOutputDestination.

Property Type Required Description
entitlementArn

string

MinLength: 1

False

The MediaConnect entitlement ARN available as a Flow source.

MultiplexOutputDestination

Configures the single output in a Multiplex output group. And array of these element belongs to Multiplex.

Property Type Required Description
mediaConnectSettings

MultiplexMediaConnectOutputDestinationSettings

False

Multiplex MediaConnect output destination settings.

MultiplexSettings

Contains configuration for a multiplex. This element belongs to MultiplexSummary, UpdateMultiplex, and CreateMultiplex.

Property Type Required Description
transportStreamId

integer

Minimum: 0

Maximum: 65535

True

Transport stream ID.

transportStreamBitrate

integer

Minimum: 1000000

Maximum: 100000000

True

Transport stream bit rate.

transportStreamReservedBitrate

integer

Minimum: 0

Maximum: 100000000

False

Transport stream reserved bit rate.

maximumVideoBufferDelayMilliseconds

integer

Minimum: 1000

Maximum: 3000

False

Maximum video buffer delay in milliseconds.

MultiplexState

The current state of the multiplex. This element belongs to Multiplex and MultiplexSummary.

  • CREATING

  • CREATE_FAILED

  • IDLE

  • STARTING

  • RUNNING

  • RECOVERING

  • STOPPING

  • DELETING

  • DELETED

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

Tags

Tags for the resource. This element belongs to many resources belon.

Property Type Required Description

*

string

False

See Also

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

StartMultiplex