Multiplexes: multiplex ID

URI

/prod/multiplexes/multiplexId

HTTP methods

DELETE

Operation ID: DeleteMultiplex

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

GET

Operation ID: DescribeMultiplex

Path parameters

Name	Type	Required	Description
multiplexId	String	True

Responses

Status code	Response model	Description
200	Multiplex	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

PUT

Operation ID: UpdateMultiplex

Path parameters

Name	Type	Required	Description
multiplexId	String	True

Responses

Status code	Response model	Description
200	UpdateMultiplexResultModel	200 response
400	InvalidRequest	400 response
403	AccessDenied	403 response
404	ResourceNotFound	404 response
409	ResourceConflict	409 response
422	MultiplexConfigurationValidationError	422 response
500	InternalServiceError	500 response
502	BadGatewayException	502 response
504	GatewayTimeoutException	504 response

Schemas

Request bodies

PUT schema

{
  "multiplexSettings": {
    "maximumVideoBufferDelayMilliseconds": integer,
    "transportStreamBitrate": integer,
    "transportStreamId": integer,
    "transportStreamReservedBitrate": integer
  },
  "name": "string"
}

Response bodies

UpdateMultiplexResultModel 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": {
    }
  }
}

Multiplex schema

{
  "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": {
  }
}

InvalidRequest schema

{
  "message": "string"
}

AccessDenied schema

{
  "message": "string"
}

ResourceNotFound schema

{
  "message": "string"
}

ResourceConflict schema

{
  "message": "string"
}

MultiplexConfigurationValidationError schema

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

LimitExceeded schema

{
  "message": "string"
}

InternalServiceError schema

{
  "message": "string"
}

BadGatewayException schema

{
  "message": "string"
}

GatewayTimeoutException schema

{
  "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.

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	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

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	MultiplexMediaConnectOutputDestinationSettings	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.

MultiplexState

The current state of the multiplex.

• 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

Property	Type	Required	Description
*	string	False

UpdateMultiplex

Property	Type	Required	Description
multiplexSettings	MultiplexSettings	False	The new settings for a multiplex.
name	string	False	Name of the multiplex.

UpdateMultiplexResultModel

Property	Type	Required	Description
multiplex	Multiplex	False	The updated multiplex.

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:

DeleteMultiplex

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DescribeMultiplex

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateMultiplex

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3