Multiplexes
URI
/prod/multiplexes
HTTP methods
GET
Operation ID: ListMultiplexes
Name | Type | Required | Description |
---|---|---|---|
nextToken | String | False | |
maxResults | String | False |
Status code | Response model | Description |
---|---|---|
200 | ListMultiplexesResultModel | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
POST
Operation ID: CreateMultiplex
Status code | Response model | Description |
---|---|---|
201 | CreateMultiplexResultModel | 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
{
"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"
}
{
"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"
}
{
"message": "string"
}
{
"message": "string"
}
{
"message": "string",
"validationErrors": [
{
"elementPath": "string",
"errorMessage": "string"
}
]
}
{
"message": "string"
}
{
"message": "string"
}
{
"message": "string"
}
{
"message": "string"
}
Properties
AccessDenied
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
BadGatewayException
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
CreateMultiplex
Property | Type | Required | Description |
---|---|---|---|
availabilityZones | Array of type string | True | A list of availability zones for the multiplex. You must specify exactly two. |
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 | False | A collection of key-value pairs. |
CreateMultiplexResultModel
Property | Type | Required | Description |
---|---|---|---|
multiplex | False | The newly created multiplex. |
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 |
ListMultiplexesResultModel
Property | Type | Required | Description |
---|---|---|---|
multiplexes | Array of type MultiplexSummary | False | List of multiplexes. |
nextToken | string | False | Token for the next ListMultiplexes request. |
Multiplex
The multiplex object.
Property | Type | Required | Description |
---|---|---|---|
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 | 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 | False | The current state of the multiplex. | |
tags | False | A collection of key-value pairs. |
MultiplexConfigurationValidationError
Property | Type | Required | Description |
---|---|---|---|
message | string | False | The error message. |
validationErrors | Array of type ValidationError | False | A collection of validation error responses. |
MultiplexMediaConnectOutputDestinationSettings
Multiplex MediaConnect output destination settings.
Property | Type | Required | Description |
---|---|---|---|
entitlementArn | string MinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. |
MultiplexOutputDestination
Multiplex output destination settings
Property | Type | Required | Description |
---|---|---|---|
mediaConnectSettings | False | Multiplex MediaConnect output destination settings. |
MultiplexSettings
Contains configuration for a Multiplex event
Property | Type | Required | Description |
---|---|---|---|
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.
Property | Type | Required | Description |
---|---|---|---|
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
Property | Type | Required | Description |
---|---|---|---|
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 | 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 | False | The current state of the multiplex. | |
tags | False | A collection of key-value pairs. |
ResourceConflict
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
Tags
Property | Type | Required | Description |
---|---|---|---|
| string | False |
ValidationError
Property | Type | Required | Description |
---|---|---|---|
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: