Multiplexes multiplexId Programs - AWS Elemental MediaLive API Reference

Multiplexes multiplexId Programs

URI

/prod/multiplexes/multiplexId/programs

HTTP Methods

GET

Operation ID: ListMultiplexPrograms

Get the list of programs in one Multiplex.

Path Parameters
Name Type Required Description
multiplexId String True
Query Parameters
Name Type Required Description
nextToken String False

Get the next token.

maxResults String False

Set the maximum number of results to include in one response.

Responses
Status Code Response Model Description
200 ListMultiplexProgramsResultModel

200 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

404 ResourceNotFound

404 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

POST

Operation ID: CreateMultiplexProgram

Create a program in one multiplex.

Path Parameters
Name Type Required Description
multiplexId String True
Responses
Status Code Response Model Description
201 CreateMultiplexProgramResultModel

201 response.

400 InvalidRequest

400 response.

403 AccessDenied

403 response.

409 ResourceConflict

409 response.

422 MultiplexConfigurationValidationError

422 response.

429 LimitExceeded

429 response.

500 InternalServiceError

500 response.

502 BadGatewayException

502 response.

504 GatewayTimeoutException

504 response.

Schemas

Request Bodies

Example POST

{ "programName": "string", "multiplexProgramSettings": { "programNumber": integer, "serviceDescriptor": { "providerName": "string", "serviceName": "string" }, "videoSettings": { "constantBitrate": integer, "statmuxSettings": { "minimumBitrate": integer, "maximumBitrate": integer } }, "preferredChannelPipeline": enum }, "requestId": "string" }

Response Bodies

Example ListMultiplexProgramsResultModel

{ "multiplexPrograms": [ { "programName": "string", "channelId": "string" } ], "nextToken": "string" }

Example CreateMultiplexProgramResultModel

{ "multiplexProgram": { "programName": "string", "channelId": "string", "multiplexProgramSettings": { "programNumber": integer, "serviceDescriptor": { "providerName": "string", "serviceName": "string" }, "videoSettings": { "constantBitrate": integer, "statmuxSettings": { "minimumBitrate": integer, "maximumBitrate": integer } }, "preferredChannelPipeline": enum }, "packetIdentifiersMap": { "pmtPid": integer, "pcrPid": integer, "videoPid": integer, "audioPids": [ integer ], "dvbSubPids": [ integer ], "scte27Pids": [ integer ], "klvDataPids": [ integer ], "scte35Pid": integer, "etvPlatformPid": integer, "etvSignalPid": integer, "dvbTeletextPid": integer, "timedMetadataPid": integer, "privateMetadataPid": integer } } }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

{ "message": "string" }

Example MultiplexConfigurationValidationError

{ "message": "string", "validationErrors": [ { "errorMessage": "string", "elementPath": "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

CreateMultiplexProgram

Property Type Required Description
programName

string

True

Name of multiplex program.

multiplexProgramSettings

MultiplexProgramSettings

True

The settings for this multiplex program.

requestId

string

True

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

CreateMultiplexProgramResultModel

Property Type Required Description
multiplexProgram

MultiplexProgram

False

The newly created multiplex program.

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

ListMultiplexProgramsResultModel

Property Type Required Description
multiplexPrograms

Array of type MultiplexProgramSummary

False

List of multiplex programs.

nextToken

string

False

Token for the next ListMultiplexProgram request.

MultiplexConfigurationValidationError

Property Type Required Description
message

string

False

The error message.

validationErrors

Array of type ValidationError

False

A collection of validation error responses.

MultiplexProgram

The multiplex program object. This element belongs to CreateMultiplexProgramResultModel, and UpdateMultiplexProgramResultModel.

Property Type Required Description
programName

string

False

The name of the multiplex program.

channelId

string

False

The MediaLive channel associated with the program.

multiplexProgramSettings

MultiplexProgramSettings

False

The settings for this multiplex program.

packetIdentifiersMap

MultiplexProgramPacketIdentifiersMap

False

The packet identifier map for this multiplex program.

MultiplexProgramPacketIdentifiersMap

Packet identifiers map for a given Multiplex program. This element belongs to MultiplexProgram.

Property Type Required Description
pmtPid

integer

False
pcrPid

integer

False
videoPid

integer

False
audioPids

Array of type integer

False
dvbSubPids

Array of type integer

False
scte27Pids

Array of type integer

False
klvDataPids

Array of type integer

False
scte35Pid

integer

False
etvPlatformPid

integer

False
etvSignalPid

integer

False
dvbTeletextPid

integer

False
timedMetadataPid

integer

False
privateMetadataPid

integer

False

MultiplexProgramServiceDescriptor

Transport stream service descriptor configuration for the Multiplex program. This element belongs to MultiplexProgramSettings.

Property Type Required Description
providerName

string

MaxLength: 256

True

Name of the provider.

serviceName

string

MaxLength: 256

True

Name of the service.

MultiplexProgramSettings

Multiplex program settings configuration. This element belongs to CreateMultiplexProgram, UpdateMultiplexProgram, and MultiplexProgram.

Property Type Required Description
programNumber

integer

Minimum: 0

Maximum: 65535

True

Unique program number.

serviceDescriptor

MultiplexProgramServiceDescriptor

False

Transport stream service descriptor configuration for the Multiplex program.

videoSettings

MultiplexVideoSettings

False

Program video settings configuration.

preferredChannelPipeline

PreferredChannelPipeline

False

Indicates which pipeline is preferred by the multiplex for program ingest.

MultiplexProgramSummary

Property Type Required Description
programName

string

False

The name of the multiplex program.

channelId

string

False

The MediaLive Channel associated with the program.

MultiplexStatmuxVideoSettings

Statmux rate control settings. This element belongs to MultiplexVideoSettings.

Property Type Required Description
minimumBitrate

integer

Minimum: 100000

Maximum: 100000000

False

Minimum statmux bitrate.

maximumBitrate

integer

Minimum: 100000

Maximum: 100000000

False

Maximum statmux bitrate.

MultiplexVideoSettings

The video configuration for each program in a multiplex. This element belongs to MultiplexProgramSettings.

Property Type Required Description
constantBitrate

integer

Minimum: 100000

Maximum: 100000000

False

The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined.

statmuxSettings

MultiplexStatmuxVideoSettings

False

Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.

PreferredChannelPipeline

Indicates which pipeline is preferred by the multiplex for program ingest. If set to \"PIPELINE_0\" or \"PIPELINE_1\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline, it will switch back once that ingest is healthy again. If set to \"CURRENTLY_ACTIVE\", it will not switch back to the other pipeline based on it recovering to a healthy state, it will only switch if the active pipeline becomes unhealthy. This element belongs to MultiplexProgramSettings.

  • CURRENTLY_ACTIVE

  • PIPELINE_0

  • PIPELINE_1

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
message

string

False

ValidationError

Property Type Required Description
errorMessage

string

False

The error message.

elementPath

string

False

Path to the source of the error.

See Also

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

ListMultiplexPrograms

CreateMultiplexProgram