# Multiplex: describe program
<a name="multiplexes-multiplexid-programs-programname"></a>

## URI
<a name="multiplexes-multiplexid-programs-programname-url"></a>

`/prod/multiplexes/multiplexId/programs/programName`

## HTTP methods
<a name="multiplexes-multiplexid-programs-programname-http-methods"></a>

### DELETE
<a name="multiplexes-multiplexid-programs-programnamedelete"></a>

**Operation ID:** `DeleteMultiplexProgram`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | String | True |  | 
| programName | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | MultiplexProgram | 200 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
<a name="multiplexes-multiplexid-programs-programnameget"></a>

**Operation ID:** `DescribeMultiplexProgram`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | String | True |  | 
| programName | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | MultiplexProgram | 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
<a name="multiplexes-multiplexid-programs-programnameput"></a>

**Operation ID:** `UpdateMultiplexProgram`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | String | True |  | 
| programName | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateMultiplexProgramResultModel | 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
<a name="multiplexes-multiplexid-programs-programname-schemas"></a>

### Request bodies
<a name="multiplexes-multiplexid-programs-programname-request-examples"></a>

#### PUT schema
<a name="multiplexes-multiplexid-programs-programname-request-body-put-example"></a>

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

### Response bodies
<a name="multiplexes-multiplexid-programs-programname-response-examples"></a>

#### MultiplexProgram schema
<a name="multiplexes-multiplexid-programs-programname-response-body-multiplexprogram-example"></a>

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

#### UpdateMultiplexProgramResultModel schema
<a name="multiplexes-multiplexid-programs-programname-response-body-updatemultiplexprogramresultmodel-example"></a>

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

#### InvalidRequest schema
<a name="multiplexes-multiplexid-programs-programname-response-body-invalidrequest-example"></a>

```
{
  "message": "string"
}
```

#### AccessDenied schema
<a name="multiplexes-multiplexid-programs-programname-response-body-accessdenied-example"></a>

```
{
  "message": "string"
}
```

#### ResourceNotFound schema
<a name="multiplexes-multiplexid-programs-programname-response-body-resourcenotfound-example"></a>

```
{
  "message": "string"
}
```

#### ResourceConflict schema
<a name="multiplexes-multiplexid-programs-programname-response-body-resourceconflict-example"></a>

```
{
  "message": "string"
}
```

#### MultiplexConfigurationValidationError schema
<a name="multiplexes-multiplexid-programs-programname-response-body-multiplexconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="multiplexes-multiplexid-programs-programname-response-body-limitexceeded-example"></a>

```
{
  "message": "string"
}
```

#### InternalServiceError schema
<a name="multiplexes-multiplexid-programs-programname-response-body-internalserviceerror-example"></a>

```
{
  "message": "string"
}
```

#### BadGatewayException schema
<a name="multiplexes-multiplexid-programs-programname-response-body-badgatewayexception-example"></a>

```
{
  "message": "string"
}
```

#### GatewayTimeoutException schema
<a name="multiplexes-multiplexid-programs-programname-response-body-gatewaytimeoutexception-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="multiplexes-multiplexid-programs-programname-properties"></a>

### AccessDenied
<a name="multiplexes-multiplexid-programs-programname-model-accessdenied"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### BadGatewayException
<a name="multiplexes-multiplexid-programs-programname-model-badgatewayexception"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### GatewayTimeoutException
<a name="multiplexes-multiplexid-programs-programname-model-gatewaytimeoutexception"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### InternalServiceError
<a name="multiplexes-multiplexid-programs-programname-model-internalserviceerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### InvalidRequest
<a name="multiplexes-multiplexid-programs-programname-model-invalidrequest"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### LimitExceeded
<a name="multiplexes-multiplexid-programs-programname-model-limitexceeded"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### MultiplexConfigurationValidationError
<a name="multiplexes-multiplexid-programs-programname-model-multiplexconfigurationvalidationerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The error message. | 
| validationErrors | Array of type [ValidationError](#multiplexes-multiplexid-programs-programname-model-validationerror) | False | A collection of validation error responses. | 

### MultiplexProgram
<a name="multiplexes-multiplexid-programs-programname-model-multiplexprogram"></a>

The multiplex program object.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | string | False | The MediaLive channel associated with the program. | 
| multiplexProgramSettings | [MultiplexProgramSettings](#multiplexes-multiplexid-programs-programname-model-multiplexprogramsettings) | False | The settings for this multiplex program. | 
| packetIdentifiersMap | [MultiplexProgramPacketIdentifiersMap](#multiplexes-multiplexid-programs-programname-model-multiplexprogrampacketidentifiersmap) | False | The packet identifier map for this multiplex program. | 
| pipelineDetails | Array of type [MultiplexProgramPipelineDetail](#multiplexes-multiplexid-programs-programname-model-multiplexprogrampipelinedetail) | False | Contains information about the current sources for the specified program in the specified multiplex. Keep in mind that each multiplex pipeline connects to both pipelines in a given source channel (the channel identified by the program). But only one of those channel pipelines is ever active at one time. | 
| programName | string | False | The name of the multiplex program. | 

### MultiplexProgramPacketIdentifiersMap
<a name="multiplexes-multiplexid-programs-programname-model-multiplexprogrampacketidentifiersmap"></a>

Packet identifiers map for a given Multiplex program.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioPids | Array of type integer | False |  | 
| dvbSubPids | Array of type integer | False |  | 
| dvbTeletextPid | integer | False |  | 
| etvPlatformPid | integer | False |  | 
| etvSignalPid | integer | False |  | 
| klvDataPids | Array of type integer | False |  | 
| pcrPid | integer | False |  | 
| pmtPid | integer | False |  | 
| privateMetadataPid | integer | False |  | 
| scte27Pids | Array of type integer | False |  | 
| scte35Pid | integer | False |  | 
| timedMetadataPid | integer | False |  | 
| videoPid | integer | False |  | 

### MultiplexProgramPipelineDetail
<a name="multiplexes-multiplexid-programs-programname-model-multiplexprogrampipelinedetail"></a>

The current source for one of the pipelines in the multiplex.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeChannelPipeline | string | False | Identifies the channel pipeline that is currently active for the pipeline (identified by PipelineId) in the multiplex. | 
| pipelineId | string | False | Identifies a specific pipeline in the multiplex. | 

### MultiplexProgramServiceDescriptor
<a name="multiplexes-multiplexid-programs-programname-model-multiplexprogramservicedescriptor"></a>

Transport stream service descriptor configuration for the Multiplex program.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| providerName | stringMaxLength: 256 | True | Name of the provider. | 
| serviceName | stringMaxLength: 256 | True | Name of the service. | 

### MultiplexProgramSettings
<a name="multiplexes-multiplexid-programs-programname-model-multiplexprogramsettings"></a>

Multiplex Program settings configuration.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| preferredChannelPipeline | [PreferredChannelPipeline](#multiplexes-multiplexid-programs-programname-model-preferredchannelpipeline) | False | Indicates which pipeline is preferred by the multiplex for program ingest. | 
| programNumber | integerMinimum: 0Maximum: 65535 | True | Unique program number. | 
| serviceDescriptor | [MultiplexProgramServiceDescriptor](#multiplexes-multiplexid-programs-programname-model-multiplexprogramservicedescriptor) | False | Transport stream service descriptor configuration for the Multiplex program. | 
| videoSettings | [MultiplexVideoSettings](#multiplexes-multiplexid-programs-programname-model-multiplexvideosettings) | False | Program video settings configuration. | 

### MultiplexStatmuxVideoSettings
<a name="multiplexes-multiplexid-programs-programname-model-multiplexstatmuxvideosettings"></a>

Statmux rate control settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maximumBitrate | integerMinimum: 100000Maximum: 100000000 | False | Maximum statmux bitrate. | 
| minimumBitrate | integerMinimum: 100000Maximum: 100000000 | False | Minimum statmux bitrate. | 
| priority | integerMinimum: -5Maximum: 5 | False | The purpose of the priority is to use a combination of the\$1nmultiplex rate control algorithm and the QVBR capability of the\$1nencoder to prioritize the video quality of some channels in a\$1nmultiplex over others. Channels that have a higher priority will\$1nget higher video quality at the expense of the video quality of\$1nother channels in the multiplex with lower priority. | 

### MultiplexVideoSettings
<a name="multiplexes-multiplexid-programs-programname-model-multiplexvideosettings"></a>

The video configuration for each program in a multiplex.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| constantBitrate | integerMinimum: 100000Maximum: 100000000 | False | The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be undefined. | 
| statmuxSettings | [MultiplexStatmuxVideoSettings](#multiplexes-multiplexid-programs-programname-model-multiplexstatmuxvideosettings) | False | Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined. | 

### PreferredChannelPipeline
<a name="multiplexes-multiplexid-programs-programname-model-preferredchannelpipeline"></a>

Indicates which pipeline is preferred by the multiplex for program ingest. If set to \$1"PIPELINE\$10\$1" or \$1"PIPELINE\$11\$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 \$1"CURRENTLY\$1ACTIVE\$1", 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. 
+ `CURRENTLY_ACTIVE`
+ `PIPELINE_0`
+ `PIPELINE_1`

### ResourceConflict
<a name="multiplexes-multiplexid-programs-programname-model-resourceconflict"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### ResourceNotFound
<a name="multiplexes-multiplexid-programs-programname-model-resourcenotfound"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 

### UpdateMultiplexProgram
<a name="multiplexes-multiplexid-programs-programname-model-updatemultiplexprogram"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexProgramSettings | [MultiplexProgramSettings](#multiplexes-multiplexid-programs-programname-model-multiplexprogramsettings) | False | The new settings for a multiplex program. | 

### UpdateMultiplexProgramResultModel
<a name="multiplexes-multiplexid-programs-programname-model-updatemultiplexprogramresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexProgram | [MultiplexProgram](#multiplexes-multiplexid-programs-programname-model-multiplexprogram) | False | The updated multiplex program. | 

### ValidationError
<a name="multiplexes-multiplexid-programs-programname-model-validationerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| elementPath | string | False | Path to the source of the error. | 
| errorMessage | string | False | The error message. | 

## See also
<a name="multiplexes-multiplexid-programs-programname-see-also"></a>

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

### DeleteMultiplexProgram
<a name="DeleteMultiplexProgram-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DeleteMultiplexProgram)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DeleteMultiplexProgram)

### DescribeMultiplexProgram
<a name="DescribeMultiplexProgram-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DescribeMultiplexProgram)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DescribeMultiplexProgram)

### UpdateMultiplexProgram
<a name="UpdateMultiplexProgram-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/UpdateMultiplexProgram)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/UpdateMultiplexProgram)