# 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 PUT ``` { "multiplexSettings": { "maximumVideoBufferDelayMilliseconds": integer, "transportStreamBitrate": integer, "transportStreamId": integer, "transportStreamReservedBitrate": integer }, "name": "string" } ``` ### Response bodies #### UpdateMultiplexResultModel schema UpdateMultiplexResultModel ``` { "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 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": { } } ``` #### InvalidRequest schema InvalidRequest ``` { "message": "string" } ``` #### AccessDenied schema AccessDenied ``` { "message": "string" } ``` #### ResourceNotFound schema ResourceNotFound ``` { "message": "string" } ``` #### ResourceConflict schema ResourceConflict ``` { "message": "string" } ``` #### MultiplexConfigurationValidationError schema MultiplexConfigurationValidationError ``` { "message": "string", "validationErrors": [ { "elementPath": "string", "errorMessage": "string" } ] } ``` #### LimitExceeded schema LimitExceeded ``` { "message": "string" } ``` #### InternalServiceError schema InternalServiceError ``` { "message": "string" } ``` #### BadGatewayException schema BadGatewayException ``` { "message": "string" } ``` #### GatewayTimeoutException schema 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. | 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](#multiplexes-multiplexid-model-multiplexoutputdestination) | False | A list of the multiplex output destinations. | | id | string | False | The unique id of the multiplex. | | multiplexSettings | [MultiplexSettings](#multiplexes-multiplexid-model-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](#multiplexes-multiplexid-model-multiplexstate) | False | The current state of the multiplex. | | tags | [Tags](#multiplexes-multiplexid-model-tags) | False | A collection of key-value pairs. | ### MultiplexConfigurationValidationError | Property | Type | Required | Description | | --- |--- |--- |--- | | message | string | False | The error message. | | validationErrors | Array of type [ValidationError](#multiplexes-multiplexid-model-validationerror) | False | A collection of validation error responses. | ### MultiplexMediaConnectOutputDestinationSettings Multiplex MediaConnect output destination settings. | Property | Type | Required | Description | | --- |--- |--- |--- | | entitlementArn | stringMinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. | ### MultiplexOutputDestination Multiplex output destination settings | Property | Type | Required | Description | | --- |--- |--- |--- | | mediaConnectSettings | [MultiplexMediaConnectOutputDestinationSettings](#multiplexes-multiplexid-model-multiplexmediaconnectoutputdestinationsettings) | False | Multiplex MediaConnect output destination settings. | ### MultiplexSettings Contains configuration for a Multiplex event | Property | Type | Required | Description | | --- |--- |--- |--- | | maximumVideoBufferDelayMilliseconds | integerMinimum: 800Maximum: 3000 | False | Maximum video buffer delay in milliseconds. | | transportStreamBitrate | integerMinimum: 1000000Maximum: 100000000 | True | Transport stream bit rate. | | transportStreamId | integerMinimum: 0Maximum: 65535 | True | Transport stream ID. | | transportStreamReservedBitrate | integerMinimum: 0Maximum: 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](#multiplexes-multiplexid-model-multiplexsettings) | False | The new settings for a multiplex. | | name | string | False | Name of the multiplex. | ### UpdateMultiplexResultModel | Property | Type | Required | Description | | --- |--- |--- |--- | | multiplex | [Multiplex](#multiplexes-multiplexid-model-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 V2](/goto/cli2/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DeleteMultiplex) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DeleteMultiplex) ### DescribeMultiplex + [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DescribeMultiplex) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DescribeMultiplex) ### UpdateMultiplex + [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/UpdateMultiplex) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/UpdateMultiplex)