# Resources
<a name="resources"></a>

The AWS Elemental MediaLive REST API includes the following resources.

**Topics**
+ [

# Batch action: delete
](batch-delete.md)
+ [

# Batch action: start
](batch-start.md)
+ [

# Batch action: stop
](batch-stop.md)
+ [

# Channels
](channels.md)
+ [

# Channels: channel ID
](channels-channelid.md)
+ [

# Channels: class
](channels-channelid-channelclass.md)
+ [

# Channels: schedule
](channels-channelid-schedule.md)
+ [

# Channels: start
](channels-channelid-start.md)
+ [

# Channels: stop
](channels-channelid-stop.md)
+ [

# Input devices
](inputdevices.md)
+ [

# Input devices: accept device transfer
](inputdevices-inputdeviceid-accept.md)
+ [

# Input devices: cancel device transfer
](inputdevices-inputdeviceid-cancel.md)
+ [

# Input devices: claim device
](claimdevice.md)
+ [

# Input devices: device ID
](inputdevices-inputdeviceid.md)
+ [

# Input devices: input device transfers
](inputdevicetransfers.md)
+ [

# Input devices: reboot
](inputdevices-inputdeviceid-reboot.md)
+ [

# Input devices: reject device transfer
](inputdevices-inputdeviceid-reject.md)
+ [

# Input devices: thumbnail data
](inputdevices-inputdeviceid-thumbnaildata.md)
+ [

# Input devices: transfer device
](inputdevices-inputdeviceid-transfer.md)
+ [

# Input devices: update
](inputdevices-inputdeviceid-startinputdevicemaintenancewindow.md)
+ [

# Input security groups
](inputsecuritygroups.md)
+ [

# Input security groups: group ID
](inputsecuritygroups-inputsecuritygroupid.md)
+ [

# Inputs
](inputs.md)
+ [

# Inputs: input ID
](inputs-inputid.md)
+ [

# Inputs: partners
](inputs-inputid-partners.md)
+ [

# Multiplex: describe program
](multiplexes-multiplexid-programs-programname.md)
+ [

# Multiplex: list programs
](multiplexes-multiplexid-programs.md)
+ [

# Multiplex: start
](multiplexes-multiplexid-start.md)
+ [

# Multiplex: stop
](multiplexes-multiplexid-stop.md)
+ [

# Multiplexes
](multiplexes.md)
+ [

# Multiplexes: multiplex ID
](multiplexes-multiplexid.md)
+ [

# Offerings: describe offering
](offerings-offeringid.md)
+ [

# Offerings: list offerings
](offerings.md)
+ [

# Offerings: purchase offering
](offerings-offeringid-purchase.md)
+ [

# Reservations: describe reservation
](reservations-reservationid.md)
+ [

# Reservations: list reservations
](reservations.md)
+ [

# Tags: list tags
](tags-resource-arn.md)
+ [

# Workflow monitor: CloudWatch alarm template groups
](cloudwatch-alarm-template-groups.md)
+ [

# Workflow monitor: CloudWatch alarm template groups ID
](cloudwatch-alarm-template-groups-identifier.md)
+ [

# Workflow monitor: CloudWatch alarm templates
](cloudwatch-alarm-templates.md)
+ [

# Workflow monitor: CloudWatch alarm templates ID
](cloudwatch-alarm-templates-identifier.md)
+ [

# Workflow monitor: EventBridge rule template groups
](eventbridge-rule-template-groups.md)
+ [

# Workflow monitor: EventBridge rule template groups ID
](eventbridge-rule-template-groups-identifier.md)
+ [

# Workflow monitor: EventBridge rule templates
](eventbridge-rule-templates.md)
+ [

# Workflow monitor: EventBridge rule templates ID
](eventbridge-rule-templates-identifier.md)
+ [

# Workflow monitor: Signal map monitor deployment
](signal-maps-identifier-monitor-deployment.md)
+ [

# Workflow monitor: Signal maps
](signal-maps.md)
+ [

# Workflow monitor: Signal maps ID
](signal-maps-identifier.md)

# Batch action: delete
<a name="batch-delete"></a>

## URI
<a name="batch-delete-url"></a>

`/prod/batch/delete`

## HTTP methods
<a name="batch-delete-http-methods"></a>

### POST
<a name="batch-deletepost"></a>

**Operation ID:** `BatchDelete`


**Responses**  

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

## Schemas
<a name="batch-delete-schemas"></a>

### Request bodies
<a name="batch-delete-request-examples"></a>

#### POST schema
<a name="batch-delete-request-body-post-example"></a>

```
{
  "channelIds": [
    "string"
  ],
  "inputIds": [
    "string"
  ],
  "inputSecurityGroupIds": [
    "string"
  ],
  "multiplexIds": [
    "string"
  ]
}
```

### Response bodies
<a name="batch-delete-response-examples"></a>

#### BatchDeleteResultModel schema
<a name="batch-delete-response-body-batchdeleteresultmodel-example"></a>

```
{
  "failed": [
    {
      "arn": "string",
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "successful": [
    {
      "arn": "string",
      "id": "string",
      "state": "string"
    }
  ]
}
```

#### InvalidRequest schema
<a name="batch-delete-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="batch-delete-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="batch-delete-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="batch-delete-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="batch-delete-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="batch-delete-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="batch-delete-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="batch-delete-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="batch-delete-properties"></a>

### AccessDenied
<a name="batch-delete-model-accessdenied"></a>


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

### BadGatewayException
<a name="batch-delete-model-badgatewayexception"></a>


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

### BatchDelete
<a name="batch-delete-model-batchdelete"></a>

Batch delete resource request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelIds | Array of type string | False | List of channel IDs | 
| inputIds | Array of type string | False | List of input IDs | 
| inputSecurityGroupIds | Array of type string | False | List of input security group IDs | 
| multiplexIds | Array of type string | False | List of multiplex IDs | 

### BatchDeleteResultModel
<a name="batch-delete-model-batchdeleteresultmodel"></a>

Batch delete resource results


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failed | Array of type [BatchFailedResultModel](#batch-delete-model-batchfailedresultmodel) | False | List of failed operations | 
| successful | Array of type [BatchSuccessfulResultModel](#batch-delete-model-batchsuccessfulresultmodel) | False | List of successful operations | 

### BatchFailedResultModel
<a name="batch-delete-model-batchfailedresultmodel"></a>

Details from a failed operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| code | string | False | Error code for the failed operation | 
| id | string | False | ID of the resource | 
| message | string | False | Error message for the failed operation | 

### BatchSuccessfulResultModel
<a name="batch-delete-model-batchsuccessfulresultmodel"></a>

Details from a successful operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| id | string | False | ID of the resource | 
| state | string | False | Current state of the resource | 

### GatewayTimeoutException
<a name="batch-delete-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="batch-delete-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="batch-delete-model-invalidrequest"></a>


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

### LimitExceeded
<a name="batch-delete-model-limitexceeded"></a>


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

### ResourceConflict
<a name="batch-delete-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="batch-delete-model-resourcenotfound"></a>


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

## See also
<a name="batch-delete-see-also"></a>

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

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

# Batch action: start
<a name="batch-start"></a>

## URI
<a name="batch-start-url"></a>

`/prod/batch/start`

## HTTP methods
<a name="batch-start-http-methods"></a>

### POST
<a name="batch-startpost"></a>

**Operation ID:** `BatchStart`


**Responses**  

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

## Schemas
<a name="batch-start-schemas"></a>

### Request bodies
<a name="batch-start-request-examples"></a>

#### POST schema
<a name="batch-start-request-body-post-example"></a>

```
{
  "channelIds": [
    "string"
  ],
  "multiplexIds": [
    "string"
  ]
}
```

### Response bodies
<a name="batch-start-response-examples"></a>

#### BatchStartResultModel schema
<a name="batch-start-response-body-batchstartresultmodel-example"></a>

```
{
  "failed": [
    {
      "arn": "string",
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "successful": [
    {
      "arn": "string",
      "id": "string",
      "state": "string"
    }
  ]
}
```

#### InvalidRequest schema
<a name="batch-start-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="batch-start-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="batch-start-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="batch-start-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="batch-start-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="batch-start-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="batch-start-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="batch-start-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="batch-start-properties"></a>

### AccessDenied
<a name="batch-start-model-accessdenied"></a>


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

### BadGatewayException
<a name="batch-start-model-badgatewayexception"></a>


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

### BatchFailedResultModel
<a name="batch-start-model-batchfailedresultmodel"></a>

Details from a failed operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| code | string | False | Error code for the failed operation | 
| id | string | False | ID of the resource | 
| message | string | False | Error message for the failed operation | 

### BatchStart
<a name="batch-start-model-batchstart"></a>

Batch start resource request


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelIds | Array of type string | False | List of channel IDs | 
| multiplexIds | Array of type string | False | List of multiplex IDs | 

### BatchStartResultModel
<a name="batch-start-model-batchstartresultmodel"></a>

Batch start resource results


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failed | Array of type [BatchFailedResultModel](#batch-start-model-batchfailedresultmodel) | False | List of failed operations | 
| successful | Array of type [BatchSuccessfulResultModel](#batch-start-model-batchsuccessfulresultmodel) | False | List of successful operations | 

### BatchSuccessfulResultModel
<a name="batch-start-model-batchsuccessfulresultmodel"></a>

Details from a successful operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| id | string | False | ID of the resource | 
| state | string | False | Current state of the resource | 

### GatewayTimeoutException
<a name="batch-start-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="batch-start-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="batch-start-model-invalidrequest"></a>


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

### LimitExceeded
<a name="batch-start-model-limitexceeded"></a>


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

### ResourceConflict
<a name="batch-start-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="batch-start-model-resourcenotfound"></a>


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

## See also
<a name="batch-start-see-also"></a>

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

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

# Batch action: stop
<a name="batch-stop"></a>

## URI
<a name="batch-stop-url"></a>

`/prod/batch/stop`

## HTTP methods
<a name="batch-stop-http-methods"></a>

### POST
<a name="batch-stoppost"></a>

**Operation ID:** `BatchStop`


**Responses**  

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

## Schemas
<a name="batch-stop-schemas"></a>

### Request bodies
<a name="batch-stop-request-examples"></a>

#### POST schema
<a name="batch-stop-request-body-post-example"></a>

```
{
  "channelIds": [
    "string"
  ],
  "multiplexIds": [
    "string"
  ]
}
```

### Response bodies
<a name="batch-stop-response-examples"></a>

#### BatchStopResultModel schema
<a name="batch-stop-response-body-batchstopresultmodel-example"></a>

```
{
  "failed": [
    {
      "arn": "string",
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "successful": [
    {
      "arn": "string",
      "id": "string",
      "state": "string"
    }
  ]
}
```

#### InvalidRequest schema
<a name="batch-stop-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="batch-stop-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="batch-stop-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="batch-stop-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="batch-stop-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="batch-stop-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="batch-stop-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="batch-stop-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="batch-stop-properties"></a>

### AccessDenied
<a name="batch-stop-model-accessdenied"></a>


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

### BadGatewayException
<a name="batch-stop-model-badgatewayexception"></a>


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

### BatchFailedResultModel
<a name="batch-stop-model-batchfailedresultmodel"></a>

Details from a failed operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| code | string | False | Error code for the failed operation | 
| id | string | False | ID of the resource | 
| message | string | False | Error message for the failed operation | 

### BatchStop
<a name="batch-stop-model-batchstop"></a>

Batch stop resource request


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelIds | Array of type string | False | List of channel IDs | 
| multiplexIds | Array of type string | False | List of multiplex IDs | 

### BatchStopResultModel
<a name="batch-stop-model-batchstopresultmodel"></a>

Batch stop resource results


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failed | Array of type [BatchFailedResultModel](#batch-stop-model-batchfailedresultmodel) | False | List of failed operations | 
| successful | Array of type [BatchSuccessfulResultModel](#batch-stop-model-batchsuccessfulresultmodel) | False | List of successful operations | 

### BatchSuccessfulResultModel
<a name="batch-stop-model-batchsuccessfulresultmodel"></a>

Details from a successful operation


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | ARN of the resource | 
| id | string | False | ID of the resource | 
| state | string | False | Current state of the resource | 

### GatewayTimeoutException
<a name="batch-stop-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="batch-stop-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="batch-stop-model-invalidrequest"></a>


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

### LimitExceeded
<a name="batch-stop-model-limitexceeded"></a>


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

### ResourceConflict
<a name="batch-stop-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="batch-stop-model-resourcenotfound"></a>


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

## See also
<a name="batch-stop-see-also"></a>

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

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

# Channels
<a name="channels"></a>

## URI
<a name="channels-url"></a>

`/prod/channels`

## HTTP methods
<a name="channels-http-methods"></a>

### GET
<a name="channelsget"></a>

**Operation ID:** `ListChannels`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| sortOrder | String | False |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 
| sortBy | String | False |  | 
| filterQuery | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListChannelsResultModel | 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
<a name="channelspost"></a>

**Operation ID:** `CreateChannel`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateChannelResultModel | 201 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ChannelConfigurationValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="channels-schemas"></a>

### Request bodies
<a name="channels-request-examples"></a>

#### POST schema
<a name="channels-request-body-post-example"></a>

```
{
  "cdiInputSpecification": {
    "resolution": enum
  },
  "channelClass": enum,
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ],
  "encoderSettings": {
    "audioDescriptions": [
      {
        "audioNormalizationSettings": {
          "algorithm": enum,
          "algorithmControl": enum,
          "targetLkfs": number
        },
        "audioSelectorName": "string",
        "audioType": enum,
        "audioTypeControl": enum,
        "audioWatermarkingSettings": {
          "nielsenWatermarksSettings": {
            "nielsenCbetSettings": {
              "cbetCheckDigitString": "string",
              "cbetStepaside": enum,
              "csid": "string"
            },
            "nielsenDistributionType": enum,
            "nielsenNaesIiNwSettings": {
              "checkDigitString": "string",
              "sid": number
            }
          }
        },
        "codecSettings": {
          "aacSettings": {
            "bitrate": number,
            "codingMode": enum,
            "inputType": enum,
            "profile": enum,
            "rateControlMode": enum,
            "rawFormat": enum,
            "sampleRate": number,
            "spec": enum,
            "vbrQuality": enum
          },
          "ac3Settings": {
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dialnorm": integer,
            "drcProfile": enum,
            "lfeFilter": enum,
            "metadataControl": enum
          },
          "eac3Settings": {
            "attenuationControl": enum,
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dcFilter": enum,
            "dialnorm": integer,
            "drcLine": enum,
            "drcRf": enum,
            "lfeControl": enum,
            "lfeFilter": enum,
            "loRoCenterMixLevel": number,
            "loRoSurroundMixLevel": number,
            "ltRtCenterMixLevel": number,
            "ltRtSurroundMixLevel": number,
            "metadataControl": enum,
            "passthroughControl": enum,
            "phaseControl": enum,
            "stereoDownmix": enum,
            "surroundExMode": enum,
            "surroundMode": enum
          },
          "mp2Settings": {
            "bitrate": number,
            "codingMode": enum,
            "sampleRate": number
          },
          "passThroughSettings": {
          },
          "wavSettings": {
            "bitDepth": number,
            "codingMode": enum,
            "sampleRate": number
          }
        },
        "languageCode": "string",
        "languageCodeControl": enum,
        "name": "string",
        "remixSettings": {
          "channelMappings": [
            {
              "inputChannelLevels": [
                {
                  "gain": integer,
                  "inputChannel": integer
                }
              ],
              "outputChannel": integer
            }
          ],
          "channelsIn": integer,
          "channelsOut": integer
        },
        "streamName": "string"
      }
    ],
    "availBlanking": {
      "availBlankingImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "state": enum
    },
    "availConfiguration": {
      "availSettings": {
        "scte35SpliceInsert": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        },
        "scte35TimeSignalApos": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        }
      }
    },
    "blackoutSlate": {
      "blackoutSlateImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkEndBlackout": enum,
      "networkEndBlackoutImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkId": "string",
      "state": enum
    },
    "captionDescriptions": [
      {
        "captionSelectorName": "string",
        "destinationSettings": {
          "aribDestinationSettings": {
          },
          "burnInDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "dvbSubDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "ebuTtDDestinationSettings": {
            "copyrightHolder": "string",
            "fillLineGap": enum,
            "fontFamily": "string",
            "styleControl": enum
          },
          "embeddedDestinationSettings": {
          },
          "embeddedPlusScte20DestinationSettings": {
          },
          "rtmpCaptionInfoDestinationSettings": {
          },
          "scte20PlusEmbeddedDestinationSettings": {
          },
          "scte27DestinationSettings": {
          },
          "smpteTtDestinationSettings": {
          },
          "teletextDestinationSettings": {
          },
          "ttmlDestinationSettings": {
            "styleControl": enum
          },
          "webvttDestinationSettings": {
            "styleControl": enum
          }
        },
        "languageCode": "string",
        "languageDescription": "string",
        "name": "string"
      }
    ],
    "featureActivations": {
      "inputPrepareScheduleActions": enum
    },
    "globalConfiguration": {
      "initialAudioGain": integer,
      "inputEndAction": enum,
      "inputLossBehavior": {
        "blackFrameMsec": integer,
        "inputLossImageColor": "string",
        "inputLossImageSlate": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "inputLossImageType": enum,
        "repeatFrameMsec": integer
      },
      "outputLockingMode": enum,
      "outputTimingSource": enum,
      "supportLowFramerateInputs": enum
    },
    "motionGraphicsConfiguration": {
      "motionGraphicsInsertion": enum,
      "motionGraphicsSettings": {
        "htmlMotionGraphicsSettings": {
        }
      }
    },
    "nielsenConfiguration": {
      "distributorId": "string",
      "nielsenPcmToId3Tagging": enum
    },
    "outputGroups": [
      {
        "name": "string",
        "outputGroupSettings": {
          "archiveGroupSettings": {
            "archiveCdnSettings": {
              "archiveS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            },
            "destination": {
              "destinationRefId": "string"
            },
            "rolloverInterval": integer
          },
          "frameCaptureGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            },
            "frameCaptureCdnSettings": {
              "frameCaptureS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            }
          },
          "hlsGroupSettings": {
            "adMarkers": [
              enum
            ],
            "baseUrlContent": "string",
            "baseUrlContent1": "string",
            "baseUrlManifest": "string",
            "baseUrlManifest1": "string",
            "captionLanguageMappings": [
              {
                "captionChannel": integer,
                "languageCode": "string",
                "languageDescription": "string"
              }
            ],
            "captionLanguageSetting": enum,
            "clientCache": enum,
            "codecSpecification": enum,
            "constantIv": "string",
            "destination": {
              "destinationRefId": "string"
            },
            "directoryStructure": enum,
            "discontinuityTags": enum,
            "encryptionType": enum,
            "hlsCdnSettings": {
              "hlsAkamaiSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer,
                "salt": "string",
                "token": "string"
              },
              "hlsBasicPutSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsMediaStoreSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "mediaStoreStorageClass": enum,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              },
              "hlsWebdavSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer
              }
            },
            "hlsId3SegmentTagging": enum,
            "iFrameOnlyPlaylists": enum,
            "incompleteSegmentBehavior": enum,
            "indexNSegments": integer,
            "inputLossAction": enum,
            "ivInManifest": enum,
            "ivSource": enum,
            "keepSegments": integer,
            "keyFormat": "string",
            "keyFormatVersions": "string",
            "keyProviderSettings": {
              "staticKeySettings": {
                "keyProviderServer": {
                  "passwordParam": "string",
                  "uri": "string",
                  "username": "string"
                },
                "staticKeyValue": "string"
              }
            },
            "manifestCompression": enum,
            "manifestDurationFormat": enum,
            "minSegmentLength": integer,
            "mode": enum,
            "outputSelection": enum,
            "programDateTime": enum,
            "programDateTimeClock": enum,
            "programDateTimePeriod": integer,
            "redundantManifest": enum,
            "segmentLength": integer,
            "segmentationMode": enum,
            "segmentsPerSubdirectory": integer,
            "streamInfResolution": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer,
            "timestampDeltaMilliseconds": integer,
            "tsFileMode": enum
          },
          "mediaPackageGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            }
          },
          "msSmoothGroupSettings": {
            "acquisitionPointId": "string",
            "audioOnlyTimecodeControl": enum,
            "certificateMode": enum,
            "connectionRetryInterval": integer,
            "destination": {
              "destinationRefId": "string"
            },
            "eventId": "string",
            "eventIdMode": enum,
            "eventStopBehavior": enum,
            "filecacheDuration": integer,
            "fragmentLength": integer,
            "inputLossAction": enum,
            "numRetries": integer,
            "restartDelay": integer,
            "segmentationMode": enum,
            "sendDelayMs": integer,
            "sparseTrackType": enum,
            "streamManifestBehavior": enum,
            "timestampOffset": "string",
            "timestampOffsetMode": enum
          },
          "multiplexGroupSettings": {
          },
          "rtmpGroupSettings": {
            "adMarkers": [
              enum
            ],
            "authenticationScheme": enum,
            "cacheFullBehavior": enum,
            "cacheLength": integer,
            "captionData": enum,
            "inputLossAction": enum,
            "restartDelay": integer
          },
          "udpGroupSettings": {
            "inputLossAction": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer
          }
        },
        "outputs": [
          {
            "audioDescriptionNames": [
              "string"
            ],
            "captionDescriptionNames": [
              "string"
            ],
            "outputName": "string",
            "outputSettings": {
              "archiveOutputSettings": {
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  },
                  "rawSettings": {
                  }
                },
                "extension": "string",
                "nameModifier": "string"
              },
              "frameCaptureOutputSettings": {
                "nameModifier": "string"
              },
              "hlsOutputSettings": {
                "h265PackagingType": enum,
                "hlsSettings": {
                  "audioOnlyHlsSettings": {
                    "audioGroupId": "string",
                    "audioOnlyImage": {
                      "passwordParam": "string",
                      "uri": "string",
                      "username": "string"
                    },
                    "audioTrackType": enum,
                    "segmentType": enum
                  },
                  "fmp4HlsSettings": {
                    "audioRenditionSets": "string",
                    "nielsenId3Behavior": enum,
                    "timedMetadataBehavior": enum
                  },
                  "frameCaptureHlsSettings": {
                  },
                  "standardHlsSettings": {
                    "audioRenditionSets": "string",
                    "m3u8Settings": {
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "ecmPid": "string",
                      "nielsenId3Behavior": enum,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "scte35Behavior": enum,
                      "scte35Pid": "string",
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  }
                },
                "nameModifier": "string",
                "segmentModifier": "string"
              },
              "mediaPackageOutputSettings": {
              },
              "msSmoothOutputSettings": {
                "h265PackagingType": enum,
                "nameModifier": "string"
              },
              "multiplexOutputSettings": {
                "destination": {
                  "destinationRefId": "string"
                }
              },
              "rtmpOutputSettings": {
                "certificateMode": enum,
                "connectionRetryInterval": integer,
                "destination": {
                  "destinationRefId": "string"
                },
                "numRetries": integer
              },
              "udpOutputSettings": {
                "bufferMsec": integer,
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  }
                },
                "destination": {
                  "destinationRefId": "string"
                },
                "fecOutputSettings": {
                  "columnDepth": integer,
                  "includeFec": enum,
                  "rowLength": integer
                }
              }
            },
            "videoDescriptionName": "string"
          }
        ]
      }
    ],
    "timecodeConfig": {
      "source": enum,
      "syncThreshold": integer
    },
    "videoDescriptions": [
      {
        "codecSettings": {
          "frameCaptureSettings": {
            "captureInterval": integer,
            "captureIntervalUnits": enum
          },
          "h264Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "bitrate": integer,
            "bufFillPct": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "entropyEncoding": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "forceFieldPictures": enum,
            "framerateControl": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopBReference": enum,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "numRefFrames": integer,
            "parControl": enum,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qualityLevel": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "softness": integer,
            "spatialAq": enum,
            "subgopLength": enum,
            "syntax": enum,
            "temporalAq": enum,
            "timecodeInsertion": enum
          },
          "h265Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "alternativeTransferFunction": enum,
            "bitrate": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "tier": enum,
            "timecodeInsertion": enum
          },
          "mpeg2Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "colorMetadata": enum,
            "colorSpace": enum,
            "displayAspectRatio": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "scanType": enum,
            "subgopLength": enum,
            "timecodeInsertion": enum
          }
        },
        "height": integer,
        "name": "string",
        "respondToAfd": enum,
        "scalingBehavior": enum,
        "sharpness": integer,
        "width": integer
      }
    ]
  },
  "inputAttachments": [
    {
      "automaticInputFailoverSettings": {
        "errorClearTimeMsec": integer,
        "failoverConditions": [
          {
            "failoverConditionSettings": {
              "audioSilenceSettings": {
                "audioSelectorName": "string",
                "audioSilenceThresholdMsec": integer
              },
              "inputLossSettings": {
                "inputLossThresholdMsec": integer
              },
              "videoBlackSettings": {
                "blackDetectThreshold": number,
                "videoBlackThresholdMsec": integer
              }
            }
          }
        ],
        "inputPreference": enum,
        "secondaryInputId": "string"
      },
      "inputAttachmentName": "string",
      "inputId": "string",
      "inputSettings": {
        "audioSelectors": [
          {
            "name": "string",
            "selectorSettings": {
              "audioHlsRenditionSelection": {
                "groupId": "string",
                "name": "string"
              },
              "audioLanguageSelection": {
                "languageCode": "string",
                "languageSelectionPolicy": enum
              },
              "audioPidSelection": {
                "pid": integer
              },
              "audioTrackSelection": {
                "tracks": [
                  {
                    "track": integer
                  }
                ]
              }
            }
          }
        ],
        "captionSelectors": [
          {
            "languageCode": "string",
            "name": "string",
            "selectorSettings": {
              "ancillarySourceSettings": {
                "sourceAncillaryChannelNumber": integer
              },
              "aribSourceSettings": {
              },
              "dvbSubSourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "embeddedSourceSettings": {
                "convert608To708": enum,
                "scte20Detection": enum,
                "source608ChannelNumber": integer,
                "source608TrackNumber": integer
              },
              "scte20SourceSettings": {
                "convert608To708": enum,
                "source608ChannelNumber": integer
              },
              "scte27SourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "teletextSourceSettings": {
                "outputRectangle": {
                  "height": number,
                  "leftOffset": number,
                  "topOffset": number,
                  "width": number
                },
                "pageNumber": "string"
              }
            }
          }
        ],
        "deblockFilter": enum,
        "denoiseFilter": enum,
        "filterStrength": integer,
        "inputFilter": enum,
        "networkInputSettings": {
          "hlsInputSettings": {
            "bandwidth": integer,
            "bufferSegments": integer,
            "retries": integer,
            "retryInterval": integer,
            "scte35Source": enum
          },
          "serverValidation": enum
        },
        "smpte2038DataPreference": enum,
        "sourceEndBehavior": enum,
        "videoSelector": {
          "colorSpace": enum,
          "colorSpaceSettings": {
            "hdr10Settings": {
              "maxCll": integer,
              "maxFall": integer
            }
          },
          "colorSpaceUsage": enum,
          "selectorSettings": {
            "videoSelectorPid": {
              "pid": integer
            },
            "videoSelectorProgramId": {
              "programId": integer
            }
          }
        }
      }
    }
  ],
  "inputSpecification": {
    "codec": enum,
    "maximumBitrate": enum,
    "resolution": enum
  },
  "logLevel": enum,
  "maintenance": {
    "maintenanceDay": enum,
    "maintenanceStartTime": "string"
  },
  "name": "string",
  "requestId": "string",
  "reserved": "string",
  "roleArn": "string",
  "tags": {
  },
  "vpc": {
    "publicAddressAllocationIds": [
      "string"
    ],
    "securityGroupIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ]
  }
}
```

### Response bodies
<a name="channels-response-examples"></a>

#### ListChannelsResultModel schema
<a name="channels-response-body-listchannelsresultmodel-example"></a>

```
{
  "channels": [
    {
      "arn": "string",
      "cdiInputSpecification": {
        "resolution": enum
      },
      "channelClass": enum,
      "destinations": [
        {
          "id": "string",
          "mediaPackageSettings": [
            {
              "channelId": "string"
            }
          ],
          "multiplexSettings": {
            "multiplexId": "string",
            "programName": "string"
          },
          "settings": [
            {
              "passwordParam": "string",
              "streamName": "string",
              "url": "string",
              "username": "string"
            }
          ]
        }
      ],
      "egressEndpoints": [
        {
          "sourceIp": "string"
        }
      ],
      "id": "string",
      "inputAttachments": [
        {
          "automaticInputFailoverSettings": {
            "errorClearTimeMsec": integer,
            "failoverConditions": [
              {
                "failoverConditionSettings": {
                  "audioSilenceSettings": {
                    "audioSelectorName": "string",
                    "audioSilenceThresholdMsec": integer
                  },
                  "inputLossSettings": {
                    "inputLossThresholdMsec": integer
                  },
                  "videoBlackSettings": {
                    "blackDetectThreshold": number,
                    "videoBlackThresholdMsec": integer
                  }
                }
              }
            ],
            "inputPreference": enum,
            "secondaryInputId": "string"
          },
          "inputAttachmentName": "string",
          "inputId": "string",
          "inputSettings": {
            "audioSelectors": [
              {
                "name": "string",
                "selectorSettings": {
                  "audioHlsRenditionSelection": {
                    "groupId": "string",
                    "name": "string"
                  },
                  "audioLanguageSelection": {
                    "languageCode": "string",
                    "languageSelectionPolicy": enum
                  },
                  "audioPidSelection": {
                    "pid": integer
                  },
                  "audioTrackSelection": {
                    "tracks": [
                      {
                        "track": integer
                      }
                    ]
                  }
                }
              }
            ],
            "captionSelectors": [
              {
                "languageCode": "string",
                "name": "string",
                "selectorSettings": {
                  "ancillarySourceSettings": {
                    "sourceAncillaryChannelNumber": integer
                  },
                  "aribSourceSettings": {
                  },
                  "dvbSubSourceSettings": {
                    "ocrLanguage": enum,
                    "pid": integer
                  },
                  "embeddedSourceSettings": {
                    "convert608To708": enum,
                    "scte20Detection": enum,
                    "source608ChannelNumber": integer,
                    "source608TrackNumber": integer
                  },
                  "scte20SourceSettings": {
                    "convert608To708": enum,
                    "source608ChannelNumber": integer
                  },
                  "scte27SourceSettings": {
                    "ocrLanguage": enum,
                    "pid": integer
                  },
                  "teletextSourceSettings": {
                    "outputRectangle": {
                      "height": number,
                      "leftOffset": number,
                      "topOffset": number,
                      "width": number
                    },
                    "pageNumber": "string"
                  }
                }
              }
            ],
            "deblockFilter": enum,
            "denoiseFilter": enum,
            "filterStrength": integer,
            "inputFilter": enum,
            "networkInputSettings": {
              "hlsInputSettings": {
                "bandwidth": integer,
                "bufferSegments": integer,
                "retries": integer,
                "retryInterval": integer,
                "scte35Source": enum
              },
              "serverValidation": enum
            },
            "smpte2038DataPreference": enum,
            "sourceEndBehavior": enum,
            "videoSelector": {
              "colorSpace": enum,
              "colorSpaceSettings": {
                "hdr10Settings": {
                  "maxCll": integer,
                  "maxFall": integer
                }
              },
              "colorSpaceUsage": enum,
              "selectorSettings": {
                "videoSelectorPid": {
                  "pid": integer
                },
                "videoSelectorProgramId": {
                  "programId": integer
                }
              }
            }
          }
        }
      ],
      "inputSpecification": {
        "codec": enum,
        "maximumBitrate": enum,
        "resolution": enum
      },
      "logLevel": enum,
      "maintenance": {
        "maintenanceDay": enum,
        "maintenanceDeadline": "string",
        "maintenanceScheduledDate": "string",
        "maintenanceStartTime": "string"
      },
      "name": "string",
      "pipelinesRunningCount": integer,
      "roleArn": "string",
      "state": enum,
      "tags": {
      },
      "vpc": {
        "availabilityZones": [
          "string"
        ],
        "networkInterfaceIds": [
          "string"
        ],
        "securityGroupIds": [
          "string"
        ],
        "subnetIds": [
          "string"
        ]
      }
    }
  ],
  "nextToken": "string"
}
```

#### CreateChannelResultModel schema
<a name="channels-response-body-createchannelresultmodel-example"></a>

```
{
  "channel": {
    "arn": "string",
    "cdiInputSpecification": {
      "resolution": enum
    },
    "channelClass": enum,
    "destinations": [
      {
        "id": "string",
        "mediaPackageSettings": [
          {
            "channelId": "string"
          }
        ],
        "multiplexSettings": {
          "multiplexId": "string",
          "programName": "string"
        },
        "settings": [
          {
            "passwordParam": "string",
            "streamName": "string",
            "url": "string",
            "username": "string"
          }
        ]
      }
    ],
    "egressEndpoints": [
      {
        "sourceIp": "string"
      }
    ],
    "encoderSettings": {
      "audioDescriptions": [
        {
          "audioNormalizationSettings": {
            "algorithm": enum,
            "algorithmControl": enum,
            "targetLkfs": number
          },
          "audioSelectorName": "string",
          "audioType": enum,
          "audioTypeControl": enum,
          "audioWatermarkingSettings": {
            "nielsenWatermarksSettings": {
              "nielsenCbetSettings": {
                "cbetCheckDigitString": "string",
                "cbetStepaside": enum,
                "csid": "string"
              },
              "nielsenDistributionType": enum,
              "nielsenNaesIiNwSettings": {
                "checkDigitString": "string",
                "sid": number
              }
            }
          },
          "codecSettings": {
            "aacSettings": {
              "bitrate": number,
              "codingMode": enum,
              "inputType": enum,
              "profile": enum,
              "rateControlMode": enum,
              "rawFormat": enum,
              "sampleRate": number,
              "spec": enum,
              "vbrQuality": enum
            },
            "ac3Settings": {
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dialnorm": integer,
              "drcProfile": enum,
              "lfeFilter": enum,
              "metadataControl": enum
            },
            "eac3Settings": {
              "attenuationControl": enum,
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dcFilter": enum,
              "dialnorm": integer,
              "drcLine": enum,
              "drcRf": enum,
              "lfeControl": enum,
              "lfeFilter": enum,
              "loRoCenterMixLevel": number,
              "loRoSurroundMixLevel": number,
              "ltRtCenterMixLevel": number,
              "ltRtSurroundMixLevel": number,
              "metadataControl": enum,
              "passthroughControl": enum,
              "phaseControl": enum,
              "stereoDownmix": enum,
              "surroundExMode": enum,
              "surroundMode": enum
            },
            "mp2Settings": {
              "bitrate": number,
              "codingMode": enum,
              "sampleRate": number
            },
            "passThroughSettings": {
            },
            "wavSettings": {
              "bitDepth": number,
              "codingMode": enum,
              "sampleRate": number
            }
          },
          "languageCode": "string",
          "languageCodeControl": enum,
          "name": "string",
          "remixSettings": {
            "channelMappings": [
              {
                "inputChannelLevels": [
                  {
                    "gain": integer,
                    "inputChannel": integer
                  }
                ],
                "outputChannel": integer
              }
            ],
            "channelsIn": integer,
            "channelsOut": integer
          },
          "streamName": "string"
        }
      ],
      "availBlanking": {
        "availBlankingImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "state": enum
      },
      "availConfiguration": {
        "availSettings": {
          "scte35SpliceInsert": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          },
          "scte35TimeSignalApos": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          }
        }
      },
      "blackoutSlate": {
        "blackoutSlateImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkEndBlackout": enum,
        "networkEndBlackoutImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkId": "string",
        "state": enum
      },
      "captionDescriptions": [
        {
          "captionSelectorName": "string",
          "destinationSettings": {
            "aribDestinationSettings": {
            },
            "burnInDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "dvbSubDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "ebuTtDDestinationSettings": {
              "copyrightHolder": "string",
              "fillLineGap": enum,
              "fontFamily": "string",
              "styleControl": enum
            },
            "embeddedDestinationSettings": {
            },
            "embeddedPlusScte20DestinationSettings": {
            },
            "rtmpCaptionInfoDestinationSettings": {
            },
            "scte20PlusEmbeddedDestinationSettings": {
            },
            "scte27DestinationSettings": {
            },
            "smpteTtDestinationSettings": {
            },
            "teletextDestinationSettings": {
            },
            "ttmlDestinationSettings": {
              "styleControl": enum
            },
            "webvttDestinationSettings": {
              "styleControl": enum
            }
          },
          "languageCode": "string",
          "languageDescription": "string",
          "name": "string"
        }
      ],
      "featureActivations": {
        "inputPrepareScheduleActions": enum
      },
      "globalConfiguration": {
        "initialAudioGain": integer,
        "inputEndAction": enum,
        "inputLossBehavior": {
          "blackFrameMsec": integer,
          "inputLossImageColor": "string",
          "inputLossImageSlate": {
            "passwordParam": "string",
            "uri": "string",
            "username": "string"
          },
          "inputLossImageType": enum,
          "repeatFrameMsec": integer
        },
        "outputLockingMode": enum,
        "outputTimingSource": enum,
        "supportLowFramerateInputs": enum
      },
      "motionGraphicsConfiguration": {
        "motionGraphicsInsertion": enum,
        "motionGraphicsSettings": {
          "htmlMotionGraphicsSettings": {
          }
        }
      },
      "nielsenConfiguration": {
        "distributorId": "string",
        "nielsenPcmToId3Tagging": enum
      },
      "outputGroups": [
        {
          "name": "string",
          "outputGroupSettings": {
            "archiveGroupSettings": {
              "archiveCdnSettings": {
                "archiveS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              },
              "destination": {
                "destinationRefId": "string"
              },
              "rolloverInterval": integer
            },
            "frameCaptureGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              },
              "frameCaptureCdnSettings": {
                "frameCaptureS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              }
            },
            "hlsGroupSettings": {
              "adMarkers": [
                enum
              ],
              "baseUrlContent": "string",
              "baseUrlContent1": "string",
              "baseUrlManifest": "string",
              "baseUrlManifest1": "string",
              "captionLanguageMappings": [
                {
                  "captionChannel": integer,
                  "languageCode": "string",
                  "languageDescription": "string"
                }
              ],
              "captionLanguageSetting": enum,
              "clientCache": enum,
              "codecSpecification": enum,
              "constantIv": "string",
              "destination": {
                "destinationRefId": "string"
              },
              "directoryStructure": enum,
              "discontinuityTags": enum,
              "encryptionType": enum,
              "hlsCdnSettings": {
                "hlsAkamaiSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer,
                  "salt": "string",
                  "token": "string"
                },
                "hlsBasicPutSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsMediaStoreSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "mediaStoreStorageClass": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                },
                "hlsWebdavSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                }
              },
              "hlsId3SegmentTagging": enum,
              "iFrameOnlyPlaylists": enum,
              "incompleteSegmentBehavior": enum,
              "indexNSegments": integer,
              "inputLossAction": enum,
              "ivInManifest": enum,
              "ivSource": enum,
              "keepSegments": integer,
              "keyFormat": "string",
              "keyFormatVersions": "string",
              "keyProviderSettings": {
                "staticKeySettings": {
                  "keyProviderServer": {
                    "passwordParam": "string",
                    "uri": "string",
                    "username": "string"
                  },
                  "staticKeyValue": "string"
                }
              },
              "manifestCompression": enum,
              "manifestDurationFormat": enum,
              "minSegmentLength": integer,
              "mode": enum,
              "outputSelection": enum,
              "programDateTime": enum,
              "programDateTimeClock": enum,
              "programDateTimePeriod": integer,
              "redundantManifest": enum,
              "segmentLength": integer,
              "segmentationMode": enum,
              "segmentsPerSubdirectory": integer,
              "streamInfResolution": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer,
              "timestampDeltaMilliseconds": integer,
              "tsFileMode": enum
            },
            "mediaPackageGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              }
            },
            "msSmoothGroupSettings": {
              "acquisitionPointId": "string",
              "audioOnlyTimecodeControl": enum,
              "certificateMode": enum,
              "connectionRetryInterval": integer,
              "destination": {
                "destinationRefId": "string"
              },
              "eventId": "string",
              "eventIdMode": enum,
              "eventStopBehavior": enum,
              "filecacheDuration": integer,
              "fragmentLength": integer,
              "inputLossAction": enum,
              "numRetries": integer,
              "restartDelay": integer,
              "segmentationMode": enum,
              "sendDelayMs": integer,
              "sparseTrackType": enum,
              "streamManifestBehavior": enum,
              "timestampOffset": "string",
              "timestampOffsetMode": enum
            },
            "multiplexGroupSettings": {
            },
            "rtmpGroupSettings": {
              "adMarkers": [
                enum
              ],
              "authenticationScheme": enum,
              "cacheFullBehavior": enum,
              "cacheLength": integer,
              "captionData": enum,
              "inputLossAction": enum,
              "restartDelay": integer
            },
            "udpGroupSettings": {
              "inputLossAction": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer
            }
          },
          "outputs": [
            {
              "audioDescriptionNames": [
                "string"
              ],
              "captionDescriptionNames": [
                "string"
              ],
              "outputName": "string",
              "outputSettings": {
                "archiveOutputSettings": {
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    },
                    "rawSettings": {
                    }
                  },
                  "extension": "string",
                  "nameModifier": "string"
                },
                "frameCaptureOutputSettings": {
                  "nameModifier": "string"
                },
                "hlsOutputSettings": {
                  "h265PackagingType": enum,
                  "hlsSettings": {
                    "audioOnlyHlsSettings": {
                      "audioGroupId": "string",
                      "audioOnlyImage": {
                        "passwordParam": "string",
                        "uri": "string",
                        "username": "string"
                      },
                      "audioTrackType": enum,
                      "segmentType": enum
                    },
                    "fmp4HlsSettings": {
                      "audioRenditionSets": "string",
                      "nielsenId3Behavior": enum,
                      "timedMetadataBehavior": enum
                    },
                    "frameCaptureHlsSettings": {
                    },
                    "standardHlsSettings": {
                      "audioRenditionSets": "string",
                      "m3u8Settings": {
                        "audioFramesPerPes": integer,
                        "audioPids": "string",
                        "ecmPid": "string",
                        "nielsenId3Behavior": enum,
                        "patInterval": integer,
                        "pcrControl": enum,
                        "pcrPeriod": integer,
                        "pcrPid": "string",
                        "pmtInterval": integer,
                        "pmtPid": "string",
                        "programNum": integer,
                        "scte35Behavior": enum,
                        "scte35Pid": "string",
                        "timedMetadataBehavior": enum,
                        "timedMetadataPid": "string",
                        "transportStreamId": integer,
                        "videoPid": "string"
                      }
                    }
                  },
                  "nameModifier": "string",
                  "segmentModifier": "string"
                },
                "mediaPackageOutputSettings": {
                },
                "msSmoothOutputSettings": {
                  "h265PackagingType": enum,
                  "nameModifier": "string"
                },
                "multiplexOutputSettings": {
                  "destination": {
                    "destinationRefId": "string"
                  }
                },
                "rtmpOutputSettings": {
                  "certificateMode": enum,
                  "connectionRetryInterval": integer,
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "numRetries": integer
                },
                "udpOutputSettings": {
                  "bufferMsec": integer,
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  },
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "fecOutputSettings": {
                    "columnDepth": integer,
                    "includeFec": enum,
                    "rowLength": integer
                  }
                }
              },
              "videoDescriptionName": "string"
            }
          ]
        }
      ],
      "timecodeConfig": {
        "source": enum,
        "syncThreshold": integer
      },
      "videoDescriptions": [
        {
          "codecSettings": {
            "frameCaptureSettings": {
              "captureInterval": integer,
              "captureIntervalUnits": enum
            },
            "h264Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "bitrate": integer,
              "bufFillPct": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "entropyEncoding": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "forceFieldPictures": enum,
              "framerateControl": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopBReference": enum,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "numRefFrames": integer,
              "parControl": enum,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qualityLevel": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "softness": integer,
              "spatialAq": enum,
              "subgopLength": enum,
              "syntax": enum,
              "temporalAq": enum,
              "timecodeInsertion": enum
            },
            "h265Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "alternativeTransferFunction": enum,
              "bitrate": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "hdr10Settings": {
                  "maxCll": integer,
                  "maxFall": integer
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "tier": enum,
              "timecodeInsertion": enum
            },
            "mpeg2Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "colorMetadata": enum,
              "colorSpace": enum,
              "displayAspectRatio": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "scanType": enum,
              "subgopLength": enum,
              "timecodeInsertion": enum
            }
          },
          "height": integer,
          "name": "string",
          "respondToAfd": enum,
          "scalingBehavior": enum,
          "sharpness": integer,
          "width": integer
        }
      ]
    },
    "id": "string",
    "inputAttachments": [
      {
        "automaticInputFailoverSettings": {
          "errorClearTimeMsec": integer,
          "failoverConditions": [
            {
              "failoverConditionSettings": {
                "audioSilenceSettings": {
                  "audioSelectorName": "string",
                  "audioSilenceThresholdMsec": integer
                },
                "inputLossSettings": {
                  "inputLossThresholdMsec": integer
                },
                "videoBlackSettings": {
                  "blackDetectThreshold": number,
                  "videoBlackThresholdMsec": integer
                }
              }
            }
          ],
          "inputPreference": enum,
          "secondaryInputId": "string"
        },
        "inputAttachmentName": "string",
        "inputId": "string",
        "inputSettings": {
          "audioSelectors": [
            {
              "name": "string",
              "selectorSettings": {
                "audioHlsRenditionSelection": {
                  "groupId": "string",
                  "name": "string"
                },
                "audioLanguageSelection": {
                  "languageCode": "string",
                  "languageSelectionPolicy": enum
                },
                "audioPidSelection": {
                  "pid": integer
                },
                "audioTrackSelection": {
                  "tracks": [
                    {
                      "track": integer
                    }
                  ]
                }
              }
            }
          ],
          "captionSelectors": [
            {
              "languageCode": "string",
              "name": "string",
              "selectorSettings": {
                "ancillarySourceSettings": {
                  "sourceAncillaryChannelNumber": integer
                },
                "aribSourceSettings": {
                },
                "dvbSubSourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "embeddedSourceSettings": {
                  "convert608To708": enum,
                  "scte20Detection": enum,
                  "source608ChannelNumber": integer,
                  "source608TrackNumber": integer
                },
                "scte20SourceSettings": {
                  "convert608To708": enum,
                  "source608ChannelNumber": integer
                },
                "scte27SourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "teletextSourceSettings": {
                  "outputRectangle": {
                    "height": number,
                    "leftOffset": number,
                    "topOffset": number,
                    "width": number
                  },
                  "pageNumber": "string"
                }
              }
            }
          ],
          "deblockFilter": enum,
          "denoiseFilter": enum,
          "filterStrength": integer,
          "inputFilter": enum,
          "networkInputSettings": {
            "hlsInputSettings": {
              "bandwidth": integer,
              "bufferSegments": integer,
              "retries": integer,
              "retryInterval": integer,
              "scte35Source": enum
            },
            "serverValidation": enum
          },
          "smpte2038DataPreference": enum,
          "sourceEndBehavior": enum,
          "videoSelector": {
            "colorSpace": enum,
            "colorSpaceSettings": {
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              }
            },
            "colorSpaceUsage": enum,
            "selectorSettings": {
              "videoSelectorPid": {
                "pid": integer
              },
              "videoSelectorProgramId": {
                "programId": integer
              }
            }
          }
        }
      }
    ],
    "inputSpecification": {
      "codec": enum,
      "maximumBitrate": enum,
      "resolution": enum
    },
    "logLevel": enum,
    "maintenance": {
      "maintenanceDay": enum,
      "maintenanceDeadline": "string",
      "maintenanceScheduledDate": "string",
      "maintenanceStartTime": "string"
    },
    "name": "string",
    "pipelineDetails": [
      {
        "activeInputAttachmentName": "string",
        "activeInputSwitchActionName": "string",
        "activeMotionGraphicsActionName": "string",
        "activeMotionGraphicsUri": "string",
        "pipelineId": "string"
      }
    ],
    "pipelinesRunningCount": integer,
    "roleArn": "string",
    "state": enum,
    "tags": {
    },
    "vpc": {
      "availabilityZones": [
        "string"
      ],
      "networkInterfaceIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ],
      "subnetIds": [
        "string"
      ]
    }
  }
}
```

#### InvalidRequest schema
<a name="channels-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-response-body-accessdenied-example"></a>

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

#### ResourceConflict schema
<a name="channels-response-body-resourceconflict-example"></a>

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

#### ChannelConfigurationValidationError schema
<a name="channels-response-body-channelconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="channels-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-properties"></a>

### AacCodingMode
<a name="channels-model-aaccodingmode"></a>

Aac Coding Mode
+ `AD_RECEIVER_MIX`
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_5_1`

### AacInputType
<a name="channels-model-aacinputtype"></a>

Aac Input Type
+ `BROADCASTER_MIXED_AD`
+ `NORMAL`

### AacProfile
<a name="channels-model-aacprofile"></a>

Aac Profile
+ `HEV1`
+ `HEV2`
+ `LC`

### AacRateControlMode
<a name="channels-model-aacratecontrolmode"></a>

Aac Rate Control Mode
+ `CBR`
+ `VBR`

### AacRawFormat
<a name="channels-model-aacrawformat"></a>

Aac Raw Format
+ `LATM_LOAS`
+ `NONE`

### AacSettings
<a name="channels-model-aacsettings"></a>

Aac Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. | 
| codingMode | [AacCodingMode](#channels-model-aaccodingmode) | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. | 
| inputType | [AacInputType](#channels-model-aacinputtype) | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio \$1 AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio \$1 AD. | 
| profile | [AacProfile](#channels-model-aacprofile) | False | AAC Profile. | 
| rateControlMode | [AacRateControlMode](#channels-model-aacratecontrolmode) | False | Rate Control Mode. | 
| rawFormat | [AacRawFormat](#channels-model-aacrawformat) | False | Sets LATM / LOAS AAC output for raw containers. | 
| sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. | 
| spec | [AacSpec](#channels-model-aacspec) | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | 
| vbrQuality | [AacVbrQuality](#channels-model-aacvbrquality) | False | VBR Quality Level - Only used if rateControlMode is VBR. | 

### AacSpec
<a name="channels-model-aacspec"></a>

Aac Spec
+ `MPEG2`
+ `MPEG4`

### AacVbrQuality
<a name="channels-model-aacvbrquality"></a>

Aac Vbr Quality
+ `HIGH`
+ `LOW`
+ `MEDIUM_HIGH`
+ `MEDIUM_LOW`

### Ac3BitstreamMode
<a name="channels-model-ac3bitstreammode"></a>

Ac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `DIALOGUE`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `MUSIC_AND_EFFECTS`
+ `VISUALLY_IMPAIRED`
+ `VOICE_OVER`

### Ac3CodingMode
<a name="channels-model-ac3codingmode"></a>

Ac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2_LFE`

### Ac3DrcProfile
<a name="channels-model-ac3drcprofile"></a>

Ac3 Drc Profile
+ `FILM_STANDARD`
+ `NONE`

### Ac3LfeFilter
<a name="channels-model-ac3lfefilter"></a>

Ac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Ac3MetadataControl
<a name="channels-model-ac3metadatacontrol"></a>

Ac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Ac3Settings
<a name="channels-model-ac3settings"></a>

Ac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Ac3BitstreamMode](#channels-model-ac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | 
| codingMode | [Ac3CodingMode](#channels-model-ac3codingmode) | False | Dolby Digital coding mode. Determines number of channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. | 
| drcProfile | [Ac3DrcProfile](#channels-model-ac3drcprofile) | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | 
| lfeFilter | [Ac3LfeFilter](#channels-model-ac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | 
| metadataControl | [Ac3MetadataControl](#channels-model-ac3metadatacontrol) | False | When set to "followInput", encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 

### AccessDenied
<a name="channels-model-accessdenied"></a>


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

### AfdSignaling
<a name="channels-model-afdsignaling"></a>

Afd Signaling
+ `AUTO`
+ `FIXED`
+ `NONE`

### AncillarySourceSettings
<a name="channels-model-ancillarysourcesettings"></a>

Ancillary Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceAncillaryChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. | 

### ArchiveCdnSettings
<a name="channels-model-archivecdnsettings"></a>

Archive Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveS3Settings | [ArchiveS3Settings](#channels-model-archives3settings) | False |  | 

### ArchiveContainerSettings
<a name="channels-model-archivecontainersettings"></a>

Archive Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-model-m2tssettings) | False |  | 
| rawSettings | [RawSettings](#channels-model-rawsettings) | False |  | 

### ArchiveGroupSettings
<a name="channels-model-archivegroupsettings"></a>

Archive Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveCdnSettings | [ArchiveCdnSettings](#channels-model-archivecdnsettings) | False | Parameters that control interactions with the CDN. | 
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | A directory and base filename where archive files should be written. | 
| rolloverInterval | integerMinimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. | 

### ArchiveOutputSettings
<a name="channels-model-archiveoutputsettings"></a>

Archive Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| containerSettings | [ArchiveContainerSettings](#channels-model-archivecontainersettings) | True | Settings specific to the container type of the file. | 
| extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### ArchiveS3LogUploads
<a name="channels-model-archives3loguploads"></a>

Archive S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### ArchiveS3Settings
<a name="channels-model-archives3settings"></a>

Archive S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [ArchiveS3LogUploads](#channels-model-archives3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### AribDestinationSettings
<a name="channels-model-aribdestinationsettings"></a>

Arib Destination Settings

### AribSourceSettings
<a name="channels-model-aribsourcesettings"></a>

Arib Source Settings

### AudioChannelMapping
<a name="channels-model-audiochannelmapping"></a>

Audio Channel Mapping


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputChannelLevels | Array of type [InputChannelLevel](#channels-model-inputchannellevel) | True | Indices and gain values for each input channel that should be remixed into this output channel. | 
| outputChannel | integerMinimum: 0Maximum: 7 | True | The index of the output channel being produced. | 

### AudioCodecSettings
<a name="channels-model-audiocodecsettings"></a>

Audio Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aacSettings | [AacSettings](#channels-model-aacsettings) | False |  | 
| ac3Settings | [Ac3Settings](#channels-model-ac3settings) | False |  | 
| eac3Settings | [Eac3Settings](#channels-model-eac3settings) | False |  | 
| mp2Settings | [Mp2Settings](#channels-model-mp2settings) | False |  | 
| passThroughSettings | [PassThroughSettings](#channels-model-passthroughsettings) | False |  | 
| wavSettings | [WavSettings](#channels-model-wavsettings) | False |  | 

### AudioDescription
<a name="channels-model-audiodescription"></a>

Audio Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioNormalizationSettings | [AudioNormalizationSettings](#channels-model-audionormalizationsettings) | False | Advanced audio normalization settings. | 
| audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. | 
| audioType | [AudioType](#channels-model-audiotype) | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | 
| audioTypeControl | [AudioDescriptionAudioTypeControl](#channels-model-audiodescriptionaudiotypecontrol) | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | 
| audioWatermarkingSettings | [AudioWatermarkSettings](#channels-model-audiowatermarksettings) | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | 
| codecSettings | [AudioCodecSettings](#channels-model-audiocodecsettings) | False | Audio codec settings. | 
| languageCode | stringMinLength: 1MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. | 
| languageCodeControl | [AudioDescriptionLanguageCodeControl](#channels-model-audiodescriptionlanguagecodecontrol) | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | 
| name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. | 
| remixSettings | [RemixSettings](#channels-model-remixsettings) | False | Settings that control how input audio channels are remixed into the output audio channels. | 
| streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). | 

### AudioDescriptionAudioTypeControl
<a name="channels-model-audiodescriptionaudiotypecontrol"></a>

Audio Description Audio Type Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioDescriptionLanguageCodeControl
<a name="channels-model-audiodescriptionlanguagecodecontrol"></a>

Audio Description Language Code Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioHlsRenditionSelection
<a name="channels-model-audiohlsrenditionselection"></a>

Audio Hls Rendition Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| groupId | stringMinLength: 1 | True | Specifies the GROUP-ID in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 
| name | stringMinLength: 1 | True | Specifies the NAME in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 

### AudioLanguageSelection
<a name="channels-model-audiolanguageselection"></a>

Audio Language Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | True | Selects a specific three-letter language code from within an audio source. | 
| languageSelectionPolicy | [AudioLanguageSelectionPolicy](#channels-model-audiolanguageselectionpolicy) | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. | 

### AudioLanguageSelectionPolicy
<a name="channels-model-audiolanguageselectionpolicy"></a>

Audio Language Selection Policy
+ `LOOSE`
+ `STRICT`

### AudioNormalizationAlgorithm
<a name="channels-model-audionormalizationalgorithm"></a>

Audio Normalization Algorithm
+ `ITU_1770_1`
+ `ITU_1770_2`

### AudioNormalizationAlgorithmControl
<a name="channels-model-audionormalizationalgorithmcontrol"></a>

Audio Normalization Algorithm Control
+ `CORRECT_AUDIO`

### AudioNormalizationSettings
<a name="channels-model-audionormalizationsettings"></a>

Audio Normalization Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| algorithm | [AudioNormalizationAlgorithm](#channels-model-audionormalizationalgorithm) | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | 
| algorithmControl | [AudioNormalizationAlgorithmControl](#channels-model-audionormalizationalgorithmcontrol) | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | 
| targetLkfs | numberMinimum: -59Maximum: 0 | False | Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. | 

### AudioOnlyHlsSegmentType
<a name="channels-model-audioonlyhlssegmenttype"></a>

Audio Only Hls Segment Type
+ `AAC`
+ `FMP4`

### AudioOnlyHlsSettings
<a name="channels-model-audioonlyhlssettings"></a>

Audio Only Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. | 
| audioOnlyImage | [InputLocation](#channels-model-inputlocation) | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | 
| audioTrackType | [AudioOnlyHlsTrackType](#channels-model-audioonlyhlstracktype) | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | 
| segmentType | [AudioOnlyHlsSegmentType](#channels-model-audioonlyhlssegmenttype) | False | Specifies the segment type. | 

### AudioOnlyHlsTrackType
<a name="channels-model-audioonlyhlstracktype"></a>

Audio Only Hls Track Type
+ `ALTERNATE_AUDIO_AUTO_SELECT`
+ `ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT`
+ `ALTERNATE_AUDIO_NOT_AUTO_SELECT`
+ `AUDIO_ONLY_VARIANT_STREAM`

### AudioPidSelection
<a name="channels-model-audiopidselection"></a>

Audio Pid Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | True | Selects a specific PID from within a source. | 

### AudioSelector
<a name="channels-model-audioselector"></a>

Audio Selector


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. | 
| selectorSettings | [AudioSelectorSettings](#channels-model-audioselectorsettings) | False | The audio selector settings. | 

### AudioSelectorSettings
<a name="channels-model-audioselectorsettings"></a>

Audio Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioHlsRenditionSelection | [AudioHlsRenditionSelection](#channels-model-audiohlsrenditionselection) | False |  | 
| audioLanguageSelection | [AudioLanguageSelection](#channels-model-audiolanguageselection) | False |  | 
| audioPidSelection | [AudioPidSelection](#channels-model-audiopidselection) | False |  | 
| audioTrackSelection | [AudioTrackSelection](#channels-model-audiotrackselection) | False |  | 

### AudioSilenceFailoverSettings
<a name="channels-model-audiosilencefailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. | 
| audioSilenceThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. | 

### AudioTrack
<a name="channels-model-audiotrack"></a>

Audio Track


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| track | integerMinimum: 1 | True | 1-based integer value that maps to a specific audio track | 

### AudioTrackSelection
<a name="channels-model-audiotrackselection"></a>

Audio Track Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tracks | Array of type [AudioTrack](#channels-model-audiotrack) | True | Selects one or more unique audio tracks from within a source. | 

### AudioType
<a name="channels-model-audiotype"></a>

Audio Type
+ `CLEAN_EFFECTS`
+ `HEARING_IMPAIRED`
+ `UNDEFINED`
+ `VISUAL_IMPAIRED_COMMENTARY`

### AudioWatermarkSettings
<a name="channels-model-audiowatermarksettings"></a>

Audio Watermark Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenWatermarksSettings | [NielsenWatermarksSettings](#channels-model-nielsenwatermarkssettings) | False | Settings to configure Nielsen Watermarks in the audio encode | 

### AuthenticationScheme
<a name="channels-model-authenticationscheme"></a>

Authentication Scheme
+ `AKAMAI`
+ `COMMON`

### AutomaticInputFailoverSettings
<a name="channels-model-automaticinputfailoversettings"></a>

The settings for Automatic Input Failover.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| errorClearTimeMsec | integerMinimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input\$1preference for the failover pair is set to PRIMARY\$1INPUT\$1PREFERRED, because after this time, MediaLive will switch back to the primary input. | 
| failoverConditions | Array of type [FailoverCondition](#channels-model-failovercondition) | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. | 
| inputPreference | [InputPreference](#channels-model-inputpreference) | False | Input preference when deciding which input to make active when a previously failed input has recovered. | 
| secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. | 

### AvailBlanking
<a name="channels-model-availblanking"></a>

Avail Blanking


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availBlankingImage | [InputLocation](#channels-model-inputlocation) | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| state | [AvailBlankingState](#channels-model-availblankingstate) | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. | 

### AvailBlankingState
<a name="channels-model-availblankingstate"></a>

Avail Blanking State
+ `DISABLED`
+ `ENABLED`

### AvailConfiguration
<a name="channels-model-availconfiguration"></a>

Avail Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availSettings | [AvailSettings](#channels-model-availsettings) | False | Ad avail settings. | 

### AvailSettings
<a name="channels-model-availsettings"></a>

Avail Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35SpliceInsert | [Scte35SpliceInsert](#channels-model-scte35spliceinsert) | False |  | 
| scte35TimeSignalApos | [Scte35TimeSignalApos](#channels-model-scte35timesignalapos) | False |  | 

### BadGatewayException
<a name="channels-model-badgatewayexception"></a>


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

### BlackoutSlate
<a name="channels-model-blackoutslate"></a>

Blackout Slate


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackoutSlateImage | [InputLocation](#channels-model-inputlocation) | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| networkEndBlackout | [BlackoutSlateNetworkEndBlackout](#channels-model-blackoutslatenetworkendblackout) | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | 
| networkEndBlackoutImage | [InputLocation](#channels-model-inputlocation) | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | 
| networkId | stringMinLength: 34MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). | 
| state | [BlackoutSlateState](#channels-model-blackoutslatestate) | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. | 

### BlackoutSlateNetworkEndBlackout
<a name="channels-model-blackoutslatenetworkendblackout"></a>

Blackout Slate Network End Blackout
+ `DISABLED`
+ `ENABLED`

### BlackoutSlateState
<a name="channels-model-blackoutslatestate"></a>

Blackout Slate State
+ `DISABLED`
+ `ENABLED`

### BurnInAlignment
<a name="channels-model-burninalignment"></a>

Burn In Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### BurnInBackgroundColor
<a name="channels-model-burninbackgroundcolor"></a>

Burn In Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInDestinationSettings
<a name="channels-model-burnindestinationsettings"></a>

Burn In Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [BurnInAlignment](#channels-model-burninalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [BurnInBackgroundColor](#channels-model-burninbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [BurnInFontColor](#channels-model-burninfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [BurnInOutlineColor](#channels-model-burninoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [BurnInShadowColor](#channels-model-burninshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [BurnInTeletextGridControl](#channels-model-burninteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. | 

### BurnInFontColor
<a name="channels-model-burninfontcolor"></a>

Burn In Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInOutlineColor
<a name="channels-model-burninoutlinecolor"></a>

Burn In Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInShadowColor
<a name="channels-model-burninshadowcolor"></a>

Burn In Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInTeletextGridControl
<a name="channels-model-burninteletextgridcontrol"></a>

Burn In Teletext Grid Control
+ `FIXED`
+ `SCALED`

### CaptionDescription
<a name="channels-model-captiondescription"></a>

Caption Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. | 
| destinationSettings | [CaptionDestinationSettings](#channels-model-captiondestinationsettings) | False | Additional settings for captions destination that depend on the destination type. | 
| languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | 
| languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). | 
| name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. | 

### CaptionDestinationSettings
<a name="channels-model-captiondestinationsettings"></a>

Caption Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aribDestinationSettings | [AribDestinationSettings](#channels-model-aribdestinationsettings) | False |  | 
| burnInDestinationSettings | [BurnInDestinationSettings](#channels-model-burnindestinationsettings) | False |  | 
| dvbSubDestinationSettings | [DvbSubDestinationSettings](#channels-model-dvbsubdestinationsettings) | False |  | 
| ebuTtDDestinationSettings | [EbuTtDDestinationSettings](#channels-model-ebuttddestinationsettings) | False |  | 
| embeddedDestinationSettings | [EmbeddedDestinationSettings](#channels-model-embeddeddestinationsettings) | False |  | 
| embeddedPlusScte20DestinationSettings | [EmbeddedPlusScte20DestinationSettings](#channels-model-embeddedplusscte20destinationsettings) | False |  | 
| rtmpCaptionInfoDestinationSettings | [RtmpCaptionInfoDestinationSettings](#channels-model-rtmpcaptioninfodestinationsettings) | False |  | 
| scte20PlusEmbeddedDestinationSettings | [Scte20PlusEmbeddedDestinationSettings](#channels-model-scte20plusembeddeddestinationsettings) | False |  | 
| scte27DestinationSettings | [Scte27DestinationSettings](#channels-model-scte27destinationsettings) | False |  | 
| smpteTtDestinationSettings | [SmpteTtDestinationSettings](#channels-model-smptettdestinationsettings) | False |  | 
| teletextDestinationSettings | [TeletextDestinationSettings](#channels-model-teletextdestinationsettings) | False |  | 
| ttmlDestinationSettings | [TtmlDestinationSettings](#channels-model-ttmldestinationsettings) | False |  | 
| webvttDestinationSettings | [WebvttDestinationSettings](#channels-model-webvttdestinationsettings) | False |  | 

### CaptionLanguageMapping
<a name="channels-model-captionlanguagemapping"></a>

Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionChannel | integerMinimum: 1Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) | 
| languageCode | stringMinLength: 3MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) | 
| languageDescription | stringMinLength: 1 | True | Textual description of language | 

### CaptionRectangle
<a name="channels-model-captionrectangle"></a>

Caption Rectangle


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| height | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \$1"80\$1" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. | 
| leftOffset | numberMinimum: 0Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. | 
| topOffset | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. | 
| width | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \$1"80\$1" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. | 

### CaptionSelector
<a name="channels-model-captionselector"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. | 
| name | stringMinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. | 
| selectorSettings | [CaptionSelectorSettings](#channels-model-captionselectorsettings) | False | Caption selector settings. | 

### CaptionSelectorSettings
<a name="channels-model-captionselectorsettings"></a>

Caption Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ancillarySourceSettings | [AncillarySourceSettings](#channels-model-ancillarysourcesettings) | False |  | 
| aribSourceSettings | [AribSourceSettings](#channels-model-aribsourcesettings) | False |  | 
| dvbSubSourceSettings | [DvbSubSourceSettings](#channels-model-dvbsubsourcesettings) | False |  | 
| embeddedSourceSettings | [EmbeddedSourceSettings](#channels-model-embeddedsourcesettings) | False |  | 
| scte20SourceSettings | [Scte20SourceSettings](#channels-model-scte20sourcesettings) | False |  | 
| scte27SourceSettings | [Scte27SourceSettings](#channels-model-scte27sourcesettings) | False |  | 
| teletextSourceSettings | [TeletextSourceSettings](#channels-model-teletextsourcesettings) | False |  | 

### CdiInputResolution
<a name="channels-model-cdiinputresolution"></a>

Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### CdiInputSpecification
<a name="channels-model-cdiinputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resolution | [CdiInputResolution](#channels-model-cdiinputresolution) | False | Maximum CDI input resolution | 

### Channel
<a name="channels-model-channel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| encoderSettings | [EncoderSettings](#channels-model-encodersettings) | False |  | 
| id | string | False | The unique ID of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelineDetails | Array of type [PipelineDetail](#channels-model-pipelinedetail) | False | Runtime details for the pipelines of a running channel. | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-model-channelstate) | False |  | 
| tags | [Tags](#channels-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-model-vpcoutputsettingsdescription) | False | Settings for VPC output | 

### ChannelClass
<a name="channels-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### ChannelConfigurationValidationError
<a name="channels-model-channelconfigurationvalidationerror"></a>


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

### ChannelEgressEndpoint
<a name="channels-model-channelegressendpoint"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceIp | string | False | Public IP of where a channel's output comes from | 

### ChannelState
<a name="channels-model-channelstate"></a>
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`
+ `UPDATING`
+ `UPDATE_FAILED`

### ChannelSummary
<a name="channels-model-channelsummary"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| id | string | False | The unique id of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-model-channelstate) | False |  | 
| tags | [Tags](#channels-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-model-vpcoutputsettingsdescription) | False | Settings for any VPC outputs. | 

### ColorSpacePassthroughSettings
<a name="channels-model-colorspacepassthroughsettings"></a>

Passthrough applies no color space conversion to the output

### CreateChannel
<a name="channels-model-createchannel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cdiInputSpecification | [CdiInputSpecification](#channels-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-model-outputdestination) | False |  | 
| encoderSettings | [EncoderSettings](#channels-model-encodersettings) | False |  | 
| inputAttachments | Array of type [InputAttachment](#channels-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-model-loglevel) | False | The log level to write to CloudWatch Logs. | 
| maintenance | [MaintenanceCreateSettings](#channels-model-maintenancecreatesettings) | False | Maintenance settings for this channel. | 
| name | string | False | Name of channel. | 
| requestId | string | False | Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.  | 
| reserved | string | False | Deprecated field that's only usable by whitelisted customers. | 
| roleArn | string | False | An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. | 
| tags | [Tags](#channels-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettings](#channels-model-vpcoutputsettings) | False | Settings for the VPC outputs | 

### CreateChannelResultModel
<a name="channels-model-createchannelresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channel | [Channel](#channels-model-channel) | False |  | 

### DvbNitSettings
<a name="channels-model-dvbnitsettings"></a>

DVB Network Information Table (NIT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| networkId | integerMinimum: 0Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). | 
| networkName | stringMinLength: 1MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. | 
| repInterval | integerMinimum: 25Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### DvbSdtOutputSdt
<a name="channels-model-dvbsdtoutputsdt"></a>

Dvb Sdt Output Sdt
+ `SDT_FOLLOW`
+ `SDT_FOLLOW_IF_PRESENT`
+ `SDT_MANUAL`
+ `SDT_NONE`

### DvbSdtSettings
<a name="channels-model-dvbsdtsettings"></a>

DVB Service Description Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputSdt | [DvbSdtOutputSdt](#channels-model-dvbsdtoutputsdt) | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | 
| repInterval | integerMinimum: 25Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. | 
| serviceName | stringMinLength: 1MaxLength: 256 | False | The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 
| serviceProviderName | stringMinLength: 1MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 

### DvbSubDestinationAlignment
<a name="channels-model-dvbsubdestinationalignment"></a>

Dvb Sub Destination Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### DvbSubDestinationBackgroundColor
<a name="channels-model-dvbsubdestinationbackgroundcolor"></a>

Dvb Sub Destination Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationFontColor
<a name="channels-model-dvbsubdestinationfontcolor"></a>

Dvb Sub Destination Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationOutlineColor
<a name="channels-model-dvbsubdestinationoutlinecolor"></a>

Dvb Sub Destination Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationSettings
<a name="channels-model-dvbsubdestinationsettings"></a>

Dvb Sub Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [DvbSubDestinationAlignment](#channels-model-dvbsubdestinationalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [DvbSubDestinationBackgroundColor](#channels-model-dvbsubdestinationbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [DvbSubDestinationFontColor](#channels-model-dvbsubdestinationfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [DvbSubDestinationOutlineColor](#channels-model-dvbsubdestinationoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [DvbSubDestinationShadowColor](#channels-model-dvbsubdestinationshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [DvbSubDestinationTeletextGridControl](#channels-model-dvbsubdestinationteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 

### DvbSubDestinationShadowColor
<a name="channels-model-dvbsubdestinationshadowcolor"></a>

Dvb Sub Destination Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationTeletextGridControl
<a name="channels-model-dvbsubdestinationteletextgridcontrol"></a>

Dvb Sub Destination Teletext Grid Control
+ `FIXED`
+ `SCALED`

### DvbSubOcrLanguage
<a name="channels-model-dvbsubocrlanguage"></a>

Dvb Sub Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### DvbSubSourceSettings
<a name="channels-model-dvbsubsourcesettings"></a>

Dvb Sub Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [DvbSubOcrLanguage](#channels-model-dvbsubocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. | 

### DvbTdtSettings
<a name="channels-model-dvbtdtsettings"></a>

DVB Time and Date Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| repInterval | integerMinimum: 1000Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### Eac3AttenuationControl
<a name="channels-model-eac3attenuationcontrol"></a>

Eac3 Attenuation Control
+ `ATTENUATE_3_DB`
+ `NONE`

### Eac3BitstreamMode
<a name="channels-model-eac3bitstreammode"></a>

Eac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `VISUALLY_IMPAIRED`

### Eac3CodingMode
<a name="channels-model-eac3codingmode"></a>

Eac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2`

### Eac3DcFilter
<a name="channels-model-eac3dcfilter"></a>

Eac3 Dc Filter
+ `DISABLED`
+ `ENABLED`

### Eac3DrcLine
<a name="channels-model-eac3drcline"></a>

Eac3 Drc Line
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3DrcRf
<a name="channels-model-eac3drcrf"></a>

Eac3 Drc Rf
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3LfeControl
<a name="channels-model-eac3lfecontrol"></a>

Eac3 Lfe Control
+ `LFE`
+ `NO_LFE`

### Eac3LfeFilter
<a name="channels-model-eac3lfefilter"></a>

Eac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Eac3MetadataControl
<a name="channels-model-eac3metadatacontrol"></a>

Eac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Eac3PassthroughControl
<a name="channels-model-eac3passthroughcontrol"></a>

Eac3 Passthrough Control
+ `NO_PASSTHROUGH`
+ `WHEN_POSSIBLE`

### Eac3PhaseControl
<a name="channels-model-eac3phasecontrol"></a>

Eac3 Phase Control
+ `NO_SHIFT`
+ `SHIFT_90_DEGREES`

### Eac3Settings
<a name="channels-model-eac3settings"></a>

Eac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| attenuationControl | [Eac3AttenuationControl](#channels-model-eac3attenuationcontrol) | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | 
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Eac3BitstreamMode](#channels-model-eac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. | 
| codingMode | [Eac3CodingMode](#channels-model-eac3codingmode) | False | Dolby Digital Plus coding mode. Determines number of channels. | 
| dcFilter | [Eac3DcFilter](#channels-model-eac3dcfilter) | False | When set to enabled, activates a DC highpass filter for all input channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. | 
| drcLine | [Eac3DrcLine](#channels-model-eac3drcline) | False | Sets the Dolby dynamic range compression profile. | 
| drcRf | [Eac3DrcRf](#channels-model-eac3drcrf) | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | 
| lfeControl | [Eac3LfeControl](#channels-model-eac3lfecontrol) | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | 
| lfeFilter | [Eac3LfeFilter](#channels-model-eac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | 
| loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. | 
| loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. | 
| ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. | 
| ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. | 
| metadataControl | [Eac3MetadataControl](#channels-model-eac3metadatacontrol) | False | When set to followInput, encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 
| passthroughControl | [Eac3PassthroughControl](#channels-model-eac3passthroughcontrol) | False | When set to whenPossible, input DD\$1 audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD\$1 and non-DD\$1 content will have a consistent DD\$1 output as the system alternates between passthrough and encoding. | 
| phaseControl | [Eac3PhaseControl](#channels-model-eac3phasecontrol) | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | 
| stereoDownmix | [Eac3StereoDownmix](#channels-model-eac3stereodownmix) | False | Stereo downmix preference. Only used for 3/2 coding mode. | 
| surroundExMode | [Eac3SurroundExMode](#channels-model-eac3surroundexmode) | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | 
| surroundMode | [Eac3SurroundMode](#channels-model-eac3surroundmode) | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. | 

### Eac3StereoDownmix
<a name="channels-model-eac3stereodownmix"></a>

Eac3 Stereo Downmix
+ `DPL2`
+ `LO_RO`
+ `LT_RT`
+ `NOT_INDICATED`

### Eac3SurroundExMode
<a name="channels-model-eac3surroundexmode"></a>

Eac3 Surround Ex Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### Eac3SurroundMode
<a name="channels-model-eac3surroundmode"></a>

Eac3 Surround Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### EbuTtDDestinationSettings
<a name="channels-model-ebuttddestinationsettings"></a>

Ebu Tt DDestination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyrightHolder | stringMaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML | 
| fillLineGap | [EbuTtDFillLineGapControl](#channels-model-ebuttdfilllinegapcontrol) | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | 
| fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. | 
| styleControl | [EbuTtDDestinationStyleControl](#channels-model-ebuttddestinationstylecontrol) | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. | 

### EbuTtDDestinationStyleControl
<a name="channels-model-ebuttddestinationstylecontrol"></a>

Ebu Tt DDestination Style Control
+ `EXCLUDE`
+ `INCLUDE`

### EbuTtDFillLineGapControl
<a name="channels-model-ebuttdfilllinegapcontrol"></a>

Ebu Tt DFill Line Gap Control
+ `DISABLED`
+ `ENABLED`

### EmbeddedConvert608To708
<a name="channels-model-embeddedconvert608to708"></a>

Embedded Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### EmbeddedDestinationSettings
<a name="channels-model-embeddeddestinationsettings"></a>

Embedded Destination Settings

### EmbeddedPlusScte20DestinationSettings
<a name="channels-model-embeddedplusscte20destinationsettings"></a>

Embedded Plus Scte20 Destination Settings

### EmbeddedScte20Detection
<a name="channels-model-embeddedscte20detection"></a>

Embedded Scte20 Detection
+ `AUTO`
+ `OFF`

### EmbeddedSourceSettings
<a name="channels-model-embeddedsourcesettings"></a>

Embedded Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [EmbeddedConvert608To708](#channels-model-embeddedconvert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| scte20Detection | [EmbeddedScte20Detection](#channels-model-embeddedscte20detection) | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 
| source608TrackNumber | integerMinimum: 1Maximum: 5 | False | This field is unused and deprecated. | 

### EncoderSettings
<a name="channels-model-encodersettings"></a>

Encoder Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptions | Array of type [AudioDescription](#channels-model-audiodescription) | True |  | 
| availBlanking | [AvailBlanking](#channels-model-availblanking) | False | Settings for ad avail blanking. | 
| availConfiguration | [AvailConfiguration](#channels-model-availconfiguration) | False | Event-wide configuration settings for ad avail insertion. | 
| blackoutSlate | [BlackoutSlate](#channels-model-blackoutslate) | False | Settings for blackout slate. | 
| captionDescriptions | Array of type [CaptionDescription](#channels-model-captiondescription) | False | Settings for caption decriptions | 
| featureActivations | [FeatureActivations](#channels-model-featureactivations) | False | Feature Activations | 
| globalConfiguration | [GlobalConfiguration](#channels-model-globalconfiguration) | False | Configuration settings that apply to the event as a whole. | 
| motionGraphicsConfiguration | [MotionGraphicsConfiguration](#channels-model-motiongraphicsconfiguration) | False | Settings for motion graphics. | 
| nielsenConfiguration | [NielsenConfiguration](#channels-model-nielsenconfiguration) | False | Nielsen configuration settings. | 
| outputGroups | Array of type [OutputGroup](#channels-model-outputgroup) | True |  | 
| timecodeConfig | [TimecodeConfig](#channels-model-timecodeconfig) | True | Contains settings used to acquire and adjust timecode information from inputs. | 
| videoDescriptions | Array of type [VideoDescription](#channels-model-videodescription) | True |  | 

### FailoverCondition
<a name="channels-model-failovercondition"></a>

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failoverConditionSettings | [FailoverConditionSettings](#channels-model-failoverconditionsettings) | False | Failover condition type-specific settings. | 

### FailoverConditionSettings
<a name="channels-model-failoverconditionsettings"></a>

Settings for one failover condition.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSilenceSettings | [AudioSilenceFailoverSettings](#channels-model-audiosilencefailoversettings) | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | 
| inputLossSettings | [InputLossFailoverSettings](#channels-model-inputlossfailoversettings) | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | 
| videoBlackSettings | [VideoBlackFailoverSettings](#channels-model-videoblackfailoversettings) | False | MediaLive will perform a failover if content is considered black for the specified period. | 

### FeatureActivations
<a name="channels-model-featureactivations"></a>

Feature Activations


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputPrepareScheduleActions | [FeatureActivationsInputPrepareScheduleActions](#channels-model-featureactivationsinputpreparescheduleactions) | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. | 

### FeatureActivationsInputPrepareScheduleActions
<a name="channels-model-featureactivationsinputpreparescheduleactions"></a>

Feature Activations Input Prepare Schedule Actions
+ `DISABLED`
+ `ENABLED`

### FecOutputIncludeFec
<a name="channels-model-fecoutputincludefec"></a>

Fec Output Include Fec
+ `COLUMN`
+ `COLUMN_AND_ROW`

### FecOutputSettings
<a name="channels-model-fecoutputsettings"></a>

Fec Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| columnDepth | integerMinimum: 4Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. | 
| includeFec | [FecOutputIncludeFec](#channels-model-fecoutputincludefec) | False | Enables column only or column and row based FEC | 
| rowLength | integerMinimum: 1Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. | 

### FixedAfd
<a name="channels-model-fixedafd"></a>

Fixed Afd
+ `AFD_0000`
+ `AFD_0010`
+ `AFD_0011`
+ `AFD_0100`
+ `AFD_1000`
+ `AFD_1001`
+ `AFD_1010`
+ `AFD_1011`
+ `AFD_1101`
+ `AFD_1110`
+ `AFD_1111`

### Fmp4HlsSettings
<a name="channels-model-fmp4hlssettings"></a>

Fmp4 Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| nielsenId3Behavior | [Fmp4NielsenId3Behavior](#channels-model-fmp4nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| timedMetadataBehavior | [Fmp4TimedMetadataBehavior](#channels-model-fmp4timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 

### Fmp4NielsenId3Behavior
<a name="channels-model-fmp4nielsenid3behavior"></a>

Fmp4 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### Fmp4TimedMetadataBehavior
<a name="channels-model-fmp4timedmetadatabehavior"></a>

Fmp4 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### FrameCaptureCdnSettings
<a name="channels-model-framecapturecdnsettings"></a>

Frame Capture Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureS3Settings | [FrameCaptureS3Settings](#channels-model-framecaptures3settings) | False |  | 

### FrameCaptureGroupSettings
<a name="channels-model-framecapturegroupsettings"></a>

Frame Capture Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") \$1 name modifier \$1 the counter (5 digits, starting from 00001) \$1 extension (which is always .jpg). For example, curling-low.00001.jpg | 
| frameCaptureCdnSettings | [FrameCaptureCdnSettings](#channels-model-framecapturecdnsettings) | False | Parameters that control interactions with the CDN. | 

### FrameCaptureHlsSettings
<a name="channels-model-framecapturehlssettings"></a>

Frame Capture Hls Settings

### FrameCaptureIntervalUnit
<a name="channels-model-framecaptureintervalunit"></a>

Frame Capture Interval Unit
+ `MILLISECONDS`
+ `SECONDS`

### FrameCaptureOutputSettings
<a name="channels-model-framecaptureoutputsettings"></a>

Frame Capture Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. | 

### FrameCaptureS3LogUploads
<a name="channels-model-framecaptures3loguploads"></a>

Frame Capture S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### FrameCaptureS3Settings
<a name="channels-model-framecaptures3settings"></a>

Frame Capture S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [FrameCaptureS3LogUploads](#channels-model-framecaptures3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### FrameCaptureSettings
<a name="channels-model-framecapturesettings"></a>

Frame Capture Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captureInterval | integerMinimum: 1Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. | 
| captureIntervalUnits | [FrameCaptureIntervalUnit](#channels-model-framecaptureintervalunit) | False | Unit for the frame capture interval. | 

### GatewayTimeoutException
<a name="channels-model-gatewaytimeoutexception"></a>


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

### GlobalConfiguration
<a name="channels-model-globalconfiguration"></a>

Global Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| initialAudioGain | integerMinimum: -60Maximum: 60 | False | Value to set the initial audio gain for the Live Event. | 
| inputEndAction | [GlobalConfigurationInputEndAction](#channels-model-globalconfigurationinputendaction) | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | 
| inputLossBehavior | [InputLossBehavior](#channels-model-inputlossbehavior) | False | Settings for system actions when input is lost. | 
| outputLockingMode | [GlobalConfigurationOutputLockingMode](#channels-model-globalconfigurationoutputlockingmode) | False | Indicates how MediaLive pipelines are synchronized. PIPELINE\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | 
| outputTimingSource | [GlobalConfigurationOutputTimingSource](#channels-model-globalconfigurationoutputtimingsource) | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | 
| supportLowFramerateInputs | [GlobalConfigurationLowFramerateInputs](#channels-model-globalconfigurationlowframerateinputs) | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. | 

### GlobalConfigurationInputEndAction
<a name="channels-model-globalconfigurationinputendaction"></a>

Global Configuration Input End Action
+ `NONE`
+ `SWITCH_AND_LOOP_INPUTS`

### GlobalConfigurationLowFramerateInputs
<a name="channels-model-globalconfigurationlowframerateinputs"></a>

Global Configuration Low Framerate Inputs
+ `DISABLED`
+ `ENABLED`

### GlobalConfigurationOutputLockingMode
<a name="channels-model-globalconfigurationoutputlockingmode"></a>

Global Configuration Output Locking Mode
+ `EPOCH_LOCKING`
+ `PIPELINE_LOCKING`

### GlobalConfigurationOutputTimingSource
<a name="channels-model-globalconfigurationoutputtimingsource"></a>

Global Configuration Output Timing Source
+ `INPUT_CLOCK`
+ `SYSTEM_CLOCK`

### H264AdaptiveQuantization
<a name="channels-model-h264adaptivequantization"></a>

H264 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H264ColorMetadata
<a name="channels-model-h264colormetadata"></a>

H264 Color Metadata
+ `IGNORE`
+ `INSERT`

### H264ColorSpaceSettings
<a name="channels-model-h264colorspacesettings"></a>

H264 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-model-colorspacepassthroughsettings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-model-rec709settings) | False |  | 

### H264EntropyEncoding
<a name="channels-model-h264entropyencoding"></a>

H264 Entropy Encoding
+ `CABAC`
+ `CAVLC`

### H264FilterSettings
<a name="channels-model-h264filtersettings"></a>

H264 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-model-temporalfiltersettings) | False |  | 

### H264FlickerAq
<a name="channels-model-h264flickeraq"></a>

H264 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H264ForceFieldPictures
<a name="channels-model-h264forcefieldpictures"></a>

H264 Force Field Pictures
+ `DISABLED`
+ `ENABLED`

### H264FramerateControl
<a name="channels-model-h264frameratecontrol"></a>

H264 Framerate Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264GopBReference
<a name="channels-model-h264gopbreference"></a>

H264 Gop BReference
+ `DISABLED`
+ `ENABLED`

### H264GopSizeUnits
<a name="channels-model-h264gopsizeunits"></a>

H264 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H264Level
<a name="channels-model-h264level"></a>

H264 Level
+ `H264_LEVEL_1`
+ `H264_LEVEL_1_1`
+ `H264_LEVEL_1_2`
+ `H264_LEVEL_1_3`
+ `H264_LEVEL_2`
+ `H264_LEVEL_2_1`
+ `H264_LEVEL_2_2`
+ `H264_LEVEL_3`
+ `H264_LEVEL_3_1`
+ `H264_LEVEL_3_2`
+ `H264_LEVEL_4`
+ `H264_LEVEL_4_1`
+ `H264_LEVEL_4_2`
+ `H264_LEVEL_5`
+ `H264_LEVEL_5_1`
+ `H264_LEVEL_5_2`
+ `H264_LEVEL_AUTO`

### H264LookAheadRateControl
<a name="channels-model-h264lookaheadratecontrol"></a>

H264 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H264ParControl
<a name="channels-model-h264parcontrol"></a>

H264 Par Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264Profile
<a name="channels-model-h264profile"></a>

H264 Profile
+ `BASELINE`
+ `HIGH`
+ `HIGH_10BIT`
+ `HIGH_422`
+ `HIGH_422_10BIT`
+ `MAIN`

### H264QualityLevel
<a name="channels-model-h264qualitylevel"></a>

H264 Quality Level
+ `ENHANCED_QUALITY`
+ `STANDARD_QUALITY`

### H264RateControlMode
<a name="channels-model-h264ratecontrolmode"></a>

H264 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`
+ `VBR`

### H264ScanType
<a name="channels-model-h264scantype"></a>

H264 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H264SceneChangeDetect
<a name="channels-model-h264scenechangedetect"></a>

H264 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H264Settings
<a name="channels-model-h264settings"></a>

H264 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H264AdaptiveQuantization](#channels-model-h264adaptivequantization) | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | 
| afdSignaling | [AfdSignaling](#channels-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| bitrate | integerMinimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufFillPct | integerMinimum: 0Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). | 
| bufSize | integerMinimum: 0 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H264ColorMetadata](#channels-model-h264colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H264ColorSpaceSettings](#channels-model-h264colorspacesettings) | False | Color Space settings | 
| entropyEncoding | [H264EntropyEncoding](#channels-model-h264entropyencoding) | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | 
| filterSettings | [H264FilterSettings](#channels-model-h264filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H264FlickerAq](#channels-model-h264flickeraq) | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | 
| forceFieldPictures | [H264ForceFieldPictures](#channels-model-h264forcefieldpictures) | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | 
| framerateControl | [H264FramerateControl](#channels-model-h264frameratecontrol) | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | 
| framerateDenominator | integerMinimum: 1 | False | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopBReference | [H264GopBReference](#channels-model-h264gopbreference) | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Number of B-frames between reference frames. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H264GopSizeUnits](#channels-model-h264gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H264Level](#channels-model-h264level) | False | H.264 Level. | 
| lookAheadRateControl | [H264LookAheadRateControl](#channels-model-h264lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| numRefFrames | integerMinimum: 1Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. | 
| parControl | [H264ParControl](#channels-model-h264parcontrol) | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H264Profile](#channels-model-h264profile) | False | H.264 Profile. | 
| qualityLevel | [H264QualityLevel](#channels-model-h264qualitylevel) | False | Leave as STANDARD\$1QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED\$1QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED\$1QUALITY. - STANDARD\$1QUALITY: Valid for any Rate control mode. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide | 
| rateControlMode | [H264RateControlMode](#channels-model-h264ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H264ScanType](#channels-model-h264scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H264SceneChangeDetect](#channels-model-h264scenechangedetect) | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | 
| slices | integerMinimum: 1Maximum: 32 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| softness | integerMinimum: 0Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. | 
| spatialAq | [H264SpatialAq](#channels-model-h264spatialaq) | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | 
| subgopLength | [H264SubGopLength](#channels-model-h264subgoplength) | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | 
| syntax | [H264Syntax](#channels-model-h264syntax) | False | Produces a bitstream compliant with SMPTE RP-2027. | 
| temporalAq | [H264TemporalAq](#channels-model-h264temporalaq) | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | 
| timecodeInsertion | [H264TimecodeInsertionBehavior](#channels-model-h264timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H264SpatialAq
<a name="channels-model-h264spatialaq"></a>

H264 Spatial Aq
+ `DISABLED`
+ `ENABLED`

### H264SubGopLength
<a name="channels-model-h264subgoplength"></a>

H264 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### H264Syntax
<a name="channels-model-h264syntax"></a>

H264 Syntax
+ `DEFAULT`
+ `RP2027`

### H264TemporalAq
<a name="channels-model-h264temporalaq"></a>

H264 Temporal Aq
+ `DISABLED`
+ `ENABLED`

### H264TimecodeInsertionBehavior
<a name="channels-model-h264timecodeinsertionbehavior"></a>

H264 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### H265AdaptiveQuantization
<a name="channels-model-h265adaptivequantization"></a>

H265 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H265AlternativeTransferFunction
<a name="channels-model-h265alternativetransferfunction"></a>

H265 Alternative Transfer Function
+ `INSERT`
+ `OMIT`

### H265ColorMetadata
<a name="channels-model-h265colormetadata"></a>

H265 Color Metadata
+ `IGNORE`
+ `INSERT`

### H265ColorSpaceSettings
<a name="channels-model-h265colorspacesettings"></a>

H265 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-model-colorspacepassthroughsettings) | False |  | 
| hdr10Settings | [Hdr10Settings](#channels-model-hdr10settings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-model-rec709settings) | False |  | 

### H265FilterSettings
<a name="channels-model-h265filtersettings"></a>

H265 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-model-temporalfiltersettings) | False |  | 

### H265FlickerAq
<a name="channels-model-h265flickeraq"></a>

H265 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H265GopSizeUnits
<a name="channels-model-h265gopsizeunits"></a>

H265 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H265Level
<a name="channels-model-h265level"></a>

H265 Level
+ `H265_LEVEL_1`
+ `H265_LEVEL_2`
+ `H265_LEVEL_2_1`
+ `H265_LEVEL_3`
+ `H265_LEVEL_3_1`
+ `H265_LEVEL_4`
+ `H265_LEVEL_4_1`
+ `H265_LEVEL_5`
+ `H265_LEVEL_5_1`
+ `H265_LEVEL_5_2`
+ `H265_LEVEL_6`
+ `H265_LEVEL_6_1`
+ `H265_LEVEL_6_2`
+ `H265_LEVEL_AUTO`

### H265LookAheadRateControl
<a name="channels-model-h265lookaheadratecontrol"></a>

H265 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H265Profile
<a name="channels-model-h265profile"></a>

H265 Profile
+ `MAIN`
+ `MAIN_10BIT`

### H265RateControlMode
<a name="channels-model-h265ratecontrolmode"></a>

H265 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`

### H265ScanType
<a name="channels-model-h265scantype"></a>

H265 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H265SceneChangeDetect
<a name="channels-model-h265scenechangedetect"></a>

H265 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H265Settings
<a name="channels-model-h265settings"></a>

H265 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H265AdaptiveQuantization](#channels-model-h265adaptivequantization) | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| alternativeTransferFunction | [H265AlternativeTransferFunction](#channels-model-h265alternativetransferfunction) | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | 
| bitrate | integerMinimum: 100000Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufSize | integerMinimum: 100000Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H265ColorMetadata](#channels-model-h265colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H265ColorSpaceSettings](#channels-model-h265colorspacesettings) | False | Color Space settings | 
| filterSettings | [H265FilterSettings](#channels-model-h265filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H265FlickerAq](#channels-model-h265flickeraq) | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | 
| framerateDenominator | integerMinimum: 1Maximum: 3003 | True | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H265GopSizeUnits](#channels-model-h265gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H265Level](#channels-model-h265level) | False | H.265 Level. | 
| lookAheadRateControl | [H265LookAheadRateControl](#channels-model-h265lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 100000Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H265Profile](#channels-model-h265profile) | False | H.265 Profile. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M | 
| rateControlMode | [H265RateControlMode](#channels-model-h265ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H265ScanType](#channels-model-h265scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H265SceneChangeDetect](#channels-model-h265scenechangedetect) | False | Scene change detection. | 
| slices | integerMinimum: 1Maximum: 16 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| tier | [H265Tier](#channels-model-h265tier) | False | H.265 Tier. | 
| timecodeInsertion | [H265TimecodeInsertionBehavior](#channels-model-h265timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H265Tier
<a name="channels-model-h265tier"></a>

H265 Tier
+ `HIGH`
+ `MAIN`

### H265TimecodeInsertionBehavior
<a name="channels-model-h265timecodeinsertionbehavior"></a>

H265 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### Hdr10Settings
<a name="channels-model-hdr10settings"></a>

Hdr10 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxCll | integerMinimum: 0Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. | 
| maxFall | integerMinimum: 0Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. | 

### HlsAdMarkers
<a name="channels-model-hlsadmarkers"></a>

Hls Ad Markers
+ `ADOBE`
+ `ELEMENTAL`
+ `ELEMENTAL_SCTE35`

### HlsAkamaiHttpTransferMode
<a name="channels-model-hlsakamaihttptransfermode"></a>

Hls Akamai Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsAkamaiSettings
<a name="channels-model-hlsakamaisettings"></a>

Hls Akamai Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsAkamaiHttpTransferMode](#channels-model-hlsakamaihttptransfermode) | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 
| salt | string | False | Salt for authenticated Akamai. | 
| token | string | False | Token parameter for authenticated akamai. If not specified, \$1gda\$1 is used. | 

### HlsBasicPutSettings
<a name="channels-model-hlsbasicputsettings"></a>

Hls Basic Put Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsCaptionLanguageSetting
<a name="channels-model-hlscaptionlanguagesetting"></a>

Hls Caption Language Setting
+ `INSERT`
+ `NONE`
+ `OMIT`

### HlsCdnSettings
<a name="channels-model-hlscdnsettings"></a>

Hls Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsAkamaiSettings | [HlsAkamaiSettings](#channels-model-hlsakamaisettings) | False |  | 
| hlsBasicPutSettings | [HlsBasicPutSettings](#channels-model-hlsbasicputsettings) | False |  | 
| hlsMediaStoreSettings | [HlsMediaStoreSettings](#channels-model-hlsmediastoresettings) | False |  | 
| hlsS3Settings | [HlsS3Settings](#channels-model-hlss3settings) | False |  | 
| hlsWebdavSettings | [HlsWebdavSettings](#channels-model-hlswebdavsettings) | False |  | 

### HlsClientCache
<a name="channels-model-hlsclientcache"></a>

Hls Client Cache
+ `DISABLED`
+ `ENABLED`

### HlsCodecSpecification
<a name="channels-model-hlscodecspecification"></a>

Hls Codec Specification
+ `RFC_4281`
+ `RFC_6381`

### HlsDirectoryStructure
<a name="channels-model-hlsdirectorystructure"></a>

Hls Directory Structure
+ `SINGLE_DIRECTORY`
+ `SUBDIRECTORY_PER_STREAM`

### HlsDiscontinuityTags
<a name="channels-model-hlsdiscontinuitytags"></a>

Hls Discontinuity Tags
+ `INSERT`
+ `NEVER_INSERT`

### HlsEncryptionType
<a name="channels-model-hlsencryptiontype"></a>

Hls Encryption Type
+ `AES128`
+ `SAMPLE_AES`

### HlsGroupSettings
<a name="channels-model-hlsgroupsettings"></a>

Hls Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [HlsAdMarkers](#channels-model-hlsadmarkers) | False | Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. | 
| baseUrlContent | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. | 
| baseUrlManifest | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. | 
| captionLanguageMappings | Array of type [CaptionLanguageMapping](#channels-model-captionlanguagemapping) | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". | 
| captionLanguageSetting | [HlsCaptionLanguageSetting](#channels-model-hlscaptionlanguagesetting) | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | 
| clientCache | [HlsClientCache](#channels-model-hlsclientcache) | False | When set to "disabled", sets the \$1EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | 
| codecSpecification | [HlsCodecSpecification](#channels-model-hlscodecspecification) | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | 
| constantIv | stringMinLength: 32MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. | 
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | 
| directoryStructure | [HlsDirectoryStructure](#channels-model-hlsdirectorystructure) | False | Place segments in subdirectories. | 
| discontinuityTags | [HlsDiscontinuityTags](#channels-model-hlsdiscontinuitytags) | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | 
| encryptionType | [HlsEncryptionType](#channels-model-hlsencryptiontype) | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | 
| hlsCdnSettings | [HlsCdnSettings](#channels-model-hlscdnsettings) | False | Parameters that control interactions with the CDN. | 
| hlsId3SegmentTagging | [HlsId3SegmentTaggingState](#channels-model-hlsid3segmenttaggingstate) | False | State of HLS ID3 Segment Tagging | 
| iFrameOnlyPlaylists | [IFrameOnlyPlaylistType](#channels-model-iframeonlyplaylisttype) | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a \$1EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more \$1EXT-X-BYTERANGE entries identifying the I-frame position. For example, \$1EXT-X-BYTERANGE:160364@1461888" | 
| incompleteSegmentBehavior | [HlsIncompleteSegmentBehavior](#channels-model-hlsincompletesegmentbehavior) | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | 
| indexNSegments | integerMinimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. | 
| inputLossAction | [InputLossActionForHlsOut](#channels-model-inputlossactionforhlsout) | False | Parameter that control output group behavior on input loss. | 
| ivInManifest | [HlsIvInManifest](#channels-model-hlsivinmanifest) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | 
| ivSource | [HlsIvSource](#channels-model-hlsivsource) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | 
| keepSegments | integerMinimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) \$1 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. | 
| keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. | 
| keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). | 
| keyProviderSettings | [KeyProviderSettings](#channels-model-keyprovidersettings) | False | The key provider settings. | 
| manifestCompression | [HlsManifestCompression](#channels-model-hlsmanifestcompression) | False | When set to gzip, compresses HLS playlist. | 
| manifestDurationFormat | [HlsManifestDurationFormat](#channels-model-hlsmanifestdurationformat) | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | 
| minSegmentLength | integerMinimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. | 
| mode | [HlsMode](#channels-model-hlsmode) | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | 
| outputSelection | [HlsOutputSelection](#channels-model-hlsoutputselection) | False | MANIFESTS\$1AND\$1SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT\$1MANIFESTS\$1AND\$1SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS\$1ONLY: Does not generate any manifests for this output group. | 
| programDateTime | [HlsProgramDateTime](#channels-model-hlsprogramdatetime) | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | 
| programDateTimeClock | [HlsProgramDateTimeClock](#channels-model-hlsprogramdatetimeclock) | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE\$1FROM\$1OUTPUT\$1TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM\$1CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | 
| programDateTimePeriod | integerMinimum: 0Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | 
| redundantManifest | [HlsRedundantManifest](#channels-model-hlsredundantmanifest) | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | 
| segmentationMode | [HlsSegmentationMode](#channels-model-hlssegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| segmentLength | integerMinimum: 1 | False | Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. | 
| segmentsPerSubdirectory | integerMinimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. | 
| streamInfResolution | [HlsStreamInfResolution](#channels-model-hlsstreaminfresolution) | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | 
| timedMetadataId3Frame | [HlsTimedMetadataId3Frame](#channels-model-hlstimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 
| timestampDeltaMilliseconds | integerMinimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. | 
| tsFileMode | [HlsTsFileMode](#channels-model-hlstsfilemode) | False | SEGMENTED\$1FILES: Emit the program as segments - multiple .ts media files. SINGLE\$1FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes \$1EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. | 

### HlsH265PackagingType
<a name="channels-model-hlsh265packagingtype"></a>

Hls H265 Packaging Type
+ `HEV1`
+ `HVC1`

### HlsId3SegmentTaggingState
<a name="channels-model-hlsid3segmenttaggingstate"></a>

State of HLS ID3 Segment Tagging
+ `DISABLED`
+ `ENABLED`

### HlsIncompleteSegmentBehavior
<a name="channels-model-hlsincompletesegmentbehavior"></a>

Hls Incomplete Segment Behavior
+ `AUTO`
+ `SUPPRESS`

### HlsInputSettings
<a name="channels-model-hlsinputsettings"></a>

Hls Input Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bandwidth | integerMinimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. | 
| bufferSegments | integerMinimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. | 
| retries | integerMinimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. | 
| retryInterval | integerMinimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. | 
| scte35Source | [HlsScte35SourceType](#channels-model-hlsscte35sourcetype) | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. | 

### HlsIvInManifest
<a name="channels-model-hlsivinmanifest"></a>

Hls Iv In Manifest
+ `EXCLUDE`
+ `INCLUDE`

### HlsIvSource
<a name="channels-model-hlsivsource"></a>

Hls Iv Source
+ `EXPLICIT`
+ `FOLLOWS_SEGMENT_NUMBER`

### HlsManifestCompression
<a name="channels-model-hlsmanifestcompression"></a>

Hls Manifest Compression
+ `GZIP`
+ `NONE`

### HlsManifestDurationFormat
<a name="channels-model-hlsmanifestdurationformat"></a>

Hls Manifest Duration Format
+ `FLOATING_POINT`
+ `INTEGER`

### HlsMediaStoreSettings
<a name="channels-model-hlsmediastoresettings"></a>

Hls Media Store Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| mediaStoreStorageClass | [HlsMediaStoreStorageClass](#channels-model-hlsmediastorestorageclass) | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsMediaStoreStorageClass
<a name="channels-model-hlsmediastorestorageclass"></a>

Hls Media Store Storage Class
+ `TEMPORAL`

### HlsMode
<a name="channels-model-hlsmode"></a>

Hls Mode
+ `LIVE`
+ `VOD`

### HlsOutputSelection
<a name="channels-model-hlsoutputselection"></a>

Hls Output Selection
+ `MANIFESTS_AND_SEGMENTS`
+ `SEGMENTS_ONLY`
+ `VARIANT_MANIFESTS_AND_SEGMENTS`

### HlsOutputSettings
<a name="channels-model-hlsoutputsettings"></a>

Hls Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [HlsH265PackagingType](#channels-model-hlsh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| hlsSettings | [HlsSettings](#channels-model-hlssettings) | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | 
| nameModifier | stringMinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \$1"Format Identifiers\$1":\$1formatIdentifierParameters. | 
| segmentModifier | string | False | String concatenated to end of segment filenames. | 

### HlsProgramDateTime
<a name="channels-model-hlsprogramdatetime"></a>

Hls Program Date Time
+ `EXCLUDE`
+ `INCLUDE`

### HlsProgramDateTimeClock
<a name="channels-model-hlsprogramdatetimeclock"></a>

Hls Program Date Time Clock
+ `INITIALIZE_FROM_OUTPUT_TIMECODE`
+ `SYSTEM_CLOCK`

### HlsRedundantManifest
<a name="channels-model-hlsredundantmanifest"></a>

Hls Redundant Manifest
+ `DISABLED`
+ `ENABLED`

### HlsS3LogUploads
<a name="channels-model-hlss3loguploads"></a>

Hls S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### HlsS3Settings
<a name="channels-model-hlss3settings"></a>

Hls S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [HlsS3LogUploads](#channels-model-hlss3loguploads) | False | When set to enabled, each fragment upload to CDN or server will be logged. | 

### HlsScte35SourceType
<a name="channels-model-hlsscte35sourcetype"></a>

Hls Scte35 Source Type
+ `MANIFEST`
+ `SEGMENTS`

### HlsSegmentationMode
<a name="channels-model-hlssegmentationmode"></a>

Hls Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### HlsSettings
<a name="channels-model-hlssettings"></a>

Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioOnlyHlsSettings | [AudioOnlyHlsSettings](#channels-model-audioonlyhlssettings) | False |  | 
| fmp4HlsSettings | [Fmp4HlsSettings](#channels-model-fmp4hlssettings) | False |  | 
| frameCaptureHlsSettings | [FrameCaptureHlsSettings](#channels-model-framecapturehlssettings) | False |  | 
| standardHlsSettings | [StandardHlsSettings](#channels-model-standardhlssettings) | False |  | 

### HlsStreamInfResolution
<a name="channels-model-hlsstreaminfresolution"></a>

Hls Stream Inf Resolution
+ `EXCLUDE`
+ `INCLUDE`

### HlsTimedMetadataId3Frame
<a name="channels-model-hlstimedmetadataid3frame"></a>

Hls Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### HlsTsFileMode
<a name="channels-model-hlstsfilemode"></a>

Hls Ts File Mode
+ `SEGMENTED_FILES`
+ `SINGLE_FILE`

### HlsWebdavHttpTransferMode
<a name="channels-model-hlswebdavhttptransfermode"></a>

Hls Webdav Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsWebdavSettings
<a name="channels-model-hlswebdavsettings"></a>

Hls Webdav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsWebdavHttpTransferMode](#channels-model-hlswebdavhttptransfermode) | False | Specify whether or not to use chunked transfer encoding to WebDAV. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HtmlMotionGraphicsSettings
<a name="channels-model-htmlmotiongraphicssettings"></a>

Html Motion Graphics Settings

### IFrameOnlyPlaylistType
<a name="channels-model-iframeonlyplaylisttype"></a>

When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
+ `DISABLED`
+ `STANDARD`

### InputAttachment
<a name="channels-model-inputattachment"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| automaticInputFailoverSettings | [AutomaticInputFailoverSettings](#channels-model-automaticinputfailoversettings) | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | 
| inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. | 
| inputId | string | False | The ID of the input | 
| inputSettings | [InputSettings](#channels-model-inputsettings) | False | Settings of an input (caption selector, etc.) | 

### InputChannelLevel
<a name="channels-model-inputchannellevel"></a>

Input Channel Level


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| gain | integerMinimum: -60Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. | 
| inputChannel | integerMinimum: 0Maximum: 15 | True | The index of the input channel used as a source. | 

### InputCodec
<a name="channels-model-inputcodec"></a>

codec in increasing order of complexity
+ `MPEG2`
+ `AVC`
+ `HEVC`

### InputDeblockFilter
<a name="channels-model-inputdeblockfilter"></a>

Input Deblock Filter
+ `DISABLED`
+ `ENABLED`

### InputDenoiseFilter
<a name="channels-model-inputdenoisefilter"></a>

Input Denoise Filter
+ `DISABLED`
+ `ENABLED`

### InputFilter
<a name="channels-model-inputfilter"></a>

Input Filter
+ `AUTO`
+ `DISABLED`
+ `FORCED`

### InputLocation
<a name="channels-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputLossActionForHlsOut
<a name="channels-model-inputlossactionforhlsout"></a>

Input Loss Action For Hls Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForMsSmoothOut
<a name="channels-model-inputlossactionformssmoothout"></a>

Input Loss Action For Ms Smooth Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForRtmpOut
<a name="channels-model-inputlossactionforrtmpout"></a>

Input Loss Action For Rtmp Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForUdpOut
<a name="channels-model-inputlossactionforudpout"></a>

Input Loss Action For Udp Out
+ `DROP_PROGRAM`
+ `DROP_TS`
+ `EMIT_PROGRAM`

### InputLossBehavior
<a name="channels-model-inputlossbehavior"></a>

Input Loss Behavior


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 
| inputLossImageColor | stringMinLength: 6MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. | 
| inputLossImageSlate | [InputLocation](#channels-model-inputlocation) | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | 
| inputLossImageType | [InputLossImageType](#channels-model-inputlossimagetype) | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | 
| repeatFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 

### InputLossFailoverSettings
<a name="channels-model-inputlossfailoversettings"></a>

MediaLive will perform a failover if content is not detected in this input for the specified period.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossThresholdMsec | integerMinimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. | 

### InputLossImageType
<a name="channels-model-inputlossimagetype"></a>

Input Loss Image Type
+ `COLOR`
+ `SLATE`

### InputMaximumBitrate
<a name="channels-model-inputmaximumbitrate"></a>

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### InputPreference
<a name="channels-model-inputpreference"></a>

Input preference when deciding which input to make active when a previously failed input has recovered. If \$1"EQUAL\$1INPUT\$1PREFERENCE\$1", then the active input will stay active as long as it is healthy. If \$1"PRIMARY\$1INPUT\$1PREFERRED\$1", then always switch back to the primary input when it is healthy. 
+ `EQUAL_INPUT_PREFERENCE`
+ `PRIMARY_INPUT_PREFERRED`

### InputResolution
<a name="channels-model-inputresolution"></a>

Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `UHD`

### InputSettings
<a name="channels-model-inputsettings"></a>

Live Event input parameters. There can be multiple inputs in a single Live Event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectors | Array of type [AudioSelector](#channels-model-audioselector) | False | Used to select the audio stream to decode for inputs that have multiple available. | 
| captionSelectors | Array of type [CaptionSelector](#channels-model-captionselector) | False | Used to select the caption input to use for inputs that have multiple available. | 
| deblockFilter | [InputDeblockFilter](#channels-model-inputdeblockfilter) | False | Enable or disable the deblock filter when filtering. | 
| denoiseFilter | [InputDenoiseFilter](#channels-model-inputdenoisefilter) | False | Enable or disable the denoise filter when filtering. | 
| filterStrength | integerMinimum: 1Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). | 
| inputFilter | [InputFilter](#channels-model-inputfilter) | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | 
| networkInputSettings | [NetworkInputSettings](#channels-model-networkinputsettings) | False | Input settings. | 
| smpte2038DataPreference | [Smpte2038DataPreference](#channels-model-smpte2038datapreference) | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | 
| sourceEndBehavior | [InputSourceEndBehavior](#channels-model-inputsourceendbehavior) | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | 
| videoSelector | [VideoSelector](#channels-model-videoselector) | False | Informs which video elementary stream to decode for input types that have multiple available. | 

### InputSourceEndBehavior
<a name="channels-model-inputsourceendbehavior"></a>

Input Source End Behavior
+ `CONTINUE`
+ `LOOP`

### InputSpecification
<a name="channels-model-inputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codec | [InputCodec](#channels-model-inputcodec) | False | Input codec | 
| maximumBitrate | [InputMaximumBitrate](#channels-model-inputmaximumbitrate) | False | Maximum input bitrate, categorized coarsely | 
| resolution | [InputResolution](#channels-model-inputresolution) | False | Input resolution, categorized coarsely | 

### InternalServiceError
<a name="channels-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-model-invalidrequest"></a>


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

### KeyProviderSettings
<a name="channels-model-keyprovidersettings"></a>

Key Provider Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| staticKeySettings | [StaticKeySettings](#channels-model-statickeysettings) | False |  | 

### LimitExceeded
<a name="channels-model-limitexceeded"></a>


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

### ListChannelsResultModel
<a name="channels-model-listchannelsresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channels | Array of type [ChannelSummary](#channels-model-channelsummary) | False |  | 
| nextToken | string | False |  | 

### LogLevel
<a name="channels-model-loglevel"></a>

The log level the user wants for their channel.
+ `ERROR`
+ `WARNING`
+ `INFO`
+ `DEBUG`
+ `DISABLED`

### M2tsAbsentInputAudioBehavior
<a name="channels-model-m2tsabsentinputaudiobehavior"></a>

M2ts Absent Input Audio Behavior
+ `DROP`
+ `ENCODE_SILENCE`

### M2tsArib
<a name="channels-model-m2tsarib"></a>

M2ts Arib
+ `DISABLED`
+ `ENABLED`

### M2tsAribCaptionsPidControl
<a name="channels-model-m2tsaribcaptionspidcontrol"></a>

M2ts Arib Captions Pid Control
+ `AUTO`
+ `USE_CONFIGURED`

### M2tsAudioBufferModel
<a name="channels-model-m2tsaudiobuffermodel"></a>

M2ts Audio Buffer Model
+ `ATSC`
+ `DVB`

### M2tsAudioInterval
<a name="channels-model-m2tsaudiointerval"></a>

M2ts Audio Interval
+ `VIDEO_AND_FIXED_INTERVALS`
+ `VIDEO_INTERVAL`

### M2tsAudioStreamType
<a name="channels-model-m2tsaudiostreamtype"></a>

M2ts Audio Stream Type
+ `ATSC`
+ `DVB`

### M2tsBufferModel
<a name="channels-model-m2tsbuffermodel"></a>

M2ts Buffer Model
+ `MULTIPLEX`
+ `NONE`

### M2tsCcDescriptor
<a name="channels-model-m2tsccdescriptor"></a>

M2ts Cc Descriptor
+ `DISABLED`
+ `ENABLED`

### M2tsEbifControl
<a name="channels-model-m2tsebifcontrol"></a>

M2ts Ebif Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsEbpPlacement
<a name="channels-model-m2tsebpplacement"></a>

M2ts Ebp Placement
+ `VIDEO_AND_AUDIO_PIDS`
+ `VIDEO_PID`

### M2tsEsRateInPes
<a name="channels-model-m2tsesrateinpes"></a>

M2ts Es Rate In Pes
+ `EXCLUDE`
+ `INCLUDE`

### M2tsKlv
<a name="channels-model-m2tsklv"></a>

M2ts Klv
+ `NONE`
+ `PASSTHROUGH`

### M2tsNielsenId3Behavior
<a name="channels-model-m2tsnielsenid3behavior"></a>

M2ts Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M2tsPcrControl
<a name="channels-model-m2tspcrcontrol"></a>

M2ts Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M2tsRateMode
<a name="channels-model-m2tsratemode"></a>

M2ts Rate Mode
+ `CBR`
+ `VBR`

### M2tsScte35Control
<a name="channels-model-m2tsscte35control"></a>

M2ts Scte35 Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsSegmentationMarkers
<a name="channels-model-m2tssegmentationmarkers"></a>

M2ts Segmentation Markers
+ `EBP`
+ `EBP_LEGACY`
+ `NONE`
+ `PSI_SEGSTART`
+ `RAI_ADAPT`
+ `RAI_SEGSTART`

### M2tsSegmentationStyle
<a name="channels-model-m2tssegmentationstyle"></a>

M2ts Segmentation Style
+ `MAINTAIN_CADENCE`
+ `RESET_CADENCE`

### M2tsSettings
<a name="channels-model-m2tssettings"></a>

M2ts Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| absentInputAudioBehavior | [M2tsAbsentInputAudioBehavior](#channels-model-m2tsabsentinputaudiobehavior) | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | 
| arib | [M2tsArib](#channels-model-m2tsarib) | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | 
| aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| aribCaptionsPidControl | [M2tsAribCaptionsPidControl](#channels-model-m2tsaribcaptionspidcontrol) | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | 
| audioBufferModel | [M2tsAudioBufferModel](#channels-model-m2tsaudiobuffermodel) | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | 
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| audioStreamType | [M2tsAudioStreamType](#channels-model-m2tsaudiostreamtype) | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | 
| bitrate | integerMinimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. | 
| bufferModel | [M2tsBufferModel](#channels-model-m2tsbuffermodel) | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | 
| ccDescriptor | [M2tsCcDescriptor](#channels-model-m2tsccdescriptor) | False | When set to enabled, generates captionServiceDescriptor in PMT. | 
| dvbNitSettings | [DvbNitSettings](#channels-model-dvbnitsettings) | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | 
| dvbSdtSettings | [DvbSdtSettings](#channels-model-dvbsdtsettings) | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | 
| dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| dvbTdtSettings | [DvbTdtSettings](#channels-model-dvbtdtsettings) | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | 
| dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| ebif | [M2tsEbifControl](#channels-model-m2tsebifcontrol) | False | If set to passthrough, passes any EBIF data from the input source to this output. | 
| ebpAudioInterval | [M2tsAudioInterval](#channels-model-m2tsaudiointerval) | False | When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | 
| ebpLookaheadMs | integerMinimum: 0Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. | 
| ebpPlacement | [M2tsEbpPlacement](#channels-model-m2tsebpplacement) | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | 
| ecmPid | string | False | This field is unused and deprecated. | 
| esRateInPes | [M2tsEsRateInPes](#channels-model-m2tsesrateinpes) | False | Include or exclude the ES Rate field in the PES header. | 
| etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| fragmentTime | numberMinimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. | 
| klv | [M2tsKlv](#channels-model-m2tsklv) | False | If set to passthrough, passes any KLV data from the input source to this output. | 
| klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| nielsenId3Behavior | [M2tsNielsenId3Behavior](#channels-model-m2tsnielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| nullPacketBitrate | numberMinimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pcrControl | [M2tsPcrControl](#channels-model-m2tspcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| rateMode | [M2tsRateMode](#channels-model-m2tsratemode) | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | 
| scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| scte35Control | [M2tsScte35Control](#channels-model-m2tsscte35control) | False | Optionally pass SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| segmentationMarkers | [M2tsSegmentationMarkers](#channels-model-m2tssegmentationmarkers) | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | 
| segmentationStyle | [M2tsSegmentationStyle](#channels-model-m2tssegmentationstyle) | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of \$1segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of \$1segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | 
| segmentationTime | numberMinimum: 1 | False | The length in seconds of each segment. Required unless markers is set to \$1none\$1. | 
| timedMetadataBehavior | [M2tsTimedMetadataBehavior](#channels-model-m2tstimedmetadatabehavior) | False | When set to passthrough, timed metadata will be passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 

### M2tsTimedMetadataBehavior
<a name="channels-model-m2tstimedmetadatabehavior"></a>

M2ts Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8NielsenId3Behavior
<a name="channels-model-m3u8nielsenid3behavior"></a>

M3u8 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8PcrControl
<a name="channels-model-m3u8pcrcontrol"></a>

M3u8 Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M3u8Scte35Behavior
<a name="channels-model-m3u8scte35behavior"></a>

M3u8 Scte35 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8Settings
<a name="channels-model-m3u8settings"></a>

Settings information for the .m3u8 container


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. | 
| ecmPid | string | False | This parameter is unused and deprecated. | 
| nielsenId3Behavior | [M3u8NielsenId3Behavior](#channels-model-m3u8nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pcrControl | [M3u8PcrControl](#channels-model-m3u8pcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| scte35Behavior | [M3u8Scte35Behavior](#channels-model-m3u8scte35behavior) | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| timedMetadataBehavior | [M3u8TimedMetadataBehavior](#channels-model-m3u8timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 

### M3u8TimedMetadataBehavior
<a name="channels-model-m3u8timedmetadatabehavior"></a>

M3u8 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### MaintenanceCreateSettings
<a name="channels-model-maintenancecreatesettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-model-maintenanceday) | False | Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows. | 
| maintenanceStartTime | stringPattern: `^([0,1]?[0-9]\|2[0-3]):00$` | False | Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows. | 

### MaintenanceDay
<a name="channels-model-maintenanceday"></a>

The currently selected maintenance day.
+ `MONDAY`
+ `TUESDAY`
+ `WEDNESDAY`
+ `THURSDAY`
+ `FRIDAY`
+ `SATURDAY`
+ `SUNDAY`

### MaintenanceStatus
<a name="channels-model-maintenancestatus"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-model-maintenanceday) | False | The currently selected maintenance day. | 
| maintenanceDeadline | stringFormat: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. | 
| maintenanceScheduledDate | stringFormat: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. | 
| maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. | 

### MediaPackageGroupSettings
<a name="channels-model-mediapackagegroupsettings"></a>

Media Package Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | MediaPackage channel destination. | 

### MediaPackageOutputDestinationSettings
<a name="channels-model-mediapackageoutputdestinationsettings"></a>

MediaPackage Output Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | stringMinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. | 

### MediaPackageOutputSettings
<a name="channels-model-mediapackageoutputsettings"></a>

Media Package Output Settings

### MotionGraphicsConfiguration
<a name="channels-model-motiongraphicsconfiguration"></a>

Motion Graphics Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| motionGraphicsInsertion | [MotionGraphicsInsertion](#channels-model-motiongraphicsinsertion) | False |  | 
| motionGraphicsSettings | [MotionGraphicsSettings](#channels-model-motiongraphicssettings) | True | Motion Graphics Settings | 

### MotionGraphicsInsertion
<a name="channels-model-motiongraphicsinsertion"></a>

Motion Graphics Insertion
+ `DISABLED`
+ `ENABLED`

### MotionGraphicsSettings
<a name="channels-model-motiongraphicssettings"></a>

Motion Graphics Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| htmlMotionGraphicsSettings | [HtmlMotionGraphicsSettings](#channels-model-htmlmotiongraphicssettings) | False |  | 

### Mp2CodingMode
<a name="channels-model-mp2codingmode"></a>

Mp2 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`

### Mp2Settings
<a name="channels-model-mp2settings"></a>

Mp2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. | 
| codingMode | [Mp2CodingMode](#channels-model-mp2codingmode) | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | 
| sampleRate | number | False | Sample rate in Hz. | 

### Mpeg2AdaptiveQuantization
<a name="channels-model-mpeg2adaptivequantization"></a>

Mpeg2 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `LOW`
+ `MEDIUM`
+ `OFF`

### Mpeg2ColorMetadata
<a name="channels-model-mpeg2colormetadata"></a>

Mpeg2 Color Metadata
+ `IGNORE`
+ `INSERT`

### Mpeg2ColorSpace
<a name="channels-model-mpeg2colorspace"></a>

Mpeg2 Color Space
+ `AUTO`
+ `PASSTHROUGH`

### Mpeg2DisplayRatio
<a name="channels-model-mpeg2displayratio"></a>

Mpeg2 Display Ratio
+ `DISPLAYRATIO16X9`
+ `DISPLAYRATIO4X3`

### Mpeg2FilterSettings
<a name="channels-model-mpeg2filtersettings"></a>

Mpeg2 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-model-temporalfiltersettings) | False |  | 

### Mpeg2GopSizeUnits
<a name="channels-model-mpeg2gopsizeunits"></a>

Mpeg2 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### Mpeg2ScanType
<a name="channels-model-mpeg2scantype"></a>

Mpeg2 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### Mpeg2Settings
<a name="channels-model-mpeg2settings"></a>

Mpeg2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [Mpeg2AdaptiveQuantization](#channels-model-mpeg2adaptivequantization) | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-model-afdsignaling) | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | 
| colorMetadata | [Mpeg2ColorMetadata](#channels-model-mpeg2colormetadata) | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | 
| colorSpace | [Mpeg2ColorSpace](#channels-model-mpeg2colorspace) | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \$1"MediaLive Features - Video - color space\$1" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | 
| displayAspectRatio | [Mpeg2DisplayRatio](#channels-model-mpeg2displayratio) | False | Sets the pixel aspect ratio for the encode. | 
| filterSettings | [Mpeg2FilterSettings](#channels-model-mpeg2filtersettings) | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | 
| fixedAfd | [FixedAfd](#channels-model-fixedafd) | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | 
| framerateDenominator | integerMinimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| framerateNumerator | integerMinimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| gopClosedCadence | integerMinimum: 0 | False | MPEG2: default is open GOP. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. | 
| gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. | 
| gopSizeUnits | [Mpeg2GopSizeUnits](#channels-model-mpeg2gopsizeunits) | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | 
| scanType | [Mpeg2ScanType](#channels-model-mpeg2scantype) | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | 
| subgopLength | [Mpeg2SubGopLength](#channels-model-mpeg2subgoplength) | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | 
| timecodeInsertion | [Mpeg2TimecodeInsertionBehavior](#channels-model-mpeg2timecodeinsertionbehavior) | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \$1"MediaLive Features - Timecode configuration\$1" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP\$1TIMECODE: Include timecode metadata in the GOP header. | 

### Mpeg2SubGopLength
<a name="channels-model-mpeg2subgoplength"></a>

Mpeg2 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### Mpeg2TimecodeInsertionBehavior
<a name="channels-model-mpeg2timecodeinsertionbehavior"></a>

Mpeg2 Timecode Insertion Behavior
+ `DISABLED`
+ `GOP_TIMECODE`

### MsSmoothGroupSettings
<a name="channels-model-mssmoothgroupsettings"></a>

Ms Smooth Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. | 
| audioOnlyTimecodeControl | [SmoothGroupAudioOnlyTimecodeControl](#channels-model-smoothgroupaudioonlytimecodecontrol) | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | 
| certificateMode | [SmoothGroupCertificateMode](#channels-model-smoothgroupcertificatemode) | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. | 
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | 
| eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. | 
| eventIdMode | [SmoothGroupEventIdMode](#channels-model-smoothgroupeventidmode) | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | 
| eventStopBehavior | [SmoothGroupEventStopBehavior](#channels-model-smoothgroupeventstopbehavior) | False | When set to sendEos, send EOS signal to IIS server when stopping the event | 
| filecacheDuration | integerMinimum: 0 | False | Size in seconds of file cache for streaming outputs. | 
| fragmentLength | integerMinimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. | 
| inputLossAction | [InputLossActionForMsSmoothOut](#channels-model-inputlossactionformssmoothout) | False | Parameter that control output group behavior on input loss. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 
| restartDelay | integerMinimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. | 
| segmentationMode | [SmoothGroupSegmentationMode](#channels-model-smoothgroupsegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| sendDelayMs | integerMinimum: 0Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. | 
| sparseTrackType | [SmoothGroupSparseTrackType](#channels-model-smoothgroupsparsetracktype) | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35\$1WITHOUT\$1SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | 
| streamManifestBehavior | [SmoothGroupStreamManifestBehavior](#channels-model-smoothgroupstreammanifestbehavior) | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | 
| timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. | 
| timestampOffsetMode | [SmoothGroupTimestampOffsetMode](#channels-model-smoothgrouptimestampoffsetmode) | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset | 

### MsSmoothH265PackagingType
<a name="channels-model-mssmoothh265packagingtype"></a>

Ms Smooth H265 Packaging Type
+ `HEV1`
+ `HVC1`

### MsSmoothOutputSettings
<a name="channels-model-mssmoothoutputsettings"></a>

Ms Smooth Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [MsSmoothH265PackagingType](#channels-model-mssmoothh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### MultiplexGroupSettings
<a name="channels-model-multiplexgroupsettings"></a>

Multiplex Group Settings

### MultiplexOutputSettings
<a name="channels-model-multiplexoutputsettings"></a>

Multiplex Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | Destination is a Multiplex. | 

### MultiplexProgramChannelDestinationSettings
<a name="channels-model-multiplexprogramchanneldestinationsettings"></a>

Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | stringMinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. | 
| programName | stringMinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. | 

### NetworkInputServerValidation
<a name="channels-model-networkinputservervalidation"></a>

Network Input Server Validation
+ `CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME`
+ `CHECK_CRYPTOGRAPHY_ONLY`

### NetworkInputSettings
<a name="channels-model-networkinputsettings"></a>

Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsInputSettings | [HlsInputSettings](#channels-model-hlsinputsettings) | False | Specifies HLS input settings when the uri is for a HLS manifest. | 
| serverValidation | [NetworkInputServerValidation](#channels-model-networkinputservervalidation) | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. | 

### NielsenCBET
<a name="channels-model-nielsencbet"></a>

Nielsen CBET


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cbetCheckDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. | 
| cbetStepaside | [NielsenWatermarksCbetStepaside](#channels-model-nielsenwatermarkscbetstepaside) | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | 
| csid | stringMinLength: 1MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark | 

### NielsenConfiguration
<a name="channels-model-nielsenconfiguration"></a>

Nielsen Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. | 
| nielsenPcmToId3Tagging | [NielsenPcmToId3TaggingState](#channels-model-nielsenpcmtoid3taggingstate) | False | Enables Nielsen PCM to ID3 tagging | 

### NielsenNaesIiNw
<a name="channels-model-nielsennaesiinw"></a>

Nielsen Naes Ii Nw


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| checkDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the check digit string for the watermark | 
| sid | numberMinimum: 1Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark | 

### NielsenPcmToId3TaggingState
<a name="channels-model-nielsenpcmtoid3taggingstate"></a>

State of Nielsen PCM to ID3 tagging
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksCbetStepaside
<a name="channels-model-nielsenwatermarkscbetstepaside"></a>

Nielsen Watermarks Cbet Stepaside
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksDistributionTypes
<a name="channels-model-nielsenwatermarksdistributiontypes"></a>

Nielsen Watermarks Distribution Types
+ `FINAL_DISTRIBUTOR`
+ `PROGRAM_CONTENT`

### NielsenWatermarksSettings
<a name="channels-model-nielsenwatermarkssettings"></a>

Nielsen Watermarks Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenCbetSettings | [NielsenCBET](#channels-model-nielsencbet) | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | 
| nielsenDistributionType | [NielsenWatermarksDistributionTypes](#channels-model-nielsenwatermarksdistributiontypes) | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM\$1CONTENT - FINAL\$1DISTRIBUTOR | 
| nielsenNaesIiNwSettings | [NielsenNaesIiNw](#channels-model-nielsennaesiinw) | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). | 

### Output
<a name="channels-model-output"></a>

Output settings. There can be multiple outputs within a group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. | 
| captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. | 
| outputName | stringMinLength: 1MaxLength: 255 | False | The name used to identify an output. | 
| outputSettings | [OutputSettings](#channels-model-outputsettings) | True | Output type-specific settings. | 
| videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. | 

### OutputDestination
<a name="channels-model-outputdestination"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | User-specified id. This is used in an output group or an output. | 
| mediaPackageSettings | Array of type [MediaPackageOutputDestinationSettings](#channels-model-mediapackageoutputdestinationsettings) | False | Destination settings for a MediaPackage output; one destination for both encoders. | 
| multiplexSettings | [MultiplexProgramChannelDestinationSettings](#channels-model-multiplexprogramchanneldestinationsettings) | False | Destination settings for a Multiplex output; one destination for both encoders. | 
| settings | Array of type [OutputDestinationSettings](#channels-model-outputdestinationsettings) | False | Destination settings for a standard output; one destination for each redundant encoder. | 

### OutputDestinationSettings
<a name="channels-model-outputdestinationsettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) | 
| url | string | False | A URL specifying a destination | 
| username | string | False | username for destination | 

### OutputGroup
<a name="channels-model-outputgroup"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. | 
| outputGroupSettings | [OutputGroupSettings](#channels-model-outputgroupsettings) | True | Settings associated with the output group. | 
| outputs | Array of type [Output](#channels-model-output) | True |  | 

### OutputGroupSettings
<a name="channels-model-outputgroupsettings"></a>

Output Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveGroupSettings | [ArchiveGroupSettings](#channels-model-archivegroupsettings) | False |  | 
| frameCaptureGroupSettings | [FrameCaptureGroupSettings](#channels-model-framecapturegroupsettings) | False |  | 
| hlsGroupSettings | [HlsGroupSettings](#channels-model-hlsgroupsettings) | False |  | 
| mediaPackageGroupSettings | [MediaPackageGroupSettings](#channels-model-mediapackagegroupsettings) | False |  | 
| msSmoothGroupSettings | [MsSmoothGroupSettings](#channels-model-mssmoothgroupsettings) | False |  | 
| multiplexGroupSettings | [MultiplexGroupSettings](#channels-model-multiplexgroupsettings) | False |  | 
| rtmpGroupSettings | [RtmpGroupSettings](#channels-model-rtmpgroupsettings) | False |  | 
| udpGroupSettings | [UdpGroupSettings](#channels-model-udpgroupsettings) | False |  | 

### OutputLocationRef
<a name="channels-model-outputlocationref"></a>

Reference to an OutputDestination ID defined in the channel


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

### OutputSettings
<a name="channels-model-outputsettings"></a>

Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveOutputSettings | [ArchiveOutputSettings](#channels-model-archiveoutputsettings) | False |  | 
| frameCaptureOutputSettings | [FrameCaptureOutputSettings](#channels-model-framecaptureoutputsettings) | False |  | 
| hlsOutputSettings | [HlsOutputSettings](#channels-model-hlsoutputsettings) | False |  | 
| mediaPackageOutputSettings | [MediaPackageOutputSettings](#channels-model-mediapackageoutputsettings) | False |  | 
| msSmoothOutputSettings | [MsSmoothOutputSettings](#channels-model-mssmoothoutputsettings) | False |  | 
| multiplexOutputSettings | [MultiplexOutputSettings](#channels-model-multiplexoutputsettings) | False |  | 
| rtmpOutputSettings | [RtmpOutputSettings](#channels-model-rtmpoutputsettings) | False |  | 
| udpOutputSettings | [UdpOutputSettings](#channels-model-udpoutputsettings) | False |  | 

### PassThroughSettings
<a name="channels-model-passthroughsettings"></a>

Pass Through Settings

### PipelineDetail
<a name="channels-model-pipelinedetail"></a>

Runtime details of a pipeline when a channel is running.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. | 
| activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. | 
| activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. | 
| activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. | 
| pipelineId | string | False | Pipeline ID | 

### RawSettings
<a name="channels-model-rawsettings"></a>

Raw Settings

### Rec601Settings
<a name="channels-model-rec601settings"></a>

Rec601 Settings

### Rec709Settings
<a name="channels-model-rec709settings"></a>

Rec709 Settings

### RemixSettings
<a name="channels-model-remixsettings"></a>

Remix Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelMappings | Array of type [AudioChannelMapping](#channels-model-audiochannelmapping) | True | Mapping of input channels to output channels, with appropriate gain adjustments. | 
| channelsIn | integerMinimum: 1Maximum: 16 | False | Number of input channels to be used. | 
| channelsOut | integerMinimum: 1Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 | 

### ResourceConflict
<a name="channels-model-resourceconflict"></a>


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

### RtmpAdMarkers
<a name="channels-model-rtmpadmarkers"></a>

Rtmp Ad Markers
+ `ON_CUE_POINT_SCTE35`

### RtmpCacheFullBehavior
<a name="channels-model-rtmpcachefullbehavior"></a>

Rtmp Cache Full Behavior
+ `DISCONNECT_IMMEDIATELY`
+ `WAIT_FOR_SERVER`

### RtmpCaptionData
<a name="channels-model-rtmpcaptiondata"></a>

Rtmp Caption Data
+ `ALL`
+ `FIELD1_608`
+ `FIELD1_AND_FIELD2_608`

### RtmpCaptionInfoDestinationSettings
<a name="channels-model-rtmpcaptioninfodestinationsettings"></a>

Rtmp Caption Info Destination Settings

### RtmpGroupSettings
<a name="channels-model-rtmpgroupsettings"></a>

Rtmp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [RtmpAdMarkers](#channels-model-rtmpadmarkers) | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. | 
| authenticationScheme | [AuthenticationScheme](#channels-model-authenticationscheme) | False | Authentication scheme to use when connecting with CDN | 
| cacheFullBehavior | [RtmpCacheFullBehavior](#channels-model-rtmpcachefullbehavior) | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | 
| cacheLength | integerMinimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. | 
| captionData | [RtmpCaptionData](#channels-model-rtmpcaptiondata) | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | 
| inputLossAction | [InputLossActionForRtmpOut](#channels-model-inputlossactionforrtmpout) | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | 
| restartDelay | integerMinimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### RtmpOutputCertificateMode
<a name="channels-model-rtmpoutputcertificatemode"></a>

Rtmp Output Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### RtmpOutputSettings
<a name="channels-model-rtmpoutputsettings"></a>

Rtmp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| certificateMode | [RtmpOutputCertificateMode](#channels-model-rtmpoutputcertificatemode) | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. | 
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 

### S3CannedAcl
<a name="channels-model-s3cannedacl"></a>

S3 Canned Acl
+ `AUTHENTICATED_READ`
+ `BUCKET_OWNER_FULL_CONTROL`
+ `BUCKET_OWNER_READ`
+ `PUBLIC_READ`

### Scte20Convert608To708
<a name="channels-model-scte20convert608to708"></a>

Scte20 Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### Scte20PlusEmbeddedDestinationSettings
<a name="channels-model-scte20plusembeddeddestinationsettings"></a>

Scte20 Plus Embedded Destination Settings

### Scte20SourceSettings
<a name="channels-model-scte20sourcesettings"></a>

Scte20 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [Scte20Convert608To708](#channels-model-scte20convert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 

### Scte27DestinationSettings
<a name="channels-model-scte27destinationsettings"></a>

Scte27 Destination Settings

### Scte27OcrLanguage
<a name="channels-model-scte27ocrlanguage"></a>

Scte27 Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### Scte27SourceSettings
<a name="channels-model-scte27sourcesettings"></a>

Scte27 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [Scte27OcrLanguage](#channels-model-scte27ocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. | 

### Scte35AposNoRegionalBlackoutBehavior
<a name="channels-model-scte35aposnoregionalblackoutbehavior"></a>

Scte35 Apos No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35AposWebDeliveryAllowedBehavior
<a name="channels-model-scte35aposwebdeliveryallowedbehavior"></a>

Scte35 Apos Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsert
<a name="channels-model-scte35spliceinsert"></a>

Scte35 Splice Insert


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35SpliceInsertNoRegionalBlackoutBehavior](#channels-model-scte35spliceinsertnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35SpliceInsertWebDeliveryAllowedBehavior](#channels-model-scte35spliceinsertwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### Scte35SpliceInsertNoRegionalBlackoutBehavior
<a name="channels-model-scte35spliceinsertnoregionalblackoutbehavior"></a>

Scte35 Splice Insert No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsertWebDeliveryAllowedBehavior
<a name="channels-model-scte35spliceinsertwebdeliveryallowedbehavior"></a>

Scte35 Splice Insert Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35TimeSignalApos
<a name="channels-model-scte35timesignalapos"></a>

Scte35 Time Signal Apos


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35AposNoRegionalBlackoutBehavior](#channels-model-scte35aposnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35AposWebDeliveryAllowedBehavior](#channels-model-scte35aposwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### SmoothGroupAudioOnlyTimecodeControl
<a name="channels-model-smoothgroupaudioonlytimecodecontrol"></a>

Smooth Group Audio Only Timecode Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED_CLOCK`

### SmoothGroupCertificateMode
<a name="channels-model-smoothgroupcertificatemode"></a>

Smooth Group Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### SmoothGroupEventIdMode
<a name="channels-model-smoothgroupeventidmode"></a>

Smooth Group Event Id Mode
+ `NO_EVENT_ID`
+ `USE_CONFIGURED`
+ `USE_TIMESTAMP`

### SmoothGroupEventStopBehavior
<a name="channels-model-smoothgroupeventstopbehavior"></a>

Smooth Group Event Stop Behavior
+ `NONE`
+ `SEND_EOS`

### SmoothGroupSegmentationMode
<a name="channels-model-smoothgroupsegmentationmode"></a>

Smooth Group Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### SmoothGroupSparseTrackType
<a name="channels-model-smoothgroupsparsetracktype"></a>

Smooth Group Sparse Track Type
+ `NONE`
+ `SCTE_35`
+ `SCTE_35_WITHOUT_SEGMENTATION`

### SmoothGroupStreamManifestBehavior
<a name="channels-model-smoothgroupstreammanifestbehavior"></a>

Smooth Group Stream Manifest Behavior
+ `DO_NOT_SEND`
+ `SEND`

### SmoothGroupTimestampOffsetMode
<a name="channels-model-smoothgrouptimestampoffsetmode"></a>

Smooth Group Timestamp Offset Mode
+ `USE_CONFIGURED_OFFSET`
+ `USE_EVENT_START_DATE`

### Smpte2038DataPreference
<a name="channels-model-smpte2038datapreference"></a>

Smpte2038 Data Preference
+ `IGNORE`
+ `PREFER`

### SmpteTtDestinationSettings
<a name="channels-model-smptettdestinationsettings"></a>

Smpte Tt Destination Settings

### StandardHlsSettings
<a name="channels-model-standardhlssettings"></a>

Standard Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| m3u8Settings | [M3u8Settings](#channels-model-m3u8settings) | True |  | 

### StaticKeySettings
<a name="channels-model-statickeysettings"></a>

Static Key Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| keyProviderServer | [InputLocation](#channels-model-inputlocation) | False | The URL of the license server used for protecting content. | 
| staticKeyValue | stringMinLength: 32MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. | 

### Tags
<a name="channels-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TeletextDestinationSettings
<a name="channels-model-teletextdestinationsettings"></a>

Teletext Destination Settings

### TeletextSourceSettings
<a name="channels-model-teletextsourcesettings"></a>

Teletext Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputRectangle | [CaptionRectangle](#channels-model-captionrectangle) | False | Optionally defines a region where TTML style captions will be displayed | 
| pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. | 

### TemporalFilterPostFilterSharpening
<a name="channels-model-temporalfilterpostfiltersharpening"></a>

Temporal Filter Post Filter Sharpening
+ `AUTO`
+ `DISABLED`
+ `ENABLED`

### TemporalFilterSettings
<a name="channels-model-temporalfiltersettings"></a>

Temporal Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| postFilterSharpening | [TemporalFilterPostFilterSharpening](#channels-model-temporalfilterpostfiltersharpening) | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | 
| strength | [TemporalFilterStrength](#channels-model-temporalfilterstrength) | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. | 

### TemporalFilterStrength
<a name="channels-model-temporalfilterstrength"></a>

Temporal Filter Strength
+ `AUTO`
+ `STRENGTH_1`
+ `STRENGTH_2`
+ `STRENGTH_3`
+ `STRENGTH_4`
+ `STRENGTH_5`
+ `STRENGTH_6`
+ `STRENGTH_7`
+ `STRENGTH_8`
+ `STRENGTH_9`
+ `STRENGTH_10`
+ `STRENGTH_11`
+ `STRENGTH_12`
+ `STRENGTH_13`
+ `STRENGTH_14`
+ `STRENGTH_15`
+ `STRENGTH_16`

### TimecodeConfig
<a name="channels-model-timecodeconfig"></a>

Timecode Config


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| source | [TimecodeConfigSource](#channels-model-timecodeconfigsource) | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | 
| syncThreshold | integerMinimum: 1Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. | 

### TimecodeConfigSource
<a name="channels-model-timecodeconfigsource"></a>

Timecode Config Source
+ `EMBEDDED`
+ `SYSTEMCLOCK`
+ `ZEROBASED`

### TtmlDestinationSettings
<a name="channels-model-ttmldestinationsettings"></a>

Ttml Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [TtmlDestinationStyleControl](#channels-model-ttmldestinationstylecontrol) | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. | 

### TtmlDestinationStyleControl
<a name="channels-model-ttmldestinationstylecontrol"></a>

Ttml Destination Style Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED`

### UdpContainerSettings
<a name="channels-model-udpcontainersettings"></a>

Udp Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-model-m2tssettings) | False |  | 

### UdpGroupSettings
<a name="channels-model-udpgroupsettings"></a>

Udp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossAction | [InputLossActionForUdpOut](#channels-model-inputlossactionforudpout) | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | 
| timedMetadataId3Frame | [UdpTimedMetadataId3Frame](#channels-model-udptimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 

### UdpOutputSettings
<a name="channels-model-udpoutputsettings"></a>

Udp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bufferMsec | integerMinimum: 0Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. | 
| containerSettings | [UdpContainerSettings](#channels-model-udpcontainersettings) | True |  | 
| destination | [OutputLocationRef](#channels-model-outputlocationref) | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | 
| fecOutputSettings | [FecOutputSettings](#channels-model-fecoutputsettings) | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. | 

### UdpTimedMetadataId3Frame
<a name="channels-model-udptimedmetadataid3frame"></a>

Udp Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### ValidationError
<a name="channels-model-validationerror"></a>


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

### VideoBlackFailoverSettings
<a name="channels-model-videoblackfailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackDetectThreshold | numberMinimum: 0Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\$10.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\$10.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. | 
| videoBlackThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. | 

### VideoCodecSettings
<a name="channels-model-videocodecsettings"></a>

Video Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureSettings | [FrameCaptureSettings](#channels-model-framecapturesettings) | False |  | 
| h264Settings | [H264Settings](#channels-model-h264settings) | False |  | 
| h265Settings | [H265Settings](#channels-model-h265settings) | False |  | 
| mpeg2Settings | [Mpeg2Settings](#channels-model-mpeg2settings) | False |  | 

### VideoDescription
<a name="channels-model-videodescription"></a>

Video settings for this stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codecSettings | [VideoCodecSettings](#channels-model-videocodecsettings) | False | Video codec settings. | 
| height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 
| name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. | 
| respondToAfd | [VideoDescriptionRespondToAfd](#channels-model-videodescriptionrespondtoafd) | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME\$1CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | 
| scalingBehavior | [VideoDescriptionScalingBehavior](#channels-model-videodescriptionscalingbehavior) | False | STRETCH\$1TO\$1OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | 
| sharpness | integerMinimum: 0Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. | 
| width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 

### VideoDescriptionRespondToAfd
<a name="channels-model-videodescriptionrespondtoafd"></a>

Video Description Respond To Afd
+ `NONE`
+ `PASSTHROUGH`
+ `RESPOND`

### VideoDescriptionScalingBehavior
<a name="channels-model-videodescriptionscalingbehavior"></a>

Video Description Scaling Behavior
+ `DEFAULT`
+ `STRETCH_TO_OUTPUT`

### VideoSelector
<a name="channels-model-videoselector"></a>

Specifies a particular video stream within an input source. An input may have only a single video selector.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpace | [VideoSelectorColorSpace](#channels-model-videoselectorcolorspace) | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | 
| colorSpaceSettings | [VideoSelectorColorSpaceSettings](#channels-model-videoselectorcolorspacesettings) | False | Color space settings | 
| colorSpaceUsage | [VideoSelectorColorSpaceUsage](#channels-model-videoselectorcolorspaceusage) | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | 
| selectorSettings | [VideoSelectorSettings](#channels-model-videoselectorsettings) | False | The video selector settings. | 

### VideoSelectorColorSpace
<a name="channels-model-videoselectorcolorspace"></a>

Video Selector Color Space
+ `FOLLOW`
+ `HDR10`
+ `HLG_2020`
+ `REC_601`
+ `REC_709`

### VideoSelectorColorSpaceSettings
<a name="channels-model-videoselectorcolorspacesettings"></a>

Video Selector Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hdr10Settings | [Hdr10Settings](#channels-model-hdr10settings) | False |  | 

### VideoSelectorColorSpaceUsage
<a name="channels-model-videoselectorcolorspaceusage"></a>

Video Selector Color Space Usage
+ `FALLBACK`
+ `FORCE`

### VideoSelectorPid
<a name="channels-model-videoselectorpid"></a>

Video Selector Pid


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | False | Selects a specific PID from within a video source. | 

### VideoSelectorProgramId
<a name="channels-model-videoselectorprogramid"></a>

Video Selector Program Id


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| programId | integerMinimum: 0Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. | 

### VideoSelectorSettings
<a name="channels-model-videoselectorsettings"></a>

Video Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| videoSelectorPid | [VideoSelectorPid](#channels-model-videoselectorpid) | False |  | 
| videoSelectorProgramId | [VideoSelectorProgramId](#channels-model-videoselectorprogramid) | False |  | 

### VpcOutputSettings
<a name="channels-model-vpcoutputsettings"></a>

The properties for a private VPC Output When this property is specified, the output egress addresses will be created in a user specified VPC 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| publicAddressAllocationIds | Array of type string | False | List of public address allocation ids to associate with ENIs that will be created in Output VPC. Must specify one for SINGLE\$1PIPELINE, two for STANDARD channels  | 
| securityGroupIds | Array of type string | False | A list of up to 5 EC2 VPC security group IDs to attach to the Output VPC network interfaces. If none are specified then the VPC default security group will be used  | 
| subnetIds | Array of type string | True | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### VpcOutputSettingsDescription
<a name="channels-model-vpcoutputsettingsdescription"></a>

The properties for a private VPC Output 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet.  | 
| networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC  | 
| securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.  | 
| subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### WavCodingMode
<a name="channels-model-wavcodingmode"></a>

Wav Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_4_0`
+ `CODING_MODE_8_0`

### WavSettings
<a name="channels-model-wavsettings"></a>

Wav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitDepth | number | False | Bits per sample. | 
| codingMode | [WavCodingMode](#channels-model-wavcodingmode) | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | 
| sampleRate | number | False | Sample rate in Hz. | 

### WebvttDestinationSettings
<a name="channels-model-webvttdestinationsettings"></a>

Webvtt Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [WebvttDestinationStyleControl](#channels-model-webvttdestinationstylecontrol) | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\$1STYLE\$1DATA - Don't pass through the style. The output captions will not contain any font styling information. | 

### WebvttDestinationStyleControl
<a name="channels-model-webvttdestinationstylecontrol"></a>

Webvtt Destination Style Control
+ `NO_STYLE_DATA`
+ `PASSTHROUGH`

## See also
<a name="channels-see-also"></a>

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

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

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

# Channels: channel ID
<a name="channels-channelid"></a>

## URI
<a name="channels-channelid-url"></a>

`/prod/channels/channelId`

## HTTP methods
<a name="channels-channelid-http-methods"></a>

### DELETE
<a name="channels-channeliddelete"></a>

**Operation ID:** `DeleteChannel`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Channel | 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="channels-channelidget"></a>

**Operation ID:** `DescribeChannel`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Channel | 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="channels-channelidput"></a>

**Operation ID:** `UpdateChannel`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateChannelResultModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ChannelConfigurationValidationError | 422 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="channels-channelid-schemas"></a>

### Request bodies
<a name="channels-channelid-request-examples"></a>

#### PUT schema
<a name="channels-channelid-request-body-put-example"></a>

```
{
  "cdiInputSpecification": {
    "resolution": enum
  },
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ],
  "encoderSettings": {
    "audioDescriptions": [
      {
        "audioNormalizationSettings": {
          "algorithm": enum,
          "algorithmControl": enum,
          "targetLkfs": number
        },
        "audioSelectorName": "string",
        "audioType": enum,
        "audioTypeControl": enum,
        "audioWatermarkingSettings": {
          "nielsenWatermarksSettings": {
            "nielsenCbetSettings": {
              "cbetCheckDigitString": "string",
              "cbetStepaside": enum,
              "csid": "string"
            },
            "nielsenDistributionType": enum,
            "nielsenNaesIiNwSettings": {
              "checkDigitString": "string",
              "sid": number
            }
          }
        },
        "codecSettings": {
          "aacSettings": {
            "bitrate": number,
            "codingMode": enum,
            "inputType": enum,
            "profile": enum,
            "rateControlMode": enum,
            "rawFormat": enum,
            "sampleRate": number,
            "spec": enum,
            "vbrQuality": enum
          },
          "ac3Settings": {
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dialnorm": integer,
            "drcProfile": enum,
            "lfeFilter": enum,
            "metadataControl": enum
          },
          "eac3Settings": {
            "attenuationControl": enum,
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dcFilter": enum,
            "dialnorm": integer,
            "drcLine": enum,
            "drcRf": enum,
            "lfeControl": enum,
            "lfeFilter": enum,
            "loRoCenterMixLevel": number,
            "loRoSurroundMixLevel": number,
            "ltRtCenterMixLevel": number,
            "ltRtSurroundMixLevel": number,
            "metadataControl": enum,
            "passthroughControl": enum,
            "phaseControl": enum,
            "stereoDownmix": enum,
            "surroundExMode": enum,
            "surroundMode": enum
          },
          "mp2Settings": {
            "bitrate": number,
            "codingMode": enum,
            "sampleRate": number
          },
          "passThroughSettings": {
          },
          "wavSettings": {
            "bitDepth": number,
            "codingMode": enum,
            "sampleRate": number
          }
        },
        "languageCode": "string",
        "languageCodeControl": enum,
        "name": "string",
        "remixSettings": {
          "channelMappings": [
            {
              "inputChannelLevels": [
                {
                  "gain": integer,
                  "inputChannel": integer
                }
              ],
              "outputChannel": integer
            }
          ],
          "channelsIn": integer,
          "channelsOut": integer
        },
        "streamName": "string"
      }
    ],
    "availBlanking": {
      "availBlankingImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "state": enum
    },
    "availConfiguration": {
      "availSettings": {
        "scte35SpliceInsert": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        },
        "scte35TimeSignalApos": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        }
      }
    },
    "blackoutSlate": {
      "blackoutSlateImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkEndBlackout": enum,
      "networkEndBlackoutImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkId": "string",
      "state": enum
    },
    "captionDescriptions": [
      {
        "captionSelectorName": "string",
        "destinationSettings": {
          "aribDestinationSettings": {
          },
          "burnInDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "dvbSubDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "ebuTtDDestinationSettings": {
            "copyrightHolder": "string",
            "fillLineGap": enum,
            "fontFamily": "string",
            "styleControl": enum
          },
          "embeddedDestinationSettings": {
          },
          "embeddedPlusScte20DestinationSettings": {
          },
          "rtmpCaptionInfoDestinationSettings": {
          },
          "scte20PlusEmbeddedDestinationSettings": {
          },
          "scte27DestinationSettings": {
          },
          "smpteTtDestinationSettings": {
          },
          "teletextDestinationSettings": {
          },
          "ttmlDestinationSettings": {
            "styleControl": enum
          },
          "webvttDestinationSettings": {
            "styleControl": enum
          }
        },
        "languageCode": "string",
        "languageDescription": "string",
        "name": "string"
      }
    ],
    "featureActivations": {
      "inputPrepareScheduleActions": enum
    },
    "globalConfiguration": {
      "initialAudioGain": integer,
      "inputEndAction": enum,
      "inputLossBehavior": {
        "blackFrameMsec": integer,
        "inputLossImageColor": "string",
        "inputLossImageSlate": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "inputLossImageType": enum,
        "repeatFrameMsec": integer
      },
      "outputLockingMode": enum,
      "outputTimingSource": enum,
      "supportLowFramerateInputs": enum
    },
    "motionGraphicsConfiguration": {
      "motionGraphicsInsertion": enum,
      "motionGraphicsSettings": {
        "htmlMotionGraphicsSettings": {
        }
      }
    },
    "nielsenConfiguration": {
      "distributorId": "string",
      "nielsenPcmToId3Tagging": enum
    },
    "outputGroups": [
      {
        "name": "string",
        "outputGroupSettings": {
          "archiveGroupSettings": {
            "archiveCdnSettings": {
              "archiveS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            },
            "destination": {
              "destinationRefId": "string"
            },
            "rolloverInterval": integer
          },
          "frameCaptureGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            },
            "frameCaptureCdnSettings": {
              "frameCaptureS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            }
          },
          "hlsGroupSettings": {
            "adMarkers": [
              enum
            ],
            "baseUrlContent": "string",
            "baseUrlContent1": "string",
            "baseUrlManifest": "string",
            "baseUrlManifest1": "string",
            "captionLanguageMappings": [
              {
                "captionChannel": integer,
                "languageCode": "string",
                "languageDescription": "string"
              }
            ],
            "captionLanguageSetting": enum,
            "clientCache": enum,
            "codecSpecification": enum,
            "constantIv": "string",
            "destination": {
              "destinationRefId": "string"
            },
            "directoryStructure": enum,
            "discontinuityTags": enum,
            "encryptionType": enum,
            "hlsCdnSettings": {
              "hlsAkamaiSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer,
                "salt": "string",
                "token": "string"
              },
              "hlsBasicPutSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsMediaStoreSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "mediaStoreStorageClass": enum,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              },
              "hlsWebdavSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer
              }
            },
            "hlsId3SegmentTagging": enum,
            "iFrameOnlyPlaylists": enum,
            "incompleteSegmentBehavior": enum,
            "indexNSegments": integer,
            "inputLossAction": enum,
            "ivInManifest": enum,
            "ivSource": enum,
            "keepSegments": integer,
            "keyFormat": "string",
            "keyFormatVersions": "string",
            "keyProviderSettings": {
              "staticKeySettings": {
                "keyProviderServer": {
                  "passwordParam": "string",
                  "uri": "string",
                  "username": "string"
                },
                "staticKeyValue": "string"
              }
            },
            "manifestCompression": enum,
            "manifestDurationFormat": enum,
            "minSegmentLength": integer,
            "mode": enum,
            "outputSelection": enum,
            "programDateTime": enum,
            "programDateTimeClock": enum,
            "programDateTimePeriod": integer,
            "redundantManifest": enum,
            "segmentLength": integer,
            "segmentationMode": enum,
            "segmentsPerSubdirectory": integer,
            "streamInfResolution": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer,
            "timestampDeltaMilliseconds": integer,
            "tsFileMode": enum
          },
          "mediaPackageGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            }
          },
          "msSmoothGroupSettings": {
            "acquisitionPointId": "string",
            "audioOnlyTimecodeControl": enum,
            "certificateMode": enum,
            "connectionRetryInterval": integer,
            "destination": {
              "destinationRefId": "string"
            },
            "eventId": "string",
            "eventIdMode": enum,
            "eventStopBehavior": enum,
            "filecacheDuration": integer,
            "fragmentLength": integer,
            "inputLossAction": enum,
            "numRetries": integer,
            "restartDelay": integer,
            "segmentationMode": enum,
            "sendDelayMs": integer,
            "sparseTrackType": enum,
            "streamManifestBehavior": enum,
            "timestampOffset": "string",
            "timestampOffsetMode": enum
          },
          "multiplexGroupSettings": {
          },
          "rtmpGroupSettings": {
            "adMarkers": [
              enum
            ],
            "authenticationScheme": enum,
            "cacheFullBehavior": enum,
            "cacheLength": integer,
            "captionData": enum,
            "inputLossAction": enum,
            "restartDelay": integer
          },
          "udpGroupSettings": {
            "inputLossAction": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer
          }
        },
        "outputs": [
          {
            "audioDescriptionNames": [
              "string"
            ],
            "captionDescriptionNames": [
              "string"
            ],
            "outputName": "string",
            "outputSettings": {
              "archiveOutputSettings": {
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  },
                  "rawSettings": {
                  }
                },
                "extension": "string",
                "nameModifier": "string"
              },
              "frameCaptureOutputSettings": {
                "nameModifier": "string"
              },
              "hlsOutputSettings": {
                "h265PackagingType": enum,
                "hlsSettings": {
                  "audioOnlyHlsSettings": {
                    "audioGroupId": "string",
                    "audioOnlyImage": {
                      "passwordParam": "string",
                      "uri": "string",
                      "username": "string"
                    },
                    "audioTrackType": enum,
                    "segmentType": enum
                  },
                  "fmp4HlsSettings": {
                    "audioRenditionSets": "string",
                    "nielsenId3Behavior": enum,
                    "timedMetadataBehavior": enum
                  },
                  "frameCaptureHlsSettings": {
                  },
                  "standardHlsSettings": {
                    "audioRenditionSets": "string",
                    "m3u8Settings": {
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "ecmPid": "string",
                      "nielsenId3Behavior": enum,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "scte35Behavior": enum,
                      "scte35Pid": "string",
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  }
                },
                "nameModifier": "string",
                "segmentModifier": "string"
              },
              "mediaPackageOutputSettings": {
              },
              "msSmoothOutputSettings": {
                "h265PackagingType": enum,
                "nameModifier": "string"
              },
              "multiplexOutputSettings": {
                "destination": {
                  "destinationRefId": "string"
                }
              },
              "rtmpOutputSettings": {
                "certificateMode": enum,
                "connectionRetryInterval": integer,
                "destination": {
                  "destinationRefId": "string"
                },
                "numRetries": integer
              },
              "udpOutputSettings": {
                "bufferMsec": integer,
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  }
                },
                "destination": {
                  "destinationRefId": "string"
                },
                "fecOutputSettings": {
                  "columnDepth": integer,
                  "includeFec": enum,
                  "rowLength": integer
                }
              }
            },
            "videoDescriptionName": "string"
          }
        ]
      }
    ],
    "timecodeConfig": {
      "source": enum,
      "syncThreshold": integer
    },
    "videoDescriptions": [
      {
        "codecSettings": {
          "frameCaptureSettings": {
            "captureInterval": integer,
            "captureIntervalUnits": enum
          },
          "h264Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "bitrate": integer,
            "bufFillPct": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "entropyEncoding": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "forceFieldPictures": enum,
            "framerateControl": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopBReference": enum,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "numRefFrames": integer,
            "parControl": enum,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qualityLevel": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "softness": integer,
            "spatialAq": enum,
            "subgopLength": enum,
            "syntax": enum,
            "temporalAq": enum,
            "timecodeInsertion": enum
          },
          "h265Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "alternativeTransferFunction": enum,
            "bitrate": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "tier": enum,
            "timecodeInsertion": enum
          },
          "mpeg2Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "colorMetadata": enum,
            "colorSpace": enum,
            "displayAspectRatio": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "scanType": enum,
            "subgopLength": enum,
            "timecodeInsertion": enum
          }
        },
        "height": integer,
        "name": "string",
        "respondToAfd": enum,
        "scalingBehavior": enum,
        "sharpness": integer,
        "width": integer
      }
    ]
  },
  "inputAttachments": [
    {
      "automaticInputFailoverSettings": {
        "errorClearTimeMsec": integer,
        "failoverConditions": [
          {
            "failoverConditionSettings": {
              "audioSilenceSettings": {
                "audioSelectorName": "string",
                "audioSilenceThresholdMsec": integer
              },
              "inputLossSettings": {
                "inputLossThresholdMsec": integer
              },
              "videoBlackSettings": {
                "blackDetectThreshold": number,
                "videoBlackThresholdMsec": integer
              }
            }
          }
        ],
        "inputPreference": enum,
        "secondaryInputId": "string"
      },
      "inputAttachmentName": "string",
      "inputId": "string",
      "inputSettings": {
        "audioSelectors": [
          {
            "name": "string",
            "selectorSettings": {
              "audioHlsRenditionSelection": {
                "groupId": "string",
                "name": "string"
              },
              "audioLanguageSelection": {
                "languageCode": "string",
                "languageSelectionPolicy": enum
              },
              "audioPidSelection": {
                "pid": integer
              },
              "audioTrackSelection": {
                "tracks": [
                  {
                    "track": integer
                  }
                ]
              }
            }
          }
        ],
        "captionSelectors": [
          {
            "languageCode": "string",
            "name": "string",
            "selectorSettings": {
              "ancillarySourceSettings": {
                "sourceAncillaryChannelNumber": integer
              },
              "aribSourceSettings": {
              },
              "dvbSubSourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "embeddedSourceSettings": {
                "convert608To708": enum,
                "scte20Detection": enum,
                "source608ChannelNumber": integer,
                "source608TrackNumber": integer
              },
              "scte20SourceSettings": {
                "convert608To708": enum,
                "source608ChannelNumber": integer
              },
              "scte27SourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "teletextSourceSettings": {
                "outputRectangle": {
                  "height": number,
                  "leftOffset": number,
                  "topOffset": number,
                  "width": number
                },
                "pageNumber": "string"
              }
            }
          }
        ],
        "deblockFilter": enum,
        "denoiseFilter": enum,
        "filterStrength": integer,
        "inputFilter": enum,
        "networkInputSettings": {
          "hlsInputSettings": {
            "bandwidth": integer,
            "bufferSegments": integer,
            "retries": integer,
            "retryInterval": integer,
            "scte35Source": enum
          },
          "serverValidation": enum
        },
        "smpte2038DataPreference": enum,
        "sourceEndBehavior": enum,
        "videoSelector": {
          "colorSpace": enum,
          "colorSpaceSettings": {
            "hdr10Settings": {
              "maxCll": integer,
              "maxFall": integer
            }
          },
          "colorSpaceUsage": enum,
          "selectorSettings": {
            "videoSelectorPid": {
              "pid": integer
            },
            "videoSelectorProgramId": {
              "programId": integer
            }
          }
        }
      }
    }
  ],
  "inputSpecification": {
    "codec": enum,
    "maximumBitrate": enum,
    "resolution": enum
  },
  "logLevel": enum,
  "maintenance": {
    "maintenanceDay": enum,
    "maintenanceScheduledDate": "string",
    "maintenanceStartTime": "string"
  },
  "name": "string",
  "roleArn": "string"
}
```

### Response bodies
<a name="channels-channelid-response-examples"></a>

#### Channel schema
<a name="channels-channelid-response-body-channel-example"></a>

```
{
  "arn": "string",
  "cdiInputSpecification": {
    "resolution": enum
  },
  "channelClass": enum,
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ],
  "egressEndpoints": [
    {
      "sourceIp": "string"
    }
  ],
  "encoderSettings": {
    "audioDescriptions": [
      {
        "audioNormalizationSettings": {
          "algorithm": enum,
          "algorithmControl": enum,
          "targetLkfs": number
        },
        "audioSelectorName": "string",
        "audioType": enum,
        "audioTypeControl": enum,
        "audioWatermarkingSettings": {
          "nielsenWatermarksSettings": {
            "nielsenCbetSettings": {
              "cbetCheckDigitString": "string",
              "cbetStepaside": enum,
              "csid": "string"
            },
            "nielsenDistributionType": enum,
            "nielsenNaesIiNwSettings": {
              "checkDigitString": "string",
              "sid": number
            }
          }
        },
        "codecSettings": {
          "aacSettings": {
            "bitrate": number,
            "codingMode": enum,
            "inputType": enum,
            "profile": enum,
            "rateControlMode": enum,
            "rawFormat": enum,
            "sampleRate": number,
            "spec": enum,
            "vbrQuality": enum
          },
          "ac3Settings": {
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dialnorm": integer,
            "drcProfile": enum,
            "lfeFilter": enum,
            "metadataControl": enum
          },
          "eac3Settings": {
            "attenuationControl": enum,
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dcFilter": enum,
            "dialnorm": integer,
            "drcLine": enum,
            "drcRf": enum,
            "lfeControl": enum,
            "lfeFilter": enum,
            "loRoCenterMixLevel": number,
            "loRoSurroundMixLevel": number,
            "ltRtCenterMixLevel": number,
            "ltRtSurroundMixLevel": number,
            "metadataControl": enum,
            "passthroughControl": enum,
            "phaseControl": enum,
            "stereoDownmix": enum,
            "surroundExMode": enum,
            "surroundMode": enum
          },
          "mp2Settings": {
            "bitrate": number,
            "codingMode": enum,
            "sampleRate": number
          },
          "passThroughSettings": {
          },
          "wavSettings": {
            "bitDepth": number,
            "codingMode": enum,
            "sampleRate": number
          }
        },
        "languageCode": "string",
        "languageCodeControl": enum,
        "name": "string",
        "remixSettings": {
          "channelMappings": [
            {
              "inputChannelLevels": [
                {
                  "gain": integer,
                  "inputChannel": integer
                }
              ],
              "outputChannel": integer
            }
          ],
          "channelsIn": integer,
          "channelsOut": integer
        },
        "streamName": "string"
      }
    ],
    "availBlanking": {
      "availBlankingImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "state": enum
    },
    "availConfiguration": {
      "availSettings": {
        "scte35SpliceInsert": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        },
        "scte35TimeSignalApos": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        }
      }
    },
    "blackoutSlate": {
      "blackoutSlateImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkEndBlackout": enum,
      "networkEndBlackoutImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkId": "string",
      "state": enum
    },
    "captionDescriptions": [
      {
        "captionSelectorName": "string",
        "destinationSettings": {
          "aribDestinationSettings": {
          },
          "burnInDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "dvbSubDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "ebuTtDDestinationSettings": {
            "copyrightHolder": "string",
            "fillLineGap": enum,
            "fontFamily": "string",
            "styleControl": enum
          },
          "embeddedDestinationSettings": {
          },
          "embeddedPlusScte20DestinationSettings": {
          },
          "rtmpCaptionInfoDestinationSettings": {
          },
          "scte20PlusEmbeddedDestinationSettings": {
          },
          "scte27DestinationSettings": {
          },
          "smpteTtDestinationSettings": {
          },
          "teletextDestinationSettings": {
          },
          "ttmlDestinationSettings": {
            "styleControl": enum
          },
          "webvttDestinationSettings": {
            "styleControl": enum
          }
        },
        "languageCode": "string",
        "languageDescription": "string",
        "name": "string"
      }
    ],
    "featureActivations": {
      "inputPrepareScheduleActions": enum
    },
    "globalConfiguration": {
      "initialAudioGain": integer,
      "inputEndAction": enum,
      "inputLossBehavior": {
        "blackFrameMsec": integer,
        "inputLossImageColor": "string",
        "inputLossImageSlate": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "inputLossImageType": enum,
        "repeatFrameMsec": integer
      },
      "outputLockingMode": enum,
      "outputTimingSource": enum,
      "supportLowFramerateInputs": enum
    },
    "motionGraphicsConfiguration": {
      "motionGraphicsInsertion": enum,
      "motionGraphicsSettings": {
        "htmlMotionGraphicsSettings": {
        }
      }
    },
    "nielsenConfiguration": {
      "distributorId": "string",
      "nielsenPcmToId3Tagging": enum
    },
    "outputGroups": [
      {
        "name": "string",
        "outputGroupSettings": {
          "archiveGroupSettings": {
            "archiveCdnSettings": {
              "archiveS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            },
            "destination": {
              "destinationRefId": "string"
            },
            "rolloverInterval": integer
          },
          "frameCaptureGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            },
            "frameCaptureCdnSettings": {
              "frameCaptureS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            }
          },
          "hlsGroupSettings": {
            "adMarkers": [
              enum
            ],
            "baseUrlContent": "string",
            "baseUrlContent1": "string",
            "baseUrlManifest": "string",
            "baseUrlManifest1": "string",
            "captionLanguageMappings": [
              {
                "captionChannel": integer,
                "languageCode": "string",
                "languageDescription": "string"
              }
            ],
            "captionLanguageSetting": enum,
            "clientCache": enum,
            "codecSpecification": enum,
            "constantIv": "string",
            "destination": {
              "destinationRefId": "string"
            },
            "directoryStructure": enum,
            "discontinuityTags": enum,
            "encryptionType": enum,
            "hlsCdnSettings": {
              "hlsAkamaiSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer,
                "salt": "string",
                "token": "string"
              },
              "hlsBasicPutSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsMediaStoreSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "mediaStoreStorageClass": enum,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              },
              "hlsWebdavSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer
              }
            },
            "hlsId3SegmentTagging": enum,
            "iFrameOnlyPlaylists": enum,
            "incompleteSegmentBehavior": enum,
            "indexNSegments": integer,
            "inputLossAction": enum,
            "ivInManifest": enum,
            "ivSource": enum,
            "keepSegments": integer,
            "keyFormat": "string",
            "keyFormatVersions": "string",
            "keyProviderSettings": {
              "staticKeySettings": {
                "keyProviderServer": {
                  "passwordParam": "string",
                  "uri": "string",
                  "username": "string"
                },
                "staticKeyValue": "string"
              }
            },
            "manifestCompression": enum,
            "manifestDurationFormat": enum,
            "minSegmentLength": integer,
            "mode": enum,
            "outputSelection": enum,
            "programDateTime": enum,
            "programDateTimeClock": enum,
            "programDateTimePeriod": integer,
            "redundantManifest": enum,
            "segmentLength": integer,
            "segmentationMode": enum,
            "segmentsPerSubdirectory": integer,
            "streamInfResolution": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer,
            "timestampDeltaMilliseconds": integer,
            "tsFileMode": enum
          },
          "mediaPackageGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            }
          },
          "msSmoothGroupSettings": {
            "acquisitionPointId": "string",
            "audioOnlyTimecodeControl": enum,
            "certificateMode": enum,
            "connectionRetryInterval": integer,
            "destination": {
              "destinationRefId": "string"
            },
            "eventId": "string",
            "eventIdMode": enum,
            "eventStopBehavior": enum,
            "filecacheDuration": integer,
            "fragmentLength": integer,
            "inputLossAction": enum,
            "numRetries": integer,
            "restartDelay": integer,
            "segmentationMode": enum,
            "sendDelayMs": integer,
            "sparseTrackType": enum,
            "streamManifestBehavior": enum,
            "timestampOffset": "string",
            "timestampOffsetMode": enum
          },
          "multiplexGroupSettings": {
          },
          "rtmpGroupSettings": {
            "adMarkers": [
              enum
            ],
            "authenticationScheme": enum,
            "cacheFullBehavior": enum,
            "cacheLength": integer,
            "captionData": enum,
            "inputLossAction": enum,
            "restartDelay": integer
          },
          "udpGroupSettings": {
            "inputLossAction": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer
          }
        },
        "outputs": [
          {
            "audioDescriptionNames": [
              "string"
            ],
            "captionDescriptionNames": [
              "string"
            ],
            "outputName": "string",
            "outputSettings": {
              "archiveOutputSettings": {
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  },
                  "rawSettings": {
                  }
                },
                "extension": "string",
                "nameModifier": "string"
              },
              "frameCaptureOutputSettings": {
                "nameModifier": "string"
              },
              "hlsOutputSettings": {
                "h265PackagingType": enum,
                "hlsSettings": {
                  "audioOnlyHlsSettings": {
                    "audioGroupId": "string",
                    "audioOnlyImage": {
                      "passwordParam": "string",
                      "uri": "string",
                      "username": "string"
                    },
                    "audioTrackType": enum,
                    "segmentType": enum
                  },
                  "fmp4HlsSettings": {
                    "audioRenditionSets": "string",
                    "nielsenId3Behavior": enum,
                    "timedMetadataBehavior": enum
                  },
                  "frameCaptureHlsSettings": {
                  },
                  "standardHlsSettings": {
                    "audioRenditionSets": "string",
                    "m3u8Settings": {
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "ecmPid": "string",
                      "nielsenId3Behavior": enum,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "scte35Behavior": enum,
                      "scte35Pid": "string",
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  }
                },
                "nameModifier": "string",
                "segmentModifier": "string"
              },
              "mediaPackageOutputSettings": {
              },
              "msSmoothOutputSettings": {
                "h265PackagingType": enum,
                "nameModifier": "string"
              },
              "multiplexOutputSettings": {
                "destination": {
                  "destinationRefId": "string"
                }
              },
              "rtmpOutputSettings": {
                "certificateMode": enum,
                "connectionRetryInterval": integer,
                "destination": {
                  "destinationRefId": "string"
                },
                "numRetries": integer
              },
              "udpOutputSettings": {
                "bufferMsec": integer,
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  }
                },
                "destination": {
                  "destinationRefId": "string"
                },
                "fecOutputSettings": {
                  "columnDepth": integer,
                  "includeFec": enum,
                  "rowLength": integer
                }
              }
            },
            "videoDescriptionName": "string"
          }
        ]
      }
    ],
    "timecodeConfig": {
      "source": enum,
      "syncThreshold": integer
    },
    "videoDescriptions": [
      {
        "codecSettings": {
          "frameCaptureSettings": {
            "captureInterval": integer,
            "captureIntervalUnits": enum
          },
          "h264Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "bitrate": integer,
            "bufFillPct": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "entropyEncoding": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "forceFieldPictures": enum,
            "framerateControl": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopBReference": enum,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "numRefFrames": integer,
            "parControl": enum,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qualityLevel": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "softness": integer,
            "spatialAq": enum,
            "subgopLength": enum,
            "syntax": enum,
            "temporalAq": enum,
            "timecodeInsertion": enum
          },
          "h265Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "alternativeTransferFunction": enum,
            "bitrate": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "tier": enum,
            "timecodeInsertion": enum
          },
          "mpeg2Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "colorMetadata": enum,
            "colorSpace": enum,
            "displayAspectRatio": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "scanType": enum,
            "subgopLength": enum,
            "timecodeInsertion": enum
          }
        },
        "height": integer,
        "name": "string",
        "respondToAfd": enum,
        "scalingBehavior": enum,
        "sharpness": integer,
        "width": integer
      }
    ]
  },
  "id": "string",
  "inputAttachments": [
    {
      "automaticInputFailoverSettings": {
        "errorClearTimeMsec": integer,
        "failoverConditions": [
          {
            "failoverConditionSettings": {
              "audioSilenceSettings": {
                "audioSelectorName": "string",
                "audioSilenceThresholdMsec": integer
              },
              "inputLossSettings": {
                "inputLossThresholdMsec": integer
              },
              "videoBlackSettings": {
                "blackDetectThreshold": number,
                "videoBlackThresholdMsec": integer
              }
            }
          }
        ],
        "inputPreference": enum,
        "secondaryInputId": "string"
      },
      "inputAttachmentName": "string",
      "inputId": "string",
      "inputSettings": {
        "audioSelectors": [
          {
            "name": "string",
            "selectorSettings": {
              "audioHlsRenditionSelection": {
                "groupId": "string",
                "name": "string"
              },
              "audioLanguageSelection": {
                "languageCode": "string",
                "languageSelectionPolicy": enum
              },
              "audioPidSelection": {
                "pid": integer
              },
              "audioTrackSelection": {
                "tracks": [
                  {
                    "track": integer
                  }
                ]
              }
            }
          }
        ],
        "captionSelectors": [
          {
            "languageCode": "string",
            "name": "string",
            "selectorSettings": {
              "ancillarySourceSettings": {
                "sourceAncillaryChannelNumber": integer
              },
              "aribSourceSettings": {
              },
              "dvbSubSourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "embeddedSourceSettings": {
                "convert608To708": enum,
                "scte20Detection": enum,
                "source608ChannelNumber": integer,
                "source608TrackNumber": integer
              },
              "scte20SourceSettings": {
                "convert608To708": enum,
                "source608ChannelNumber": integer
              },
              "scte27SourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "teletextSourceSettings": {
                "outputRectangle": {
                  "height": number,
                  "leftOffset": number,
                  "topOffset": number,
                  "width": number
                },
                "pageNumber": "string"
              }
            }
          }
        ],
        "deblockFilter": enum,
        "denoiseFilter": enum,
        "filterStrength": integer,
        "inputFilter": enum,
        "networkInputSettings": {
          "hlsInputSettings": {
            "bandwidth": integer,
            "bufferSegments": integer,
            "retries": integer,
            "retryInterval": integer,
            "scte35Source": enum
          },
          "serverValidation": enum
        },
        "smpte2038DataPreference": enum,
        "sourceEndBehavior": enum,
        "videoSelector": {
          "colorSpace": enum,
          "colorSpaceSettings": {
            "hdr10Settings": {
              "maxCll": integer,
              "maxFall": integer
            }
          },
          "colorSpaceUsage": enum,
          "selectorSettings": {
            "videoSelectorPid": {
              "pid": integer
            },
            "videoSelectorProgramId": {
              "programId": integer
            }
          }
        }
      }
    }
  ],
  "inputSpecification": {
    "codec": enum,
    "maximumBitrate": enum,
    "resolution": enum
  },
  "logLevel": enum,
  "maintenance": {
    "maintenanceDay": enum,
    "maintenanceDeadline": "string",
    "maintenanceScheduledDate": "string",
    "maintenanceStartTime": "string"
  },
  "name": "string",
  "pipelineDetails": [
    {
      "activeInputAttachmentName": "string",
      "activeInputSwitchActionName": "string",
      "activeMotionGraphicsActionName": "string",
      "activeMotionGraphicsUri": "string",
      "pipelineId": "string"
    }
  ],
  "pipelinesRunningCount": integer,
  "roleArn": "string",
  "state": enum,
  "tags": {
  },
  "vpc": {
    "availabilityZones": [
      "string"
    ],
    "networkInterfaceIds": [
      "string"
    ],
    "securityGroupIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ]
  }
}
```

#### UpdateChannelResultModel schema
<a name="channels-channelid-response-body-updatechannelresultmodel-example"></a>

```
{
  "channel": {
    "arn": "string",
    "cdiInputSpecification": {
      "resolution": enum
    },
    "channelClass": enum,
    "destinations": [
      {
        "id": "string",
        "mediaPackageSettings": [
          {
            "channelId": "string"
          }
        ],
        "multiplexSettings": {
          "multiplexId": "string",
          "programName": "string"
        },
        "settings": [
          {
            "passwordParam": "string",
            "streamName": "string",
            "url": "string",
            "username": "string"
          }
        ]
      }
    ],
    "egressEndpoints": [
      {
        "sourceIp": "string"
      }
    ],
    "encoderSettings": {
      "audioDescriptions": [
        {
          "audioNormalizationSettings": {
            "algorithm": enum,
            "algorithmControl": enum,
            "targetLkfs": number
          },
          "audioSelectorName": "string",
          "audioType": enum,
          "audioTypeControl": enum,
          "audioWatermarkingSettings": {
            "nielsenWatermarksSettings": {
              "nielsenCbetSettings": {
                "cbetCheckDigitString": "string",
                "cbetStepaside": enum,
                "csid": "string"
              },
              "nielsenDistributionType": enum,
              "nielsenNaesIiNwSettings": {
                "checkDigitString": "string",
                "sid": number
              }
            }
          },
          "codecSettings": {
            "aacSettings": {
              "bitrate": number,
              "codingMode": enum,
              "inputType": enum,
              "profile": enum,
              "rateControlMode": enum,
              "rawFormat": enum,
              "sampleRate": number,
              "spec": enum,
              "vbrQuality": enum
            },
            "ac3Settings": {
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dialnorm": integer,
              "drcProfile": enum,
              "lfeFilter": enum,
              "metadataControl": enum
            },
            "eac3Settings": {
              "attenuationControl": enum,
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dcFilter": enum,
              "dialnorm": integer,
              "drcLine": enum,
              "drcRf": enum,
              "lfeControl": enum,
              "lfeFilter": enum,
              "loRoCenterMixLevel": number,
              "loRoSurroundMixLevel": number,
              "ltRtCenterMixLevel": number,
              "ltRtSurroundMixLevel": number,
              "metadataControl": enum,
              "passthroughControl": enum,
              "phaseControl": enum,
              "stereoDownmix": enum,
              "surroundExMode": enum,
              "surroundMode": enum
            },
            "mp2Settings": {
              "bitrate": number,
              "codingMode": enum,
              "sampleRate": number
            },
            "passThroughSettings": {
            },
            "wavSettings": {
              "bitDepth": number,
              "codingMode": enum,
              "sampleRate": number
            }
          },
          "languageCode": "string",
          "languageCodeControl": enum,
          "name": "string",
          "remixSettings": {
            "channelMappings": [
              {
                "inputChannelLevels": [
                  {
                    "gain": integer,
                    "inputChannel": integer
                  }
                ],
                "outputChannel": integer
              }
            ],
            "channelsIn": integer,
            "channelsOut": integer
          },
          "streamName": "string"
        }
      ],
      "availBlanking": {
        "availBlankingImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "state": enum
      },
      "availConfiguration": {
        "availSettings": {
          "scte35SpliceInsert": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          },
          "scte35TimeSignalApos": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          }
        }
      },
      "blackoutSlate": {
        "blackoutSlateImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkEndBlackout": enum,
        "networkEndBlackoutImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkId": "string",
        "state": enum
      },
      "captionDescriptions": [
        {
          "captionSelectorName": "string",
          "destinationSettings": {
            "aribDestinationSettings": {
            },
            "burnInDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "dvbSubDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "ebuTtDDestinationSettings": {
              "copyrightHolder": "string",
              "fillLineGap": enum,
              "fontFamily": "string",
              "styleControl": enum
            },
            "embeddedDestinationSettings": {
            },
            "embeddedPlusScte20DestinationSettings": {
            },
            "rtmpCaptionInfoDestinationSettings": {
            },
            "scte20PlusEmbeddedDestinationSettings": {
            },
            "scte27DestinationSettings": {
            },
            "smpteTtDestinationSettings": {
            },
            "teletextDestinationSettings": {
            },
            "ttmlDestinationSettings": {
              "styleControl": enum
            },
            "webvttDestinationSettings": {
              "styleControl": enum
            }
          },
          "languageCode": "string",
          "languageDescription": "string",
          "name": "string"
        }
      ],
      "featureActivations": {
        "inputPrepareScheduleActions": enum
      },
      "globalConfiguration": {
        "initialAudioGain": integer,
        "inputEndAction": enum,
        "inputLossBehavior": {
          "blackFrameMsec": integer,
          "inputLossImageColor": "string",
          "inputLossImageSlate": {
            "passwordParam": "string",
            "uri": "string",
            "username": "string"
          },
          "inputLossImageType": enum,
          "repeatFrameMsec": integer
        },
        "outputLockingMode": enum,
        "outputTimingSource": enum,
        "supportLowFramerateInputs": enum
      },
      "motionGraphicsConfiguration": {
        "motionGraphicsInsertion": enum,
        "motionGraphicsSettings": {
          "htmlMotionGraphicsSettings": {
          }
        }
      },
      "nielsenConfiguration": {
        "distributorId": "string",
        "nielsenPcmToId3Tagging": enum
      },
      "outputGroups": [
        {
          "name": "string",
          "outputGroupSettings": {
            "archiveGroupSettings": {
              "archiveCdnSettings": {
                "archiveS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              },
              "destination": {
                "destinationRefId": "string"
              },
              "rolloverInterval": integer
            },
            "frameCaptureGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              },
              "frameCaptureCdnSettings": {
                "frameCaptureS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              }
            },
            "hlsGroupSettings": {
              "adMarkers": [
                enum
              ],
              "baseUrlContent": "string",
              "baseUrlContent1": "string",
              "baseUrlManifest": "string",
              "baseUrlManifest1": "string",
              "captionLanguageMappings": [
                {
                  "captionChannel": integer,
                  "languageCode": "string",
                  "languageDescription": "string"
                }
              ],
              "captionLanguageSetting": enum,
              "clientCache": enum,
              "codecSpecification": enum,
              "constantIv": "string",
              "destination": {
                "destinationRefId": "string"
              },
              "directoryStructure": enum,
              "discontinuityTags": enum,
              "encryptionType": enum,
              "hlsCdnSettings": {
                "hlsAkamaiSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer,
                  "salt": "string",
                  "token": "string"
                },
                "hlsBasicPutSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsMediaStoreSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "mediaStoreStorageClass": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                },
                "hlsWebdavSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                }
              },
              "hlsId3SegmentTagging": enum,
              "iFrameOnlyPlaylists": enum,
              "incompleteSegmentBehavior": enum,
              "indexNSegments": integer,
              "inputLossAction": enum,
              "ivInManifest": enum,
              "ivSource": enum,
              "keepSegments": integer,
              "keyFormat": "string",
              "keyFormatVersions": "string",
              "keyProviderSettings": {
                "staticKeySettings": {
                  "keyProviderServer": {
                    "passwordParam": "string",
                    "uri": "string",
                    "username": "string"
                  },
                  "staticKeyValue": "string"
                }
              },
              "manifestCompression": enum,
              "manifestDurationFormat": enum,
              "minSegmentLength": integer,
              "mode": enum,
              "outputSelection": enum,
              "programDateTime": enum,
              "programDateTimeClock": enum,
              "programDateTimePeriod": integer,
              "redundantManifest": enum,
              "segmentLength": integer,
              "segmentationMode": enum,
              "segmentsPerSubdirectory": integer,
              "streamInfResolution": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer,
              "timestampDeltaMilliseconds": integer,
              "tsFileMode": enum
            },
            "mediaPackageGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              }
            },
            "msSmoothGroupSettings": {
              "acquisitionPointId": "string",
              "audioOnlyTimecodeControl": enum,
              "certificateMode": enum,
              "connectionRetryInterval": integer,
              "destination": {
                "destinationRefId": "string"
              },
              "eventId": "string",
              "eventIdMode": enum,
              "eventStopBehavior": enum,
              "filecacheDuration": integer,
              "fragmentLength": integer,
              "inputLossAction": enum,
              "numRetries": integer,
              "restartDelay": integer,
              "segmentationMode": enum,
              "sendDelayMs": integer,
              "sparseTrackType": enum,
              "streamManifestBehavior": enum,
              "timestampOffset": "string",
              "timestampOffsetMode": enum
            },
            "multiplexGroupSettings": {
            },
            "rtmpGroupSettings": {
              "adMarkers": [
                enum
              ],
              "authenticationScheme": enum,
              "cacheFullBehavior": enum,
              "cacheLength": integer,
              "captionData": enum,
              "inputLossAction": enum,
              "restartDelay": integer
            },
            "udpGroupSettings": {
              "inputLossAction": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer
            }
          },
          "outputs": [
            {
              "audioDescriptionNames": [
                "string"
              ],
              "captionDescriptionNames": [
                "string"
              ],
              "outputName": "string",
              "outputSettings": {
                "archiveOutputSettings": {
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    },
                    "rawSettings": {
                    }
                  },
                  "extension": "string",
                  "nameModifier": "string"
                },
                "frameCaptureOutputSettings": {
                  "nameModifier": "string"
                },
                "hlsOutputSettings": {
                  "h265PackagingType": enum,
                  "hlsSettings": {
                    "audioOnlyHlsSettings": {
                      "audioGroupId": "string",
                      "audioOnlyImage": {
                        "passwordParam": "string",
                        "uri": "string",
                        "username": "string"
                      },
                      "audioTrackType": enum,
                      "segmentType": enum
                    },
                    "fmp4HlsSettings": {
                      "audioRenditionSets": "string",
                      "nielsenId3Behavior": enum,
                      "timedMetadataBehavior": enum
                    },
                    "frameCaptureHlsSettings": {
                    },
                    "standardHlsSettings": {
                      "audioRenditionSets": "string",
                      "m3u8Settings": {
                        "audioFramesPerPes": integer,
                        "audioPids": "string",
                        "ecmPid": "string",
                        "nielsenId3Behavior": enum,
                        "patInterval": integer,
                        "pcrControl": enum,
                        "pcrPeriod": integer,
                        "pcrPid": "string",
                        "pmtInterval": integer,
                        "pmtPid": "string",
                        "programNum": integer,
                        "scte35Behavior": enum,
                        "scte35Pid": "string",
                        "timedMetadataBehavior": enum,
                        "timedMetadataPid": "string",
                        "transportStreamId": integer,
                        "videoPid": "string"
                      }
                    }
                  },
                  "nameModifier": "string",
                  "segmentModifier": "string"
                },
                "mediaPackageOutputSettings": {
                },
                "msSmoothOutputSettings": {
                  "h265PackagingType": enum,
                  "nameModifier": "string"
                },
                "multiplexOutputSettings": {
                  "destination": {
                    "destinationRefId": "string"
                  }
                },
                "rtmpOutputSettings": {
                  "certificateMode": enum,
                  "connectionRetryInterval": integer,
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "numRetries": integer
                },
                "udpOutputSettings": {
                  "bufferMsec": integer,
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  },
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "fecOutputSettings": {
                    "columnDepth": integer,
                    "includeFec": enum,
                    "rowLength": integer
                  }
                }
              },
              "videoDescriptionName": "string"
            }
          ]
        }
      ],
      "timecodeConfig": {
        "source": enum,
        "syncThreshold": integer
      },
      "videoDescriptions": [
        {
          "codecSettings": {
            "frameCaptureSettings": {
              "captureInterval": integer,
              "captureIntervalUnits": enum
            },
            "h264Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "bitrate": integer,
              "bufFillPct": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "entropyEncoding": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "forceFieldPictures": enum,
              "framerateControl": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopBReference": enum,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "numRefFrames": integer,
              "parControl": enum,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qualityLevel": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "softness": integer,
              "spatialAq": enum,
              "subgopLength": enum,
              "syntax": enum,
              "temporalAq": enum,
              "timecodeInsertion": enum
            },
            "h265Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "alternativeTransferFunction": enum,
              "bitrate": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "hdr10Settings": {
                  "maxCll": integer,
                  "maxFall": integer
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "tier": enum,
              "timecodeInsertion": enum
            },
            "mpeg2Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "colorMetadata": enum,
              "colorSpace": enum,
              "displayAspectRatio": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "scanType": enum,
              "subgopLength": enum,
              "timecodeInsertion": enum
            }
          },
          "height": integer,
          "name": "string",
          "respondToAfd": enum,
          "scalingBehavior": enum,
          "sharpness": integer,
          "width": integer
        }
      ]
    },
    "id": "string",
    "inputAttachments": [
      {
        "automaticInputFailoverSettings": {
          "errorClearTimeMsec": integer,
          "failoverConditions": [
            {
              "failoverConditionSettings": {
                "audioSilenceSettings": {
                  "audioSelectorName": "string",
                  "audioSilenceThresholdMsec": integer
                },
                "inputLossSettings": {
                  "inputLossThresholdMsec": integer
                },
                "videoBlackSettings": {
                  "blackDetectThreshold": number,
                  "videoBlackThresholdMsec": integer
                }
              }
            }
          ],
          "inputPreference": enum,
          "secondaryInputId": "string"
        },
        "inputAttachmentName": "string",
        "inputId": "string",
        "inputSettings": {
          "audioSelectors": [
            {
              "name": "string",
              "selectorSettings": {
                "audioHlsRenditionSelection": {
                  "groupId": "string",
                  "name": "string"
                },
                "audioLanguageSelection": {
                  "languageCode": "string",
                  "languageSelectionPolicy": enum
                },
                "audioPidSelection": {
                  "pid": integer
                },
                "audioTrackSelection": {
                  "tracks": [
                    {
                      "track": integer
                    }
                  ]
                }
              }
            }
          ],
          "captionSelectors": [
            {
              "languageCode": "string",
              "name": "string",
              "selectorSettings": {
                "ancillarySourceSettings": {
                  "sourceAncillaryChannelNumber": integer
                },
                "aribSourceSettings": {
                },
                "dvbSubSourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "embeddedSourceSettings": {
                  "convert608To708": enum,
                  "scte20Detection": enum,
                  "source608ChannelNumber": integer,
                  "source608TrackNumber": integer
                },
                "scte20SourceSettings": {
                  "convert608To708": enum,
                  "source608ChannelNumber": integer
                },
                "scte27SourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "teletextSourceSettings": {
                  "outputRectangle": {
                    "height": number,
                    "leftOffset": number,
                    "topOffset": number,
                    "width": number
                  },
                  "pageNumber": "string"
                }
              }
            }
          ],
          "deblockFilter": enum,
          "denoiseFilter": enum,
          "filterStrength": integer,
          "inputFilter": enum,
          "networkInputSettings": {
            "hlsInputSettings": {
              "bandwidth": integer,
              "bufferSegments": integer,
              "retries": integer,
              "retryInterval": integer,
              "scte35Source": enum
            },
            "serverValidation": enum
          },
          "smpte2038DataPreference": enum,
          "sourceEndBehavior": enum,
          "videoSelector": {
            "colorSpace": enum,
            "colorSpaceSettings": {
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              }
            },
            "colorSpaceUsage": enum,
            "selectorSettings": {
              "videoSelectorPid": {
                "pid": integer
              },
              "videoSelectorProgramId": {
                "programId": integer
              }
            }
          }
        }
      }
    ],
    "inputSpecification": {
      "codec": enum,
      "maximumBitrate": enum,
      "resolution": enum
    },
    "logLevel": enum,
    "maintenance": {
      "maintenanceDay": enum,
      "maintenanceDeadline": "string",
      "maintenanceScheduledDate": "string",
      "maintenanceStartTime": "string"
    },
    "name": "string",
    "pipelineDetails": [
      {
        "activeInputAttachmentName": "string",
        "activeInputSwitchActionName": "string",
        "activeMotionGraphicsActionName": "string",
        "activeMotionGraphicsUri": "string",
        "pipelineId": "string"
      }
    ],
    "pipelinesRunningCount": integer,
    "roleArn": "string",
    "state": enum,
    "tags": {
    },
    "vpc": {
      "availabilityZones": [
        "string"
      ],
      "networkInterfaceIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ],
      "subnetIds": [
        "string"
      ]
    }
  }
}
```

#### InvalidRequest schema
<a name="channels-channelid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-channelid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="channels-channelid-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="channels-channelid-response-body-resourceconflict-example"></a>

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

#### ChannelConfigurationValidationError schema
<a name="channels-channelid-response-body-channelconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="channels-channelid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-channelid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-channelid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-channelid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-channelid-properties"></a>

### AacCodingMode
<a name="channels-channelid-model-aaccodingmode"></a>

Aac Coding Mode
+ `AD_RECEIVER_MIX`
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_5_1`

### AacInputType
<a name="channels-channelid-model-aacinputtype"></a>

Aac Input Type
+ `BROADCASTER_MIXED_AD`
+ `NORMAL`

### AacProfile
<a name="channels-channelid-model-aacprofile"></a>

Aac Profile
+ `HEV1`
+ `HEV2`
+ `LC`

### AacRateControlMode
<a name="channels-channelid-model-aacratecontrolmode"></a>

Aac Rate Control Mode
+ `CBR`
+ `VBR`

### AacRawFormat
<a name="channels-channelid-model-aacrawformat"></a>

Aac Raw Format
+ `LATM_LOAS`
+ `NONE`

### AacSettings
<a name="channels-channelid-model-aacsettings"></a>

Aac Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. | 
| codingMode | [AacCodingMode](#channels-channelid-model-aaccodingmode) | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. | 
| inputType | [AacInputType](#channels-channelid-model-aacinputtype) | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio \$1 AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio \$1 AD. | 
| profile | [AacProfile](#channels-channelid-model-aacprofile) | False | AAC Profile. | 
| rateControlMode | [AacRateControlMode](#channels-channelid-model-aacratecontrolmode) | False | Rate Control Mode. | 
| rawFormat | [AacRawFormat](#channels-channelid-model-aacrawformat) | False | Sets LATM / LOAS AAC output for raw containers. | 
| sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. | 
| spec | [AacSpec](#channels-channelid-model-aacspec) | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | 
| vbrQuality | [AacVbrQuality](#channels-channelid-model-aacvbrquality) | False | VBR Quality Level - Only used if rateControlMode is VBR. | 

### AacSpec
<a name="channels-channelid-model-aacspec"></a>

Aac Spec
+ `MPEG2`
+ `MPEG4`

### AacVbrQuality
<a name="channels-channelid-model-aacvbrquality"></a>

Aac Vbr Quality
+ `HIGH`
+ `LOW`
+ `MEDIUM_HIGH`
+ `MEDIUM_LOW`

### Ac3BitstreamMode
<a name="channels-channelid-model-ac3bitstreammode"></a>

Ac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `DIALOGUE`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `MUSIC_AND_EFFECTS`
+ `VISUALLY_IMPAIRED`
+ `VOICE_OVER`

### Ac3CodingMode
<a name="channels-channelid-model-ac3codingmode"></a>

Ac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2_LFE`

### Ac3DrcProfile
<a name="channels-channelid-model-ac3drcprofile"></a>

Ac3 Drc Profile
+ `FILM_STANDARD`
+ `NONE`

### Ac3LfeFilter
<a name="channels-channelid-model-ac3lfefilter"></a>

Ac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Ac3MetadataControl
<a name="channels-channelid-model-ac3metadatacontrol"></a>

Ac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Ac3Settings
<a name="channels-channelid-model-ac3settings"></a>

Ac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Ac3BitstreamMode](#channels-channelid-model-ac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | 
| codingMode | [Ac3CodingMode](#channels-channelid-model-ac3codingmode) | False | Dolby Digital coding mode. Determines number of channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. | 
| drcProfile | [Ac3DrcProfile](#channels-channelid-model-ac3drcprofile) | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | 
| lfeFilter | [Ac3LfeFilter](#channels-channelid-model-ac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | 
| metadataControl | [Ac3MetadataControl](#channels-channelid-model-ac3metadatacontrol) | False | When set to "followInput", encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 

### AccessDenied
<a name="channels-channelid-model-accessdenied"></a>


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

### AfdSignaling
<a name="channels-channelid-model-afdsignaling"></a>

Afd Signaling
+ `AUTO`
+ `FIXED`
+ `NONE`

### AncillarySourceSettings
<a name="channels-channelid-model-ancillarysourcesettings"></a>

Ancillary Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceAncillaryChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. | 

### ArchiveCdnSettings
<a name="channels-channelid-model-archivecdnsettings"></a>

Archive Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveS3Settings | [ArchiveS3Settings](#channels-channelid-model-archives3settings) | False |  | 

### ArchiveContainerSettings
<a name="channels-channelid-model-archivecontainersettings"></a>

Archive Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-model-m2tssettings) | False |  | 
| rawSettings | [RawSettings](#channels-channelid-model-rawsettings) | False |  | 

### ArchiveGroupSettings
<a name="channels-channelid-model-archivegroupsettings"></a>

Archive Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveCdnSettings | [ArchiveCdnSettings](#channels-channelid-model-archivecdnsettings) | False | Parameters that control interactions with the CDN. | 
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | A directory and base filename where archive files should be written. | 
| rolloverInterval | integerMinimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. | 

### ArchiveOutputSettings
<a name="channels-channelid-model-archiveoutputsettings"></a>

Archive Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| containerSettings | [ArchiveContainerSettings](#channels-channelid-model-archivecontainersettings) | True | Settings specific to the container type of the file. | 
| extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### ArchiveS3LogUploads
<a name="channels-channelid-model-archives3loguploads"></a>

Archive S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### ArchiveS3Settings
<a name="channels-channelid-model-archives3settings"></a>

Archive S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [ArchiveS3LogUploads](#channels-channelid-model-archives3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### AribDestinationSettings
<a name="channels-channelid-model-aribdestinationsettings"></a>

Arib Destination Settings

### AribSourceSettings
<a name="channels-channelid-model-aribsourcesettings"></a>

Arib Source Settings

### AudioChannelMapping
<a name="channels-channelid-model-audiochannelmapping"></a>

Audio Channel Mapping


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputChannelLevels | Array of type [InputChannelLevel](#channels-channelid-model-inputchannellevel) | True | Indices and gain values for each input channel that should be remixed into this output channel. | 
| outputChannel | integerMinimum: 0Maximum: 7 | True | The index of the output channel being produced. | 

### AudioCodecSettings
<a name="channels-channelid-model-audiocodecsettings"></a>

Audio Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aacSettings | [AacSettings](#channels-channelid-model-aacsettings) | False |  | 
| ac3Settings | [Ac3Settings](#channels-channelid-model-ac3settings) | False |  | 
| eac3Settings | [Eac3Settings](#channels-channelid-model-eac3settings) | False |  | 
| mp2Settings | [Mp2Settings](#channels-channelid-model-mp2settings) | False |  | 
| passThroughSettings | [PassThroughSettings](#channels-channelid-model-passthroughsettings) | False |  | 
| wavSettings | [WavSettings](#channels-channelid-model-wavsettings) | False |  | 

### AudioDescription
<a name="channels-channelid-model-audiodescription"></a>

Audio Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioNormalizationSettings | [AudioNormalizationSettings](#channels-channelid-model-audionormalizationsettings) | False | Advanced audio normalization settings. | 
| audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. | 
| audioType | [AudioType](#channels-channelid-model-audiotype) | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | 
| audioTypeControl | [AudioDescriptionAudioTypeControl](#channels-channelid-model-audiodescriptionaudiotypecontrol) | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | 
| audioWatermarkingSettings | [AudioWatermarkSettings](#channels-channelid-model-audiowatermarksettings) | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | 
| codecSettings | [AudioCodecSettings](#channels-channelid-model-audiocodecsettings) | False | Audio codec settings. | 
| languageCode | stringMinLength: 1MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. | 
| languageCodeControl | [AudioDescriptionLanguageCodeControl](#channels-channelid-model-audiodescriptionlanguagecodecontrol) | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | 
| name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. | 
| remixSettings | [RemixSettings](#channels-channelid-model-remixsettings) | False | Settings that control how input audio channels are remixed into the output audio channels. | 
| streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). | 

### AudioDescriptionAudioTypeControl
<a name="channels-channelid-model-audiodescriptionaudiotypecontrol"></a>

Audio Description Audio Type Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioDescriptionLanguageCodeControl
<a name="channels-channelid-model-audiodescriptionlanguagecodecontrol"></a>

Audio Description Language Code Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioHlsRenditionSelection
<a name="channels-channelid-model-audiohlsrenditionselection"></a>

Audio Hls Rendition Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| groupId | stringMinLength: 1 | True | Specifies the GROUP-ID in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 
| name | stringMinLength: 1 | True | Specifies the NAME in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 

### AudioLanguageSelection
<a name="channels-channelid-model-audiolanguageselection"></a>

Audio Language Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | True | Selects a specific three-letter language code from within an audio source. | 
| languageSelectionPolicy | [AudioLanguageSelectionPolicy](#channels-channelid-model-audiolanguageselectionpolicy) | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. | 

### AudioLanguageSelectionPolicy
<a name="channels-channelid-model-audiolanguageselectionpolicy"></a>

Audio Language Selection Policy
+ `LOOSE`
+ `STRICT`

### AudioNormalizationAlgorithm
<a name="channels-channelid-model-audionormalizationalgorithm"></a>

Audio Normalization Algorithm
+ `ITU_1770_1`
+ `ITU_1770_2`

### AudioNormalizationAlgorithmControl
<a name="channels-channelid-model-audionormalizationalgorithmcontrol"></a>

Audio Normalization Algorithm Control
+ `CORRECT_AUDIO`

### AudioNormalizationSettings
<a name="channels-channelid-model-audionormalizationsettings"></a>

Audio Normalization Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| algorithm | [AudioNormalizationAlgorithm](#channels-channelid-model-audionormalizationalgorithm) | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | 
| algorithmControl | [AudioNormalizationAlgorithmControl](#channels-channelid-model-audionormalizationalgorithmcontrol) | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | 
| targetLkfs | numberMinimum: -59Maximum: 0 | False | Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. | 

### AudioOnlyHlsSegmentType
<a name="channels-channelid-model-audioonlyhlssegmenttype"></a>

Audio Only Hls Segment Type
+ `AAC`
+ `FMP4`

### AudioOnlyHlsSettings
<a name="channels-channelid-model-audioonlyhlssettings"></a>

Audio Only Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. | 
| audioOnlyImage | [InputLocation](#channels-channelid-model-inputlocation) | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | 
| audioTrackType | [AudioOnlyHlsTrackType](#channels-channelid-model-audioonlyhlstracktype) | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | 
| segmentType | [AudioOnlyHlsSegmentType](#channels-channelid-model-audioonlyhlssegmenttype) | False | Specifies the segment type. | 

### AudioOnlyHlsTrackType
<a name="channels-channelid-model-audioonlyhlstracktype"></a>

Audio Only Hls Track Type
+ `ALTERNATE_AUDIO_AUTO_SELECT`
+ `ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT`
+ `ALTERNATE_AUDIO_NOT_AUTO_SELECT`
+ `AUDIO_ONLY_VARIANT_STREAM`

### AudioPidSelection
<a name="channels-channelid-model-audiopidselection"></a>

Audio Pid Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | True | Selects a specific PID from within a source. | 

### AudioSelector
<a name="channels-channelid-model-audioselector"></a>

Audio Selector


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. | 
| selectorSettings | [AudioSelectorSettings](#channels-channelid-model-audioselectorsettings) | False | The audio selector settings. | 

### AudioSelectorSettings
<a name="channels-channelid-model-audioselectorsettings"></a>

Audio Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioHlsRenditionSelection | [AudioHlsRenditionSelection](#channels-channelid-model-audiohlsrenditionselection) | False |  | 
| audioLanguageSelection | [AudioLanguageSelection](#channels-channelid-model-audiolanguageselection) | False |  | 
| audioPidSelection | [AudioPidSelection](#channels-channelid-model-audiopidselection) | False |  | 
| audioTrackSelection | [AudioTrackSelection](#channels-channelid-model-audiotrackselection) | False |  | 

### AudioSilenceFailoverSettings
<a name="channels-channelid-model-audiosilencefailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. | 
| audioSilenceThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. | 

### AudioTrack
<a name="channels-channelid-model-audiotrack"></a>

Audio Track


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| track | integerMinimum: 1 | True | 1-based integer value that maps to a specific audio track | 

### AudioTrackSelection
<a name="channels-channelid-model-audiotrackselection"></a>

Audio Track Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tracks | Array of type [AudioTrack](#channels-channelid-model-audiotrack) | True | Selects one or more unique audio tracks from within a source. | 

### AudioType
<a name="channels-channelid-model-audiotype"></a>

Audio Type
+ `CLEAN_EFFECTS`
+ `HEARING_IMPAIRED`
+ `UNDEFINED`
+ `VISUAL_IMPAIRED_COMMENTARY`

### AudioWatermarkSettings
<a name="channels-channelid-model-audiowatermarksettings"></a>

Audio Watermark Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenWatermarksSettings | [NielsenWatermarksSettings](#channels-channelid-model-nielsenwatermarkssettings) | False | Settings to configure Nielsen Watermarks in the audio encode | 

### AuthenticationScheme
<a name="channels-channelid-model-authenticationscheme"></a>

Authentication Scheme
+ `AKAMAI`
+ `COMMON`

### AutomaticInputFailoverSettings
<a name="channels-channelid-model-automaticinputfailoversettings"></a>

The settings for Automatic Input Failover.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| errorClearTimeMsec | integerMinimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input\$1preference for the failover pair is set to PRIMARY\$1INPUT\$1PREFERRED, because after this time, MediaLive will switch back to the primary input. | 
| failoverConditions | Array of type [FailoverCondition](#channels-channelid-model-failovercondition) | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. | 
| inputPreference | [InputPreference](#channels-channelid-model-inputpreference) | False | Input preference when deciding which input to make active when a previously failed input has recovered. | 
| secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. | 

### AvailBlanking
<a name="channels-channelid-model-availblanking"></a>

Avail Blanking


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availBlankingImage | [InputLocation](#channels-channelid-model-inputlocation) | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| state | [AvailBlankingState](#channels-channelid-model-availblankingstate) | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. | 

### AvailBlankingState
<a name="channels-channelid-model-availblankingstate"></a>

Avail Blanking State
+ `DISABLED`
+ `ENABLED`

### AvailConfiguration
<a name="channels-channelid-model-availconfiguration"></a>

Avail Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availSettings | [AvailSettings](#channels-channelid-model-availsettings) | False | Ad avail settings. | 

### AvailSettings
<a name="channels-channelid-model-availsettings"></a>

Avail Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35SpliceInsert | [Scte35SpliceInsert](#channels-channelid-model-scte35spliceinsert) | False |  | 
| scte35TimeSignalApos | [Scte35TimeSignalApos](#channels-channelid-model-scte35timesignalapos) | False |  | 

### BadGatewayException
<a name="channels-channelid-model-badgatewayexception"></a>


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

### BlackoutSlate
<a name="channels-channelid-model-blackoutslate"></a>

Blackout Slate


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackoutSlateImage | [InputLocation](#channels-channelid-model-inputlocation) | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| networkEndBlackout | [BlackoutSlateNetworkEndBlackout](#channels-channelid-model-blackoutslatenetworkendblackout) | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | 
| networkEndBlackoutImage | [InputLocation](#channels-channelid-model-inputlocation) | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | 
| networkId | stringMinLength: 34MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). | 
| state | [BlackoutSlateState](#channels-channelid-model-blackoutslatestate) | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. | 

### BlackoutSlateNetworkEndBlackout
<a name="channels-channelid-model-blackoutslatenetworkendblackout"></a>

Blackout Slate Network End Blackout
+ `DISABLED`
+ `ENABLED`

### BlackoutSlateState
<a name="channels-channelid-model-blackoutslatestate"></a>

Blackout Slate State
+ `DISABLED`
+ `ENABLED`

### BurnInAlignment
<a name="channels-channelid-model-burninalignment"></a>

Burn In Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### BurnInBackgroundColor
<a name="channels-channelid-model-burninbackgroundcolor"></a>

Burn In Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInDestinationSettings
<a name="channels-channelid-model-burnindestinationsettings"></a>

Burn In Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [BurnInAlignment](#channels-channelid-model-burninalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [BurnInBackgroundColor](#channels-channelid-model-burninbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [BurnInFontColor](#channels-channelid-model-burninfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [BurnInOutlineColor](#channels-channelid-model-burninoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [BurnInShadowColor](#channels-channelid-model-burninshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [BurnInTeletextGridControl](#channels-channelid-model-burninteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. | 

### BurnInFontColor
<a name="channels-channelid-model-burninfontcolor"></a>

Burn In Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInOutlineColor
<a name="channels-channelid-model-burninoutlinecolor"></a>

Burn In Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInShadowColor
<a name="channels-channelid-model-burninshadowcolor"></a>

Burn In Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInTeletextGridControl
<a name="channels-channelid-model-burninteletextgridcontrol"></a>

Burn In Teletext Grid Control
+ `FIXED`
+ `SCALED`

### CaptionDescription
<a name="channels-channelid-model-captiondescription"></a>

Caption Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. | 
| destinationSettings | [CaptionDestinationSettings](#channels-channelid-model-captiondestinationsettings) | False | Additional settings for captions destination that depend on the destination type. | 
| languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | 
| languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). | 
| name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. | 

### CaptionDestinationSettings
<a name="channels-channelid-model-captiondestinationsettings"></a>

Caption Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aribDestinationSettings | [AribDestinationSettings](#channels-channelid-model-aribdestinationsettings) | False |  | 
| burnInDestinationSettings | [BurnInDestinationSettings](#channels-channelid-model-burnindestinationsettings) | False |  | 
| dvbSubDestinationSettings | [DvbSubDestinationSettings](#channels-channelid-model-dvbsubdestinationsettings) | False |  | 
| ebuTtDDestinationSettings | [EbuTtDDestinationSettings](#channels-channelid-model-ebuttddestinationsettings) | False |  | 
| embeddedDestinationSettings | [EmbeddedDestinationSettings](#channels-channelid-model-embeddeddestinationsettings) | False |  | 
| embeddedPlusScte20DestinationSettings | [EmbeddedPlusScte20DestinationSettings](#channels-channelid-model-embeddedplusscte20destinationsettings) | False |  | 
| rtmpCaptionInfoDestinationSettings | [RtmpCaptionInfoDestinationSettings](#channels-channelid-model-rtmpcaptioninfodestinationsettings) | False |  | 
| scte20PlusEmbeddedDestinationSettings | [Scte20PlusEmbeddedDestinationSettings](#channels-channelid-model-scte20plusembeddeddestinationsettings) | False |  | 
| scte27DestinationSettings | [Scte27DestinationSettings](#channels-channelid-model-scte27destinationsettings) | False |  | 
| smpteTtDestinationSettings | [SmpteTtDestinationSettings](#channels-channelid-model-smptettdestinationsettings) | False |  | 
| teletextDestinationSettings | [TeletextDestinationSettings](#channels-channelid-model-teletextdestinationsettings) | False |  | 
| ttmlDestinationSettings | [TtmlDestinationSettings](#channels-channelid-model-ttmldestinationsettings) | False |  | 
| webvttDestinationSettings | [WebvttDestinationSettings](#channels-channelid-model-webvttdestinationsettings) | False |  | 

### CaptionLanguageMapping
<a name="channels-channelid-model-captionlanguagemapping"></a>

Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionChannel | integerMinimum: 1Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) | 
| languageCode | stringMinLength: 3MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) | 
| languageDescription | stringMinLength: 1 | True | Textual description of language | 

### CaptionRectangle
<a name="channels-channelid-model-captionrectangle"></a>

Caption Rectangle


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| height | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \$1"80\$1" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. | 
| leftOffset | numberMinimum: 0Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. | 
| topOffset | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. | 
| width | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \$1"80\$1" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. | 

### CaptionSelector
<a name="channels-channelid-model-captionselector"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. | 
| name | stringMinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. | 
| selectorSettings | [CaptionSelectorSettings](#channels-channelid-model-captionselectorsettings) | False | Caption selector settings. | 

### CaptionSelectorSettings
<a name="channels-channelid-model-captionselectorsettings"></a>

Caption Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ancillarySourceSettings | [AncillarySourceSettings](#channels-channelid-model-ancillarysourcesettings) | False |  | 
| aribSourceSettings | [AribSourceSettings](#channels-channelid-model-aribsourcesettings) | False |  | 
| dvbSubSourceSettings | [DvbSubSourceSettings](#channels-channelid-model-dvbsubsourcesettings) | False |  | 
| embeddedSourceSettings | [EmbeddedSourceSettings](#channels-channelid-model-embeddedsourcesettings) | False |  | 
| scte20SourceSettings | [Scte20SourceSettings](#channels-channelid-model-scte20sourcesettings) | False |  | 
| scte27SourceSettings | [Scte27SourceSettings](#channels-channelid-model-scte27sourcesettings) | False |  | 
| teletextSourceSettings | [TeletextSourceSettings](#channels-channelid-model-teletextsourcesettings) | False |  | 

### CdiInputResolution
<a name="channels-channelid-model-cdiinputresolution"></a>

Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### CdiInputSpecification
<a name="channels-channelid-model-cdiinputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resolution | [CdiInputResolution](#channels-channelid-model-cdiinputresolution) | False | Maximum CDI input resolution | 

### Channel
<a name="channels-channelid-model-channel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-channelid-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-channelid-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-channelid-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-channelid-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| encoderSettings | [EncoderSettings](#channels-channelid-model-encodersettings) | False |  | 
| id | string | False | The unique ID of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-channelid-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-channelid-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-channelid-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-channelid-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelineDetails | Array of type [PipelineDetail](#channels-channelid-model-pipelinedetail) | False | Runtime details for the pipelines of a running channel. | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-channelid-model-channelstate) | False |  | 
| tags | [Tags](#channels-channelid-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-channelid-model-vpcoutputsettingsdescription) | False | Settings for VPC output | 

### ChannelClass
<a name="channels-channelid-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### ChannelConfigurationValidationError
<a name="channels-channelid-model-channelconfigurationvalidationerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 
| validationErrors | Array of type [ValidationError](#channels-channelid-model-validationerror) | False | A collection of validation error responses. | 

### ChannelEgressEndpoint
<a name="channels-channelid-model-channelegressendpoint"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceIp | string | False | Public IP of where a channel's output comes from | 

### ChannelState
<a name="channels-channelid-model-channelstate"></a>
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`
+ `UPDATING`
+ `UPDATE_FAILED`

### ColorSpacePassthroughSettings
<a name="channels-channelid-model-colorspacepassthroughsettings"></a>

Passthrough applies no color space conversion to the output

### DvbNitSettings
<a name="channels-channelid-model-dvbnitsettings"></a>

DVB Network Information Table (NIT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| networkId | integerMinimum: 0Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). | 
| networkName | stringMinLength: 1MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. | 
| repInterval | integerMinimum: 25Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### DvbSdtOutputSdt
<a name="channels-channelid-model-dvbsdtoutputsdt"></a>

Dvb Sdt Output Sdt
+ `SDT_FOLLOW`
+ `SDT_FOLLOW_IF_PRESENT`
+ `SDT_MANUAL`
+ `SDT_NONE`

### DvbSdtSettings
<a name="channels-channelid-model-dvbsdtsettings"></a>

DVB Service Description Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputSdt | [DvbSdtOutputSdt](#channels-channelid-model-dvbsdtoutputsdt) | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | 
| repInterval | integerMinimum: 25Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. | 
| serviceName | stringMinLength: 1MaxLength: 256 | False | The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 
| serviceProviderName | stringMinLength: 1MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 

### DvbSubDestinationAlignment
<a name="channels-channelid-model-dvbsubdestinationalignment"></a>

Dvb Sub Destination Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### DvbSubDestinationBackgroundColor
<a name="channels-channelid-model-dvbsubdestinationbackgroundcolor"></a>

Dvb Sub Destination Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationFontColor
<a name="channels-channelid-model-dvbsubdestinationfontcolor"></a>

Dvb Sub Destination Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationOutlineColor
<a name="channels-channelid-model-dvbsubdestinationoutlinecolor"></a>

Dvb Sub Destination Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationSettings
<a name="channels-channelid-model-dvbsubdestinationsettings"></a>

Dvb Sub Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [DvbSubDestinationAlignment](#channels-channelid-model-dvbsubdestinationalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [DvbSubDestinationBackgroundColor](#channels-channelid-model-dvbsubdestinationbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [DvbSubDestinationFontColor](#channels-channelid-model-dvbsubdestinationfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [DvbSubDestinationOutlineColor](#channels-channelid-model-dvbsubdestinationoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [DvbSubDestinationShadowColor](#channels-channelid-model-dvbsubdestinationshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [DvbSubDestinationTeletextGridControl](#channels-channelid-model-dvbsubdestinationteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 

### DvbSubDestinationShadowColor
<a name="channels-channelid-model-dvbsubdestinationshadowcolor"></a>

Dvb Sub Destination Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationTeletextGridControl
<a name="channels-channelid-model-dvbsubdestinationteletextgridcontrol"></a>

Dvb Sub Destination Teletext Grid Control
+ `FIXED`
+ `SCALED`

### DvbSubOcrLanguage
<a name="channels-channelid-model-dvbsubocrlanguage"></a>

Dvb Sub Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### DvbSubSourceSettings
<a name="channels-channelid-model-dvbsubsourcesettings"></a>

Dvb Sub Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [DvbSubOcrLanguage](#channels-channelid-model-dvbsubocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. | 

### DvbTdtSettings
<a name="channels-channelid-model-dvbtdtsettings"></a>

DVB Time and Date Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| repInterval | integerMinimum: 1000Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### Eac3AttenuationControl
<a name="channels-channelid-model-eac3attenuationcontrol"></a>

Eac3 Attenuation Control
+ `ATTENUATE_3_DB`
+ `NONE`

### Eac3BitstreamMode
<a name="channels-channelid-model-eac3bitstreammode"></a>

Eac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `VISUALLY_IMPAIRED`

### Eac3CodingMode
<a name="channels-channelid-model-eac3codingmode"></a>

Eac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2`

### Eac3DcFilter
<a name="channels-channelid-model-eac3dcfilter"></a>

Eac3 Dc Filter
+ `DISABLED`
+ `ENABLED`

### Eac3DrcLine
<a name="channels-channelid-model-eac3drcline"></a>

Eac3 Drc Line
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3DrcRf
<a name="channels-channelid-model-eac3drcrf"></a>

Eac3 Drc Rf
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3LfeControl
<a name="channels-channelid-model-eac3lfecontrol"></a>

Eac3 Lfe Control
+ `LFE`
+ `NO_LFE`

### Eac3LfeFilter
<a name="channels-channelid-model-eac3lfefilter"></a>

Eac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Eac3MetadataControl
<a name="channels-channelid-model-eac3metadatacontrol"></a>

Eac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Eac3PassthroughControl
<a name="channels-channelid-model-eac3passthroughcontrol"></a>

Eac3 Passthrough Control
+ `NO_PASSTHROUGH`
+ `WHEN_POSSIBLE`

### Eac3PhaseControl
<a name="channels-channelid-model-eac3phasecontrol"></a>

Eac3 Phase Control
+ `NO_SHIFT`
+ `SHIFT_90_DEGREES`

### Eac3Settings
<a name="channels-channelid-model-eac3settings"></a>

Eac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| attenuationControl | [Eac3AttenuationControl](#channels-channelid-model-eac3attenuationcontrol) | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | 
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Eac3BitstreamMode](#channels-channelid-model-eac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. | 
| codingMode | [Eac3CodingMode](#channels-channelid-model-eac3codingmode) | False | Dolby Digital Plus coding mode. Determines number of channels. | 
| dcFilter | [Eac3DcFilter](#channels-channelid-model-eac3dcfilter) | False | When set to enabled, activates a DC highpass filter for all input channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. | 
| drcLine | [Eac3DrcLine](#channels-channelid-model-eac3drcline) | False | Sets the Dolby dynamic range compression profile. | 
| drcRf | [Eac3DrcRf](#channels-channelid-model-eac3drcrf) | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | 
| lfeControl | [Eac3LfeControl](#channels-channelid-model-eac3lfecontrol) | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | 
| lfeFilter | [Eac3LfeFilter](#channels-channelid-model-eac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | 
| loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. | 
| loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. | 
| ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. | 
| ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. | 
| metadataControl | [Eac3MetadataControl](#channels-channelid-model-eac3metadatacontrol) | False | When set to followInput, encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 
| passthroughControl | [Eac3PassthroughControl](#channels-channelid-model-eac3passthroughcontrol) | False | When set to whenPossible, input DD\$1 audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD\$1 and non-DD\$1 content will have a consistent DD\$1 output as the system alternates between passthrough and encoding. | 
| phaseControl | [Eac3PhaseControl](#channels-channelid-model-eac3phasecontrol) | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | 
| stereoDownmix | [Eac3StereoDownmix](#channels-channelid-model-eac3stereodownmix) | False | Stereo downmix preference. Only used for 3/2 coding mode. | 
| surroundExMode | [Eac3SurroundExMode](#channels-channelid-model-eac3surroundexmode) | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | 
| surroundMode | [Eac3SurroundMode](#channels-channelid-model-eac3surroundmode) | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. | 

### Eac3StereoDownmix
<a name="channels-channelid-model-eac3stereodownmix"></a>

Eac3 Stereo Downmix
+ `DPL2`
+ `LO_RO`
+ `LT_RT`
+ `NOT_INDICATED`

### Eac3SurroundExMode
<a name="channels-channelid-model-eac3surroundexmode"></a>

Eac3 Surround Ex Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### Eac3SurroundMode
<a name="channels-channelid-model-eac3surroundmode"></a>

Eac3 Surround Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### EbuTtDDestinationSettings
<a name="channels-channelid-model-ebuttddestinationsettings"></a>

Ebu Tt DDestination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyrightHolder | stringMaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML | 
| fillLineGap | [EbuTtDFillLineGapControl](#channels-channelid-model-ebuttdfilllinegapcontrol) | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | 
| fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. | 
| styleControl | [EbuTtDDestinationStyleControl](#channels-channelid-model-ebuttddestinationstylecontrol) | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. | 

### EbuTtDDestinationStyleControl
<a name="channels-channelid-model-ebuttddestinationstylecontrol"></a>

Ebu Tt DDestination Style Control
+ `EXCLUDE`
+ `INCLUDE`

### EbuTtDFillLineGapControl
<a name="channels-channelid-model-ebuttdfilllinegapcontrol"></a>

Ebu Tt DFill Line Gap Control
+ `DISABLED`
+ `ENABLED`

### EmbeddedConvert608To708
<a name="channels-channelid-model-embeddedconvert608to708"></a>

Embedded Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### EmbeddedDestinationSettings
<a name="channels-channelid-model-embeddeddestinationsettings"></a>

Embedded Destination Settings

### EmbeddedPlusScte20DestinationSettings
<a name="channels-channelid-model-embeddedplusscte20destinationsettings"></a>

Embedded Plus Scte20 Destination Settings

### EmbeddedScte20Detection
<a name="channels-channelid-model-embeddedscte20detection"></a>

Embedded Scte20 Detection
+ `AUTO`
+ `OFF`

### EmbeddedSourceSettings
<a name="channels-channelid-model-embeddedsourcesettings"></a>

Embedded Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [EmbeddedConvert608To708](#channels-channelid-model-embeddedconvert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| scte20Detection | [EmbeddedScte20Detection](#channels-channelid-model-embeddedscte20detection) | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 
| source608TrackNumber | integerMinimum: 1Maximum: 5 | False | This field is unused and deprecated. | 

### EncoderSettings
<a name="channels-channelid-model-encodersettings"></a>

Encoder Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptions | Array of type [AudioDescription](#channels-channelid-model-audiodescription) | True |  | 
| availBlanking | [AvailBlanking](#channels-channelid-model-availblanking) | False | Settings for ad avail blanking. | 
| availConfiguration | [AvailConfiguration](#channels-channelid-model-availconfiguration) | False | Event-wide configuration settings for ad avail insertion. | 
| blackoutSlate | [BlackoutSlate](#channels-channelid-model-blackoutslate) | False | Settings for blackout slate. | 
| captionDescriptions | Array of type [CaptionDescription](#channels-channelid-model-captiondescription) | False | Settings for caption decriptions | 
| featureActivations | [FeatureActivations](#channels-channelid-model-featureactivations) | False | Feature Activations | 
| globalConfiguration | [GlobalConfiguration](#channels-channelid-model-globalconfiguration) | False | Configuration settings that apply to the event as a whole. | 
| motionGraphicsConfiguration | [MotionGraphicsConfiguration](#channels-channelid-model-motiongraphicsconfiguration) | False | Settings for motion graphics. | 
| nielsenConfiguration | [NielsenConfiguration](#channels-channelid-model-nielsenconfiguration) | False | Nielsen configuration settings. | 
| outputGroups | Array of type [OutputGroup](#channels-channelid-model-outputgroup) | True |  | 
| timecodeConfig | [TimecodeConfig](#channels-channelid-model-timecodeconfig) | True | Contains settings used to acquire and adjust timecode information from inputs. | 
| videoDescriptions | Array of type [VideoDescription](#channels-channelid-model-videodescription) | True |  | 

### FailoverCondition
<a name="channels-channelid-model-failovercondition"></a>

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failoverConditionSettings | [FailoverConditionSettings](#channels-channelid-model-failoverconditionsettings) | False | Failover condition type-specific settings. | 

### FailoverConditionSettings
<a name="channels-channelid-model-failoverconditionsettings"></a>

Settings for one failover condition.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSilenceSettings | [AudioSilenceFailoverSettings](#channels-channelid-model-audiosilencefailoversettings) | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | 
| inputLossSettings | [InputLossFailoverSettings](#channels-channelid-model-inputlossfailoversettings) | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | 
| videoBlackSettings | [VideoBlackFailoverSettings](#channels-channelid-model-videoblackfailoversettings) | False | MediaLive will perform a failover if content is considered black for the specified period. | 

### FeatureActivations
<a name="channels-channelid-model-featureactivations"></a>

Feature Activations


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputPrepareScheduleActions | [FeatureActivationsInputPrepareScheduleActions](#channels-channelid-model-featureactivationsinputpreparescheduleactions) | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. | 

### FeatureActivationsInputPrepareScheduleActions
<a name="channels-channelid-model-featureactivationsinputpreparescheduleactions"></a>

Feature Activations Input Prepare Schedule Actions
+ `DISABLED`
+ `ENABLED`

### FecOutputIncludeFec
<a name="channels-channelid-model-fecoutputincludefec"></a>

Fec Output Include Fec
+ `COLUMN`
+ `COLUMN_AND_ROW`

### FecOutputSettings
<a name="channels-channelid-model-fecoutputsettings"></a>

Fec Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| columnDepth | integerMinimum: 4Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. | 
| includeFec | [FecOutputIncludeFec](#channels-channelid-model-fecoutputincludefec) | False | Enables column only or column and row based FEC | 
| rowLength | integerMinimum: 1Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. | 

### FixedAfd
<a name="channels-channelid-model-fixedafd"></a>

Fixed Afd
+ `AFD_0000`
+ `AFD_0010`
+ `AFD_0011`
+ `AFD_0100`
+ `AFD_1000`
+ `AFD_1001`
+ `AFD_1010`
+ `AFD_1011`
+ `AFD_1101`
+ `AFD_1110`
+ `AFD_1111`

### Fmp4HlsSettings
<a name="channels-channelid-model-fmp4hlssettings"></a>

Fmp4 Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| nielsenId3Behavior | [Fmp4NielsenId3Behavior](#channels-channelid-model-fmp4nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| timedMetadataBehavior | [Fmp4TimedMetadataBehavior](#channels-channelid-model-fmp4timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 

### Fmp4NielsenId3Behavior
<a name="channels-channelid-model-fmp4nielsenid3behavior"></a>

Fmp4 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### Fmp4TimedMetadataBehavior
<a name="channels-channelid-model-fmp4timedmetadatabehavior"></a>

Fmp4 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### FrameCaptureCdnSettings
<a name="channels-channelid-model-framecapturecdnsettings"></a>

Frame Capture Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureS3Settings | [FrameCaptureS3Settings](#channels-channelid-model-framecaptures3settings) | False |  | 

### FrameCaptureGroupSettings
<a name="channels-channelid-model-framecapturegroupsettings"></a>

Frame Capture Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") \$1 name modifier \$1 the counter (5 digits, starting from 00001) \$1 extension (which is always .jpg). For example, curling-low.00001.jpg | 
| frameCaptureCdnSettings | [FrameCaptureCdnSettings](#channels-channelid-model-framecapturecdnsettings) | False | Parameters that control interactions with the CDN. | 

### FrameCaptureHlsSettings
<a name="channels-channelid-model-framecapturehlssettings"></a>

Frame Capture Hls Settings

### FrameCaptureIntervalUnit
<a name="channels-channelid-model-framecaptureintervalunit"></a>

Frame Capture Interval Unit
+ `MILLISECONDS`
+ `SECONDS`

### FrameCaptureOutputSettings
<a name="channels-channelid-model-framecaptureoutputsettings"></a>

Frame Capture Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. | 

### FrameCaptureS3LogUploads
<a name="channels-channelid-model-framecaptures3loguploads"></a>

Frame Capture S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### FrameCaptureS3Settings
<a name="channels-channelid-model-framecaptures3settings"></a>

Frame Capture S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [FrameCaptureS3LogUploads](#channels-channelid-model-framecaptures3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### FrameCaptureSettings
<a name="channels-channelid-model-framecapturesettings"></a>

Frame Capture Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captureInterval | integerMinimum: 1Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. | 
| captureIntervalUnits | [FrameCaptureIntervalUnit](#channels-channelid-model-framecaptureintervalunit) | False | Unit for the frame capture interval. | 

### GatewayTimeoutException
<a name="channels-channelid-model-gatewaytimeoutexception"></a>


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

### GlobalConfiguration
<a name="channels-channelid-model-globalconfiguration"></a>

Global Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| initialAudioGain | integerMinimum: -60Maximum: 60 | False | Value to set the initial audio gain for the Live Event. | 
| inputEndAction | [GlobalConfigurationInputEndAction](#channels-channelid-model-globalconfigurationinputendaction) | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | 
| inputLossBehavior | [InputLossBehavior](#channels-channelid-model-inputlossbehavior) | False | Settings for system actions when input is lost. | 
| outputLockingMode | [GlobalConfigurationOutputLockingMode](#channels-channelid-model-globalconfigurationoutputlockingmode) | False | Indicates how MediaLive pipelines are synchronized. PIPELINE\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | 
| outputTimingSource | [GlobalConfigurationOutputTimingSource](#channels-channelid-model-globalconfigurationoutputtimingsource) | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | 
| supportLowFramerateInputs | [GlobalConfigurationLowFramerateInputs](#channels-channelid-model-globalconfigurationlowframerateinputs) | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. | 

### GlobalConfigurationInputEndAction
<a name="channels-channelid-model-globalconfigurationinputendaction"></a>

Global Configuration Input End Action
+ `NONE`
+ `SWITCH_AND_LOOP_INPUTS`

### GlobalConfigurationLowFramerateInputs
<a name="channels-channelid-model-globalconfigurationlowframerateinputs"></a>

Global Configuration Low Framerate Inputs
+ `DISABLED`
+ `ENABLED`

### GlobalConfigurationOutputLockingMode
<a name="channels-channelid-model-globalconfigurationoutputlockingmode"></a>

Global Configuration Output Locking Mode
+ `EPOCH_LOCKING`
+ `PIPELINE_LOCKING`

### GlobalConfigurationOutputTimingSource
<a name="channels-channelid-model-globalconfigurationoutputtimingsource"></a>

Global Configuration Output Timing Source
+ `INPUT_CLOCK`
+ `SYSTEM_CLOCK`

### H264AdaptiveQuantization
<a name="channels-channelid-model-h264adaptivequantization"></a>

H264 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H264ColorMetadata
<a name="channels-channelid-model-h264colormetadata"></a>

H264 Color Metadata
+ `IGNORE`
+ `INSERT`

### H264ColorSpaceSettings
<a name="channels-channelid-model-h264colorspacesettings"></a>

H264 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-model-colorspacepassthroughsettings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-model-rec709settings) | False |  | 

### H264EntropyEncoding
<a name="channels-channelid-model-h264entropyencoding"></a>

H264 Entropy Encoding
+ `CABAC`
+ `CAVLC`

### H264FilterSettings
<a name="channels-channelid-model-h264filtersettings"></a>

H264 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-model-temporalfiltersettings) | False |  | 

### H264FlickerAq
<a name="channels-channelid-model-h264flickeraq"></a>

H264 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H264ForceFieldPictures
<a name="channels-channelid-model-h264forcefieldpictures"></a>

H264 Force Field Pictures
+ `DISABLED`
+ `ENABLED`

### H264FramerateControl
<a name="channels-channelid-model-h264frameratecontrol"></a>

H264 Framerate Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264GopBReference
<a name="channels-channelid-model-h264gopbreference"></a>

H264 Gop BReference
+ `DISABLED`
+ `ENABLED`

### H264GopSizeUnits
<a name="channels-channelid-model-h264gopsizeunits"></a>

H264 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H264Level
<a name="channels-channelid-model-h264level"></a>

H264 Level
+ `H264_LEVEL_1`
+ `H264_LEVEL_1_1`
+ `H264_LEVEL_1_2`
+ `H264_LEVEL_1_3`
+ `H264_LEVEL_2`
+ `H264_LEVEL_2_1`
+ `H264_LEVEL_2_2`
+ `H264_LEVEL_3`
+ `H264_LEVEL_3_1`
+ `H264_LEVEL_3_2`
+ `H264_LEVEL_4`
+ `H264_LEVEL_4_1`
+ `H264_LEVEL_4_2`
+ `H264_LEVEL_5`
+ `H264_LEVEL_5_1`
+ `H264_LEVEL_5_2`
+ `H264_LEVEL_AUTO`

### H264LookAheadRateControl
<a name="channels-channelid-model-h264lookaheadratecontrol"></a>

H264 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H264ParControl
<a name="channels-channelid-model-h264parcontrol"></a>

H264 Par Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264Profile
<a name="channels-channelid-model-h264profile"></a>

H264 Profile
+ `BASELINE`
+ `HIGH`
+ `HIGH_10BIT`
+ `HIGH_422`
+ `HIGH_422_10BIT`
+ `MAIN`

### H264QualityLevel
<a name="channels-channelid-model-h264qualitylevel"></a>

H264 Quality Level
+ `ENHANCED_QUALITY`
+ `STANDARD_QUALITY`

### H264RateControlMode
<a name="channels-channelid-model-h264ratecontrolmode"></a>

H264 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`
+ `VBR`

### H264ScanType
<a name="channels-channelid-model-h264scantype"></a>

H264 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H264SceneChangeDetect
<a name="channels-channelid-model-h264scenechangedetect"></a>

H264 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H264Settings
<a name="channels-channelid-model-h264settings"></a>

H264 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H264AdaptiveQuantization](#channels-channelid-model-h264adaptivequantization) | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | 
| afdSignaling | [AfdSignaling](#channels-channelid-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| bitrate | integerMinimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufFillPct | integerMinimum: 0Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). | 
| bufSize | integerMinimum: 0 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H264ColorMetadata](#channels-channelid-model-h264colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H264ColorSpaceSettings](#channels-channelid-model-h264colorspacesettings) | False | Color Space settings | 
| entropyEncoding | [H264EntropyEncoding](#channels-channelid-model-h264entropyencoding) | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | 
| filterSettings | [H264FilterSettings](#channels-channelid-model-h264filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H264FlickerAq](#channels-channelid-model-h264flickeraq) | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | 
| forceFieldPictures | [H264ForceFieldPictures](#channels-channelid-model-h264forcefieldpictures) | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | 
| framerateControl | [H264FramerateControl](#channels-channelid-model-h264frameratecontrol) | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | 
| framerateDenominator | integerMinimum: 1 | False | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopBReference | [H264GopBReference](#channels-channelid-model-h264gopbreference) | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Number of B-frames between reference frames. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H264GopSizeUnits](#channels-channelid-model-h264gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H264Level](#channels-channelid-model-h264level) | False | H.264 Level. | 
| lookAheadRateControl | [H264LookAheadRateControl](#channels-channelid-model-h264lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| numRefFrames | integerMinimum: 1Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. | 
| parControl | [H264ParControl](#channels-channelid-model-h264parcontrol) | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H264Profile](#channels-channelid-model-h264profile) | False | H.264 Profile. | 
| qualityLevel | [H264QualityLevel](#channels-channelid-model-h264qualitylevel) | False | Leave as STANDARD\$1QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED\$1QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED\$1QUALITY. - STANDARD\$1QUALITY: Valid for any Rate control mode. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide | 
| rateControlMode | [H264RateControlMode](#channels-channelid-model-h264ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H264ScanType](#channels-channelid-model-h264scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H264SceneChangeDetect](#channels-channelid-model-h264scenechangedetect) | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | 
| slices | integerMinimum: 1Maximum: 32 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| softness | integerMinimum: 0Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. | 
| spatialAq | [H264SpatialAq](#channels-channelid-model-h264spatialaq) | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | 
| subgopLength | [H264SubGopLength](#channels-channelid-model-h264subgoplength) | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | 
| syntax | [H264Syntax](#channels-channelid-model-h264syntax) | False | Produces a bitstream compliant with SMPTE RP-2027. | 
| temporalAq | [H264TemporalAq](#channels-channelid-model-h264temporalaq) | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | 
| timecodeInsertion | [H264TimecodeInsertionBehavior](#channels-channelid-model-h264timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H264SpatialAq
<a name="channels-channelid-model-h264spatialaq"></a>

H264 Spatial Aq
+ `DISABLED`
+ `ENABLED`

### H264SubGopLength
<a name="channels-channelid-model-h264subgoplength"></a>

H264 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### H264Syntax
<a name="channels-channelid-model-h264syntax"></a>

H264 Syntax
+ `DEFAULT`
+ `RP2027`

### H264TemporalAq
<a name="channels-channelid-model-h264temporalaq"></a>

H264 Temporal Aq
+ `DISABLED`
+ `ENABLED`

### H264TimecodeInsertionBehavior
<a name="channels-channelid-model-h264timecodeinsertionbehavior"></a>

H264 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### H265AdaptiveQuantization
<a name="channels-channelid-model-h265adaptivequantization"></a>

H265 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H265AlternativeTransferFunction
<a name="channels-channelid-model-h265alternativetransferfunction"></a>

H265 Alternative Transfer Function
+ `INSERT`
+ `OMIT`

### H265ColorMetadata
<a name="channels-channelid-model-h265colormetadata"></a>

H265 Color Metadata
+ `IGNORE`
+ `INSERT`

### H265ColorSpaceSettings
<a name="channels-channelid-model-h265colorspacesettings"></a>

H265 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-model-colorspacepassthroughsettings) | False |  | 
| hdr10Settings | [Hdr10Settings](#channels-channelid-model-hdr10settings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-model-rec709settings) | False |  | 

### H265FilterSettings
<a name="channels-channelid-model-h265filtersettings"></a>

H265 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-model-temporalfiltersettings) | False |  | 

### H265FlickerAq
<a name="channels-channelid-model-h265flickeraq"></a>

H265 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H265GopSizeUnits
<a name="channels-channelid-model-h265gopsizeunits"></a>

H265 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H265Level
<a name="channels-channelid-model-h265level"></a>

H265 Level
+ `H265_LEVEL_1`
+ `H265_LEVEL_2`
+ `H265_LEVEL_2_1`
+ `H265_LEVEL_3`
+ `H265_LEVEL_3_1`
+ `H265_LEVEL_4`
+ `H265_LEVEL_4_1`
+ `H265_LEVEL_5`
+ `H265_LEVEL_5_1`
+ `H265_LEVEL_5_2`
+ `H265_LEVEL_6`
+ `H265_LEVEL_6_1`
+ `H265_LEVEL_6_2`
+ `H265_LEVEL_AUTO`

### H265LookAheadRateControl
<a name="channels-channelid-model-h265lookaheadratecontrol"></a>

H265 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H265Profile
<a name="channels-channelid-model-h265profile"></a>

H265 Profile
+ `MAIN`
+ `MAIN_10BIT`

### H265RateControlMode
<a name="channels-channelid-model-h265ratecontrolmode"></a>

H265 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`

### H265ScanType
<a name="channels-channelid-model-h265scantype"></a>

H265 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H265SceneChangeDetect
<a name="channels-channelid-model-h265scenechangedetect"></a>

H265 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H265Settings
<a name="channels-channelid-model-h265settings"></a>

H265 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H265AdaptiveQuantization](#channels-channelid-model-h265adaptivequantization) | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| alternativeTransferFunction | [H265AlternativeTransferFunction](#channels-channelid-model-h265alternativetransferfunction) | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | 
| bitrate | integerMinimum: 100000Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufSize | integerMinimum: 100000Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H265ColorMetadata](#channels-channelid-model-h265colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H265ColorSpaceSettings](#channels-channelid-model-h265colorspacesettings) | False | Color Space settings | 
| filterSettings | [H265FilterSettings](#channels-channelid-model-h265filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H265FlickerAq](#channels-channelid-model-h265flickeraq) | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | 
| framerateDenominator | integerMinimum: 1Maximum: 3003 | True | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H265GopSizeUnits](#channels-channelid-model-h265gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H265Level](#channels-channelid-model-h265level) | False | H.265 Level. | 
| lookAheadRateControl | [H265LookAheadRateControl](#channels-channelid-model-h265lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 100000Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H265Profile](#channels-channelid-model-h265profile) | False | H.265 Profile. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M | 
| rateControlMode | [H265RateControlMode](#channels-channelid-model-h265ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H265ScanType](#channels-channelid-model-h265scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H265SceneChangeDetect](#channels-channelid-model-h265scenechangedetect) | False | Scene change detection. | 
| slices | integerMinimum: 1Maximum: 16 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| tier | [H265Tier](#channels-channelid-model-h265tier) | False | H.265 Tier. | 
| timecodeInsertion | [H265TimecodeInsertionBehavior](#channels-channelid-model-h265timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H265Tier
<a name="channels-channelid-model-h265tier"></a>

H265 Tier
+ `HIGH`
+ `MAIN`

### H265TimecodeInsertionBehavior
<a name="channels-channelid-model-h265timecodeinsertionbehavior"></a>

H265 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### Hdr10Settings
<a name="channels-channelid-model-hdr10settings"></a>

Hdr10 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxCll | integerMinimum: 0Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. | 
| maxFall | integerMinimum: 0Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. | 

### HlsAdMarkers
<a name="channels-channelid-model-hlsadmarkers"></a>

Hls Ad Markers
+ `ADOBE`
+ `ELEMENTAL`
+ `ELEMENTAL_SCTE35`

### HlsAkamaiHttpTransferMode
<a name="channels-channelid-model-hlsakamaihttptransfermode"></a>

Hls Akamai Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsAkamaiSettings
<a name="channels-channelid-model-hlsakamaisettings"></a>

Hls Akamai Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsAkamaiHttpTransferMode](#channels-channelid-model-hlsakamaihttptransfermode) | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 
| salt | string | False | Salt for authenticated Akamai. | 
| token | string | False | Token parameter for authenticated akamai. If not specified, \$1gda\$1 is used. | 

### HlsBasicPutSettings
<a name="channels-channelid-model-hlsbasicputsettings"></a>

Hls Basic Put Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsCaptionLanguageSetting
<a name="channels-channelid-model-hlscaptionlanguagesetting"></a>

Hls Caption Language Setting
+ `INSERT`
+ `NONE`
+ `OMIT`

### HlsCdnSettings
<a name="channels-channelid-model-hlscdnsettings"></a>

Hls Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsAkamaiSettings | [HlsAkamaiSettings](#channels-channelid-model-hlsakamaisettings) | False |  | 
| hlsBasicPutSettings | [HlsBasicPutSettings](#channels-channelid-model-hlsbasicputsettings) | False |  | 
| hlsMediaStoreSettings | [HlsMediaStoreSettings](#channels-channelid-model-hlsmediastoresettings) | False |  | 
| hlsS3Settings | [HlsS3Settings](#channels-channelid-model-hlss3settings) | False |  | 
| hlsWebdavSettings | [HlsWebdavSettings](#channels-channelid-model-hlswebdavsettings) | False |  | 

### HlsClientCache
<a name="channels-channelid-model-hlsclientcache"></a>

Hls Client Cache
+ `DISABLED`
+ `ENABLED`

### HlsCodecSpecification
<a name="channels-channelid-model-hlscodecspecification"></a>

Hls Codec Specification
+ `RFC_4281`
+ `RFC_6381`

### HlsDirectoryStructure
<a name="channels-channelid-model-hlsdirectorystructure"></a>

Hls Directory Structure
+ `SINGLE_DIRECTORY`
+ `SUBDIRECTORY_PER_STREAM`

### HlsDiscontinuityTags
<a name="channels-channelid-model-hlsdiscontinuitytags"></a>

Hls Discontinuity Tags
+ `INSERT`
+ `NEVER_INSERT`

### HlsEncryptionType
<a name="channels-channelid-model-hlsencryptiontype"></a>

Hls Encryption Type
+ `AES128`
+ `SAMPLE_AES`

### HlsGroupSettings
<a name="channels-channelid-model-hlsgroupsettings"></a>

Hls Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [HlsAdMarkers](#channels-channelid-model-hlsadmarkers) | False | Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. | 
| baseUrlContent | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. | 
| baseUrlManifest | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. | 
| captionLanguageMappings | Array of type [CaptionLanguageMapping](#channels-channelid-model-captionlanguagemapping) | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". | 
| captionLanguageSetting | [HlsCaptionLanguageSetting](#channels-channelid-model-hlscaptionlanguagesetting) | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | 
| clientCache | [HlsClientCache](#channels-channelid-model-hlsclientcache) | False | When set to "disabled", sets the \$1EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | 
| codecSpecification | [HlsCodecSpecification](#channels-channelid-model-hlscodecspecification) | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | 
| constantIv | stringMinLength: 32MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. | 
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | 
| directoryStructure | [HlsDirectoryStructure](#channels-channelid-model-hlsdirectorystructure) | False | Place segments in subdirectories. | 
| discontinuityTags | [HlsDiscontinuityTags](#channels-channelid-model-hlsdiscontinuitytags) | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | 
| encryptionType | [HlsEncryptionType](#channels-channelid-model-hlsencryptiontype) | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | 
| hlsCdnSettings | [HlsCdnSettings](#channels-channelid-model-hlscdnsettings) | False | Parameters that control interactions with the CDN. | 
| hlsId3SegmentTagging | [HlsId3SegmentTaggingState](#channels-channelid-model-hlsid3segmenttaggingstate) | False | State of HLS ID3 Segment Tagging | 
| iFrameOnlyPlaylists | [IFrameOnlyPlaylistType](#channels-channelid-model-iframeonlyplaylisttype) | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a \$1EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more \$1EXT-X-BYTERANGE entries identifying the I-frame position. For example, \$1EXT-X-BYTERANGE:160364@1461888" | 
| incompleteSegmentBehavior | [HlsIncompleteSegmentBehavior](#channels-channelid-model-hlsincompletesegmentbehavior) | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | 
| indexNSegments | integerMinimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. | 
| inputLossAction | [InputLossActionForHlsOut](#channels-channelid-model-inputlossactionforhlsout) | False | Parameter that control output group behavior on input loss. | 
| ivInManifest | [HlsIvInManifest](#channels-channelid-model-hlsivinmanifest) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | 
| ivSource | [HlsIvSource](#channels-channelid-model-hlsivsource) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | 
| keepSegments | integerMinimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) \$1 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. | 
| keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. | 
| keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). | 
| keyProviderSettings | [KeyProviderSettings](#channels-channelid-model-keyprovidersettings) | False | The key provider settings. | 
| manifestCompression | [HlsManifestCompression](#channels-channelid-model-hlsmanifestcompression) | False | When set to gzip, compresses HLS playlist. | 
| manifestDurationFormat | [HlsManifestDurationFormat](#channels-channelid-model-hlsmanifestdurationformat) | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | 
| minSegmentLength | integerMinimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. | 
| mode | [HlsMode](#channels-channelid-model-hlsmode) | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | 
| outputSelection | [HlsOutputSelection](#channels-channelid-model-hlsoutputselection) | False | MANIFESTS\$1AND\$1SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT\$1MANIFESTS\$1AND\$1SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS\$1ONLY: Does not generate any manifests for this output group. | 
| programDateTime | [HlsProgramDateTime](#channels-channelid-model-hlsprogramdatetime) | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | 
| programDateTimeClock | [HlsProgramDateTimeClock](#channels-channelid-model-hlsprogramdatetimeclock) | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE\$1FROM\$1OUTPUT\$1TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM\$1CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | 
| programDateTimePeriod | integerMinimum: 0Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | 
| redundantManifest | [HlsRedundantManifest](#channels-channelid-model-hlsredundantmanifest) | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | 
| segmentationMode | [HlsSegmentationMode](#channels-channelid-model-hlssegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| segmentLength | integerMinimum: 1 | False | Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. | 
| segmentsPerSubdirectory | integerMinimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. | 
| streamInfResolution | [HlsStreamInfResolution](#channels-channelid-model-hlsstreaminfresolution) | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | 
| timedMetadataId3Frame | [HlsTimedMetadataId3Frame](#channels-channelid-model-hlstimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 
| timestampDeltaMilliseconds | integerMinimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. | 
| tsFileMode | [HlsTsFileMode](#channels-channelid-model-hlstsfilemode) | False | SEGMENTED\$1FILES: Emit the program as segments - multiple .ts media files. SINGLE\$1FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes \$1EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. | 

### HlsH265PackagingType
<a name="channels-channelid-model-hlsh265packagingtype"></a>

Hls H265 Packaging Type
+ `HEV1`
+ `HVC1`

### HlsId3SegmentTaggingState
<a name="channels-channelid-model-hlsid3segmenttaggingstate"></a>

State of HLS ID3 Segment Tagging
+ `DISABLED`
+ `ENABLED`

### HlsIncompleteSegmentBehavior
<a name="channels-channelid-model-hlsincompletesegmentbehavior"></a>

Hls Incomplete Segment Behavior
+ `AUTO`
+ `SUPPRESS`

### HlsInputSettings
<a name="channels-channelid-model-hlsinputsettings"></a>

Hls Input Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bandwidth | integerMinimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. | 
| bufferSegments | integerMinimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. | 
| retries | integerMinimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. | 
| retryInterval | integerMinimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. | 
| scte35Source | [HlsScte35SourceType](#channels-channelid-model-hlsscte35sourcetype) | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. | 

### HlsIvInManifest
<a name="channels-channelid-model-hlsivinmanifest"></a>

Hls Iv In Manifest
+ `EXCLUDE`
+ `INCLUDE`

### HlsIvSource
<a name="channels-channelid-model-hlsivsource"></a>

Hls Iv Source
+ `EXPLICIT`
+ `FOLLOWS_SEGMENT_NUMBER`

### HlsManifestCompression
<a name="channels-channelid-model-hlsmanifestcompression"></a>

Hls Manifest Compression
+ `GZIP`
+ `NONE`

### HlsManifestDurationFormat
<a name="channels-channelid-model-hlsmanifestdurationformat"></a>

Hls Manifest Duration Format
+ `FLOATING_POINT`
+ `INTEGER`

### HlsMediaStoreSettings
<a name="channels-channelid-model-hlsmediastoresettings"></a>

Hls Media Store Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| mediaStoreStorageClass | [HlsMediaStoreStorageClass](#channels-channelid-model-hlsmediastorestorageclass) | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsMediaStoreStorageClass
<a name="channels-channelid-model-hlsmediastorestorageclass"></a>

Hls Media Store Storage Class
+ `TEMPORAL`

### HlsMode
<a name="channels-channelid-model-hlsmode"></a>

Hls Mode
+ `LIVE`
+ `VOD`

### HlsOutputSelection
<a name="channels-channelid-model-hlsoutputselection"></a>

Hls Output Selection
+ `MANIFESTS_AND_SEGMENTS`
+ `SEGMENTS_ONLY`
+ `VARIANT_MANIFESTS_AND_SEGMENTS`

### HlsOutputSettings
<a name="channels-channelid-model-hlsoutputsettings"></a>

Hls Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [HlsH265PackagingType](#channels-channelid-model-hlsh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| hlsSettings | [HlsSettings](#channels-channelid-model-hlssettings) | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | 
| nameModifier | stringMinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \$1"Format Identifiers\$1":\$1formatIdentifierParameters. | 
| segmentModifier | string | False | String concatenated to end of segment filenames. | 

### HlsProgramDateTime
<a name="channels-channelid-model-hlsprogramdatetime"></a>

Hls Program Date Time
+ `EXCLUDE`
+ `INCLUDE`

### HlsProgramDateTimeClock
<a name="channels-channelid-model-hlsprogramdatetimeclock"></a>

Hls Program Date Time Clock
+ `INITIALIZE_FROM_OUTPUT_TIMECODE`
+ `SYSTEM_CLOCK`

### HlsRedundantManifest
<a name="channels-channelid-model-hlsredundantmanifest"></a>

Hls Redundant Manifest
+ `DISABLED`
+ `ENABLED`

### HlsS3LogUploads
<a name="channels-channelid-model-hlss3loguploads"></a>

Hls S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### HlsS3Settings
<a name="channels-channelid-model-hlss3settings"></a>

Hls S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [HlsS3LogUploads](#channels-channelid-model-hlss3loguploads) | False | When set to enabled, each fragment upload to CDN or server will be logged. | 

### HlsScte35SourceType
<a name="channels-channelid-model-hlsscte35sourcetype"></a>

Hls Scte35 Source Type
+ `MANIFEST`
+ `SEGMENTS`

### HlsSegmentationMode
<a name="channels-channelid-model-hlssegmentationmode"></a>

Hls Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### HlsSettings
<a name="channels-channelid-model-hlssettings"></a>

Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioOnlyHlsSettings | [AudioOnlyHlsSettings](#channels-channelid-model-audioonlyhlssettings) | False |  | 
| fmp4HlsSettings | [Fmp4HlsSettings](#channels-channelid-model-fmp4hlssettings) | False |  | 
| frameCaptureHlsSettings | [FrameCaptureHlsSettings](#channels-channelid-model-framecapturehlssettings) | False |  | 
| standardHlsSettings | [StandardHlsSettings](#channels-channelid-model-standardhlssettings) | False |  | 

### HlsStreamInfResolution
<a name="channels-channelid-model-hlsstreaminfresolution"></a>

Hls Stream Inf Resolution
+ `EXCLUDE`
+ `INCLUDE`

### HlsTimedMetadataId3Frame
<a name="channels-channelid-model-hlstimedmetadataid3frame"></a>

Hls Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### HlsTsFileMode
<a name="channels-channelid-model-hlstsfilemode"></a>

Hls Ts File Mode
+ `SEGMENTED_FILES`
+ `SINGLE_FILE`

### HlsWebdavHttpTransferMode
<a name="channels-channelid-model-hlswebdavhttptransfermode"></a>

Hls Webdav Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsWebdavSettings
<a name="channels-channelid-model-hlswebdavsettings"></a>

Hls Webdav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsWebdavHttpTransferMode](#channels-channelid-model-hlswebdavhttptransfermode) | False | Specify whether or not to use chunked transfer encoding to WebDAV. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HtmlMotionGraphicsSettings
<a name="channels-channelid-model-htmlmotiongraphicssettings"></a>

Html Motion Graphics Settings

### IFrameOnlyPlaylistType
<a name="channels-channelid-model-iframeonlyplaylisttype"></a>

When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
+ `DISABLED`
+ `STANDARD`

### InputAttachment
<a name="channels-channelid-model-inputattachment"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| automaticInputFailoverSettings | [AutomaticInputFailoverSettings](#channels-channelid-model-automaticinputfailoversettings) | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | 
| inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. | 
| inputId | string | False | The ID of the input | 
| inputSettings | [InputSettings](#channels-channelid-model-inputsettings) | False | Settings of an input (caption selector, etc.) | 

### InputChannelLevel
<a name="channels-channelid-model-inputchannellevel"></a>

Input Channel Level


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| gain | integerMinimum: -60Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. | 
| inputChannel | integerMinimum: 0Maximum: 15 | True | The index of the input channel used as a source. | 

### InputCodec
<a name="channels-channelid-model-inputcodec"></a>

codec in increasing order of complexity
+ `MPEG2`
+ `AVC`
+ `HEVC`

### InputDeblockFilter
<a name="channels-channelid-model-inputdeblockfilter"></a>

Input Deblock Filter
+ `DISABLED`
+ `ENABLED`

### InputDenoiseFilter
<a name="channels-channelid-model-inputdenoisefilter"></a>

Input Denoise Filter
+ `DISABLED`
+ `ENABLED`

### InputFilter
<a name="channels-channelid-model-inputfilter"></a>

Input Filter
+ `AUTO`
+ `DISABLED`
+ `FORCED`

### InputLocation
<a name="channels-channelid-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputLossActionForHlsOut
<a name="channels-channelid-model-inputlossactionforhlsout"></a>

Input Loss Action For Hls Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForMsSmoothOut
<a name="channels-channelid-model-inputlossactionformssmoothout"></a>

Input Loss Action For Ms Smooth Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForRtmpOut
<a name="channels-channelid-model-inputlossactionforrtmpout"></a>

Input Loss Action For Rtmp Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForUdpOut
<a name="channels-channelid-model-inputlossactionforudpout"></a>

Input Loss Action For Udp Out
+ `DROP_PROGRAM`
+ `DROP_TS`
+ `EMIT_PROGRAM`

### InputLossBehavior
<a name="channels-channelid-model-inputlossbehavior"></a>

Input Loss Behavior


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 
| inputLossImageColor | stringMinLength: 6MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. | 
| inputLossImageSlate | [InputLocation](#channels-channelid-model-inputlocation) | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | 
| inputLossImageType | [InputLossImageType](#channels-channelid-model-inputlossimagetype) | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | 
| repeatFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 

### InputLossFailoverSettings
<a name="channels-channelid-model-inputlossfailoversettings"></a>

MediaLive will perform a failover if content is not detected in this input for the specified period.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossThresholdMsec | integerMinimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. | 

### InputLossImageType
<a name="channels-channelid-model-inputlossimagetype"></a>

Input Loss Image Type
+ `COLOR`
+ `SLATE`

### InputMaximumBitrate
<a name="channels-channelid-model-inputmaximumbitrate"></a>

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### InputPreference
<a name="channels-channelid-model-inputpreference"></a>

Input preference when deciding which input to make active when a previously failed input has recovered. If \$1"EQUAL\$1INPUT\$1PREFERENCE\$1", then the active input will stay active as long as it is healthy. If \$1"PRIMARY\$1INPUT\$1PREFERRED\$1", then always switch back to the primary input when it is healthy. 
+ `EQUAL_INPUT_PREFERENCE`
+ `PRIMARY_INPUT_PREFERRED`

### InputResolution
<a name="channels-channelid-model-inputresolution"></a>

Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `UHD`

### InputSettings
<a name="channels-channelid-model-inputsettings"></a>

Live Event input parameters. There can be multiple inputs in a single Live Event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectors | Array of type [AudioSelector](#channels-channelid-model-audioselector) | False | Used to select the audio stream to decode for inputs that have multiple available. | 
| captionSelectors | Array of type [CaptionSelector](#channels-channelid-model-captionselector) | False | Used to select the caption input to use for inputs that have multiple available. | 
| deblockFilter | [InputDeblockFilter](#channels-channelid-model-inputdeblockfilter) | False | Enable or disable the deblock filter when filtering. | 
| denoiseFilter | [InputDenoiseFilter](#channels-channelid-model-inputdenoisefilter) | False | Enable or disable the denoise filter when filtering. | 
| filterStrength | integerMinimum: 1Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). | 
| inputFilter | [InputFilter](#channels-channelid-model-inputfilter) | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | 
| networkInputSettings | [NetworkInputSettings](#channels-channelid-model-networkinputsettings) | False | Input settings. | 
| smpte2038DataPreference | [Smpte2038DataPreference](#channels-channelid-model-smpte2038datapreference) | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | 
| sourceEndBehavior | [InputSourceEndBehavior](#channels-channelid-model-inputsourceendbehavior) | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | 
| videoSelector | [VideoSelector](#channels-channelid-model-videoselector) | False | Informs which video elementary stream to decode for input types that have multiple available. | 

### InputSourceEndBehavior
<a name="channels-channelid-model-inputsourceendbehavior"></a>

Input Source End Behavior
+ `CONTINUE`
+ `LOOP`

### InputSpecification
<a name="channels-channelid-model-inputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codec | [InputCodec](#channels-channelid-model-inputcodec) | False | Input codec | 
| maximumBitrate | [InputMaximumBitrate](#channels-channelid-model-inputmaximumbitrate) | False | Maximum input bitrate, categorized coarsely | 
| resolution | [InputResolution](#channels-channelid-model-inputresolution) | False | Input resolution, categorized coarsely | 

### InternalServiceError
<a name="channels-channelid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-channelid-model-invalidrequest"></a>


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

### KeyProviderSettings
<a name="channels-channelid-model-keyprovidersettings"></a>

Key Provider Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| staticKeySettings | [StaticKeySettings](#channels-channelid-model-statickeysettings) | False |  | 

### LimitExceeded
<a name="channels-channelid-model-limitexceeded"></a>


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

### LogLevel
<a name="channels-channelid-model-loglevel"></a>

The log level the user wants for their channel.
+ `ERROR`
+ `WARNING`
+ `INFO`
+ `DEBUG`
+ `DISABLED`

### M2tsAbsentInputAudioBehavior
<a name="channels-channelid-model-m2tsabsentinputaudiobehavior"></a>

M2ts Absent Input Audio Behavior
+ `DROP`
+ `ENCODE_SILENCE`

### M2tsArib
<a name="channels-channelid-model-m2tsarib"></a>

M2ts Arib
+ `DISABLED`
+ `ENABLED`

### M2tsAribCaptionsPidControl
<a name="channels-channelid-model-m2tsaribcaptionspidcontrol"></a>

M2ts Arib Captions Pid Control
+ `AUTO`
+ `USE_CONFIGURED`

### M2tsAudioBufferModel
<a name="channels-channelid-model-m2tsaudiobuffermodel"></a>

M2ts Audio Buffer Model
+ `ATSC`
+ `DVB`

### M2tsAudioInterval
<a name="channels-channelid-model-m2tsaudiointerval"></a>

M2ts Audio Interval
+ `VIDEO_AND_FIXED_INTERVALS`
+ `VIDEO_INTERVAL`

### M2tsAudioStreamType
<a name="channels-channelid-model-m2tsaudiostreamtype"></a>

M2ts Audio Stream Type
+ `ATSC`
+ `DVB`

### M2tsBufferModel
<a name="channels-channelid-model-m2tsbuffermodel"></a>

M2ts Buffer Model
+ `MULTIPLEX`
+ `NONE`

### M2tsCcDescriptor
<a name="channels-channelid-model-m2tsccdescriptor"></a>

M2ts Cc Descriptor
+ `DISABLED`
+ `ENABLED`

### M2tsEbifControl
<a name="channels-channelid-model-m2tsebifcontrol"></a>

M2ts Ebif Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsEbpPlacement
<a name="channels-channelid-model-m2tsebpplacement"></a>

M2ts Ebp Placement
+ `VIDEO_AND_AUDIO_PIDS`
+ `VIDEO_PID`

### M2tsEsRateInPes
<a name="channels-channelid-model-m2tsesrateinpes"></a>

M2ts Es Rate In Pes
+ `EXCLUDE`
+ `INCLUDE`

### M2tsKlv
<a name="channels-channelid-model-m2tsklv"></a>

M2ts Klv
+ `NONE`
+ `PASSTHROUGH`

### M2tsNielsenId3Behavior
<a name="channels-channelid-model-m2tsnielsenid3behavior"></a>

M2ts Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M2tsPcrControl
<a name="channels-channelid-model-m2tspcrcontrol"></a>

M2ts Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M2tsRateMode
<a name="channels-channelid-model-m2tsratemode"></a>

M2ts Rate Mode
+ `CBR`
+ `VBR`

### M2tsScte35Control
<a name="channels-channelid-model-m2tsscte35control"></a>

M2ts Scte35 Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsSegmentationMarkers
<a name="channels-channelid-model-m2tssegmentationmarkers"></a>

M2ts Segmentation Markers
+ `EBP`
+ `EBP_LEGACY`
+ `NONE`
+ `PSI_SEGSTART`
+ `RAI_ADAPT`
+ `RAI_SEGSTART`

### M2tsSegmentationStyle
<a name="channels-channelid-model-m2tssegmentationstyle"></a>

M2ts Segmentation Style
+ `MAINTAIN_CADENCE`
+ `RESET_CADENCE`

### M2tsSettings
<a name="channels-channelid-model-m2tssettings"></a>

M2ts Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| absentInputAudioBehavior | [M2tsAbsentInputAudioBehavior](#channels-channelid-model-m2tsabsentinputaudiobehavior) | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | 
| arib | [M2tsArib](#channels-channelid-model-m2tsarib) | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | 
| aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| aribCaptionsPidControl | [M2tsAribCaptionsPidControl](#channels-channelid-model-m2tsaribcaptionspidcontrol) | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | 
| audioBufferModel | [M2tsAudioBufferModel](#channels-channelid-model-m2tsaudiobuffermodel) | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | 
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| audioStreamType | [M2tsAudioStreamType](#channels-channelid-model-m2tsaudiostreamtype) | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | 
| bitrate | integerMinimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. | 
| bufferModel | [M2tsBufferModel](#channels-channelid-model-m2tsbuffermodel) | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | 
| ccDescriptor | [M2tsCcDescriptor](#channels-channelid-model-m2tsccdescriptor) | False | When set to enabled, generates captionServiceDescriptor in PMT. | 
| dvbNitSettings | [DvbNitSettings](#channels-channelid-model-dvbnitsettings) | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | 
| dvbSdtSettings | [DvbSdtSettings](#channels-channelid-model-dvbsdtsettings) | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | 
| dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| dvbTdtSettings | [DvbTdtSettings](#channels-channelid-model-dvbtdtsettings) | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | 
| dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| ebif | [M2tsEbifControl](#channels-channelid-model-m2tsebifcontrol) | False | If set to passthrough, passes any EBIF data from the input source to this output. | 
| ebpAudioInterval | [M2tsAudioInterval](#channels-channelid-model-m2tsaudiointerval) | False | When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | 
| ebpLookaheadMs | integerMinimum: 0Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. | 
| ebpPlacement | [M2tsEbpPlacement](#channels-channelid-model-m2tsebpplacement) | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | 
| ecmPid | string | False | This field is unused and deprecated. | 
| esRateInPes | [M2tsEsRateInPes](#channels-channelid-model-m2tsesrateinpes) | False | Include or exclude the ES Rate field in the PES header. | 
| etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| fragmentTime | numberMinimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. | 
| klv | [M2tsKlv](#channels-channelid-model-m2tsklv) | False | If set to passthrough, passes any KLV data from the input source to this output. | 
| klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| nielsenId3Behavior | [M2tsNielsenId3Behavior](#channels-channelid-model-m2tsnielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| nullPacketBitrate | numberMinimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pcrControl | [M2tsPcrControl](#channels-channelid-model-m2tspcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| rateMode | [M2tsRateMode](#channels-channelid-model-m2tsratemode) | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | 
| scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| scte35Control | [M2tsScte35Control](#channels-channelid-model-m2tsscte35control) | False | Optionally pass SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| segmentationMarkers | [M2tsSegmentationMarkers](#channels-channelid-model-m2tssegmentationmarkers) | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | 
| segmentationStyle | [M2tsSegmentationStyle](#channels-channelid-model-m2tssegmentationstyle) | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of \$1segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of \$1segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | 
| segmentationTime | numberMinimum: 1 | False | The length in seconds of each segment. Required unless markers is set to \$1none\$1. | 
| timedMetadataBehavior | [M2tsTimedMetadataBehavior](#channels-channelid-model-m2tstimedmetadatabehavior) | False | When set to passthrough, timed metadata will be passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 

### M2tsTimedMetadataBehavior
<a name="channels-channelid-model-m2tstimedmetadatabehavior"></a>

M2ts Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8NielsenId3Behavior
<a name="channels-channelid-model-m3u8nielsenid3behavior"></a>

M3u8 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8PcrControl
<a name="channels-channelid-model-m3u8pcrcontrol"></a>

M3u8 Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M3u8Scte35Behavior
<a name="channels-channelid-model-m3u8scte35behavior"></a>

M3u8 Scte35 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8Settings
<a name="channels-channelid-model-m3u8settings"></a>

Settings information for the .m3u8 container


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. | 
| ecmPid | string | False | This parameter is unused and deprecated. | 
| nielsenId3Behavior | [M3u8NielsenId3Behavior](#channels-channelid-model-m3u8nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pcrControl | [M3u8PcrControl](#channels-channelid-model-m3u8pcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| scte35Behavior | [M3u8Scte35Behavior](#channels-channelid-model-m3u8scte35behavior) | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| timedMetadataBehavior | [M3u8TimedMetadataBehavior](#channels-channelid-model-m3u8timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 

### M3u8TimedMetadataBehavior
<a name="channels-channelid-model-m3u8timedmetadatabehavior"></a>

M3u8 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### MaintenanceDay
<a name="channels-channelid-model-maintenanceday"></a>

The currently selected maintenance day.
+ `MONDAY`
+ `TUESDAY`
+ `WEDNESDAY`
+ `THURSDAY`
+ `FRIDAY`
+ `SATURDAY`
+ `SUNDAY`

### MaintenanceStatus
<a name="channels-channelid-model-maintenancestatus"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-channelid-model-maintenanceday) | False | The currently selected maintenance day. | 
| maintenanceDeadline | stringFormat: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. | 
| maintenanceScheduledDate | stringFormat: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. | 
| maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. | 

### MaintenanceUpdateSettings
<a name="channels-channelid-model-maintenanceupdatesettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-channelid-model-maintenanceday) | False | Choose one day of the week for maintenance. The chosen day is used for all future maintenance windows. | 
| maintenanceScheduledDate | stringFormat: string | False | Choose a specific date for maintenance to occur. The chosen date is used for the next maintenance window only. | 
| maintenanceStartTime | stringPattern: `^([0,1]?[0-9]\|2[0-3]):00$` | False | Choose the hour that maintenance will start. The chosen time is used for all future maintenance windows. | 

### MediaPackageGroupSettings
<a name="channels-channelid-model-mediapackagegroupsettings"></a>

Media Package Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | MediaPackage channel destination. | 

### MediaPackageOutputDestinationSettings
<a name="channels-channelid-model-mediapackageoutputdestinationsettings"></a>

MediaPackage Output Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | stringMinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. | 

### MediaPackageOutputSettings
<a name="channels-channelid-model-mediapackageoutputsettings"></a>

Media Package Output Settings

### MotionGraphicsConfiguration
<a name="channels-channelid-model-motiongraphicsconfiguration"></a>

Motion Graphics Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| motionGraphicsInsertion | [MotionGraphicsInsertion](#channels-channelid-model-motiongraphicsinsertion) | False |  | 
| motionGraphicsSettings | [MotionGraphicsSettings](#channels-channelid-model-motiongraphicssettings) | True | Motion Graphics Settings | 

### MotionGraphicsInsertion
<a name="channels-channelid-model-motiongraphicsinsertion"></a>

Motion Graphics Insertion
+ `DISABLED`
+ `ENABLED`

### MotionGraphicsSettings
<a name="channels-channelid-model-motiongraphicssettings"></a>

Motion Graphics Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| htmlMotionGraphicsSettings | [HtmlMotionGraphicsSettings](#channels-channelid-model-htmlmotiongraphicssettings) | False |  | 

### Mp2CodingMode
<a name="channels-channelid-model-mp2codingmode"></a>

Mp2 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`

### Mp2Settings
<a name="channels-channelid-model-mp2settings"></a>

Mp2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. | 
| codingMode | [Mp2CodingMode](#channels-channelid-model-mp2codingmode) | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | 
| sampleRate | number | False | Sample rate in Hz. | 

### Mpeg2AdaptiveQuantization
<a name="channels-channelid-model-mpeg2adaptivequantization"></a>

Mpeg2 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `LOW`
+ `MEDIUM`
+ `OFF`

### Mpeg2ColorMetadata
<a name="channels-channelid-model-mpeg2colormetadata"></a>

Mpeg2 Color Metadata
+ `IGNORE`
+ `INSERT`

### Mpeg2ColorSpace
<a name="channels-channelid-model-mpeg2colorspace"></a>

Mpeg2 Color Space
+ `AUTO`
+ `PASSTHROUGH`

### Mpeg2DisplayRatio
<a name="channels-channelid-model-mpeg2displayratio"></a>

Mpeg2 Display Ratio
+ `DISPLAYRATIO16X9`
+ `DISPLAYRATIO4X3`

### Mpeg2FilterSettings
<a name="channels-channelid-model-mpeg2filtersettings"></a>

Mpeg2 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-model-temporalfiltersettings) | False |  | 

### Mpeg2GopSizeUnits
<a name="channels-channelid-model-mpeg2gopsizeunits"></a>

Mpeg2 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### Mpeg2ScanType
<a name="channels-channelid-model-mpeg2scantype"></a>

Mpeg2 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### Mpeg2Settings
<a name="channels-channelid-model-mpeg2settings"></a>

Mpeg2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [Mpeg2AdaptiveQuantization](#channels-channelid-model-mpeg2adaptivequantization) | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-model-afdsignaling) | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | 
| colorMetadata | [Mpeg2ColorMetadata](#channels-channelid-model-mpeg2colormetadata) | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | 
| colorSpace | [Mpeg2ColorSpace](#channels-channelid-model-mpeg2colorspace) | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \$1"MediaLive Features - Video - color space\$1" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | 
| displayAspectRatio | [Mpeg2DisplayRatio](#channels-channelid-model-mpeg2displayratio) | False | Sets the pixel aspect ratio for the encode. | 
| filterSettings | [Mpeg2FilterSettings](#channels-channelid-model-mpeg2filtersettings) | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | 
| fixedAfd | [FixedAfd](#channels-channelid-model-fixedafd) | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | 
| framerateDenominator | integerMinimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| framerateNumerator | integerMinimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| gopClosedCadence | integerMinimum: 0 | False | MPEG2: default is open GOP. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. | 
| gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. | 
| gopSizeUnits | [Mpeg2GopSizeUnits](#channels-channelid-model-mpeg2gopsizeunits) | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | 
| scanType | [Mpeg2ScanType](#channels-channelid-model-mpeg2scantype) | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | 
| subgopLength | [Mpeg2SubGopLength](#channels-channelid-model-mpeg2subgoplength) | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | 
| timecodeInsertion | [Mpeg2TimecodeInsertionBehavior](#channels-channelid-model-mpeg2timecodeinsertionbehavior) | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \$1"MediaLive Features - Timecode configuration\$1" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP\$1TIMECODE: Include timecode metadata in the GOP header. | 

### Mpeg2SubGopLength
<a name="channels-channelid-model-mpeg2subgoplength"></a>

Mpeg2 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### Mpeg2TimecodeInsertionBehavior
<a name="channels-channelid-model-mpeg2timecodeinsertionbehavior"></a>

Mpeg2 Timecode Insertion Behavior
+ `DISABLED`
+ `GOP_TIMECODE`

### MsSmoothGroupSettings
<a name="channels-channelid-model-mssmoothgroupsettings"></a>

Ms Smooth Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. | 
| audioOnlyTimecodeControl | [SmoothGroupAudioOnlyTimecodeControl](#channels-channelid-model-smoothgroupaudioonlytimecodecontrol) | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | 
| certificateMode | [SmoothGroupCertificateMode](#channels-channelid-model-smoothgroupcertificatemode) | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. | 
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | 
| eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. | 
| eventIdMode | [SmoothGroupEventIdMode](#channels-channelid-model-smoothgroupeventidmode) | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | 
| eventStopBehavior | [SmoothGroupEventStopBehavior](#channels-channelid-model-smoothgroupeventstopbehavior) | False | When set to sendEos, send EOS signal to IIS server when stopping the event | 
| filecacheDuration | integerMinimum: 0 | False | Size in seconds of file cache for streaming outputs. | 
| fragmentLength | integerMinimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. | 
| inputLossAction | [InputLossActionForMsSmoothOut](#channels-channelid-model-inputlossactionformssmoothout) | False | Parameter that control output group behavior on input loss. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 
| restartDelay | integerMinimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. | 
| segmentationMode | [SmoothGroupSegmentationMode](#channels-channelid-model-smoothgroupsegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| sendDelayMs | integerMinimum: 0Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. | 
| sparseTrackType | [SmoothGroupSparseTrackType](#channels-channelid-model-smoothgroupsparsetracktype) | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35\$1WITHOUT\$1SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | 
| streamManifestBehavior | [SmoothGroupStreamManifestBehavior](#channels-channelid-model-smoothgroupstreammanifestbehavior) | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | 
| timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. | 
| timestampOffsetMode | [SmoothGroupTimestampOffsetMode](#channels-channelid-model-smoothgrouptimestampoffsetmode) | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset | 

### MsSmoothH265PackagingType
<a name="channels-channelid-model-mssmoothh265packagingtype"></a>

Ms Smooth H265 Packaging Type
+ `HEV1`
+ `HVC1`

### MsSmoothOutputSettings
<a name="channels-channelid-model-mssmoothoutputsettings"></a>

Ms Smooth Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [MsSmoothH265PackagingType](#channels-channelid-model-mssmoothh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### MultiplexGroupSettings
<a name="channels-channelid-model-multiplexgroupsettings"></a>

Multiplex Group Settings

### MultiplexOutputSettings
<a name="channels-channelid-model-multiplexoutputsettings"></a>

Multiplex Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | Destination is a Multiplex. | 

### MultiplexProgramChannelDestinationSettings
<a name="channels-channelid-model-multiplexprogramchanneldestinationsettings"></a>

Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | stringMinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. | 
| programName | stringMinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. | 

### NetworkInputServerValidation
<a name="channels-channelid-model-networkinputservervalidation"></a>

Network Input Server Validation
+ `CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME`
+ `CHECK_CRYPTOGRAPHY_ONLY`

### NetworkInputSettings
<a name="channels-channelid-model-networkinputsettings"></a>

Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsInputSettings | [HlsInputSettings](#channels-channelid-model-hlsinputsettings) | False | Specifies HLS input settings when the uri is for a HLS manifest. | 
| serverValidation | [NetworkInputServerValidation](#channels-channelid-model-networkinputservervalidation) | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. | 

### NielsenCBET
<a name="channels-channelid-model-nielsencbet"></a>

Nielsen CBET


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cbetCheckDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. | 
| cbetStepaside | [NielsenWatermarksCbetStepaside](#channels-channelid-model-nielsenwatermarkscbetstepaside) | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | 
| csid | stringMinLength: 1MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark | 

### NielsenConfiguration
<a name="channels-channelid-model-nielsenconfiguration"></a>

Nielsen Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. | 
| nielsenPcmToId3Tagging | [NielsenPcmToId3TaggingState](#channels-channelid-model-nielsenpcmtoid3taggingstate) | False | Enables Nielsen PCM to ID3 tagging | 

### NielsenNaesIiNw
<a name="channels-channelid-model-nielsennaesiinw"></a>

Nielsen Naes Ii Nw


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| checkDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the check digit string for the watermark | 
| sid | numberMinimum: 1Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark | 

### NielsenPcmToId3TaggingState
<a name="channels-channelid-model-nielsenpcmtoid3taggingstate"></a>

State of Nielsen PCM to ID3 tagging
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksCbetStepaside
<a name="channels-channelid-model-nielsenwatermarkscbetstepaside"></a>

Nielsen Watermarks Cbet Stepaside
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksDistributionTypes
<a name="channels-channelid-model-nielsenwatermarksdistributiontypes"></a>

Nielsen Watermarks Distribution Types
+ `FINAL_DISTRIBUTOR`
+ `PROGRAM_CONTENT`

### NielsenWatermarksSettings
<a name="channels-channelid-model-nielsenwatermarkssettings"></a>

Nielsen Watermarks Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenCbetSettings | [NielsenCBET](#channels-channelid-model-nielsencbet) | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | 
| nielsenDistributionType | [NielsenWatermarksDistributionTypes](#channels-channelid-model-nielsenwatermarksdistributiontypes) | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM\$1CONTENT - FINAL\$1DISTRIBUTOR | 
| nielsenNaesIiNwSettings | [NielsenNaesIiNw](#channels-channelid-model-nielsennaesiinw) | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). | 

### Output
<a name="channels-channelid-model-output"></a>

Output settings. There can be multiple outputs within a group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. | 
| captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. | 
| outputName | stringMinLength: 1MaxLength: 255 | False | The name used to identify an output. | 
| outputSettings | [OutputSettings](#channels-channelid-model-outputsettings) | True | Output type-specific settings. | 
| videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. | 

### OutputDestination
<a name="channels-channelid-model-outputdestination"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | User-specified id. This is used in an output group or an output. | 
| mediaPackageSettings | Array of type [MediaPackageOutputDestinationSettings](#channels-channelid-model-mediapackageoutputdestinationsettings) | False | Destination settings for a MediaPackage output; one destination for both encoders. | 
| multiplexSettings | [MultiplexProgramChannelDestinationSettings](#channels-channelid-model-multiplexprogramchanneldestinationsettings) | False | Destination settings for a Multiplex output; one destination for both encoders. | 
| settings | Array of type [OutputDestinationSettings](#channels-channelid-model-outputdestinationsettings) | False | Destination settings for a standard output; one destination for each redundant encoder. | 

### OutputDestinationSettings
<a name="channels-channelid-model-outputdestinationsettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) | 
| url | string | False | A URL specifying a destination | 
| username | string | False | username for destination | 

### OutputGroup
<a name="channels-channelid-model-outputgroup"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. | 
| outputGroupSettings | [OutputGroupSettings](#channels-channelid-model-outputgroupsettings) | True | Settings associated with the output group. | 
| outputs | Array of type [Output](#channels-channelid-model-output) | True |  | 

### OutputGroupSettings
<a name="channels-channelid-model-outputgroupsettings"></a>

Output Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveGroupSettings | [ArchiveGroupSettings](#channels-channelid-model-archivegroupsettings) | False |  | 
| frameCaptureGroupSettings | [FrameCaptureGroupSettings](#channels-channelid-model-framecapturegroupsettings) | False |  | 
| hlsGroupSettings | [HlsGroupSettings](#channels-channelid-model-hlsgroupsettings) | False |  | 
| mediaPackageGroupSettings | [MediaPackageGroupSettings](#channels-channelid-model-mediapackagegroupsettings) | False |  | 
| msSmoothGroupSettings | [MsSmoothGroupSettings](#channels-channelid-model-mssmoothgroupsettings) | False |  | 
| multiplexGroupSettings | [MultiplexGroupSettings](#channels-channelid-model-multiplexgroupsettings) | False |  | 
| rtmpGroupSettings | [RtmpGroupSettings](#channels-channelid-model-rtmpgroupsettings) | False |  | 
| udpGroupSettings | [UdpGroupSettings](#channels-channelid-model-udpgroupsettings) | False |  | 

### OutputLocationRef
<a name="channels-channelid-model-outputlocationref"></a>

Reference to an OutputDestination ID defined in the channel


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

### OutputSettings
<a name="channels-channelid-model-outputsettings"></a>

Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveOutputSettings | [ArchiveOutputSettings](#channels-channelid-model-archiveoutputsettings) | False |  | 
| frameCaptureOutputSettings | [FrameCaptureOutputSettings](#channels-channelid-model-framecaptureoutputsettings) | False |  | 
| hlsOutputSettings | [HlsOutputSettings](#channels-channelid-model-hlsoutputsettings) | False |  | 
| mediaPackageOutputSettings | [MediaPackageOutputSettings](#channels-channelid-model-mediapackageoutputsettings) | False |  | 
| msSmoothOutputSettings | [MsSmoothOutputSettings](#channels-channelid-model-mssmoothoutputsettings) | False |  | 
| multiplexOutputSettings | [MultiplexOutputSettings](#channels-channelid-model-multiplexoutputsettings) | False |  | 
| rtmpOutputSettings | [RtmpOutputSettings](#channels-channelid-model-rtmpoutputsettings) | False |  | 
| udpOutputSettings | [UdpOutputSettings](#channels-channelid-model-udpoutputsettings) | False |  | 

### PassThroughSettings
<a name="channels-channelid-model-passthroughsettings"></a>

Pass Through Settings

### PipelineDetail
<a name="channels-channelid-model-pipelinedetail"></a>

Runtime details of a pipeline when a channel is running.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. | 
| activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. | 
| activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. | 
| activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. | 
| pipelineId | string | False | Pipeline ID | 

### RawSettings
<a name="channels-channelid-model-rawsettings"></a>

Raw Settings

### Rec601Settings
<a name="channels-channelid-model-rec601settings"></a>

Rec601 Settings

### Rec709Settings
<a name="channels-channelid-model-rec709settings"></a>

Rec709 Settings

### RemixSettings
<a name="channels-channelid-model-remixsettings"></a>

Remix Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelMappings | Array of type [AudioChannelMapping](#channels-channelid-model-audiochannelmapping) | True | Mapping of input channels to output channels, with appropriate gain adjustments. | 
| channelsIn | integerMinimum: 1Maximum: 16 | False | Number of input channels to be used. | 
| channelsOut | integerMinimum: 1Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 | 

### ResourceConflict
<a name="channels-channelid-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="channels-channelid-model-resourcenotfound"></a>


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

### RtmpAdMarkers
<a name="channels-channelid-model-rtmpadmarkers"></a>

Rtmp Ad Markers
+ `ON_CUE_POINT_SCTE35`

### RtmpCacheFullBehavior
<a name="channels-channelid-model-rtmpcachefullbehavior"></a>

Rtmp Cache Full Behavior
+ `DISCONNECT_IMMEDIATELY`
+ `WAIT_FOR_SERVER`

### RtmpCaptionData
<a name="channels-channelid-model-rtmpcaptiondata"></a>

Rtmp Caption Data
+ `ALL`
+ `FIELD1_608`
+ `FIELD1_AND_FIELD2_608`

### RtmpCaptionInfoDestinationSettings
<a name="channels-channelid-model-rtmpcaptioninfodestinationsettings"></a>

Rtmp Caption Info Destination Settings

### RtmpGroupSettings
<a name="channels-channelid-model-rtmpgroupsettings"></a>

Rtmp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [RtmpAdMarkers](#channels-channelid-model-rtmpadmarkers) | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. | 
| authenticationScheme | [AuthenticationScheme](#channels-channelid-model-authenticationscheme) | False | Authentication scheme to use when connecting with CDN | 
| cacheFullBehavior | [RtmpCacheFullBehavior](#channels-channelid-model-rtmpcachefullbehavior) | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | 
| cacheLength | integerMinimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. | 
| captionData | [RtmpCaptionData](#channels-channelid-model-rtmpcaptiondata) | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | 
| inputLossAction | [InputLossActionForRtmpOut](#channels-channelid-model-inputlossactionforrtmpout) | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | 
| restartDelay | integerMinimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### RtmpOutputCertificateMode
<a name="channels-channelid-model-rtmpoutputcertificatemode"></a>

Rtmp Output Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### RtmpOutputSettings
<a name="channels-channelid-model-rtmpoutputsettings"></a>

Rtmp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| certificateMode | [RtmpOutputCertificateMode](#channels-channelid-model-rtmpoutputcertificatemode) | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. | 
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 

### S3CannedAcl
<a name="channels-channelid-model-s3cannedacl"></a>

S3 Canned Acl
+ `AUTHENTICATED_READ`
+ `BUCKET_OWNER_FULL_CONTROL`
+ `BUCKET_OWNER_READ`
+ `PUBLIC_READ`

### Scte20Convert608To708
<a name="channels-channelid-model-scte20convert608to708"></a>

Scte20 Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### Scte20PlusEmbeddedDestinationSettings
<a name="channels-channelid-model-scte20plusembeddeddestinationsettings"></a>

Scte20 Plus Embedded Destination Settings

### Scte20SourceSettings
<a name="channels-channelid-model-scte20sourcesettings"></a>

Scte20 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [Scte20Convert608To708](#channels-channelid-model-scte20convert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 

### Scte27DestinationSettings
<a name="channels-channelid-model-scte27destinationsettings"></a>

Scte27 Destination Settings

### Scte27OcrLanguage
<a name="channels-channelid-model-scte27ocrlanguage"></a>

Scte27 Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### Scte27SourceSettings
<a name="channels-channelid-model-scte27sourcesettings"></a>

Scte27 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [Scte27OcrLanguage](#channels-channelid-model-scte27ocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. | 

### Scte35AposNoRegionalBlackoutBehavior
<a name="channels-channelid-model-scte35aposnoregionalblackoutbehavior"></a>

Scte35 Apos No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35AposWebDeliveryAllowedBehavior
<a name="channels-channelid-model-scte35aposwebdeliveryallowedbehavior"></a>

Scte35 Apos Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsert
<a name="channels-channelid-model-scte35spliceinsert"></a>

Scte35 Splice Insert


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35SpliceInsertNoRegionalBlackoutBehavior](#channels-channelid-model-scte35spliceinsertnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35SpliceInsertWebDeliveryAllowedBehavior](#channels-channelid-model-scte35spliceinsertwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### Scte35SpliceInsertNoRegionalBlackoutBehavior
<a name="channels-channelid-model-scte35spliceinsertnoregionalblackoutbehavior"></a>

Scte35 Splice Insert No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsertWebDeliveryAllowedBehavior
<a name="channels-channelid-model-scte35spliceinsertwebdeliveryallowedbehavior"></a>

Scte35 Splice Insert Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35TimeSignalApos
<a name="channels-channelid-model-scte35timesignalapos"></a>

Scte35 Time Signal Apos


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35AposNoRegionalBlackoutBehavior](#channels-channelid-model-scte35aposnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35AposWebDeliveryAllowedBehavior](#channels-channelid-model-scte35aposwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### SmoothGroupAudioOnlyTimecodeControl
<a name="channels-channelid-model-smoothgroupaudioonlytimecodecontrol"></a>

Smooth Group Audio Only Timecode Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED_CLOCK`

### SmoothGroupCertificateMode
<a name="channels-channelid-model-smoothgroupcertificatemode"></a>

Smooth Group Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### SmoothGroupEventIdMode
<a name="channels-channelid-model-smoothgroupeventidmode"></a>

Smooth Group Event Id Mode
+ `NO_EVENT_ID`
+ `USE_CONFIGURED`
+ `USE_TIMESTAMP`

### SmoothGroupEventStopBehavior
<a name="channels-channelid-model-smoothgroupeventstopbehavior"></a>

Smooth Group Event Stop Behavior
+ `NONE`
+ `SEND_EOS`

### SmoothGroupSegmentationMode
<a name="channels-channelid-model-smoothgroupsegmentationmode"></a>

Smooth Group Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### SmoothGroupSparseTrackType
<a name="channels-channelid-model-smoothgroupsparsetracktype"></a>

Smooth Group Sparse Track Type
+ `NONE`
+ `SCTE_35`
+ `SCTE_35_WITHOUT_SEGMENTATION`

### SmoothGroupStreamManifestBehavior
<a name="channels-channelid-model-smoothgroupstreammanifestbehavior"></a>

Smooth Group Stream Manifest Behavior
+ `DO_NOT_SEND`
+ `SEND`

### SmoothGroupTimestampOffsetMode
<a name="channels-channelid-model-smoothgrouptimestampoffsetmode"></a>

Smooth Group Timestamp Offset Mode
+ `USE_CONFIGURED_OFFSET`
+ `USE_EVENT_START_DATE`

### Smpte2038DataPreference
<a name="channels-channelid-model-smpte2038datapreference"></a>

Smpte2038 Data Preference
+ `IGNORE`
+ `PREFER`

### SmpteTtDestinationSettings
<a name="channels-channelid-model-smptettdestinationsettings"></a>

Smpte Tt Destination Settings

### StandardHlsSettings
<a name="channels-channelid-model-standardhlssettings"></a>

Standard Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| m3u8Settings | [M3u8Settings](#channels-channelid-model-m3u8settings) | True |  | 

### StaticKeySettings
<a name="channels-channelid-model-statickeysettings"></a>

Static Key Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| keyProviderServer | [InputLocation](#channels-channelid-model-inputlocation) | False | The URL of the license server used for protecting content. | 
| staticKeyValue | stringMinLength: 32MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. | 

### Tags
<a name="channels-channelid-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TeletextDestinationSettings
<a name="channels-channelid-model-teletextdestinationsettings"></a>

Teletext Destination Settings

### TeletextSourceSettings
<a name="channels-channelid-model-teletextsourcesettings"></a>

Teletext Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputRectangle | [CaptionRectangle](#channels-channelid-model-captionrectangle) | False | Optionally defines a region where TTML style captions will be displayed | 
| pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. | 

### TemporalFilterPostFilterSharpening
<a name="channels-channelid-model-temporalfilterpostfiltersharpening"></a>

Temporal Filter Post Filter Sharpening
+ `AUTO`
+ `DISABLED`
+ `ENABLED`

### TemporalFilterSettings
<a name="channels-channelid-model-temporalfiltersettings"></a>

Temporal Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| postFilterSharpening | [TemporalFilterPostFilterSharpening](#channels-channelid-model-temporalfilterpostfiltersharpening) | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | 
| strength | [TemporalFilterStrength](#channels-channelid-model-temporalfilterstrength) | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. | 

### TemporalFilterStrength
<a name="channels-channelid-model-temporalfilterstrength"></a>

Temporal Filter Strength
+ `AUTO`
+ `STRENGTH_1`
+ `STRENGTH_2`
+ `STRENGTH_3`
+ `STRENGTH_4`
+ `STRENGTH_5`
+ `STRENGTH_6`
+ `STRENGTH_7`
+ `STRENGTH_8`
+ `STRENGTH_9`
+ `STRENGTH_10`
+ `STRENGTH_11`
+ `STRENGTH_12`
+ `STRENGTH_13`
+ `STRENGTH_14`
+ `STRENGTH_15`
+ `STRENGTH_16`

### TimecodeConfig
<a name="channels-channelid-model-timecodeconfig"></a>

Timecode Config


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| source | [TimecodeConfigSource](#channels-channelid-model-timecodeconfigsource) | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | 
| syncThreshold | integerMinimum: 1Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. | 

### TimecodeConfigSource
<a name="channels-channelid-model-timecodeconfigsource"></a>

Timecode Config Source
+ `EMBEDDED`
+ `SYSTEMCLOCK`
+ `ZEROBASED`

### TtmlDestinationSettings
<a name="channels-channelid-model-ttmldestinationsettings"></a>

Ttml Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [TtmlDestinationStyleControl](#channels-channelid-model-ttmldestinationstylecontrol) | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. | 

### TtmlDestinationStyleControl
<a name="channels-channelid-model-ttmldestinationstylecontrol"></a>

Ttml Destination Style Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED`

### UdpContainerSettings
<a name="channels-channelid-model-udpcontainersettings"></a>

Udp Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-model-m2tssettings) | False |  | 

### UdpGroupSettings
<a name="channels-channelid-model-udpgroupsettings"></a>

Udp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossAction | [InputLossActionForUdpOut](#channels-channelid-model-inputlossactionforudpout) | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | 
| timedMetadataId3Frame | [UdpTimedMetadataId3Frame](#channels-channelid-model-udptimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 

### UdpOutputSettings
<a name="channels-channelid-model-udpoutputsettings"></a>

Udp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bufferMsec | integerMinimum: 0Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. | 
| containerSettings | [UdpContainerSettings](#channels-channelid-model-udpcontainersettings) | True |  | 
| destination | [OutputLocationRef](#channels-channelid-model-outputlocationref) | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | 
| fecOutputSettings | [FecOutputSettings](#channels-channelid-model-fecoutputsettings) | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. | 

### UdpTimedMetadataId3Frame
<a name="channels-channelid-model-udptimedmetadataid3frame"></a>

Udp Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### UpdateChannel
<a name="channels-channelid-model-updatechannel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cdiInputSpecification | [CdiInputSpecification](#channels-channelid-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| destinations | Array of type [OutputDestination](#channels-channelid-model-outputdestination) | False | A list of output destinations for this channel. | 
| encoderSettings | [EncoderSettings](#channels-channelid-model-encodersettings) | False | The encoder settings for this channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-channelid-model-inputattachment) | False |  | 
| inputSpecification | [InputSpecification](#channels-channelid-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-channelid-model-loglevel) | False | The log level to write to CloudWatch Logs. | 
| maintenance | [MaintenanceUpdateSettings](#channels-channelid-model-maintenanceupdatesettings) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. | 
| roleArn | string | False | An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed. | 

### UpdateChannelResultModel
<a name="channels-channelid-model-updatechannelresultmodel"></a>

The updated channel's description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channel | [Channel](#channels-channelid-model-channel) | False |  | 

### ValidationError
<a name="channels-channelid-model-validationerror"></a>


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

### VideoBlackFailoverSettings
<a name="channels-channelid-model-videoblackfailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackDetectThreshold | numberMinimum: 0Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\$10.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\$10.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. | 
| videoBlackThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. | 

### VideoCodecSettings
<a name="channels-channelid-model-videocodecsettings"></a>

Video Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureSettings | [FrameCaptureSettings](#channels-channelid-model-framecapturesettings) | False |  | 
| h264Settings | [H264Settings](#channels-channelid-model-h264settings) | False |  | 
| h265Settings | [H265Settings](#channels-channelid-model-h265settings) | False |  | 
| mpeg2Settings | [Mpeg2Settings](#channels-channelid-model-mpeg2settings) | False |  | 

### VideoDescription
<a name="channels-channelid-model-videodescription"></a>

Video settings for this stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codecSettings | [VideoCodecSettings](#channels-channelid-model-videocodecsettings) | False | Video codec settings. | 
| height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 
| name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. | 
| respondToAfd | [VideoDescriptionRespondToAfd](#channels-channelid-model-videodescriptionrespondtoafd) | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME\$1CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | 
| scalingBehavior | [VideoDescriptionScalingBehavior](#channels-channelid-model-videodescriptionscalingbehavior) | False | STRETCH\$1TO\$1OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | 
| sharpness | integerMinimum: 0Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. | 
| width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 

### VideoDescriptionRespondToAfd
<a name="channels-channelid-model-videodescriptionrespondtoafd"></a>

Video Description Respond To Afd
+ `NONE`
+ `PASSTHROUGH`
+ `RESPOND`

### VideoDescriptionScalingBehavior
<a name="channels-channelid-model-videodescriptionscalingbehavior"></a>

Video Description Scaling Behavior
+ `DEFAULT`
+ `STRETCH_TO_OUTPUT`

### VideoSelector
<a name="channels-channelid-model-videoselector"></a>

Specifies a particular video stream within an input source. An input may have only a single video selector.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpace | [VideoSelectorColorSpace](#channels-channelid-model-videoselectorcolorspace) | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | 
| colorSpaceSettings | [VideoSelectorColorSpaceSettings](#channels-channelid-model-videoselectorcolorspacesettings) | False | Color space settings | 
| colorSpaceUsage | [VideoSelectorColorSpaceUsage](#channels-channelid-model-videoselectorcolorspaceusage) | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | 
| selectorSettings | [VideoSelectorSettings](#channels-channelid-model-videoselectorsettings) | False | The video selector settings. | 

### VideoSelectorColorSpace
<a name="channels-channelid-model-videoselectorcolorspace"></a>

Video Selector Color Space
+ `FOLLOW`
+ `HDR10`
+ `HLG_2020`
+ `REC_601`
+ `REC_709`

### VideoSelectorColorSpaceSettings
<a name="channels-channelid-model-videoselectorcolorspacesettings"></a>

Video Selector Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hdr10Settings | [Hdr10Settings](#channels-channelid-model-hdr10settings) | False |  | 

### VideoSelectorColorSpaceUsage
<a name="channels-channelid-model-videoselectorcolorspaceusage"></a>

Video Selector Color Space Usage
+ `FALLBACK`
+ `FORCE`

### VideoSelectorPid
<a name="channels-channelid-model-videoselectorpid"></a>

Video Selector Pid


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | False | Selects a specific PID from within a video source. | 

### VideoSelectorProgramId
<a name="channels-channelid-model-videoselectorprogramid"></a>

Video Selector Program Id


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| programId | integerMinimum: 0Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. | 

### VideoSelectorSettings
<a name="channels-channelid-model-videoselectorsettings"></a>

Video Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| videoSelectorPid | [VideoSelectorPid](#channels-channelid-model-videoselectorpid) | False |  | 
| videoSelectorProgramId | [VideoSelectorProgramId](#channels-channelid-model-videoselectorprogramid) | False |  | 

### VpcOutputSettingsDescription
<a name="channels-channelid-model-vpcoutputsettingsdescription"></a>

The properties for a private VPC Output 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet.  | 
| networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC  | 
| securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.  | 
| subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### WavCodingMode
<a name="channels-channelid-model-wavcodingmode"></a>

Wav Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_4_0`
+ `CODING_MODE_8_0`

### WavSettings
<a name="channels-channelid-model-wavsettings"></a>

Wav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitDepth | number | False | Bits per sample. | 
| codingMode | [WavCodingMode](#channels-channelid-model-wavcodingmode) | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | 
| sampleRate | number | False | Sample rate in Hz. | 

### WebvttDestinationSettings
<a name="channels-channelid-model-webvttdestinationsettings"></a>

Webvtt Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [WebvttDestinationStyleControl](#channels-channelid-model-webvttdestinationstylecontrol) | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\$1STYLE\$1DATA - Don't pass through the style. The output captions will not contain any font styling information. | 

### WebvttDestinationStyleControl
<a name="channels-channelid-model-webvttdestinationstylecontrol"></a>

Webvtt Destination Style Control
+ `NO_STYLE_DATA`
+ `PASSTHROUGH`

## See also
<a name="channels-channelid-see-also"></a>

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

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

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

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

# Channels: class
<a name="channels-channelid-channelclass"></a>

## URI
<a name="channels-channelid-channelclass-url"></a>

`/prod/channels/channelId/channelClass`

## HTTP methods
<a name="channels-channelid-channelclass-http-methods"></a>

### PUT
<a name="channels-channelid-channelclassput"></a>

**Operation ID:** `UpdateChannelClass`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateChannelResultModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ChannelConfigurationValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="channels-channelid-channelclass-schemas"></a>

### Request bodies
<a name="channels-channelid-channelclass-request-examples"></a>

#### PUT schema
<a name="channels-channelid-channelclass-request-body-put-example"></a>

```
{
  "channelClass": enum,
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ]
}
```

### Response bodies
<a name="channels-channelid-channelclass-response-examples"></a>

#### UpdateChannelResultModel schema
<a name="channels-channelid-channelclass-response-body-updatechannelresultmodel-example"></a>

```
{
  "channel": {
    "arn": "string",
    "cdiInputSpecification": {
      "resolution": enum
    },
    "channelClass": enum,
    "destinations": [
      {
        "id": "string",
        "mediaPackageSettings": [
          {
            "channelId": "string"
          }
        ],
        "multiplexSettings": {
          "multiplexId": "string",
          "programName": "string"
        },
        "settings": [
          {
            "passwordParam": "string",
            "streamName": "string",
            "url": "string",
            "username": "string"
          }
        ]
      }
    ],
    "egressEndpoints": [
      {
        "sourceIp": "string"
      }
    ],
    "encoderSettings": {
      "audioDescriptions": [
        {
          "audioNormalizationSettings": {
            "algorithm": enum,
            "algorithmControl": enum,
            "targetLkfs": number
          },
          "audioSelectorName": "string",
          "audioType": enum,
          "audioTypeControl": enum,
          "audioWatermarkingSettings": {
            "nielsenWatermarksSettings": {
              "nielsenCbetSettings": {
                "cbetCheckDigitString": "string",
                "cbetStepaside": enum,
                "csid": "string"
              },
              "nielsenDistributionType": enum,
              "nielsenNaesIiNwSettings": {
                "checkDigitString": "string",
                "sid": number
              }
            }
          },
          "codecSettings": {
            "aacSettings": {
              "bitrate": number,
              "codingMode": enum,
              "inputType": enum,
              "profile": enum,
              "rateControlMode": enum,
              "rawFormat": enum,
              "sampleRate": number,
              "spec": enum,
              "vbrQuality": enum
            },
            "ac3Settings": {
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dialnorm": integer,
              "drcProfile": enum,
              "lfeFilter": enum,
              "metadataControl": enum
            },
            "eac3Settings": {
              "attenuationControl": enum,
              "bitrate": number,
              "bitstreamMode": enum,
              "codingMode": enum,
              "dcFilter": enum,
              "dialnorm": integer,
              "drcLine": enum,
              "drcRf": enum,
              "lfeControl": enum,
              "lfeFilter": enum,
              "loRoCenterMixLevel": number,
              "loRoSurroundMixLevel": number,
              "ltRtCenterMixLevel": number,
              "ltRtSurroundMixLevel": number,
              "metadataControl": enum,
              "passthroughControl": enum,
              "phaseControl": enum,
              "stereoDownmix": enum,
              "surroundExMode": enum,
              "surroundMode": enum
            },
            "mp2Settings": {
              "bitrate": number,
              "codingMode": enum,
              "sampleRate": number
            },
            "passThroughSettings": {
            },
            "wavSettings": {
              "bitDepth": number,
              "codingMode": enum,
              "sampleRate": number
            }
          },
          "languageCode": "string",
          "languageCodeControl": enum,
          "name": "string",
          "remixSettings": {
            "channelMappings": [
              {
                "inputChannelLevels": [
                  {
                    "gain": integer,
                    "inputChannel": integer
                  }
                ],
                "outputChannel": integer
              }
            ],
            "channelsIn": integer,
            "channelsOut": integer
          },
          "streamName": "string"
        }
      ],
      "availBlanking": {
        "availBlankingImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "state": enum
      },
      "availConfiguration": {
        "availSettings": {
          "scte35SpliceInsert": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          },
          "scte35TimeSignalApos": {
            "adAvailOffset": integer,
            "noRegionalBlackoutFlag": enum,
            "webDeliveryAllowedFlag": enum
          }
        }
      },
      "blackoutSlate": {
        "blackoutSlateImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkEndBlackout": enum,
        "networkEndBlackoutImage": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "networkId": "string",
        "state": enum
      },
      "captionDescriptions": [
        {
          "captionSelectorName": "string",
          "destinationSettings": {
            "aribDestinationSettings": {
            },
            "burnInDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "dvbSubDestinationSettings": {
              "alignment": enum,
              "backgroundColor": enum,
              "backgroundOpacity": integer,
              "font": {
                "passwordParam": "string",
                "uri": "string",
                "username": "string"
              },
              "fontColor": enum,
              "fontOpacity": integer,
              "fontResolution": integer,
              "fontSize": "string",
              "outlineColor": enum,
              "outlineSize": integer,
              "shadowColor": enum,
              "shadowOpacity": integer,
              "shadowXOffset": integer,
              "shadowYOffset": integer,
              "teletextGridControl": enum,
              "xPosition": integer,
              "yPosition": integer
            },
            "ebuTtDDestinationSettings": {
              "copyrightHolder": "string",
              "fillLineGap": enum,
              "fontFamily": "string",
              "styleControl": enum
            },
            "embeddedDestinationSettings": {
            },
            "embeddedPlusScte20DestinationSettings": {
            },
            "rtmpCaptionInfoDestinationSettings": {
            },
            "scte20PlusEmbeddedDestinationSettings": {
            },
            "scte27DestinationSettings": {
            },
            "smpteTtDestinationSettings": {
            },
            "teletextDestinationSettings": {
            },
            "ttmlDestinationSettings": {
              "styleControl": enum
            },
            "webvttDestinationSettings": {
              "styleControl": enum
            }
          },
          "languageCode": "string",
          "languageDescription": "string",
          "name": "string"
        }
      ],
      "featureActivations": {
        "inputPrepareScheduleActions": enum
      },
      "globalConfiguration": {
        "initialAudioGain": integer,
        "inputEndAction": enum,
        "inputLossBehavior": {
          "blackFrameMsec": integer,
          "inputLossImageColor": "string",
          "inputLossImageSlate": {
            "passwordParam": "string",
            "uri": "string",
            "username": "string"
          },
          "inputLossImageType": enum,
          "repeatFrameMsec": integer
        },
        "outputLockingMode": enum,
        "outputTimingSource": enum,
        "supportLowFramerateInputs": enum
      },
      "motionGraphicsConfiguration": {
        "motionGraphicsInsertion": enum,
        "motionGraphicsSettings": {
          "htmlMotionGraphicsSettings": {
          }
        }
      },
      "nielsenConfiguration": {
        "distributorId": "string",
        "nielsenPcmToId3Tagging": enum
      },
      "outputGroups": [
        {
          "name": "string",
          "outputGroupSettings": {
            "archiveGroupSettings": {
              "archiveCdnSettings": {
                "archiveS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              },
              "destination": {
                "destinationRefId": "string"
              },
              "rolloverInterval": integer
            },
            "frameCaptureGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              },
              "frameCaptureCdnSettings": {
                "frameCaptureS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                }
              }
            },
            "hlsGroupSettings": {
              "adMarkers": [
                enum
              ],
              "baseUrlContent": "string",
              "baseUrlContent1": "string",
              "baseUrlManifest": "string",
              "baseUrlManifest1": "string",
              "captionLanguageMappings": [
                {
                  "captionChannel": integer,
                  "languageCode": "string",
                  "languageDescription": "string"
                }
              ],
              "captionLanguageSetting": enum,
              "clientCache": enum,
              "codecSpecification": enum,
              "constantIv": "string",
              "destination": {
                "destinationRefId": "string"
              },
              "directoryStructure": enum,
              "discontinuityTags": enum,
              "encryptionType": enum,
              "hlsCdnSettings": {
                "hlsAkamaiSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer,
                  "salt": "string",
                  "token": "string"
                },
                "hlsBasicPutSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsMediaStoreSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "mediaStoreStorageClass": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                },
                "hlsS3Settings": {
                  "cannedAcl": enum,
                  "logUploads": enum
                },
                "hlsWebdavSettings": {
                  "connectionRetryInterval": integer,
                  "filecacheDuration": integer,
                  "httpTransferMode": enum,
                  "numRetries": integer,
                  "restartDelay": integer
                }
              },
              "hlsId3SegmentTagging": enum,
              "iFrameOnlyPlaylists": enum,
              "incompleteSegmentBehavior": enum,
              "indexNSegments": integer,
              "inputLossAction": enum,
              "ivInManifest": enum,
              "ivSource": enum,
              "keepSegments": integer,
              "keyFormat": "string",
              "keyFormatVersions": "string",
              "keyProviderSettings": {
                "staticKeySettings": {
                  "keyProviderServer": {
                    "passwordParam": "string",
                    "uri": "string",
                    "username": "string"
                  },
                  "staticKeyValue": "string"
                }
              },
              "manifestCompression": enum,
              "manifestDurationFormat": enum,
              "minSegmentLength": integer,
              "mode": enum,
              "outputSelection": enum,
              "programDateTime": enum,
              "programDateTimeClock": enum,
              "programDateTimePeriod": integer,
              "redundantManifest": enum,
              "segmentLength": integer,
              "segmentationMode": enum,
              "segmentsPerSubdirectory": integer,
              "streamInfResolution": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer,
              "timestampDeltaMilliseconds": integer,
              "tsFileMode": enum
            },
            "mediaPackageGroupSettings": {
              "destination": {
                "destinationRefId": "string"
              }
            },
            "msSmoothGroupSettings": {
              "acquisitionPointId": "string",
              "audioOnlyTimecodeControl": enum,
              "certificateMode": enum,
              "connectionRetryInterval": integer,
              "destination": {
                "destinationRefId": "string"
              },
              "eventId": "string",
              "eventIdMode": enum,
              "eventStopBehavior": enum,
              "filecacheDuration": integer,
              "fragmentLength": integer,
              "inputLossAction": enum,
              "numRetries": integer,
              "restartDelay": integer,
              "segmentationMode": enum,
              "sendDelayMs": integer,
              "sparseTrackType": enum,
              "streamManifestBehavior": enum,
              "timestampOffset": "string",
              "timestampOffsetMode": enum
            },
            "multiplexGroupSettings": {
            },
            "rtmpGroupSettings": {
              "adMarkers": [
                enum
              ],
              "authenticationScheme": enum,
              "cacheFullBehavior": enum,
              "cacheLength": integer,
              "captionData": enum,
              "inputLossAction": enum,
              "restartDelay": integer
            },
            "udpGroupSettings": {
              "inputLossAction": enum,
              "timedMetadataId3Frame": enum,
              "timedMetadataId3Period": integer
            }
          },
          "outputs": [
            {
              "audioDescriptionNames": [
                "string"
              ],
              "captionDescriptionNames": [
                "string"
              ],
              "outputName": "string",
              "outputSettings": {
                "archiveOutputSettings": {
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    },
                    "rawSettings": {
                    }
                  },
                  "extension": "string",
                  "nameModifier": "string"
                },
                "frameCaptureOutputSettings": {
                  "nameModifier": "string"
                },
                "hlsOutputSettings": {
                  "h265PackagingType": enum,
                  "hlsSettings": {
                    "audioOnlyHlsSettings": {
                      "audioGroupId": "string",
                      "audioOnlyImage": {
                        "passwordParam": "string",
                        "uri": "string",
                        "username": "string"
                      },
                      "audioTrackType": enum,
                      "segmentType": enum
                    },
                    "fmp4HlsSettings": {
                      "audioRenditionSets": "string",
                      "nielsenId3Behavior": enum,
                      "timedMetadataBehavior": enum
                    },
                    "frameCaptureHlsSettings": {
                    },
                    "standardHlsSettings": {
                      "audioRenditionSets": "string",
                      "m3u8Settings": {
                        "audioFramesPerPes": integer,
                        "audioPids": "string",
                        "ecmPid": "string",
                        "nielsenId3Behavior": enum,
                        "patInterval": integer,
                        "pcrControl": enum,
                        "pcrPeriod": integer,
                        "pcrPid": "string",
                        "pmtInterval": integer,
                        "pmtPid": "string",
                        "programNum": integer,
                        "scte35Behavior": enum,
                        "scte35Pid": "string",
                        "timedMetadataBehavior": enum,
                        "timedMetadataPid": "string",
                        "transportStreamId": integer,
                        "videoPid": "string"
                      }
                    }
                  },
                  "nameModifier": "string",
                  "segmentModifier": "string"
                },
                "mediaPackageOutputSettings": {
                },
                "msSmoothOutputSettings": {
                  "h265PackagingType": enum,
                  "nameModifier": "string"
                },
                "multiplexOutputSettings": {
                  "destination": {
                    "destinationRefId": "string"
                  }
                },
                "rtmpOutputSettings": {
                  "certificateMode": enum,
                  "connectionRetryInterval": integer,
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "numRetries": integer
                },
                "udpOutputSettings": {
                  "bufferMsec": integer,
                  "containerSettings": {
                    "m2tsSettings": {
                      "absentInputAudioBehavior": enum,
                      "arib": enum,
                      "aribCaptionsPid": "string",
                      "aribCaptionsPidControl": enum,
                      "audioBufferModel": enum,
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "audioStreamType": enum,
                      "bitrate": integer,
                      "bufferModel": enum,
                      "ccDescriptor": enum,
                      "dvbNitSettings": {
                        "networkId": integer,
                        "networkName": "string",
                        "repInterval": integer
                      },
                      "dvbSdtSettings": {
                        "outputSdt": enum,
                        "repInterval": integer,
                        "serviceName": "string",
                        "serviceProviderName": "string"
                      },
                      "dvbSubPids": "string",
                      "dvbTdtSettings": {
                        "repInterval": integer
                      },
                      "dvbTeletextPid": "string",
                      "ebif": enum,
                      "ebpAudioInterval": enum,
                      "ebpLookaheadMs": integer,
                      "ebpPlacement": enum,
                      "ecmPid": "string",
                      "esRateInPes": enum,
                      "etvPlatformPid": "string",
                      "etvSignalPid": "string",
                      "fragmentTime": number,
                      "klv": enum,
                      "klvDataPids": "string",
                      "nielsenId3Behavior": enum,
                      "nullPacketBitrate": number,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "rateMode": enum,
                      "scte27Pids": "string",
                      "scte35Control": enum,
                      "scte35Pid": "string",
                      "segmentationMarkers": enum,
                      "segmentationStyle": enum,
                      "segmentationTime": number,
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  },
                  "destination": {
                    "destinationRefId": "string"
                  },
                  "fecOutputSettings": {
                    "columnDepth": integer,
                    "includeFec": enum,
                    "rowLength": integer
                  }
                }
              },
              "videoDescriptionName": "string"
            }
          ]
        }
      ],
      "timecodeConfig": {
        "source": enum,
        "syncThreshold": integer
      },
      "videoDescriptions": [
        {
          "codecSettings": {
            "frameCaptureSettings": {
              "captureInterval": integer,
              "captureIntervalUnits": enum
            },
            "h264Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "bitrate": integer,
              "bufFillPct": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "entropyEncoding": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "forceFieldPictures": enum,
              "framerateControl": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopBReference": enum,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "numRefFrames": integer,
              "parControl": enum,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qualityLevel": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "softness": integer,
              "spatialAq": enum,
              "subgopLength": enum,
              "syntax": enum,
              "temporalAq": enum,
              "timecodeInsertion": enum
            },
            "h265Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "alternativeTransferFunction": enum,
              "bitrate": integer,
              "bufSize": integer,
              "colorMetadata": enum,
              "colorSpaceSettings": {
                "colorSpacePassthroughSettings": {
                },
                "hdr10Settings": {
                  "maxCll": integer,
                  "maxFall": integer
                },
                "rec601Settings": {
                },
                "rec709Settings": {
                }
              },
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "flickerAq": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "level": enum,
              "lookAheadRateControl": enum,
              "maxBitrate": integer,
              "minIInterval": integer,
              "parDenominator": integer,
              "parNumerator": integer,
              "profile": enum,
              "qvbrQualityLevel": integer,
              "rateControlMode": enum,
              "scanType": enum,
              "sceneChangeDetect": enum,
              "slices": integer,
              "tier": enum,
              "timecodeInsertion": enum
            },
            "mpeg2Settings": {
              "adaptiveQuantization": enum,
              "afdSignaling": enum,
              "colorMetadata": enum,
              "colorSpace": enum,
              "displayAspectRatio": enum,
              "filterSettings": {
                "temporalFilterSettings": {
                  "postFilterSharpening": enum,
                  "strength": enum
                }
              },
              "fixedAfd": enum,
              "framerateDenominator": integer,
              "framerateNumerator": integer,
              "gopClosedCadence": integer,
              "gopNumBFrames": integer,
              "gopSize": number,
              "gopSizeUnits": enum,
              "scanType": enum,
              "subgopLength": enum,
              "timecodeInsertion": enum
            }
          },
          "height": integer,
          "name": "string",
          "respondToAfd": enum,
          "scalingBehavior": enum,
          "sharpness": integer,
          "width": integer
        }
      ]
    },
    "id": "string",
    "inputAttachments": [
      {
        "automaticInputFailoverSettings": {
          "errorClearTimeMsec": integer,
          "failoverConditions": [
            {
              "failoverConditionSettings": {
                "audioSilenceSettings": {
                  "audioSelectorName": "string",
                  "audioSilenceThresholdMsec": integer
                },
                "inputLossSettings": {
                  "inputLossThresholdMsec": integer
                },
                "videoBlackSettings": {
                  "blackDetectThreshold": number,
                  "videoBlackThresholdMsec": integer
                }
              }
            }
          ],
          "inputPreference": enum,
          "secondaryInputId": "string"
        },
        "inputAttachmentName": "string",
        "inputId": "string",
        "inputSettings": {
          "audioSelectors": [
            {
              "name": "string",
              "selectorSettings": {
                "audioHlsRenditionSelection": {
                  "groupId": "string",
                  "name": "string"
                },
                "audioLanguageSelection": {
                  "languageCode": "string",
                  "languageSelectionPolicy": enum
                },
                "audioPidSelection": {
                  "pid": integer
                },
                "audioTrackSelection": {
                  "tracks": [
                    {
                      "track": integer
                    }
                  ]
                }
              }
            }
          ],
          "captionSelectors": [
            {
              "languageCode": "string",
              "name": "string",
              "selectorSettings": {
                "ancillarySourceSettings": {
                  "sourceAncillaryChannelNumber": integer
                },
                "aribSourceSettings": {
                },
                "dvbSubSourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "embeddedSourceSettings": {
                  "convert608To708": enum,
                  "scte20Detection": enum,
                  "source608ChannelNumber": integer,
                  "source608TrackNumber": integer
                },
                "scte20SourceSettings": {
                  "convert608To708": enum,
                  "source608ChannelNumber": integer
                },
                "scte27SourceSettings": {
                  "ocrLanguage": enum,
                  "pid": integer
                },
                "teletextSourceSettings": {
                  "outputRectangle": {
                    "height": number,
                    "leftOffset": number,
                    "topOffset": number,
                    "width": number
                  },
                  "pageNumber": "string"
                }
              }
            }
          ],
          "deblockFilter": enum,
          "denoiseFilter": enum,
          "filterStrength": integer,
          "inputFilter": enum,
          "networkInputSettings": {
            "hlsInputSettings": {
              "bandwidth": integer,
              "bufferSegments": integer,
              "retries": integer,
              "retryInterval": integer,
              "scte35Source": enum
            },
            "serverValidation": enum
          },
          "smpte2038DataPreference": enum,
          "sourceEndBehavior": enum,
          "videoSelector": {
            "colorSpace": enum,
            "colorSpaceSettings": {
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              }
            },
            "colorSpaceUsage": enum,
            "selectorSettings": {
              "videoSelectorPid": {
                "pid": integer
              },
              "videoSelectorProgramId": {
                "programId": integer
              }
            }
          }
        }
      }
    ],
    "inputSpecification": {
      "codec": enum,
      "maximumBitrate": enum,
      "resolution": enum
    },
    "logLevel": enum,
    "maintenance": {
      "maintenanceDay": enum,
      "maintenanceDeadline": "string",
      "maintenanceScheduledDate": "string",
      "maintenanceStartTime": "string"
    },
    "name": "string",
    "pipelineDetails": [
      {
        "activeInputAttachmentName": "string",
        "activeInputSwitchActionName": "string",
        "activeMotionGraphicsActionName": "string",
        "activeMotionGraphicsUri": "string",
        "pipelineId": "string"
      }
    ],
    "pipelinesRunningCount": integer,
    "roleArn": "string",
    "state": enum,
    "tags": {
    },
    "vpc": {
      "availabilityZones": [
        "string"
      ],
      "networkInterfaceIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ],
      "subnetIds": [
        "string"
      ]
    }
  }
}
```

#### InvalidRequest schema
<a name="channels-channelid-channelclass-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-channelid-channelclass-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="channels-channelid-channelclass-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="channels-channelid-channelclass-response-body-resourceconflict-example"></a>

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

#### ChannelConfigurationValidationError schema
<a name="channels-channelid-channelclass-response-body-channelconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="channels-channelid-channelclass-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-channelid-channelclass-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-channelid-channelclass-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-channelid-channelclass-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-channelid-channelclass-properties"></a>

### AacCodingMode
<a name="channels-channelid-channelclass-model-aaccodingmode"></a>

Aac Coding Mode
+ `AD_RECEIVER_MIX`
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_5_1`

### AacInputType
<a name="channels-channelid-channelclass-model-aacinputtype"></a>

Aac Input Type
+ `BROADCASTER_MIXED_AD`
+ `NORMAL`

### AacProfile
<a name="channels-channelid-channelclass-model-aacprofile"></a>

Aac Profile
+ `HEV1`
+ `HEV2`
+ `LC`

### AacRateControlMode
<a name="channels-channelid-channelclass-model-aacratecontrolmode"></a>

Aac Rate Control Mode
+ `CBR`
+ `VBR`

### AacRawFormat
<a name="channels-channelid-channelclass-model-aacrawformat"></a>

Aac Raw Format
+ `LATM_LOAS`
+ `NONE`

### AacSettings
<a name="channels-channelid-channelclass-model-aacsettings"></a>

Aac Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. | 
| codingMode | [AacCodingMode](#channels-channelid-channelclass-model-aaccodingmode) | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. | 
| inputType | [AacInputType](#channels-channelid-channelclass-model-aacinputtype) | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio \$1 AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio \$1 AD. | 
| profile | [AacProfile](#channels-channelid-channelclass-model-aacprofile) | False | AAC Profile. | 
| rateControlMode | [AacRateControlMode](#channels-channelid-channelclass-model-aacratecontrolmode) | False | Rate Control Mode. | 
| rawFormat | [AacRawFormat](#channels-channelid-channelclass-model-aacrawformat) | False | Sets LATM / LOAS AAC output for raw containers. | 
| sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. | 
| spec | [AacSpec](#channels-channelid-channelclass-model-aacspec) | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | 
| vbrQuality | [AacVbrQuality](#channels-channelid-channelclass-model-aacvbrquality) | False | VBR Quality Level - Only used if rateControlMode is VBR. | 

### AacSpec
<a name="channels-channelid-channelclass-model-aacspec"></a>

Aac Spec
+ `MPEG2`
+ `MPEG4`

### AacVbrQuality
<a name="channels-channelid-channelclass-model-aacvbrquality"></a>

Aac Vbr Quality
+ `HIGH`
+ `LOW`
+ `MEDIUM_HIGH`
+ `MEDIUM_LOW`

### Ac3BitstreamMode
<a name="channels-channelid-channelclass-model-ac3bitstreammode"></a>

Ac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `DIALOGUE`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `MUSIC_AND_EFFECTS`
+ `VISUALLY_IMPAIRED`
+ `VOICE_OVER`

### Ac3CodingMode
<a name="channels-channelid-channelclass-model-ac3codingmode"></a>

Ac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2_LFE`

### Ac3DrcProfile
<a name="channels-channelid-channelclass-model-ac3drcprofile"></a>

Ac3 Drc Profile
+ `FILM_STANDARD`
+ `NONE`

### Ac3LfeFilter
<a name="channels-channelid-channelclass-model-ac3lfefilter"></a>

Ac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Ac3MetadataControl
<a name="channels-channelid-channelclass-model-ac3metadatacontrol"></a>

Ac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Ac3Settings
<a name="channels-channelid-channelclass-model-ac3settings"></a>

Ac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Ac3BitstreamMode](#channels-channelid-channelclass-model-ac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | 
| codingMode | [Ac3CodingMode](#channels-channelid-channelclass-model-ac3codingmode) | False | Dolby Digital coding mode. Determines number of channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. | 
| drcProfile | [Ac3DrcProfile](#channels-channelid-channelclass-model-ac3drcprofile) | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | 
| lfeFilter | [Ac3LfeFilter](#channels-channelid-channelclass-model-ac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | 
| metadataControl | [Ac3MetadataControl](#channels-channelid-channelclass-model-ac3metadatacontrol) | False | When set to "followInput", encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 

### AccessDenied
<a name="channels-channelid-channelclass-model-accessdenied"></a>


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

### AfdSignaling
<a name="channels-channelid-channelclass-model-afdsignaling"></a>

Afd Signaling
+ `AUTO`
+ `FIXED`
+ `NONE`

### AncillarySourceSettings
<a name="channels-channelid-channelclass-model-ancillarysourcesettings"></a>

Ancillary Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceAncillaryChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. | 

### ArchiveCdnSettings
<a name="channels-channelid-channelclass-model-archivecdnsettings"></a>

Archive Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveS3Settings | [ArchiveS3Settings](#channels-channelid-channelclass-model-archives3settings) | False |  | 

### ArchiveContainerSettings
<a name="channels-channelid-channelclass-model-archivecontainersettings"></a>

Archive Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-channelclass-model-m2tssettings) | False |  | 
| rawSettings | [RawSettings](#channels-channelid-channelclass-model-rawsettings) | False |  | 

### ArchiveGroupSettings
<a name="channels-channelid-channelclass-model-archivegroupsettings"></a>

Archive Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveCdnSettings | [ArchiveCdnSettings](#channels-channelid-channelclass-model-archivecdnsettings) | False | Parameters that control interactions with the CDN. | 
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | A directory and base filename where archive files should be written. | 
| rolloverInterval | integerMinimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. | 

### ArchiveOutputSettings
<a name="channels-channelid-channelclass-model-archiveoutputsettings"></a>

Archive Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| containerSettings | [ArchiveContainerSettings](#channels-channelid-channelclass-model-archivecontainersettings) | True | Settings specific to the container type of the file. | 
| extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### ArchiveS3LogUploads
<a name="channels-channelid-channelclass-model-archives3loguploads"></a>

Archive S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### ArchiveS3Settings
<a name="channels-channelid-channelclass-model-archives3settings"></a>

Archive S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-channelclass-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [ArchiveS3LogUploads](#channels-channelid-channelclass-model-archives3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### AribDestinationSettings
<a name="channels-channelid-channelclass-model-aribdestinationsettings"></a>

Arib Destination Settings

### AribSourceSettings
<a name="channels-channelid-channelclass-model-aribsourcesettings"></a>

Arib Source Settings

### AudioChannelMapping
<a name="channels-channelid-channelclass-model-audiochannelmapping"></a>

Audio Channel Mapping


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputChannelLevels | Array of type [InputChannelLevel](#channels-channelid-channelclass-model-inputchannellevel) | True | Indices and gain values for each input channel that should be remixed into this output channel. | 
| outputChannel | integerMinimum: 0Maximum: 7 | True | The index of the output channel being produced. | 

### AudioCodecSettings
<a name="channels-channelid-channelclass-model-audiocodecsettings"></a>

Audio Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aacSettings | [AacSettings](#channels-channelid-channelclass-model-aacsettings) | False |  | 
| ac3Settings | [Ac3Settings](#channels-channelid-channelclass-model-ac3settings) | False |  | 
| eac3Settings | [Eac3Settings](#channels-channelid-channelclass-model-eac3settings) | False |  | 
| mp2Settings | [Mp2Settings](#channels-channelid-channelclass-model-mp2settings) | False |  | 
| passThroughSettings | [PassThroughSettings](#channels-channelid-channelclass-model-passthroughsettings) | False |  | 
| wavSettings | [WavSettings](#channels-channelid-channelclass-model-wavsettings) | False |  | 

### AudioDescription
<a name="channels-channelid-channelclass-model-audiodescription"></a>

Audio Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioNormalizationSettings | [AudioNormalizationSettings](#channels-channelid-channelclass-model-audionormalizationsettings) | False | Advanced audio normalization settings. | 
| audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. | 
| audioType | [AudioType](#channels-channelid-channelclass-model-audiotype) | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | 
| audioTypeControl | [AudioDescriptionAudioTypeControl](#channels-channelid-channelclass-model-audiodescriptionaudiotypecontrol) | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | 
| audioWatermarkingSettings | [AudioWatermarkSettings](#channels-channelid-channelclass-model-audiowatermarksettings) | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | 
| codecSettings | [AudioCodecSettings](#channels-channelid-channelclass-model-audiocodecsettings) | False | Audio codec settings. | 
| languageCode | stringMinLength: 1MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. | 
| languageCodeControl | [AudioDescriptionLanguageCodeControl](#channels-channelid-channelclass-model-audiodescriptionlanguagecodecontrol) | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | 
| name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. | 
| remixSettings | [RemixSettings](#channels-channelid-channelclass-model-remixsettings) | False | Settings that control how input audio channels are remixed into the output audio channels. | 
| streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). | 

### AudioDescriptionAudioTypeControl
<a name="channels-channelid-channelclass-model-audiodescriptionaudiotypecontrol"></a>

Audio Description Audio Type Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioDescriptionLanguageCodeControl
<a name="channels-channelid-channelclass-model-audiodescriptionlanguagecodecontrol"></a>

Audio Description Language Code Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioHlsRenditionSelection
<a name="channels-channelid-channelclass-model-audiohlsrenditionselection"></a>

Audio Hls Rendition Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| groupId | stringMinLength: 1 | True | Specifies the GROUP-ID in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 
| name | stringMinLength: 1 | True | Specifies the NAME in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 

### AudioLanguageSelection
<a name="channels-channelid-channelclass-model-audiolanguageselection"></a>

Audio Language Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | True | Selects a specific three-letter language code from within an audio source. | 
| languageSelectionPolicy | [AudioLanguageSelectionPolicy](#channels-channelid-channelclass-model-audiolanguageselectionpolicy) | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. | 

### AudioLanguageSelectionPolicy
<a name="channels-channelid-channelclass-model-audiolanguageselectionpolicy"></a>

Audio Language Selection Policy
+ `LOOSE`
+ `STRICT`

### AudioNormalizationAlgorithm
<a name="channels-channelid-channelclass-model-audionormalizationalgorithm"></a>

Audio Normalization Algorithm
+ `ITU_1770_1`
+ `ITU_1770_2`

### AudioNormalizationAlgorithmControl
<a name="channels-channelid-channelclass-model-audionormalizationalgorithmcontrol"></a>

Audio Normalization Algorithm Control
+ `CORRECT_AUDIO`

### AudioNormalizationSettings
<a name="channels-channelid-channelclass-model-audionormalizationsettings"></a>

Audio Normalization Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| algorithm | [AudioNormalizationAlgorithm](#channels-channelid-channelclass-model-audionormalizationalgorithm) | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | 
| algorithmControl | [AudioNormalizationAlgorithmControl](#channels-channelid-channelclass-model-audionormalizationalgorithmcontrol) | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | 
| targetLkfs | numberMinimum: -59Maximum: 0 | False | Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. | 

### AudioOnlyHlsSegmentType
<a name="channels-channelid-channelclass-model-audioonlyhlssegmenttype"></a>

Audio Only Hls Segment Type
+ `AAC`
+ `FMP4`

### AudioOnlyHlsSettings
<a name="channels-channelid-channelclass-model-audioonlyhlssettings"></a>

Audio Only Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. | 
| audioOnlyImage | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | 
| audioTrackType | [AudioOnlyHlsTrackType](#channels-channelid-channelclass-model-audioonlyhlstracktype) | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | 
| segmentType | [AudioOnlyHlsSegmentType](#channels-channelid-channelclass-model-audioonlyhlssegmenttype) | False | Specifies the segment type. | 

### AudioOnlyHlsTrackType
<a name="channels-channelid-channelclass-model-audioonlyhlstracktype"></a>

Audio Only Hls Track Type
+ `ALTERNATE_AUDIO_AUTO_SELECT`
+ `ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT`
+ `ALTERNATE_AUDIO_NOT_AUTO_SELECT`
+ `AUDIO_ONLY_VARIANT_STREAM`

### AudioPidSelection
<a name="channels-channelid-channelclass-model-audiopidselection"></a>

Audio Pid Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | True | Selects a specific PID from within a source. | 

### AudioSelector
<a name="channels-channelid-channelclass-model-audioselector"></a>

Audio Selector


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. | 
| selectorSettings | [AudioSelectorSettings](#channels-channelid-channelclass-model-audioselectorsettings) | False | The audio selector settings. | 

### AudioSelectorSettings
<a name="channels-channelid-channelclass-model-audioselectorsettings"></a>

Audio Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioHlsRenditionSelection | [AudioHlsRenditionSelection](#channels-channelid-channelclass-model-audiohlsrenditionselection) | False |  | 
| audioLanguageSelection | [AudioLanguageSelection](#channels-channelid-channelclass-model-audiolanguageselection) | False |  | 
| audioPidSelection | [AudioPidSelection](#channels-channelid-channelclass-model-audiopidselection) | False |  | 
| audioTrackSelection | [AudioTrackSelection](#channels-channelid-channelclass-model-audiotrackselection) | False |  | 

### AudioSilenceFailoverSettings
<a name="channels-channelid-channelclass-model-audiosilencefailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. | 
| audioSilenceThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. | 

### AudioTrack
<a name="channels-channelid-channelclass-model-audiotrack"></a>

Audio Track


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| track | integerMinimum: 1 | True | 1-based integer value that maps to a specific audio track | 

### AudioTrackSelection
<a name="channels-channelid-channelclass-model-audiotrackselection"></a>

Audio Track Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tracks | Array of type [AudioTrack](#channels-channelid-channelclass-model-audiotrack) | True | Selects one or more unique audio tracks from within a source. | 

### AudioType
<a name="channels-channelid-channelclass-model-audiotype"></a>

Audio Type
+ `CLEAN_EFFECTS`
+ `HEARING_IMPAIRED`
+ `UNDEFINED`
+ `VISUAL_IMPAIRED_COMMENTARY`

### AudioWatermarkSettings
<a name="channels-channelid-channelclass-model-audiowatermarksettings"></a>

Audio Watermark Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenWatermarksSettings | [NielsenWatermarksSettings](#channels-channelid-channelclass-model-nielsenwatermarkssettings) | False | Settings to configure Nielsen Watermarks in the audio encode | 

### AuthenticationScheme
<a name="channels-channelid-channelclass-model-authenticationscheme"></a>

Authentication Scheme
+ `AKAMAI`
+ `COMMON`

### AutomaticInputFailoverSettings
<a name="channels-channelid-channelclass-model-automaticinputfailoversettings"></a>

The settings for Automatic Input Failover.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| errorClearTimeMsec | integerMinimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input\$1preference for the failover pair is set to PRIMARY\$1INPUT\$1PREFERRED, because after this time, MediaLive will switch back to the primary input. | 
| failoverConditions | Array of type [FailoverCondition](#channels-channelid-channelclass-model-failovercondition) | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. | 
| inputPreference | [InputPreference](#channels-channelid-channelclass-model-inputpreference) | False | Input preference when deciding which input to make active when a previously failed input has recovered. | 
| secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. | 

### AvailBlanking
<a name="channels-channelid-channelclass-model-availblanking"></a>

Avail Blanking


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availBlankingImage | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| state | [AvailBlankingState](#channels-channelid-channelclass-model-availblankingstate) | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. | 

### AvailBlankingState
<a name="channels-channelid-channelclass-model-availblankingstate"></a>

Avail Blanking State
+ `DISABLED`
+ `ENABLED`

### AvailConfiguration
<a name="channels-channelid-channelclass-model-availconfiguration"></a>

Avail Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availSettings | [AvailSettings](#channels-channelid-channelclass-model-availsettings) | False | Ad avail settings. | 

### AvailSettings
<a name="channels-channelid-channelclass-model-availsettings"></a>

Avail Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35SpliceInsert | [Scte35SpliceInsert](#channels-channelid-channelclass-model-scte35spliceinsert) | False |  | 
| scte35TimeSignalApos | [Scte35TimeSignalApos](#channels-channelid-channelclass-model-scte35timesignalapos) | False |  | 

### BadGatewayException
<a name="channels-channelid-channelclass-model-badgatewayexception"></a>


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

### BlackoutSlate
<a name="channels-channelid-channelclass-model-blackoutslate"></a>

Blackout Slate


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackoutSlateImage | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| networkEndBlackout | [BlackoutSlateNetworkEndBlackout](#channels-channelid-channelclass-model-blackoutslatenetworkendblackout) | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | 
| networkEndBlackoutImage | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | 
| networkId | stringMinLength: 34MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). | 
| state | [BlackoutSlateState](#channels-channelid-channelclass-model-blackoutslatestate) | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. | 

### BlackoutSlateNetworkEndBlackout
<a name="channels-channelid-channelclass-model-blackoutslatenetworkendblackout"></a>

Blackout Slate Network End Blackout
+ `DISABLED`
+ `ENABLED`

### BlackoutSlateState
<a name="channels-channelid-channelclass-model-blackoutslatestate"></a>

Blackout Slate State
+ `DISABLED`
+ `ENABLED`

### BurnInAlignment
<a name="channels-channelid-channelclass-model-burninalignment"></a>

Burn In Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### BurnInBackgroundColor
<a name="channels-channelid-channelclass-model-burninbackgroundcolor"></a>

Burn In Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInDestinationSettings
<a name="channels-channelid-channelclass-model-burnindestinationsettings"></a>

Burn In Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [BurnInAlignment](#channels-channelid-channelclass-model-burninalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [BurnInBackgroundColor](#channels-channelid-channelclass-model-burninbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [BurnInFontColor](#channels-channelid-channelclass-model-burninfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [BurnInOutlineColor](#channels-channelid-channelclass-model-burninoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [BurnInShadowColor](#channels-channelid-channelclass-model-burninshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [BurnInTeletextGridControl](#channels-channelid-channelclass-model-burninteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. | 

### BurnInFontColor
<a name="channels-channelid-channelclass-model-burninfontcolor"></a>

Burn In Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInOutlineColor
<a name="channels-channelid-channelclass-model-burninoutlinecolor"></a>

Burn In Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInShadowColor
<a name="channels-channelid-channelclass-model-burninshadowcolor"></a>

Burn In Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInTeletextGridControl
<a name="channels-channelid-channelclass-model-burninteletextgridcontrol"></a>

Burn In Teletext Grid Control
+ `FIXED`
+ `SCALED`

### CaptionDescription
<a name="channels-channelid-channelclass-model-captiondescription"></a>

Caption Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. | 
| destinationSettings | [CaptionDestinationSettings](#channels-channelid-channelclass-model-captiondestinationsettings) | False | Additional settings for captions destination that depend on the destination type. | 
| languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | 
| languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). | 
| name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. | 

### CaptionDestinationSettings
<a name="channels-channelid-channelclass-model-captiondestinationsettings"></a>

Caption Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aribDestinationSettings | [AribDestinationSettings](#channels-channelid-channelclass-model-aribdestinationsettings) | False |  | 
| burnInDestinationSettings | [BurnInDestinationSettings](#channels-channelid-channelclass-model-burnindestinationsettings) | False |  | 
| dvbSubDestinationSettings | [DvbSubDestinationSettings](#channels-channelid-channelclass-model-dvbsubdestinationsettings) | False |  | 
| ebuTtDDestinationSettings | [EbuTtDDestinationSettings](#channels-channelid-channelclass-model-ebuttddestinationsettings) | False |  | 
| embeddedDestinationSettings | [EmbeddedDestinationSettings](#channels-channelid-channelclass-model-embeddeddestinationsettings) | False |  | 
| embeddedPlusScte20DestinationSettings | [EmbeddedPlusScte20DestinationSettings](#channels-channelid-channelclass-model-embeddedplusscte20destinationsettings) | False |  | 
| rtmpCaptionInfoDestinationSettings | [RtmpCaptionInfoDestinationSettings](#channels-channelid-channelclass-model-rtmpcaptioninfodestinationsettings) | False |  | 
| scte20PlusEmbeddedDestinationSettings | [Scte20PlusEmbeddedDestinationSettings](#channels-channelid-channelclass-model-scte20plusembeddeddestinationsettings) | False |  | 
| scte27DestinationSettings | [Scte27DestinationSettings](#channels-channelid-channelclass-model-scte27destinationsettings) | False |  | 
| smpteTtDestinationSettings | [SmpteTtDestinationSettings](#channels-channelid-channelclass-model-smptettdestinationsettings) | False |  | 
| teletextDestinationSettings | [TeletextDestinationSettings](#channels-channelid-channelclass-model-teletextdestinationsettings) | False |  | 
| ttmlDestinationSettings | [TtmlDestinationSettings](#channels-channelid-channelclass-model-ttmldestinationsettings) | False |  | 
| webvttDestinationSettings | [WebvttDestinationSettings](#channels-channelid-channelclass-model-webvttdestinationsettings) | False |  | 

### CaptionLanguageMapping
<a name="channels-channelid-channelclass-model-captionlanguagemapping"></a>

Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionChannel | integerMinimum: 1Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) | 
| languageCode | stringMinLength: 3MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) | 
| languageDescription | stringMinLength: 1 | True | Textual description of language | 

### CaptionRectangle
<a name="channels-channelid-channelclass-model-captionrectangle"></a>

Caption Rectangle


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| height | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \$1"80\$1" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. | 
| leftOffset | numberMinimum: 0Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. | 
| topOffset | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. | 
| width | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \$1"80\$1" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. | 

### CaptionSelector
<a name="channels-channelid-channelclass-model-captionselector"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. | 
| name | stringMinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. | 
| selectorSettings | [CaptionSelectorSettings](#channels-channelid-channelclass-model-captionselectorsettings) | False | Caption selector settings. | 

### CaptionSelectorSettings
<a name="channels-channelid-channelclass-model-captionselectorsettings"></a>

Caption Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ancillarySourceSettings | [AncillarySourceSettings](#channels-channelid-channelclass-model-ancillarysourcesettings) | False |  | 
| aribSourceSettings | [AribSourceSettings](#channels-channelid-channelclass-model-aribsourcesettings) | False |  | 
| dvbSubSourceSettings | [DvbSubSourceSettings](#channels-channelid-channelclass-model-dvbsubsourcesettings) | False |  | 
| embeddedSourceSettings | [EmbeddedSourceSettings](#channels-channelid-channelclass-model-embeddedsourcesettings) | False |  | 
| scte20SourceSettings | [Scte20SourceSettings](#channels-channelid-channelclass-model-scte20sourcesettings) | False |  | 
| scte27SourceSettings | [Scte27SourceSettings](#channels-channelid-channelclass-model-scte27sourcesettings) | False |  | 
| teletextSourceSettings | [TeletextSourceSettings](#channels-channelid-channelclass-model-teletextsourcesettings) | False |  | 

### CdiInputResolution
<a name="channels-channelid-channelclass-model-cdiinputresolution"></a>

Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### CdiInputSpecification
<a name="channels-channelid-channelclass-model-cdiinputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resolution | [CdiInputResolution](#channels-channelid-channelclass-model-cdiinputresolution) | False | Maximum CDI input resolution | 

### Channel
<a name="channels-channelid-channelclass-model-channel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-channelid-channelclass-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-channelid-channelclass-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-channelid-channelclass-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-channelid-channelclass-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| encoderSettings | [EncoderSettings](#channels-channelid-channelclass-model-encodersettings) | False |  | 
| id | string | False | The unique ID of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-channelid-channelclass-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-channelid-channelclass-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-channelid-channelclass-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-channelid-channelclass-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelineDetails | Array of type [PipelineDetail](#channels-channelid-channelclass-model-pipelinedetail) | False | Runtime details for the pipelines of a running channel. | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-channelid-channelclass-model-channelstate) | False |  | 
| tags | [Tags](#channels-channelid-channelclass-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-channelid-channelclass-model-vpcoutputsettingsdescription) | False | Settings for VPC output | 

### ChannelClass
<a name="channels-channelid-channelclass-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### ChannelConfigurationValidationError
<a name="channels-channelid-channelclass-model-channelconfigurationvalidationerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 
| validationErrors | Array of type [ValidationError](#channels-channelid-channelclass-model-validationerror) | False | A collection of validation error responses. | 

### ChannelEgressEndpoint
<a name="channels-channelid-channelclass-model-channelegressendpoint"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceIp | string | False | Public IP of where a channel's output comes from | 

### ChannelState
<a name="channels-channelid-channelclass-model-channelstate"></a>
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`
+ `UPDATING`
+ `UPDATE_FAILED`

### ColorSpacePassthroughSettings
<a name="channels-channelid-channelclass-model-colorspacepassthroughsettings"></a>

Passthrough applies no color space conversion to the output

### DvbNitSettings
<a name="channels-channelid-channelclass-model-dvbnitsettings"></a>

DVB Network Information Table (NIT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| networkId | integerMinimum: 0Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). | 
| networkName | stringMinLength: 1MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. | 
| repInterval | integerMinimum: 25Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### DvbSdtOutputSdt
<a name="channels-channelid-channelclass-model-dvbsdtoutputsdt"></a>

Dvb Sdt Output Sdt
+ `SDT_FOLLOW`
+ `SDT_FOLLOW_IF_PRESENT`
+ `SDT_MANUAL`
+ `SDT_NONE`

### DvbSdtSettings
<a name="channels-channelid-channelclass-model-dvbsdtsettings"></a>

DVB Service Description Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputSdt | [DvbSdtOutputSdt](#channels-channelid-channelclass-model-dvbsdtoutputsdt) | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | 
| repInterval | integerMinimum: 25Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. | 
| serviceName | stringMinLength: 1MaxLength: 256 | False | The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 
| serviceProviderName | stringMinLength: 1MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 

### DvbSubDestinationAlignment
<a name="channels-channelid-channelclass-model-dvbsubdestinationalignment"></a>

Dvb Sub Destination Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### DvbSubDestinationBackgroundColor
<a name="channels-channelid-channelclass-model-dvbsubdestinationbackgroundcolor"></a>

Dvb Sub Destination Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationFontColor
<a name="channels-channelid-channelclass-model-dvbsubdestinationfontcolor"></a>

Dvb Sub Destination Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationOutlineColor
<a name="channels-channelid-channelclass-model-dvbsubdestinationoutlinecolor"></a>

Dvb Sub Destination Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationSettings
<a name="channels-channelid-channelclass-model-dvbsubdestinationsettings"></a>

Dvb Sub Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [DvbSubDestinationAlignment](#channels-channelid-channelclass-model-dvbsubdestinationalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [DvbSubDestinationBackgroundColor](#channels-channelid-channelclass-model-dvbsubdestinationbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [DvbSubDestinationFontColor](#channels-channelid-channelclass-model-dvbsubdestinationfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [DvbSubDestinationOutlineColor](#channels-channelid-channelclass-model-dvbsubdestinationoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [DvbSubDestinationShadowColor](#channels-channelid-channelclass-model-dvbsubdestinationshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [DvbSubDestinationTeletextGridControl](#channels-channelid-channelclass-model-dvbsubdestinationteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 

### DvbSubDestinationShadowColor
<a name="channels-channelid-channelclass-model-dvbsubdestinationshadowcolor"></a>

Dvb Sub Destination Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationTeletextGridControl
<a name="channels-channelid-channelclass-model-dvbsubdestinationteletextgridcontrol"></a>

Dvb Sub Destination Teletext Grid Control
+ `FIXED`
+ `SCALED`

### DvbSubOcrLanguage
<a name="channels-channelid-channelclass-model-dvbsubocrlanguage"></a>

Dvb Sub Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### DvbSubSourceSettings
<a name="channels-channelid-channelclass-model-dvbsubsourcesettings"></a>

Dvb Sub Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [DvbSubOcrLanguage](#channels-channelid-channelclass-model-dvbsubocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. | 

### DvbTdtSettings
<a name="channels-channelid-channelclass-model-dvbtdtsettings"></a>

DVB Time and Date Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| repInterval | integerMinimum: 1000Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### Eac3AttenuationControl
<a name="channels-channelid-channelclass-model-eac3attenuationcontrol"></a>

Eac3 Attenuation Control
+ `ATTENUATE_3_DB`
+ `NONE`

### Eac3BitstreamMode
<a name="channels-channelid-channelclass-model-eac3bitstreammode"></a>

Eac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `VISUALLY_IMPAIRED`

### Eac3CodingMode
<a name="channels-channelid-channelclass-model-eac3codingmode"></a>

Eac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2`

### Eac3DcFilter
<a name="channels-channelid-channelclass-model-eac3dcfilter"></a>

Eac3 Dc Filter
+ `DISABLED`
+ `ENABLED`

### Eac3DrcLine
<a name="channels-channelid-channelclass-model-eac3drcline"></a>

Eac3 Drc Line
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3DrcRf
<a name="channels-channelid-channelclass-model-eac3drcrf"></a>

Eac3 Drc Rf
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3LfeControl
<a name="channels-channelid-channelclass-model-eac3lfecontrol"></a>

Eac3 Lfe Control
+ `LFE`
+ `NO_LFE`

### Eac3LfeFilter
<a name="channels-channelid-channelclass-model-eac3lfefilter"></a>

Eac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Eac3MetadataControl
<a name="channels-channelid-channelclass-model-eac3metadatacontrol"></a>

Eac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Eac3PassthroughControl
<a name="channels-channelid-channelclass-model-eac3passthroughcontrol"></a>

Eac3 Passthrough Control
+ `NO_PASSTHROUGH`
+ `WHEN_POSSIBLE`

### Eac3PhaseControl
<a name="channels-channelid-channelclass-model-eac3phasecontrol"></a>

Eac3 Phase Control
+ `NO_SHIFT`
+ `SHIFT_90_DEGREES`

### Eac3Settings
<a name="channels-channelid-channelclass-model-eac3settings"></a>

Eac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| attenuationControl | [Eac3AttenuationControl](#channels-channelid-channelclass-model-eac3attenuationcontrol) | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | 
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Eac3BitstreamMode](#channels-channelid-channelclass-model-eac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. | 
| codingMode | [Eac3CodingMode](#channels-channelid-channelclass-model-eac3codingmode) | False | Dolby Digital Plus coding mode. Determines number of channels. | 
| dcFilter | [Eac3DcFilter](#channels-channelid-channelclass-model-eac3dcfilter) | False | When set to enabled, activates a DC highpass filter for all input channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. | 
| drcLine | [Eac3DrcLine](#channels-channelid-channelclass-model-eac3drcline) | False | Sets the Dolby dynamic range compression profile. | 
| drcRf | [Eac3DrcRf](#channels-channelid-channelclass-model-eac3drcrf) | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | 
| lfeControl | [Eac3LfeControl](#channels-channelid-channelclass-model-eac3lfecontrol) | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | 
| lfeFilter | [Eac3LfeFilter](#channels-channelid-channelclass-model-eac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | 
| loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. | 
| loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. | 
| ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. | 
| ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. | 
| metadataControl | [Eac3MetadataControl](#channels-channelid-channelclass-model-eac3metadatacontrol) | False | When set to followInput, encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 
| passthroughControl | [Eac3PassthroughControl](#channels-channelid-channelclass-model-eac3passthroughcontrol) | False | When set to whenPossible, input DD\$1 audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD\$1 and non-DD\$1 content will have a consistent DD\$1 output as the system alternates between passthrough and encoding. | 
| phaseControl | [Eac3PhaseControl](#channels-channelid-channelclass-model-eac3phasecontrol) | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | 
| stereoDownmix | [Eac3StereoDownmix](#channels-channelid-channelclass-model-eac3stereodownmix) | False | Stereo downmix preference. Only used for 3/2 coding mode. | 
| surroundExMode | [Eac3SurroundExMode](#channels-channelid-channelclass-model-eac3surroundexmode) | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | 
| surroundMode | [Eac3SurroundMode](#channels-channelid-channelclass-model-eac3surroundmode) | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. | 

### Eac3StereoDownmix
<a name="channels-channelid-channelclass-model-eac3stereodownmix"></a>

Eac3 Stereo Downmix
+ `DPL2`
+ `LO_RO`
+ `LT_RT`
+ `NOT_INDICATED`

### Eac3SurroundExMode
<a name="channels-channelid-channelclass-model-eac3surroundexmode"></a>

Eac3 Surround Ex Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### Eac3SurroundMode
<a name="channels-channelid-channelclass-model-eac3surroundmode"></a>

Eac3 Surround Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### EbuTtDDestinationSettings
<a name="channels-channelid-channelclass-model-ebuttddestinationsettings"></a>

Ebu Tt DDestination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyrightHolder | stringMaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML | 
| fillLineGap | [EbuTtDFillLineGapControl](#channels-channelid-channelclass-model-ebuttdfilllinegapcontrol) | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | 
| fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. | 
| styleControl | [EbuTtDDestinationStyleControl](#channels-channelid-channelclass-model-ebuttddestinationstylecontrol) | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. | 

### EbuTtDDestinationStyleControl
<a name="channels-channelid-channelclass-model-ebuttddestinationstylecontrol"></a>

Ebu Tt DDestination Style Control
+ `EXCLUDE`
+ `INCLUDE`

### EbuTtDFillLineGapControl
<a name="channels-channelid-channelclass-model-ebuttdfilllinegapcontrol"></a>

Ebu Tt DFill Line Gap Control
+ `DISABLED`
+ `ENABLED`

### EmbeddedConvert608To708
<a name="channels-channelid-channelclass-model-embeddedconvert608to708"></a>

Embedded Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### EmbeddedDestinationSettings
<a name="channels-channelid-channelclass-model-embeddeddestinationsettings"></a>

Embedded Destination Settings

### EmbeddedPlusScte20DestinationSettings
<a name="channels-channelid-channelclass-model-embeddedplusscte20destinationsettings"></a>

Embedded Plus Scte20 Destination Settings

### EmbeddedScte20Detection
<a name="channels-channelid-channelclass-model-embeddedscte20detection"></a>

Embedded Scte20 Detection
+ `AUTO`
+ `OFF`

### EmbeddedSourceSettings
<a name="channels-channelid-channelclass-model-embeddedsourcesettings"></a>

Embedded Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [EmbeddedConvert608To708](#channels-channelid-channelclass-model-embeddedconvert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| scte20Detection | [EmbeddedScte20Detection](#channels-channelid-channelclass-model-embeddedscte20detection) | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 
| source608TrackNumber | integerMinimum: 1Maximum: 5 | False | This field is unused and deprecated. | 

### EncoderSettings
<a name="channels-channelid-channelclass-model-encodersettings"></a>

Encoder Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptions | Array of type [AudioDescription](#channels-channelid-channelclass-model-audiodescription) | True |  | 
| availBlanking | [AvailBlanking](#channels-channelid-channelclass-model-availblanking) | False | Settings for ad avail blanking. | 
| availConfiguration | [AvailConfiguration](#channels-channelid-channelclass-model-availconfiguration) | False | Event-wide configuration settings for ad avail insertion. | 
| blackoutSlate | [BlackoutSlate](#channels-channelid-channelclass-model-blackoutslate) | False | Settings for blackout slate. | 
| captionDescriptions | Array of type [CaptionDescription](#channels-channelid-channelclass-model-captiondescription) | False | Settings for caption decriptions | 
| featureActivations | [FeatureActivations](#channels-channelid-channelclass-model-featureactivations) | False | Feature Activations | 
| globalConfiguration | [GlobalConfiguration](#channels-channelid-channelclass-model-globalconfiguration) | False | Configuration settings that apply to the event as a whole. | 
| motionGraphicsConfiguration | [MotionGraphicsConfiguration](#channels-channelid-channelclass-model-motiongraphicsconfiguration) | False | Settings for motion graphics. | 
| nielsenConfiguration | [NielsenConfiguration](#channels-channelid-channelclass-model-nielsenconfiguration) | False | Nielsen configuration settings. | 
| outputGroups | Array of type [OutputGroup](#channels-channelid-channelclass-model-outputgroup) | True |  | 
| timecodeConfig | [TimecodeConfig](#channels-channelid-channelclass-model-timecodeconfig) | True | Contains settings used to acquire and adjust timecode information from inputs. | 
| videoDescriptions | Array of type [VideoDescription](#channels-channelid-channelclass-model-videodescription) | True |  | 

### FailoverCondition
<a name="channels-channelid-channelclass-model-failovercondition"></a>

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failoverConditionSettings | [FailoverConditionSettings](#channels-channelid-channelclass-model-failoverconditionsettings) | False | Failover condition type-specific settings. | 

### FailoverConditionSettings
<a name="channels-channelid-channelclass-model-failoverconditionsettings"></a>

Settings for one failover condition.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSilenceSettings | [AudioSilenceFailoverSettings](#channels-channelid-channelclass-model-audiosilencefailoversettings) | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | 
| inputLossSettings | [InputLossFailoverSettings](#channels-channelid-channelclass-model-inputlossfailoversettings) | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | 
| videoBlackSettings | [VideoBlackFailoverSettings](#channels-channelid-channelclass-model-videoblackfailoversettings) | False | MediaLive will perform a failover if content is considered black for the specified period. | 

### FeatureActivations
<a name="channels-channelid-channelclass-model-featureactivations"></a>

Feature Activations


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputPrepareScheduleActions | [FeatureActivationsInputPrepareScheduleActions](#channels-channelid-channelclass-model-featureactivationsinputpreparescheduleactions) | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. | 

### FeatureActivationsInputPrepareScheduleActions
<a name="channels-channelid-channelclass-model-featureactivationsinputpreparescheduleactions"></a>

Feature Activations Input Prepare Schedule Actions
+ `DISABLED`
+ `ENABLED`

### FecOutputIncludeFec
<a name="channels-channelid-channelclass-model-fecoutputincludefec"></a>

Fec Output Include Fec
+ `COLUMN`
+ `COLUMN_AND_ROW`

### FecOutputSettings
<a name="channels-channelid-channelclass-model-fecoutputsettings"></a>

Fec Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| columnDepth | integerMinimum: 4Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. | 
| includeFec | [FecOutputIncludeFec](#channels-channelid-channelclass-model-fecoutputincludefec) | False | Enables column only or column and row based FEC | 
| rowLength | integerMinimum: 1Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. | 

### FixedAfd
<a name="channels-channelid-channelclass-model-fixedafd"></a>

Fixed Afd
+ `AFD_0000`
+ `AFD_0010`
+ `AFD_0011`
+ `AFD_0100`
+ `AFD_1000`
+ `AFD_1001`
+ `AFD_1010`
+ `AFD_1011`
+ `AFD_1101`
+ `AFD_1110`
+ `AFD_1111`

### Fmp4HlsSettings
<a name="channels-channelid-channelclass-model-fmp4hlssettings"></a>

Fmp4 Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| nielsenId3Behavior | [Fmp4NielsenId3Behavior](#channels-channelid-channelclass-model-fmp4nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| timedMetadataBehavior | [Fmp4TimedMetadataBehavior](#channels-channelid-channelclass-model-fmp4timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 

### Fmp4NielsenId3Behavior
<a name="channels-channelid-channelclass-model-fmp4nielsenid3behavior"></a>

Fmp4 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### Fmp4TimedMetadataBehavior
<a name="channels-channelid-channelclass-model-fmp4timedmetadatabehavior"></a>

Fmp4 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### FrameCaptureCdnSettings
<a name="channels-channelid-channelclass-model-framecapturecdnsettings"></a>

Frame Capture Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureS3Settings | [FrameCaptureS3Settings](#channels-channelid-channelclass-model-framecaptures3settings) | False |  | 

### FrameCaptureGroupSettings
<a name="channels-channelid-channelclass-model-framecapturegroupsettings"></a>

Frame Capture Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") \$1 name modifier \$1 the counter (5 digits, starting from 00001) \$1 extension (which is always .jpg). For example, curling-low.00001.jpg | 
| frameCaptureCdnSettings | [FrameCaptureCdnSettings](#channels-channelid-channelclass-model-framecapturecdnsettings) | False | Parameters that control interactions with the CDN. | 

### FrameCaptureHlsSettings
<a name="channels-channelid-channelclass-model-framecapturehlssettings"></a>

Frame Capture Hls Settings

### FrameCaptureIntervalUnit
<a name="channels-channelid-channelclass-model-framecaptureintervalunit"></a>

Frame Capture Interval Unit
+ `MILLISECONDS`
+ `SECONDS`

### FrameCaptureOutputSettings
<a name="channels-channelid-channelclass-model-framecaptureoutputsettings"></a>

Frame Capture Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. | 

### FrameCaptureS3LogUploads
<a name="channels-channelid-channelclass-model-framecaptures3loguploads"></a>

Frame Capture S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### FrameCaptureS3Settings
<a name="channels-channelid-channelclass-model-framecaptures3settings"></a>

Frame Capture S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-channelclass-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [FrameCaptureS3LogUploads](#channels-channelid-channelclass-model-framecaptures3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### FrameCaptureSettings
<a name="channels-channelid-channelclass-model-framecapturesettings"></a>

Frame Capture Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captureInterval | integerMinimum: 1Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. | 
| captureIntervalUnits | [FrameCaptureIntervalUnit](#channels-channelid-channelclass-model-framecaptureintervalunit) | False | Unit for the frame capture interval. | 

### GatewayTimeoutException
<a name="channels-channelid-channelclass-model-gatewaytimeoutexception"></a>


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

### GlobalConfiguration
<a name="channels-channelid-channelclass-model-globalconfiguration"></a>

Global Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| initialAudioGain | integerMinimum: -60Maximum: 60 | False | Value to set the initial audio gain for the Live Event. | 
| inputEndAction | [GlobalConfigurationInputEndAction](#channels-channelid-channelclass-model-globalconfigurationinputendaction) | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | 
| inputLossBehavior | [InputLossBehavior](#channels-channelid-channelclass-model-inputlossbehavior) | False | Settings for system actions when input is lost. | 
| outputLockingMode | [GlobalConfigurationOutputLockingMode](#channels-channelid-channelclass-model-globalconfigurationoutputlockingmode) | False | Indicates how MediaLive pipelines are synchronized. PIPELINE\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | 
| outputTimingSource | [GlobalConfigurationOutputTimingSource](#channels-channelid-channelclass-model-globalconfigurationoutputtimingsource) | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | 
| supportLowFramerateInputs | [GlobalConfigurationLowFramerateInputs](#channels-channelid-channelclass-model-globalconfigurationlowframerateinputs) | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. | 

### GlobalConfigurationInputEndAction
<a name="channels-channelid-channelclass-model-globalconfigurationinputendaction"></a>

Global Configuration Input End Action
+ `NONE`
+ `SWITCH_AND_LOOP_INPUTS`

### GlobalConfigurationLowFramerateInputs
<a name="channels-channelid-channelclass-model-globalconfigurationlowframerateinputs"></a>

Global Configuration Low Framerate Inputs
+ `DISABLED`
+ `ENABLED`

### GlobalConfigurationOutputLockingMode
<a name="channels-channelid-channelclass-model-globalconfigurationoutputlockingmode"></a>

Global Configuration Output Locking Mode
+ `EPOCH_LOCKING`
+ `PIPELINE_LOCKING`

### GlobalConfigurationOutputTimingSource
<a name="channels-channelid-channelclass-model-globalconfigurationoutputtimingsource"></a>

Global Configuration Output Timing Source
+ `INPUT_CLOCK`
+ `SYSTEM_CLOCK`

### H264AdaptiveQuantization
<a name="channels-channelid-channelclass-model-h264adaptivequantization"></a>

H264 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H264ColorMetadata
<a name="channels-channelid-channelclass-model-h264colormetadata"></a>

H264 Color Metadata
+ `IGNORE`
+ `INSERT`

### H264ColorSpaceSettings
<a name="channels-channelid-channelclass-model-h264colorspacesettings"></a>

H264 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-channelclass-model-colorspacepassthroughsettings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-channelclass-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-channelclass-model-rec709settings) | False |  | 

### H264EntropyEncoding
<a name="channels-channelid-channelclass-model-h264entropyencoding"></a>

H264 Entropy Encoding
+ `CABAC`
+ `CAVLC`

### H264FilterSettings
<a name="channels-channelid-channelclass-model-h264filtersettings"></a>

H264 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-channelclass-model-temporalfiltersettings) | False |  | 

### H264FlickerAq
<a name="channels-channelid-channelclass-model-h264flickeraq"></a>

H264 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H264ForceFieldPictures
<a name="channels-channelid-channelclass-model-h264forcefieldpictures"></a>

H264 Force Field Pictures
+ `DISABLED`
+ `ENABLED`

### H264FramerateControl
<a name="channels-channelid-channelclass-model-h264frameratecontrol"></a>

H264 Framerate Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264GopBReference
<a name="channels-channelid-channelclass-model-h264gopbreference"></a>

H264 Gop BReference
+ `DISABLED`
+ `ENABLED`

### H264GopSizeUnits
<a name="channels-channelid-channelclass-model-h264gopsizeunits"></a>

H264 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H264Level
<a name="channels-channelid-channelclass-model-h264level"></a>

H264 Level
+ `H264_LEVEL_1`
+ `H264_LEVEL_1_1`
+ `H264_LEVEL_1_2`
+ `H264_LEVEL_1_3`
+ `H264_LEVEL_2`
+ `H264_LEVEL_2_1`
+ `H264_LEVEL_2_2`
+ `H264_LEVEL_3`
+ `H264_LEVEL_3_1`
+ `H264_LEVEL_3_2`
+ `H264_LEVEL_4`
+ `H264_LEVEL_4_1`
+ `H264_LEVEL_4_2`
+ `H264_LEVEL_5`
+ `H264_LEVEL_5_1`
+ `H264_LEVEL_5_2`
+ `H264_LEVEL_AUTO`

### H264LookAheadRateControl
<a name="channels-channelid-channelclass-model-h264lookaheadratecontrol"></a>

H264 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H264ParControl
<a name="channels-channelid-channelclass-model-h264parcontrol"></a>

H264 Par Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264Profile
<a name="channels-channelid-channelclass-model-h264profile"></a>

H264 Profile
+ `BASELINE`
+ `HIGH`
+ `HIGH_10BIT`
+ `HIGH_422`
+ `HIGH_422_10BIT`
+ `MAIN`

### H264QualityLevel
<a name="channels-channelid-channelclass-model-h264qualitylevel"></a>

H264 Quality Level
+ `ENHANCED_QUALITY`
+ `STANDARD_QUALITY`

### H264RateControlMode
<a name="channels-channelid-channelclass-model-h264ratecontrolmode"></a>

H264 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`
+ `VBR`

### H264ScanType
<a name="channels-channelid-channelclass-model-h264scantype"></a>

H264 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H264SceneChangeDetect
<a name="channels-channelid-channelclass-model-h264scenechangedetect"></a>

H264 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H264Settings
<a name="channels-channelid-channelclass-model-h264settings"></a>

H264 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H264AdaptiveQuantization](#channels-channelid-channelclass-model-h264adaptivequantization) | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | 
| afdSignaling | [AfdSignaling](#channels-channelid-channelclass-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| bitrate | integerMinimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufFillPct | integerMinimum: 0Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). | 
| bufSize | integerMinimum: 0 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H264ColorMetadata](#channels-channelid-channelclass-model-h264colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H264ColorSpaceSettings](#channels-channelid-channelclass-model-h264colorspacesettings) | False | Color Space settings | 
| entropyEncoding | [H264EntropyEncoding](#channels-channelid-channelclass-model-h264entropyencoding) | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | 
| filterSettings | [H264FilterSettings](#channels-channelid-channelclass-model-h264filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-channelclass-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H264FlickerAq](#channels-channelid-channelclass-model-h264flickeraq) | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | 
| forceFieldPictures | [H264ForceFieldPictures](#channels-channelid-channelclass-model-h264forcefieldpictures) | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | 
| framerateControl | [H264FramerateControl](#channels-channelid-channelclass-model-h264frameratecontrol) | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | 
| framerateDenominator | integerMinimum: 1 | False | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopBReference | [H264GopBReference](#channels-channelid-channelclass-model-h264gopbreference) | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Number of B-frames between reference frames. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H264GopSizeUnits](#channels-channelid-channelclass-model-h264gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H264Level](#channels-channelid-channelclass-model-h264level) | False | H.264 Level. | 
| lookAheadRateControl | [H264LookAheadRateControl](#channels-channelid-channelclass-model-h264lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| numRefFrames | integerMinimum: 1Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. | 
| parControl | [H264ParControl](#channels-channelid-channelclass-model-h264parcontrol) | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H264Profile](#channels-channelid-channelclass-model-h264profile) | False | H.264 Profile. | 
| qualityLevel | [H264QualityLevel](#channels-channelid-channelclass-model-h264qualitylevel) | False | Leave as STANDARD\$1QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED\$1QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED\$1QUALITY. - STANDARD\$1QUALITY: Valid for any Rate control mode. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide | 
| rateControlMode | [H264RateControlMode](#channels-channelid-channelclass-model-h264ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H264ScanType](#channels-channelid-channelclass-model-h264scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H264SceneChangeDetect](#channels-channelid-channelclass-model-h264scenechangedetect) | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | 
| slices | integerMinimum: 1Maximum: 32 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| softness | integerMinimum: 0Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. | 
| spatialAq | [H264SpatialAq](#channels-channelid-channelclass-model-h264spatialaq) | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | 
| subgopLength | [H264SubGopLength](#channels-channelid-channelclass-model-h264subgoplength) | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | 
| syntax | [H264Syntax](#channels-channelid-channelclass-model-h264syntax) | False | Produces a bitstream compliant with SMPTE RP-2027. | 
| temporalAq | [H264TemporalAq](#channels-channelid-channelclass-model-h264temporalaq) | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | 
| timecodeInsertion | [H264TimecodeInsertionBehavior](#channels-channelid-channelclass-model-h264timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H264SpatialAq
<a name="channels-channelid-channelclass-model-h264spatialaq"></a>

H264 Spatial Aq
+ `DISABLED`
+ `ENABLED`

### H264SubGopLength
<a name="channels-channelid-channelclass-model-h264subgoplength"></a>

H264 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### H264Syntax
<a name="channels-channelid-channelclass-model-h264syntax"></a>

H264 Syntax
+ `DEFAULT`
+ `RP2027`

### H264TemporalAq
<a name="channels-channelid-channelclass-model-h264temporalaq"></a>

H264 Temporal Aq
+ `DISABLED`
+ `ENABLED`

### H264TimecodeInsertionBehavior
<a name="channels-channelid-channelclass-model-h264timecodeinsertionbehavior"></a>

H264 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### H265AdaptiveQuantization
<a name="channels-channelid-channelclass-model-h265adaptivequantization"></a>

H265 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H265AlternativeTransferFunction
<a name="channels-channelid-channelclass-model-h265alternativetransferfunction"></a>

H265 Alternative Transfer Function
+ `INSERT`
+ `OMIT`

### H265ColorMetadata
<a name="channels-channelid-channelclass-model-h265colormetadata"></a>

H265 Color Metadata
+ `IGNORE`
+ `INSERT`

### H265ColorSpaceSettings
<a name="channels-channelid-channelclass-model-h265colorspacesettings"></a>

H265 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-channelclass-model-colorspacepassthroughsettings) | False |  | 
| hdr10Settings | [Hdr10Settings](#channels-channelid-channelclass-model-hdr10settings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-channelclass-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-channelclass-model-rec709settings) | False |  | 

### H265FilterSettings
<a name="channels-channelid-channelclass-model-h265filtersettings"></a>

H265 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-channelclass-model-temporalfiltersettings) | False |  | 

### H265FlickerAq
<a name="channels-channelid-channelclass-model-h265flickeraq"></a>

H265 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H265GopSizeUnits
<a name="channels-channelid-channelclass-model-h265gopsizeunits"></a>

H265 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H265Level
<a name="channels-channelid-channelclass-model-h265level"></a>

H265 Level
+ `H265_LEVEL_1`
+ `H265_LEVEL_2`
+ `H265_LEVEL_2_1`
+ `H265_LEVEL_3`
+ `H265_LEVEL_3_1`
+ `H265_LEVEL_4`
+ `H265_LEVEL_4_1`
+ `H265_LEVEL_5`
+ `H265_LEVEL_5_1`
+ `H265_LEVEL_5_2`
+ `H265_LEVEL_6`
+ `H265_LEVEL_6_1`
+ `H265_LEVEL_6_2`
+ `H265_LEVEL_AUTO`

### H265LookAheadRateControl
<a name="channels-channelid-channelclass-model-h265lookaheadratecontrol"></a>

H265 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H265Profile
<a name="channels-channelid-channelclass-model-h265profile"></a>

H265 Profile
+ `MAIN`
+ `MAIN_10BIT`

### H265RateControlMode
<a name="channels-channelid-channelclass-model-h265ratecontrolmode"></a>

H265 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`

### H265ScanType
<a name="channels-channelid-channelclass-model-h265scantype"></a>

H265 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H265SceneChangeDetect
<a name="channels-channelid-channelclass-model-h265scenechangedetect"></a>

H265 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H265Settings
<a name="channels-channelid-channelclass-model-h265settings"></a>

H265 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H265AdaptiveQuantization](#channels-channelid-channelclass-model-h265adaptivequantization) | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-channelclass-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| alternativeTransferFunction | [H265AlternativeTransferFunction](#channels-channelid-channelclass-model-h265alternativetransferfunction) | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | 
| bitrate | integerMinimum: 100000Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufSize | integerMinimum: 100000Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H265ColorMetadata](#channels-channelid-channelclass-model-h265colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H265ColorSpaceSettings](#channels-channelid-channelclass-model-h265colorspacesettings) | False | Color Space settings | 
| filterSettings | [H265FilterSettings](#channels-channelid-channelclass-model-h265filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-channelclass-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H265FlickerAq](#channels-channelid-channelclass-model-h265flickeraq) | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | 
| framerateDenominator | integerMinimum: 1Maximum: 3003 | True | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H265GopSizeUnits](#channels-channelid-channelclass-model-h265gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H265Level](#channels-channelid-channelclass-model-h265level) | False | H.265 Level. | 
| lookAheadRateControl | [H265LookAheadRateControl](#channels-channelid-channelclass-model-h265lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 100000Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H265Profile](#channels-channelid-channelclass-model-h265profile) | False | H.265 Profile. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M | 
| rateControlMode | [H265RateControlMode](#channels-channelid-channelclass-model-h265ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H265ScanType](#channels-channelid-channelclass-model-h265scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H265SceneChangeDetect](#channels-channelid-channelclass-model-h265scenechangedetect) | False | Scene change detection. | 
| slices | integerMinimum: 1Maximum: 16 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| tier | [H265Tier](#channels-channelid-channelclass-model-h265tier) | False | H.265 Tier. | 
| timecodeInsertion | [H265TimecodeInsertionBehavior](#channels-channelid-channelclass-model-h265timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H265Tier
<a name="channels-channelid-channelclass-model-h265tier"></a>

H265 Tier
+ `HIGH`
+ `MAIN`

### H265TimecodeInsertionBehavior
<a name="channels-channelid-channelclass-model-h265timecodeinsertionbehavior"></a>

H265 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### Hdr10Settings
<a name="channels-channelid-channelclass-model-hdr10settings"></a>

Hdr10 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxCll | integerMinimum: 0Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. | 
| maxFall | integerMinimum: 0Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. | 

### HlsAdMarkers
<a name="channels-channelid-channelclass-model-hlsadmarkers"></a>

Hls Ad Markers
+ `ADOBE`
+ `ELEMENTAL`
+ `ELEMENTAL_SCTE35`

### HlsAkamaiHttpTransferMode
<a name="channels-channelid-channelclass-model-hlsakamaihttptransfermode"></a>

Hls Akamai Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsAkamaiSettings
<a name="channels-channelid-channelclass-model-hlsakamaisettings"></a>

Hls Akamai Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsAkamaiHttpTransferMode](#channels-channelid-channelclass-model-hlsakamaihttptransfermode) | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 
| salt | string | False | Salt for authenticated Akamai. | 
| token | string | False | Token parameter for authenticated akamai. If not specified, \$1gda\$1 is used. | 

### HlsBasicPutSettings
<a name="channels-channelid-channelclass-model-hlsbasicputsettings"></a>

Hls Basic Put Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsCaptionLanguageSetting
<a name="channels-channelid-channelclass-model-hlscaptionlanguagesetting"></a>

Hls Caption Language Setting
+ `INSERT`
+ `NONE`
+ `OMIT`

### HlsCdnSettings
<a name="channels-channelid-channelclass-model-hlscdnsettings"></a>

Hls Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsAkamaiSettings | [HlsAkamaiSettings](#channels-channelid-channelclass-model-hlsakamaisettings) | False |  | 
| hlsBasicPutSettings | [HlsBasicPutSettings](#channels-channelid-channelclass-model-hlsbasicputsettings) | False |  | 
| hlsMediaStoreSettings | [HlsMediaStoreSettings](#channels-channelid-channelclass-model-hlsmediastoresettings) | False |  | 
| hlsS3Settings | [HlsS3Settings](#channels-channelid-channelclass-model-hlss3settings) | False |  | 
| hlsWebdavSettings | [HlsWebdavSettings](#channels-channelid-channelclass-model-hlswebdavsettings) | False |  | 

### HlsClientCache
<a name="channels-channelid-channelclass-model-hlsclientcache"></a>

Hls Client Cache
+ `DISABLED`
+ `ENABLED`

### HlsCodecSpecification
<a name="channels-channelid-channelclass-model-hlscodecspecification"></a>

Hls Codec Specification
+ `RFC_4281`
+ `RFC_6381`

### HlsDirectoryStructure
<a name="channels-channelid-channelclass-model-hlsdirectorystructure"></a>

Hls Directory Structure
+ `SINGLE_DIRECTORY`
+ `SUBDIRECTORY_PER_STREAM`

### HlsDiscontinuityTags
<a name="channels-channelid-channelclass-model-hlsdiscontinuitytags"></a>

Hls Discontinuity Tags
+ `INSERT`
+ `NEVER_INSERT`

### HlsEncryptionType
<a name="channels-channelid-channelclass-model-hlsencryptiontype"></a>

Hls Encryption Type
+ `AES128`
+ `SAMPLE_AES`

### HlsGroupSettings
<a name="channels-channelid-channelclass-model-hlsgroupsettings"></a>

Hls Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [HlsAdMarkers](#channels-channelid-channelclass-model-hlsadmarkers) | False | Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. | 
| baseUrlContent | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. | 
| baseUrlManifest | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. | 
| captionLanguageMappings | Array of type [CaptionLanguageMapping](#channels-channelid-channelclass-model-captionlanguagemapping) | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". | 
| captionLanguageSetting | [HlsCaptionLanguageSetting](#channels-channelid-channelclass-model-hlscaptionlanguagesetting) | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | 
| clientCache | [HlsClientCache](#channels-channelid-channelclass-model-hlsclientcache) | False | When set to "disabled", sets the \$1EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | 
| codecSpecification | [HlsCodecSpecification](#channels-channelid-channelclass-model-hlscodecspecification) | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | 
| constantIv | stringMinLength: 32MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. | 
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | 
| directoryStructure | [HlsDirectoryStructure](#channels-channelid-channelclass-model-hlsdirectorystructure) | False | Place segments in subdirectories. | 
| discontinuityTags | [HlsDiscontinuityTags](#channels-channelid-channelclass-model-hlsdiscontinuitytags) | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | 
| encryptionType | [HlsEncryptionType](#channels-channelid-channelclass-model-hlsencryptiontype) | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | 
| hlsCdnSettings | [HlsCdnSettings](#channels-channelid-channelclass-model-hlscdnsettings) | False | Parameters that control interactions with the CDN. | 
| hlsId3SegmentTagging | [HlsId3SegmentTaggingState](#channels-channelid-channelclass-model-hlsid3segmenttaggingstate) | False | State of HLS ID3 Segment Tagging | 
| iFrameOnlyPlaylists | [IFrameOnlyPlaylistType](#channels-channelid-channelclass-model-iframeonlyplaylisttype) | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a \$1EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more \$1EXT-X-BYTERANGE entries identifying the I-frame position. For example, \$1EXT-X-BYTERANGE:160364@1461888" | 
| incompleteSegmentBehavior | [HlsIncompleteSegmentBehavior](#channels-channelid-channelclass-model-hlsincompletesegmentbehavior) | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | 
| indexNSegments | integerMinimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. | 
| inputLossAction | [InputLossActionForHlsOut](#channels-channelid-channelclass-model-inputlossactionforhlsout) | False | Parameter that control output group behavior on input loss. | 
| ivInManifest | [HlsIvInManifest](#channels-channelid-channelclass-model-hlsivinmanifest) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | 
| ivSource | [HlsIvSource](#channels-channelid-channelclass-model-hlsivsource) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | 
| keepSegments | integerMinimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) \$1 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. | 
| keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. | 
| keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). | 
| keyProviderSettings | [KeyProviderSettings](#channels-channelid-channelclass-model-keyprovidersettings) | False | The key provider settings. | 
| manifestCompression | [HlsManifestCompression](#channels-channelid-channelclass-model-hlsmanifestcompression) | False | When set to gzip, compresses HLS playlist. | 
| manifestDurationFormat | [HlsManifestDurationFormat](#channels-channelid-channelclass-model-hlsmanifestdurationformat) | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | 
| minSegmentLength | integerMinimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. | 
| mode | [HlsMode](#channels-channelid-channelclass-model-hlsmode) | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | 
| outputSelection | [HlsOutputSelection](#channels-channelid-channelclass-model-hlsoutputselection) | False | MANIFESTS\$1AND\$1SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT\$1MANIFESTS\$1AND\$1SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS\$1ONLY: Does not generate any manifests for this output group. | 
| programDateTime | [HlsProgramDateTime](#channels-channelid-channelclass-model-hlsprogramdatetime) | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | 
| programDateTimeClock | [HlsProgramDateTimeClock](#channels-channelid-channelclass-model-hlsprogramdatetimeclock) | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE\$1FROM\$1OUTPUT\$1TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM\$1CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | 
| programDateTimePeriod | integerMinimum: 0Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | 
| redundantManifest | [HlsRedundantManifest](#channels-channelid-channelclass-model-hlsredundantmanifest) | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | 
| segmentationMode | [HlsSegmentationMode](#channels-channelid-channelclass-model-hlssegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| segmentLength | integerMinimum: 1 | False | Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. | 
| segmentsPerSubdirectory | integerMinimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. | 
| streamInfResolution | [HlsStreamInfResolution](#channels-channelid-channelclass-model-hlsstreaminfresolution) | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | 
| timedMetadataId3Frame | [HlsTimedMetadataId3Frame](#channels-channelid-channelclass-model-hlstimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 
| timestampDeltaMilliseconds | integerMinimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. | 
| tsFileMode | [HlsTsFileMode](#channels-channelid-channelclass-model-hlstsfilemode) | False | SEGMENTED\$1FILES: Emit the program as segments - multiple .ts media files. SINGLE\$1FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes \$1EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. | 

### HlsH265PackagingType
<a name="channels-channelid-channelclass-model-hlsh265packagingtype"></a>

Hls H265 Packaging Type
+ `HEV1`
+ `HVC1`

### HlsId3SegmentTaggingState
<a name="channels-channelid-channelclass-model-hlsid3segmenttaggingstate"></a>

State of HLS ID3 Segment Tagging
+ `DISABLED`
+ `ENABLED`

### HlsIncompleteSegmentBehavior
<a name="channels-channelid-channelclass-model-hlsincompletesegmentbehavior"></a>

Hls Incomplete Segment Behavior
+ `AUTO`
+ `SUPPRESS`

### HlsInputSettings
<a name="channels-channelid-channelclass-model-hlsinputsettings"></a>

Hls Input Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bandwidth | integerMinimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. | 
| bufferSegments | integerMinimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. | 
| retries | integerMinimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. | 
| retryInterval | integerMinimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. | 
| scte35Source | [HlsScte35SourceType](#channels-channelid-channelclass-model-hlsscte35sourcetype) | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. | 

### HlsIvInManifest
<a name="channels-channelid-channelclass-model-hlsivinmanifest"></a>

Hls Iv In Manifest
+ `EXCLUDE`
+ `INCLUDE`

### HlsIvSource
<a name="channels-channelid-channelclass-model-hlsivsource"></a>

Hls Iv Source
+ `EXPLICIT`
+ `FOLLOWS_SEGMENT_NUMBER`

### HlsManifestCompression
<a name="channels-channelid-channelclass-model-hlsmanifestcompression"></a>

Hls Manifest Compression
+ `GZIP`
+ `NONE`

### HlsManifestDurationFormat
<a name="channels-channelid-channelclass-model-hlsmanifestdurationformat"></a>

Hls Manifest Duration Format
+ `FLOATING_POINT`
+ `INTEGER`

### HlsMediaStoreSettings
<a name="channels-channelid-channelclass-model-hlsmediastoresettings"></a>

Hls Media Store Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| mediaStoreStorageClass | [HlsMediaStoreStorageClass](#channels-channelid-channelclass-model-hlsmediastorestorageclass) | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsMediaStoreStorageClass
<a name="channels-channelid-channelclass-model-hlsmediastorestorageclass"></a>

Hls Media Store Storage Class
+ `TEMPORAL`

### HlsMode
<a name="channels-channelid-channelclass-model-hlsmode"></a>

Hls Mode
+ `LIVE`
+ `VOD`

### HlsOutputSelection
<a name="channels-channelid-channelclass-model-hlsoutputselection"></a>

Hls Output Selection
+ `MANIFESTS_AND_SEGMENTS`
+ `SEGMENTS_ONLY`
+ `VARIANT_MANIFESTS_AND_SEGMENTS`

### HlsOutputSettings
<a name="channels-channelid-channelclass-model-hlsoutputsettings"></a>

Hls Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [HlsH265PackagingType](#channels-channelid-channelclass-model-hlsh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| hlsSettings | [HlsSettings](#channels-channelid-channelclass-model-hlssettings) | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | 
| nameModifier | stringMinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \$1"Format Identifiers\$1":\$1formatIdentifierParameters. | 
| segmentModifier | string | False | String concatenated to end of segment filenames. | 

### HlsProgramDateTime
<a name="channels-channelid-channelclass-model-hlsprogramdatetime"></a>

Hls Program Date Time
+ `EXCLUDE`
+ `INCLUDE`

### HlsProgramDateTimeClock
<a name="channels-channelid-channelclass-model-hlsprogramdatetimeclock"></a>

Hls Program Date Time Clock
+ `INITIALIZE_FROM_OUTPUT_TIMECODE`
+ `SYSTEM_CLOCK`

### HlsRedundantManifest
<a name="channels-channelid-channelclass-model-hlsredundantmanifest"></a>

Hls Redundant Manifest
+ `DISABLED`
+ `ENABLED`

### HlsS3LogUploads
<a name="channels-channelid-channelclass-model-hlss3loguploads"></a>

Hls S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### HlsS3Settings
<a name="channels-channelid-channelclass-model-hlss3settings"></a>

Hls S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-channelclass-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [HlsS3LogUploads](#channels-channelid-channelclass-model-hlss3loguploads) | False | When set to enabled, each fragment upload to CDN or server will be logged. | 

### HlsScte35SourceType
<a name="channels-channelid-channelclass-model-hlsscte35sourcetype"></a>

Hls Scte35 Source Type
+ `MANIFEST`
+ `SEGMENTS`

### HlsSegmentationMode
<a name="channels-channelid-channelclass-model-hlssegmentationmode"></a>

Hls Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### HlsSettings
<a name="channels-channelid-channelclass-model-hlssettings"></a>

Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioOnlyHlsSettings | [AudioOnlyHlsSettings](#channels-channelid-channelclass-model-audioonlyhlssettings) | False |  | 
| fmp4HlsSettings | [Fmp4HlsSettings](#channels-channelid-channelclass-model-fmp4hlssettings) | False |  | 
| frameCaptureHlsSettings | [FrameCaptureHlsSettings](#channels-channelid-channelclass-model-framecapturehlssettings) | False |  | 
| standardHlsSettings | [StandardHlsSettings](#channels-channelid-channelclass-model-standardhlssettings) | False |  | 

### HlsStreamInfResolution
<a name="channels-channelid-channelclass-model-hlsstreaminfresolution"></a>

Hls Stream Inf Resolution
+ `EXCLUDE`
+ `INCLUDE`

### HlsTimedMetadataId3Frame
<a name="channels-channelid-channelclass-model-hlstimedmetadataid3frame"></a>

Hls Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### HlsTsFileMode
<a name="channels-channelid-channelclass-model-hlstsfilemode"></a>

Hls Ts File Mode
+ `SEGMENTED_FILES`
+ `SINGLE_FILE`

### HlsWebdavHttpTransferMode
<a name="channels-channelid-channelclass-model-hlswebdavhttptransfermode"></a>

Hls Webdav Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsWebdavSettings
<a name="channels-channelid-channelclass-model-hlswebdavsettings"></a>

Hls Webdav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsWebdavHttpTransferMode](#channels-channelid-channelclass-model-hlswebdavhttptransfermode) | False | Specify whether or not to use chunked transfer encoding to WebDAV. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HtmlMotionGraphicsSettings
<a name="channels-channelid-channelclass-model-htmlmotiongraphicssettings"></a>

Html Motion Graphics Settings

### IFrameOnlyPlaylistType
<a name="channels-channelid-channelclass-model-iframeonlyplaylisttype"></a>

When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
+ `DISABLED`
+ `STANDARD`

### InputAttachment
<a name="channels-channelid-channelclass-model-inputattachment"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| automaticInputFailoverSettings | [AutomaticInputFailoverSettings](#channels-channelid-channelclass-model-automaticinputfailoversettings) | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | 
| inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. | 
| inputId | string | False | The ID of the input | 
| inputSettings | [InputSettings](#channels-channelid-channelclass-model-inputsettings) | False | Settings of an input (caption selector, etc.) | 

### InputChannelLevel
<a name="channels-channelid-channelclass-model-inputchannellevel"></a>

Input Channel Level


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| gain | integerMinimum: -60Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. | 
| inputChannel | integerMinimum: 0Maximum: 15 | True | The index of the input channel used as a source. | 

### InputCodec
<a name="channels-channelid-channelclass-model-inputcodec"></a>

codec in increasing order of complexity
+ `MPEG2`
+ `AVC`
+ `HEVC`

### InputDeblockFilter
<a name="channels-channelid-channelclass-model-inputdeblockfilter"></a>

Input Deblock Filter
+ `DISABLED`
+ `ENABLED`

### InputDenoiseFilter
<a name="channels-channelid-channelclass-model-inputdenoisefilter"></a>

Input Denoise Filter
+ `DISABLED`
+ `ENABLED`

### InputFilter
<a name="channels-channelid-channelclass-model-inputfilter"></a>

Input Filter
+ `AUTO`
+ `DISABLED`
+ `FORCED`

### InputLocation
<a name="channels-channelid-channelclass-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputLossActionForHlsOut
<a name="channels-channelid-channelclass-model-inputlossactionforhlsout"></a>

Input Loss Action For Hls Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForMsSmoothOut
<a name="channels-channelid-channelclass-model-inputlossactionformssmoothout"></a>

Input Loss Action For Ms Smooth Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForRtmpOut
<a name="channels-channelid-channelclass-model-inputlossactionforrtmpout"></a>

Input Loss Action For Rtmp Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForUdpOut
<a name="channels-channelid-channelclass-model-inputlossactionforudpout"></a>

Input Loss Action For Udp Out
+ `DROP_PROGRAM`
+ `DROP_TS`
+ `EMIT_PROGRAM`

### InputLossBehavior
<a name="channels-channelid-channelclass-model-inputlossbehavior"></a>

Input Loss Behavior


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 
| inputLossImageColor | stringMinLength: 6MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. | 
| inputLossImageSlate | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | 
| inputLossImageType | [InputLossImageType](#channels-channelid-channelclass-model-inputlossimagetype) | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | 
| repeatFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 

### InputLossFailoverSettings
<a name="channels-channelid-channelclass-model-inputlossfailoversettings"></a>

MediaLive will perform a failover if content is not detected in this input for the specified period.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossThresholdMsec | integerMinimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. | 

### InputLossImageType
<a name="channels-channelid-channelclass-model-inputlossimagetype"></a>

Input Loss Image Type
+ `COLOR`
+ `SLATE`

### InputMaximumBitrate
<a name="channels-channelid-channelclass-model-inputmaximumbitrate"></a>

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### InputPreference
<a name="channels-channelid-channelclass-model-inputpreference"></a>

Input preference when deciding which input to make active when a previously failed input has recovered. If \$1"EQUAL\$1INPUT\$1PREFERENCE\$1", then the active input will stay active as long as it is healthy. If \$1"PRIMARY\$1INPUT\$1PREFERRED\$1", then always switch back to the primary input when it is healthy. 
+ `EQUAL_INPUT_PREFERENCE`
+ `PRIMARY_INPUT_PREFERRED`

### InputResolution
<a name="channels-channelid-channelclass-model-inputresolution"></a>

Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `UHD`

### InputSettings
<a name="channels-channelid-channelclass-model-inputsettings"></a>

Live Event input parameters. There can be multiple inputs in a single Live Event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectors | Array of type [AudioSelector](#channels-channelid-channelclass-model-audioselector) | False | Used to select the audio stream to decode for inputs that have multiple available. | 
| captionSelectors | Array of type [CaptionSelector](#channels-channelid-channelclass-model-captionselector) | False | Used to select the caption input to use for inputs that have multiple available. | 
| deblockFilter | [InputDeblockFilter](#channels-channelid-channelclass-model-inputdeblockfilter) | False | Enable or disable the deblock filter when filtering. | 
| denoiseFilter | [InputDenoiseFilter](#channels-channelid-channelclass-model-inputdenoisefilter) | False | Enable or disable the denoise filter when filtering. | 
| filterStrength | integerMinimum: 1Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). | 
| inputFilter | [InputFilter](#channels-channelid-channelclass-model-inputfilter) | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | 
| networkInputSettings | [NetworkInputSettings](#channels-channelid-channelclass-model-networkinputsettings) | False | Input settings. | 
| smpte2038DataPreference | [Smpte2038DataPreference](#channels-channelid-channelclass-model-smpte2038datapreference) | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | 
| sourceEndBehavior | [InputSourceEndBehavior](#channels-channelid-channelclass-model-inputsourceendbehavior) | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | 
| videoSelector | [VideoSelector](#channels-channelid-channelclass-model-videoselector) | False | Informs which video elementary stream to decode for input types that have multiple available. | 

### InputSourceEndBehavior
<a name="channels-channelid-channelclass-model-inputsourceendbehavior"></a>

Input Source End Behavior
+ `CONTINUE`
+ `LOOP`

### InputSpecification
<a name="channels-channelid-channelclass-model-inputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codec | [InputCodec](#channels-channelid-channelclass-model-inputcodec) | False | Input codec | 
| maximumBitrate | [InputMaximumBitrate](#channels-channelid-channelclass-model-inputmaximumbitrate) | False | Maximum input bitrate, categorized coarsely | 
| resolution | [InputResolution](#channels-channelid-channelclass-model-inputresolution) | False | Input resolution, categorized coarsely | 

### InternalServiceError
<a name="channels-channelid-channelclass-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-channelid-channelclass-model-invalidrequest"></a>


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

### KeyProviderSettings
<a name="channels-channelid-channelclass-model-keyprovidersettings"></a>

Key Provider Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| staticKeySettings | [StaticKeySettings](#channels-channelid-channelclass-model-statickeysettings) | False |  | 

### LimitExceeded
<a name="channels-channelid-channelclass-model-limitexceeded"></a>


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

### LogLevel
<a name="channels-channelid-channelclass-model-loglevel"></a>

The log level the user wants for their channel.
+ `ERROR`
+ `WARNING`
+ `INFO`
+ `DEBUG`
+ `DISABLED`

### M2tsAbsentInputAudioBehavior
<a name="channels-channelid-channelclass-model-m2tsabsentinputaudiobehavior"></a>

M2ts Absent Input Audio Behavior
+ `DROP`
+ `ENCODE_SILENCE`

### M2tsArib
<a name="channels-channelid-channelclass-model-m2tsarib"></a>

M2ts Arib
+ `DISABLED`
+ `ENABLED`

### M2tsAribCaptionsPidControl
<a name="channels-channelid-channelclass-model-m2tsaribcaptionspidcontrol"></a>

M2ts Arib Captions Pid Control
+ `AUTO`
+ `USE_CONFIGURED`

### M2tsAudioBufferModel
<a name="channels-channelid-channelclass-model-m2tsaudiobuffermodel"></a>

M2ts Audio Buffer Model
+ `ATSC`
+ `DVB`

### M2tsAudioInterval
<a name="channels-channelid-channelclass-model-m2tsaudiointerval"></a>

M2ts Audio Interval
+ `VIDEO_AND_FIXED_INTERVALS`
+ `VIDEO_INTERVAL`

### M2tsAudioStreamType
<a name="channels-channelid-channelclass-model-m2tsaudiostreamtype"></a>

M2ts Audio Stream Type
+ `ATSC`
+ `DVB`

### M2tsBufferModel
<a name="channels-channelid-channelclass-model-m2tsbuffermodel"></a>

M2ts Buffer Model
+ `MULTIPLEX`
+ `NONE`

### M2tsCcDescriptor
<a name="channels-channelid-channelclass-model-m2tsccdescriptor"></a>

M2ts Cc Descriptor
+ `DISABLED`
+ `ENABLED`

### M2tsEbifControl
<a name="channels-channelid-channelclass-model-m2tsebifcontrol"></a>

M2ts Ebif Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsEbpPlacement
<a name="channels-channelid-channelclass-model-m2tsebpplacement"></a>

M2ts Ebp Placement
+ `VIDEO_AND_AUDIO_PIDS`
+ `VIDEO_PID`

### M2tsEsRateInPes
<a name="channels-channelid-channelclass-model-m2tsesrateinpes"></a>

M2ts Es Rate In Pes
+ `EXCLUDE`
+ `INCLUDE`

### M2tsKlv
<a name="channels-channelid-channelclass-model-m2tsklv"></a>

M2ts Klv
+ `NONE`
+ `PASSTHROUGH`

### M2tsNielsenId3Behavior
<a name="channels-channelid-channelclass-model-m2tsnielsenid3behavior"></a>

M2ts Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M2tsPcrControl
<a name="channels-channelid-channelclass-model-m2tspcrcontrol"></a>

M2ts Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M2tsRateMode
<a name="channels-channelid-channelclass-model-m2tsratemode"></a>

M2ts Rate Mode
+ `CBR`
+ `VBR`

### M2tsScte35Control
<a name="channels-channelid-channelclass-model-m2tsscte35control"></a>

M2ts Scte35 Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsSegmentationMarkers
<a name="channels-channelid-channelclass-model-m2tssegmentationmarkers"></a>

M2ts Segmentation Markers
+ `EBP`
+ `EBP_LEGACY`
+ `NONE`
+ `PSI_SEGSTART`
+ `RAI_ADAPT`
+ `RAI_SEGSTART`

### M2tsSegmentationStyle
<a name="channels-channelid-channelclass-model-m2tssegmentationstyle"></a>

M2ts Segmentation Style
+ `MAINTAIN_CADENCE`
+ `RESET_CADENCE`

### M2tsSettings
<a name="channels-channelid-channelclass-model-m2tssettings"></a>

M2ts Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| absentInputAudioBehavior | [M2tsAbsentInputAudioBehavior](#channels-channelid-channelclass-model-m2tsabsentinputaudiobehavior) | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | 
| arib | [M2tsArib](#channels-channelid-channelclass-model-m2tsarib) | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | 
| aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| aribCaptionsPidControl | [M2tsAribCaptionsPidControl](#channels-channelid-channelclass-model-m2tsaribcaptionspidcontrol) | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | 
| audioBufferModel | [M2tsAudioBufferModel](#channels-channelid-channelclass-model-m2tsaudiobuffermodel) | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | 
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| audioStreamType | [M2tsAudioStreamType](#channels-channelid-channelclass-model-m2tsaudiostreamtype) | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | 
| bitrate | integerMinimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. | 
| bufferModel | [M2tsBufferModel](#channels-channelid-channelclass-model-m2tsbuffermodel) | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | 
| ccDescriptor | [M2tsCcDescriptor](#channels-channelid-channelclass-model-m2tsccdescriptor) | False | When set to enabled, generates captionServiceDescriptor in PMT. | 
| dvbNitSettings | [DvbNitSettings](#channels-channelid-channelclass-model-dvbnitsettings) | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | 
| dvbSdtSettings | [DvbSdtSettings](#channels-channelid-channelclass-model-dvbsdtsettings) | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | 
| dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| dvbTdtSettings | [DvbTdtSettings](#channels-channelid-channelclass-model-dvbtdtsettings) | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | 
| dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| ebif | [M2tsEbifControl](#channels-channelid-channelclass-model-m2tsebifcontrol) | False | If set to passthrough, passes any EBIF data from the input source to this output. | 
| ebpAudioInterval | [M2tsAudioInterval](#channels-channelid-channelclass-model-m2tsaudiointerval) | False | When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | 
| ebpLookaheadMs | integerMinimum: 0Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. | 
| ebpPlacement | [M2tsEbpPlacement](#channels-channelid-channelclass-model-m2tsebpplacement) | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | 
| ecmPid | string | False | This field is unused and deprecated. | 
| esRateInPes | [M2tsEsRateInPes](#channels-channelid-channelclass-model-m2tsesrateinpes) | False | Include or exclude the ES Rate field in the PES header. | 
| etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| fragmentTime | numberMinimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. | 
| klv | [M2tsKlv](#channels-channelid-channelclass-model-m2tsklv) | False | If set to passthrough, passes any KLV data from the input source to this output. | 
| klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| nielsenId3Behavior | [M2tsNielsenId3Behavior](#channels-channelid-channelclass-model-m2tsnielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| nullPacketBitrate | numberMinimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pcrControl | [M2tsPcrControl](#channels-channelid-channelclass-model-m2tspcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| rateMode | [M2tsRateMode](#channels-channelid-channelclass-model-m2tsratemode) | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | 
| scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| scte35Control | [M2tsScte35Control](#channels-channelid-channelclass-model-m2tsscte35control) | False | Optionally pass SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| segmentationMarkers | [M2tsSegmentationMarkers](#channels-channelid-channelclass-model-m2tssegmentationmarkers) | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | 
| segmentationStyle | [M2tsSegmentationStyle](#channels-channelid-channelclass-model-m2tssegmentationstyle) | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of \$1segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of \$1segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | 
| segmentationTime | numberMinimum: 1 | False | The length in seconds of each segment. Required unless markers is set to \$1none\$1. | 
| timedMetadataBehavior | [M2tsTimedMetadataBehavior](#channels-channelid-channelclass-model-m2tstimedmetadatabehavior) | False | When set to passthrough, timed metadata will be passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 

### M2tsTimedMetadataBehavior
<a name="channels-channelid-channelclass-model-m2tstimedmetadatabehavior"></a>

M2ts Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8NielsenId3Behavior
<a name="channels-channelid-channelclass-model-m3u8nielsenid3behavior"></a>

M3u8 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8PcrControl
<a name="channels-channelid-channelclass-model-m3u8pcrcontrol"></a>

M3u8 Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M3u8Scte35Behavior
<a name="channels-channelid-channelclass-model-m3u8scte35behavior"></a>

M3u8 Scte35 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8Settings
<a name="channels-channelid-channelclass-model-m3u8settings"></a>

Settings information for the .m3u8 container


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. | 
| ecmPid | string | False | This parameter is unused and deprecated. | 
| nielsenId3Behavior | [M3u8NielsenId3Behavior](#channels-channelid-channelclass-model-m3u8nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pcrControl | [M3u8PcrControl](#channels-channelid-channelclass-model-m3u8pcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| scte35Behavior | [M3u8Scte35Behavior](#channels-channelid-channelclass-model-m3u8scte35behavior) | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| timedMetadataBehavior | [M3u8TimedMetadataBehavior](#channels-channelid-channelclass-model-m3u8timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 

### M3u8TimedMetadataBehavior
<a name="channels-channelid-channelclass-model-m3u8timedmetadatabehavior"></a>

M3u8 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### MaintenanceDay
<a name="channels-channelid-channelclass-model-maintenanceday"></a>

The currently selected maintenance day.
+ `MONDAY`
+ `TUESDAY`
+ `WEDNESDAY`
+ `THURSDAY`
+ `FRIDAY`
+ `SATURDAY`
+ `SUNDAY`

### MaintenanceStatus
<a name="channels-channelid-channelclass-model-maintenancestatus"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-channelid-channelclass-model-maintenanceday) | False | The currently selected maintenance day. | 
| maintenanceDeadline | stringFormat: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. | 
| maintenanceScheduledDate | stringFormat: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. | 
| maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. | 

### MediaPackageGroupSettings
<a name="channels-channelid-channelclass-model-mediapackagegroupsettings"></a>

Media Package Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | MediaPackage channel destination. | 

### MediaPackageOutputDestinationSettings
<a name="channels-channelid-channelclass-model-mediapackageoutputdestinationsettings"></a>

MediaPackage Output Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | stringMinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. | 

### MediaPackageOutputSettings
<a name="channels-channelid-channelclass-model-mediapackageoutputsettings"></a>

Media Package Output Settings

### MotionGraphicsConfiguration
<a name="channels-channelid-channelclass-model-motiongraphicsconfiguration"></a>

Motion Graphics Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| motionGraphicsInsertion | [MotionGraphicsInsertion](#channels-channelid-channelclass-model-motiongraphicsinsertion) | False |  | 
| motionGraphicsSettings | [MotionGraphicsSettings](#channels-channelid-channelclass-model-motiongraphicssettings) | True | Motion Graphics Settings | 

### MotionGraphicsInsertion
<a name="channels-channelid-channelclass-model-motiongraphicsinsertion"></a>

Motion Graphics Insertion
+ `DISABLED`
+ `ENABLED`

### MotionGraphicsSettings
<a name="channels-channelid-channelclass-model-motiongraphicssettings"></a>

Motion Graphics Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| htmlMotionGraphicsSettings | [HtmlMotionGraphicsSettings](#channels-channelid-channelclass-model-htmlmotiongraphicssettings) | False |  | 

### Mp2CodingMode
<a name="channels-channelid-channelclass-model-mp2codingmode"></a>

Mp2 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`

### Mp2Settings
<a name="channels-channelid-channelclass-model-mp2settings"></a>

Mp2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. | 
| codingMode | [Mp2CodingMode](#channels-channelid-channelclass-model-mp2codingmode) | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | 
| sampleRate | number | False | Sample rate in Hz. | 

### Mpeg2AdaptiveQuantization
<a name="channels-channelid-channelclass-model-mpeg2adaptivequantization"></a>

Mpeg2 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `LOW`
+ `MEDIUM`
+ `OFF`

### Mpeg2ColorMetadata
<a name="channels-channelid-channelclass-model-mpeg2colormetadata"></a>

Mpeg2 Color Metadata
+ `IGNORE`
+ `INSERT`

### Mpeg2ColorSpace
<a name="channels-channelid-channelclass-model-mpeg2colorspace"></a>

Mpeg2 Color Space
+ `AUTO`
+ `PASSTHROUGH`

### Mpeg2DisplayRatio
<a name="channels-channelid-channelclass-model-mpeg2displayratio"></a>

Mpeg2 Display Ratio
+ `DISPLAYRATIO16X9`
+ `DISPLAYRATIO4X3`

### Mpeg2FilterSettings
<a name="channels-channelid-channelclass-model-mpeg2filtersettings"></a>

Mpeg2 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-channelclass-model-temporalfiltersettings) | False |  | 

### Mpeg2GopSizeUnits
<a name="channels-channelid-channelclass-model-mpeg2gopsizeunits"></a>

Mpeg2 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### Mpeg2ScanType
<a name="channels-channelid-channelclass-model-mpeg2scantype"></a>

Mpeg2 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### Mpeg2Settings
<a name="channels-channelid-channelclass-model-mpeg2settings"></a>

Mpeg2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [Mpeg2AdaptiveQuantization](#channels-channelid-channelclass-model-mpeg2adaptivequantization) | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-channelclass-model-afdsignaling) | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | 
| colorMetadata | [Mpeg2ColorMetadata](#channels-channelid-channelclass-model-mpeg2colormetadata) | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | 
| colorSpace | [Mpeg2ColorSpace](#channels-channelid-channelclass-model-mpeg2colorspace) | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \$1"MediaLive Features - Video - color space\$1" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | 
| displayAspectRatio | [Mpeg2DisplayRatio](#channels-channelid-channelclass-model-mpeg2displayratio) | False | Sets the pixel aspect ratio for the encode. | 
| filterSettings | [Mpeg2FilterSettings](#channels-channelid-channelclass-model-mpeg2filtersettings) | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | 
| fixedAfd | [FixedAfd](#channels-channelid-channelclass-model-fixedafd) | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | 
| framerateDenominator | integerMinimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| framerateNumerator | integerMinimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| gopClosedCadence | integerMinimum: 0 | False | MPEG2: default is open GOP. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. | 
| gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. | 
| gopSizeUnits | [Mpeg2GopSizeUnits](#channels-channelid-channelclass-model-mpeg2gopsizeunits) | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | 
| scanType | [Mpeg2ScanType](#channels-channelid-channelclass-model-mpeg2scantype) | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | 
| subgopLength | [Mpeg2SubGopLength](#channels-channelid-channelclass-model-mpeg2subgoplength) | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | 
| timecodeInsertion | [Mpeg2TimecodeInsertionBehavior](#channels-channelid-channelclass-model-mpeg2timecodeinsertionbehavior) | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \$1"MediaLive Features - Timecode configuration\$1" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP\$1TIMECODE: Include timecode metadata in the GOP header. | 

### Mpeg2SubGopLength
<a name="channels-channelid-channelclass-model-mpeg2subgoplength"></a>

Mpeg2 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### Mpeg2TimecodeInsertionBehavior
<a name="channels-channelid-channelclass-model-mpeg2timecodeinsertionbehavior"></a>

Mpeg2 Timecode Insertion Behavior
+ `DISABLED`
+ `GOP_TIMECODE`

### MsSmoothGroupSettings
<a name="channels-channelid-channelclass-model-mssmoothgroupsettings"></a>

Ms Smooth Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. | 
| audioOnlyTimecodeControl | [SmoothGroupAudioOnlyTimecodeControl](#channels-channelid-channelclass-model-smoothgroupaudioonlytimecodecontrol) | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | 
| certificateMode | [SmoothGroupCertificateMode](#channels-channelid-channelclass-model-smoothgroupcertificatemode) | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. | 
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | 
| eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. | 
| eventIdMode | [SmoothGroupEventIdMode](#channels-channelid-channelclass-model-smoothgroupeventidmode) | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | 
| eventStopBehavior | [SmoothGroupEventStopBehavior](#channels-channelid-channelclass-model-smoothgroupeventstopbehavior) | False | When set to sendEos, send EOS signal to IIS server when stopping the event | 
| filecacheDuration | integerMinimum: 0 | False | Size in seconds of file cache for streaming outputs. | 
| fragmentLength | integerMinimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. | 
| inputLossAction | [InputLossActionForMsSmoothOut](#channels-channelid-channelclass-model-inputlossactionformssmoothout) | False | Parameter that control output group behavior on input loss. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 
| restartDelay | integerMinimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. | 
| segmentationMode | [SmoothGroupSegmentationMode](#channels-channelid-channelclass-model-smoothgroupsegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| sendDelayMs | integerMinimum: 0Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. | 
| sparseTrackType | [SmoothGroupSparseTrackType](#channels-channelid-channelclass-model-smoothgroupsparsetracktype) | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35\$1WITHOUT\$1SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | 
| streamManifestBehavior | [SmoothGroupStreamManifestBehavior](#channels-channelid-channelclass-model-smoothgroupstreammanifestbehavior) | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | 
| timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. | 
| timestampOffsetMode | [SmoothGroupTimestampOffsetMode](#channels-channelid-channelclass-model-smoothgrouptimestampoffsetmode) | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset | 

### MsSmoothH265PackagingType
<a name="channels-channelid-channelclass-model-mssmoothh265packagingtype"></a>

Ms Smooth H265 Packaging Type
+ `HEV1`
+ `HVC1`

### MsSmoothOutputSettings
<a name="channels-channelid-channelclass-model-mssmoothoutputsettings"></a>

Ms Smooth Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [MsSmoothH265PackagingType](#channels-channelid-channelclass-model-mssmoothh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### MultiplexGroupSettings
<a name="channels-channelid-channelclass-model-multiplexgroupsettings"></a>

Multiplex Group Settings

### MultiplexOutputSettings
<a name="channels-channelid-channelclass-model-multiplexoutputsettings"></a>

Multiplex Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | Destination is a Multiplex. | 

### MultiplexProgramChannelDestinationSettings
<a name="channels-channelid-channelclass-model-multiplexprogramchanneldestinationsettings"></a>

Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | stringMinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. | 
| programName | stringMinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. | 

### NetworkInputServerValidation
<a name="channels-channelid-channelclass-model-networkinputservervalidation"></a>

Network Input Server Validation
+ `CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME`
+ `CHECK_CRYPTOGRAPHY_ONLY`

### NetworkInputSettings
<a name="channels-channelid-channelclass-model-networkinputsettings"></a>

Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsInputSettings | [HlsInputSettings](#channels-channelid-channelclass-model-hlsinputsettings) | False | Specifies HLS input settings when the uri is for a HLS manifest. | 
| serverValidation | [NetworkInputServerValidation](#channels-channelid-channelclass-model-networkinputservervalidation) | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. | 

### NielsenCBET
<a name="channels-channelid-channelclass-model-nielsencbet"></a>

Nielsen CBET


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cbetCheckDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. | 
| cbetStepaside | [NielsenWatermarksCbetStepaside](#channels-channelid-channelclass-model-nielsenwatermarkscbetstepaside) | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | 
| csid | stringMinLength: 1MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark | 

### NielsenConfiguration
<a name="channels-channelid-channelclass-model-nielsenconfiguration"></a>

Nielsen Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. | 
| nielsenPcmToId3Tagging | [NielsenPcmToId3TaggingState](#channels-channelid-channelclass-model-nielsenpcmtoid3taggingstate) | False | Enables Nielsen PCM to ID3 tagging | 

### NielsenNaesIiNw
<a name="channels-channelid-channelclass-model-nielsennaesiinw"></a>

Nielsen Naes Ii Nw


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| checkDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the check digit string for the watermark | 
| sid | numberMinimum: 1Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark | 

### NielsenPcmToId3TaggingState
<a name="channels-channelid-channelclass-model-nielsenpcmtoid3taggingstate"></a>

State of Nielsen PCM to ID3 tagging
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksCbetStepaside
<a name="channels-channelid-channelclass-model-nielsenwatermarkscbetstepaside"></a>

Nielsen Watermarks Cbet Stepaside
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksDistributionTypes
<a name="channels-channelid-channelclass-model-nielsenwatermarksdistributiontypes"></a>

Nielsen Watermarks Distribution Types
+ `FINAL_DISTRIBUTOR`
+ `PROGRAM_CONTENT`

### NielsenWatermarksSettings
<a name="channels-channelid-channelclass-model-nielsenwatermarkssettings"></a>

Nielsen Watermarks Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenCbetSettings | [NielsenCBET](#channels-channelid-channelclass-model-nielsencbet) | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | 
| nielsenDistributionType | [NielsenWatermarksDistributionTypes](#channels-channelid-channelclass-model-nielsenwatermarksdistributiontypes) | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM\$1CONTENT - FINAL\$1DISTRIBUTOR | 
| nielsenNaesIiNwSettings | [NielsenNaesIiNw](#channels-channelid-channelclass-model-nielsennaesiinw) | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). | 

### Output
<a name="channels-channelid-channelclass-model-output"></a>

Output settings. There can be multiple outputs within a group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. | 
| captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. | 
| outputName | stringMinLength: 1MaxLength: 255 | False | The name used to identify an output. | 
| outputSettings | [OutputSettings](#channels-channelid-channelclass-model-outputsettings) | True | Output type-specific settings. | 
| videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. | 

### OutputDestination
<a name="channels-channelid-channelclass-model-outputdestination"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | User-specified id. This is used in an output group or an output. | 
| mediaPackageSettings | Array of type [MediaPackageOutputDestinationSettings](#channels-channelid-channelclass-model-mediapackageoutputdestinationsettings) | False | Destination settings for a MediaPackage output; one destination for both encoders. | 
| multiplexSettings | [MultiplexProgramChannelDestinationSettings](#channels-channelid-channelclass-model-multiplexprogramchanneldestinationsettings) | False | Destination settings for a Multiplex output; one destination for both encoders. | 
| settings | Array of type [OutputDestinationSettings](#channels-channelid-channelclass-model-outputdestinationsettings) | False | Destination settings for a standard output; one destination for each redundant encoder. | 

### OutputDestinationSettings
<a name="channels-channelid-channelclass-model-outputdestinationsettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) | 
| url | string | False | A URL specifying a destination | 
| username | string | False | username for destination | 

### OutputGroup
<a name="channels-channelid-channelclass-model-outputgroup"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. | 
| outputGroupSettings | [OutputGroupSettings](#channels-channelid-channelclass-model-outputgroupsettings) | True | Settings associated with the output group. | 
| outputs | Array of type [Output](#channels-channelid-channelclass-model-output) | True |  | 

### OutputGroupSettings
<a name="channels-channelid-channelclass-model-outputgroupsettings"></a>

Output Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveGroupSettings | [ArchiveGroupSettings](#channels-channelid-channelclass-model-archivegroupsettings) | False |  | 
| frameCaptureGroupSettings | [FrameCaptureGroupSettings](#channels-channelid-channelclass-model-framecapturegroupsettings) | False |  | 
| hlsGroupSettings | [HlsGroupSettings](#channels-channelid-channelclass-model-hlsgroupsettings) | False |  | 
| mediaPackageGroupSettings | [MediaPackageGroupSettings](#channels-channelid-channelclass-model-mediapackagegroupsettings) | False |  | 
| msSmoothGroupSettings | [MsSmoothGroupSettings](#channels-channelid-channelclass-model-mssmoothgroupsettings) | False |  | 
| multiplexGroupSettings | [MultiplexGroupSettings](#channels-channelid-channelclass-model-multiplexgroupsettings) | False |  | 
| rtmpGroupSettings | [RtmpGroupSettings](#channels-channelid-channelclass-model-rtmpgroupsettings) | False |  | 
| udpGroupSettings | [UdpGroupSettings](#channels-channelid-channelclass-model-udpgroupsettings) | False |  | 

### OutputLocationRef
<a name="channels-channelid-channelclass-model-outputlocationref"></a>

Reference to an OutputDestination ID defined in the channel


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

### OutputSettings
<a name="channels-channelid-channelclass-model-outputsettings"></a>

Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveOutputSettings | [ArchiveOutputSettings](#channels-channelid-channelclass-model-archiveoutputsettings) | False |  | 
| frameCaptureOutputSettings | [FrameCaptureOutputSettings](#channels-channelid-channelclass-model-framecaptureoutputsettings) | False |  | 
| hlsOutputSettings | [HlsOutputSettings](#channels-channelid-channelclass-model-hlsoutputsettings) | False |  | 
| mediaPackageOutputSettings | [MediaPackageOutputSettings](#channels-channelid-channelclass-model-mediapackageoutputsettings) | False |  | 
| msSmoothOutputSettings | [MsSmoothOutputSettings](#channels-channelid-channelclass-model-mssmoothoutputsettings) | False |  | 
| multiplexOutputSettings | [MultiplexOutputSettings](#channels-channelid-channelclass-model-multiplexoutputsettings) | False |  | 
| rtmpOutputSettings | [RtmpOutputSettings](#channels-channelid-channelclass-model-rtmpoutputsettings) | False |  | 
| udpOutputSettings | [UdpOutputSettings](#channels-channelid-channelclass-model-udpoutputsettings) | False |  | 

### PassThroughSettings
<a name="channels-channelid-channelclass-model-passthroughsettings"></a>

Pass Through Settings

### PipelineDetail
<a name="channels-channelid-channelclass-model-pipelinedetail"></a>

Runtime details of a pipeline when a channel is running.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. | 
| activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. | 
| activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. | 
| activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. | 
| pipelineId | string | False | Pipeline ID | 

### RawSettings
<a name="channels-channelid-channelclass-model-rawsettings"></a>

Raw Settings

### Rec601Settings
<a name="channels-channelid-channelclass-model-rec601settings"></a>

Rec601 Settings

### Rec709Settings
<a name="channels-channelid-channelclass-model-rec709settings"></a>

Rec709 Settings

### RemixSettings
<a name="channels-channelid-channelclass-model-remixsettings"></a>

Remix Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelMappings | Array of type [AudioChannelMapping](#channels-channelid-channelclass-model-audiochannelmapping) | True | Mapping of input channels to output channels, with appropriate gain adjustments. | 
| channelsIn | integerMinimum: 1Maximum: 16 | False | Number of input channels to be used. | 
| channelsOut | integerMinimum: 1Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 | 

### ResourceConflict
<a name="channels-channelid-channelclass-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="channels-channelid-channelclass-model-resourcenotfound"></a>


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

### RtmpAdMarkers
<a name="channels-channelid-channelclass-model-rtmpadmarkers"></a>

Rtmp Ad Markers
+ `ON_CUE_POINT_SCTE35`

### RtmpCacheFullBehavior
<a name="channels-channelid-channelclass-model-rtmpcachefullbehavior"></a>

Rtmp Cache Full Behavior
+ `DISCONNECT_IMMEDIATELY`
+ `WAIT_FOR_SERVER`

### RtmpCaptionData
<a name="channels-channelid-channelclass-model-rtmpcaptiondata"></a>

Rtmp Caption Data
+ `ALL`
+ `FIELD1_608`
+ `FIELD1_AND_FIELD2_608`

### RtmpCaptionInfoDestinationSettings
<a name="channels-channelid-channelclass-model-rtmpcaptioninfodestinationsettings"></a>

Rtmp Caption Info Destination Settings

### RtmpGroupSettings
<a name="channels-channelid-channelclass-model-rtmpgroupsettings"></a>

Rtmp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [RtmpAdMarkers](#channels-channelid-channelclass-model-rtmpadmarkers) | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. | 
| authenticationScheme | [AuthenticationScheme](#channels-channelid-channelclass-model-authenticationscheme) | False | Authentication scheme to use when connecting with CDN | 
| cacheFullBehavior | [RtmpCacheFullBehavior](#channels-channelid-channelclass-model-rtmpcachefullbehavior) | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | 
| cacheLength | integerMinimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. | 
| captionData | [RtmpCaptionData](#channels-channelid-channelclass-model-rtmpcaptiondata) | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | 
| inputLossAction | [InputLossActionForRtmpOut](#channels-channelid-channelclass-model-inputlossactionforrtmpout) | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | 
| restartDelay | integerMinimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### RtmpOutputCertificateMode
<a name="channels-channelid-channelclass-model-rtmpoutputcertificatemode"></a>

Rtmp Output Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### RtmpOutputSettings
<a name="channels-channelid-channelclass-model-rtmpoutputsettings"></a>

Rtmp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| certificateMode | [RtmpOutputCertificateMode](#channels-channelid-channelclass-model-rtmpoutputcertificatemode) | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. | 
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 

### S3CannedAcl
<a name="channels-channelid-channelclass-model-s3cannedacl"></a>

S3 Canned Acl
+ `AUTHENTICATED_READ`
+ `BUCKET_OWNER_FULL_CONTROL`
+ `BUCKET_OWNER_READ`
+ `PUBLIC_READ`

### Scte20Convert608To708
<a name="channels-channelid-channelclass-model-scte20convert608to708"></a>

Scte20 Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### Scte20PlusEmbeddedDestinationSettings
<a name="channels-channelid-channelclass-model-scte20plusembeddeddestinationsettings"></a>

Scte20 Plus Embedded Destination Settings

### Scte20SourceSettings
<a name="channels-channelid-channelclass-model-scte20sourcesettings"></a>

Scte20 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [Scte20Convert608To708](#channels-channelid-channelclass-model-scte20convert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 

### Scte27DestinationSettings
<a name="channels-channelid-channelclass-model-scte27destinationsettings"></a>

Scte27 Destination Settings

### Scte27OcrLanguage
<a name="channels-channelid-channelclass-model-scte27ocrlanguage"></a>

Scte27 Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### Scte27SourceSettings
<a name="channels-channelid-channelclass-model-scte27sourcesettings"></a>

Scte27 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [Scte27OcrLanguage](#channels-channelid-channelclass-model-scte27ocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. | 

### Scte35AposNoRegionalBlackoutBehavior
<a name="channels-channelid-channelclass-model-scte35aposnoregionalblackoutbehavior"></a>

Scte35 Apos No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35AposWebDeliveryAllowedBehavior
<a name="channels-channelid-channelclass-model-scte35aposwebdeliveryallowedbehavior"></a>

Scte35 Apos Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsert
<a name="channels-channelid-channelclass-model-scte35spliceinsert"></a>

Scte35 Splice Insert


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35SpliceInsertNoRegionalBlackoutBehavior](#channels-channelid-channelclass-model-scte35spliceinsertnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35SpliceInsertWebDeliveryAllowedBehavior](#channels-channelid-channelclass-model-scte35spliceinsertwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### Scte35SpliceInsertNoRegionalBlackoutBehavior
<a name="channels-channelid-channelclass-model-scte35spliceinsertnoregionalblackoutbehavior"></a>

Scte35 Splice Insert No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsertWebDeliveryAllowedBehavior
<a name="channels-channelid-channelclass-model-scte35spliceinsertwebdeliveryallowedbehavior"></a>

Scte35 Splice Insert Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35TimeSignalApos
<a name="channels-channelid-channelclass-model-scte35timesignalapos"></a>

Scte35 Time Signal Apos


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35AposNoRegionalBlackoutBehavior](#channels-channelid-channelclass-model-scte35aposnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35AposWebDeliveryAllowedBehavior](#channels-channelid-channelclass-model-scte35aposwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### SmoothGroupAudioOnlyTimecodeControl
<a name="channels-channelid-channelclass-model-smoothgroupaudioonlytimecodecontrol"></a>

Smooth Group Audio Only Timecode Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED_CLOCK`

### SmoothGroupCertificateMode
<a name="channels-channelid-channelclass-model-smoothgroupcertificatemode"></a>

Smooth Group Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### SmoothGroupEventIdMode
<a name="channels-channelid-channelclass-model-smoothgroupeventidmode"></a>

Smooth Group Event Id Mode
+ `NO_EVENT_ID`
+ `USE_CONFIGURED`
+ `USE_TIMESTAMP`

### SmoothGroupEventStopBehavior
<a name="channels-channelid-channelclass-model-smoothgroupeventstopbehavior"></a>

Smooth Group Event Stop Behavior
+ `NONE`
+ `SEND_EOS`

### SmoothGroupSegmentationMode
<a name="channels-channelid-channelclass-model-smoothgroupsegmentationmode"></a>

Smooth Group Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### SmoothGroupSparseTrackType
<a name="channels-channelid-channelclass-model-smoothgroupsparsetracktype"></a>

Smooth Group Sparse Track Type
+ `NONE`
+ `SCTE_35`
+ `SCTE_35_WITHOUT_SEGMENTATION`

### SmoothGroupStreamManifestBehavior
<a name="channels-channelid-channelclass-model-smoothgroupstreammanifestbehavior"></a>

Smooth Group Stream Manifest Behavior
+ `DO_NOT_SEND`
+ `SEND`

### SmoothGroupTimestampOffsetMode
<a name="channels-channelid-channelclass-model-smoothgrouptimestampoffsetmode"></a>

Smooth Group Timestamp Offset Mode
+ `USE_CONFIGURED_OFFSET`
+ `USE_EVENT_START_DATE`

### Smpte2038DataPreference
<a name="channels-channelid-channelclass-model-smpte2038datapreference"></a>

Smpte2038 Data Preference
+ `IGNORE`
+ `PREFER`

### SmpteTtDestinationSettings
<a name="channels-channelid-channelclass-model-smptettdestinationsettings"></a>

Smpte Tt Destination Settings

### StandardHlsSettings
<a name="channels-channelid-channelclass-model-standardhlssettings"></a>

Standard Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| m3u8Settings | [M3u8Settings](#channels-channelid-channelclass-model-m3u8settings) | True |  | 

### StaticKeySettings
<a name="channels-channelid-channelclass-model-statickeysettings"></a>

Static Key Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| keyProviderServer | [InputLocation](#channels-channelid-channelclass-model-inputlocation) | False | The URL of the license server used for protecting content. | 
| staticKeyValue | stringMinLength: 32MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. | 

### Tags
<a name="channels-channelid-channelclass-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TeletextDestinationSettings
<a name="channels-channelid-channelclass-model-teletextdestinationsettings"></a>

Teletext Destination Settings

### TeletextSourceSettings
<a name="channels-channelid-channelclass-model-teletextsourcesettings"></a>

Teletext Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputRectangle | [CaptionRectangle](#channels-channelid-channelclass-model-captionrectangle) | False | Optionally defines a region where TTML style captions will be displayed | 
| pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. | 

### TemporalFilterPostFilterSharpening
<a name="channels-channelid-channelclass-model-temporalfilterpostfiltersharpening"></a>

Temporal Filter Post Filter Sharpening
+ `AUTO`
+ `DISABLED`
+ `ENABLED`

### TemporalFilterSettings
<a name="channels-channelid-channelclass-model-temporalfiltersettings"></a>

Temporal Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| postFilterSharpening | [TemporalFilterPostFilterSharpening](#channels-channelid-channelclass-model-temporalfilterpostfiltersharpening) | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | 
| strength | [TemporalFilterStrength](#channels-channelid-channelclass-model-temporalfilterstrength) | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. | 

### TemporalFilterStrength
<a name="channels-channelid-channelclass-model-temporalfilterstrength"></a>

Temporal Filter Strength
+ `AUTO`
+ `STRENGTH_1`
+ `STRENGTH_2`
+ `STRENGTH_3`
+ `STRENGTH_4`
+ `STRENGTH_5`
+ `STRENGTH_6`
+ `STRENGTH_7`
+ `STRENGTH_8`
+ `STRENGTH_9`
+ `STRENGTH_10`
+ `STRENGTH_11`
+ `STRENGTH_12`
+ `STRENGTH_13`
+ `STRENGTH_14`
+ `STRENGTH_15`
+ `STRENGTH_16`

### TimecodeConfig
<a name="channels-channelid-channelclass-model-timecodeconfig"></a>

Timecode Config


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| source | [TimecodeConfigSource](#channels-channelid-channelclass-model-timecodeconfigsource) | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | 
| syncThreshold | integerMinimum: 1Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. | 

### TimecodeConfigSource
<a name="channels-channelid-channelclass-model-timecodeconfigsource"></a>

Timecode Config Source
+ `EMBEDDED`
+ `SYSTEMCLOCK`
+ `ZEROBASED`

### TtmlDestinationSettings
<a name="channels-channelid-channelclass-model-ttmldestinationsettings"></a>

Ttml Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [TtmlDestinationStyleControl](#channels-channelid-channelclass-model-ttmldestinationstylecontrol) | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. | 

### TtmlDestinationStyleControl
<a name="channels-channelid-channelclass-model-ttmldestinationstylecontrol"></a>

Ttml Destination Style Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED`

### UdpContainerSettings
<a name="channels-channelid-channelclass-model-udpcontainersettings"></a>

Udp Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-channelclass-model-m2tssettings) | False |  | 

### UdpGroupSettings
<a name="channels-channelid-channelclass-model-udpgroupsettings"></a>

Udp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossAction | [InputLossActionForUdpOut](#channels-channelid-channelclass-model-inputlossactionforudpout) | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | 
| timedMetadataId3Frame | [UdpTimedMetadataId3Frame](#channels-channelid-channelclass-model-udptimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 

### UdpOutputSettings
<a name="channels-channelid-channelclass-model-udpoutputsettings"></a>

Udp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bufferMsec | integerMinimum: 0Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. | 
| containerSettings | [UdpContainerSettings](#channels-channelid-channelclass-model-udpcontainersettings) | True |  | 
| destination | [OutputLocationRef](#channels-channelid-channelclass-model-outputlocationref) | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | 
| fecOutputSettings | [FecOutputSettings](#channels-channelid-channelclass-model-fecoutputsettings) | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. | 

### UdpTimedMetadataId3Frame
<a name="channels-channelid-channelclass-model-udptimedmetadataid3frame"></a>

Udp Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### UpdateChannelClass
<a name="channels-channelid-channelclass-model-updatechannelclass"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#channels-channelid-channelclass-model-channelclass) | True | The channel class that you wish to update this channel to use. | 
| destinations | Array of type [OutputDestination](#channels-channelid-channelclass-model-outputdestination) | False | A list of output destinations for this channel. | 

### UpdateChannelResultModel
<a name="channels-channelid-channelclass-model-updatechannelresultmodel"></a>

The updated channel's description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channel | [Channel](#channels-channelid-channelclass-model-channel) | False |  | 

### ValidationError
<a name="channels-channelid-channelclass-model-validationerror"></a>


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

### VideoBlackFailoverSettings
<a name="channels-channelid-channelclass-model-videoblackfailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackDetectThreshold | numberMinimum: 0Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\$10.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\$10.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. | 
| videoBlackThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. | 

### VideoCodecSettings
<a name="channels-channelid-channelclass-model-videocodecsettings"></a>

Video Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureSettings | [FrameCaptureSettings](#channels-channelid-channelclass-model-framecapturesettings) | False |  | 
| h264Settings | [H264Settings](#channels-channelid-channelclass-model-h264settings) | False |  | 
| h265Settings | [H265Settings](#channels-channelid-channelclass-model-h265settings) | False |  | 
| mpeg2Settings | [Mpeg2Settings](#channels-channelid-channelclass-model-mpeg2settings) | False |  | 

### VideoDescription
<a name="channels-channelid-channelclass-model-videodescription"></a>

Video settings for this stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codecSettings | [VideoCodecSettings](#channels-channelid-channelclass-model-videocodecsettings) | False | Video codec settings. | 
| height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 
| name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. | 
| respondToAfd | [VideoDescriptionRespondToAfd](#channels-channelid-channelclass-model-videodescriptionrespondtoafd) | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME\$1CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | 
| scalingBehavior | [VideoDescriptionScalingBehavior](#channels-channelid-channelclass-model-videodescriptionscalingbehavior) | False | STRETCH\$1TO\$1OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | 
| sharpness | integerMinimum: 0Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. | 
| width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 

### VideoDescriptionRespondToAfd
<a name="channels-channelid-channelclass-model-videodescriptionrespondtoafd"></a>

Video Description Respond To Afd
+ `NONE`
+ `PASSTHROUGH`
+ `RESPOND`

### VideoDescriptionScalingBehavior
<a name="channels-channelid-channelclass-model-videodescriptionscalingbehavior"></a>

Video Description Scaling Behavior
+ `DEFAULT`
+ `STRETCH_TO_OUTPUT`

### VideoSelector
<a name="channels-channelid-channelclass-model-videoselector"></a>

Specifies a particular video stream within an input source. An input may have only a single video selector.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpace | [VideoSelectorColorSpace](#channels-channelid-channelclass-model-videoselectorcolorspace) | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | 
| colorSpaceSettings | [VideoSelectorColorSpaceSettings](#channels-channelid-channelclass-model-videoselectorcolorspacesettings) | False | Color space settings | 
| colorSpaceUsage | [VideoSelectorColorSpaceUsage](#channels-channelid-channelclass-model-videoselectorcolorspaceusage) | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | 
| selectorSettings | [VideoSelectorSettings](#channels-channelid-channelclass-model-videoselectorsettings) | False | The video selector settings. | 

### VideoSelectorColorSpace
<a name="channels-channelid-channelclass-model-videoselectorcolorspace"></a>

Video Selector Color Space
+ `FOLLOW`
+ `HDR10`
+ `HLG_2020`
+ `REC_601`
+ `REC_709`

### VideoSelectorColorSpaceSettings
<a name="channels-channelid-channelclass-model-videoselectorcolorspacesettings"></a>

Video Selector Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hdr10Settings | [Hdr10Settings](#channels-channelid-channelclass-model-hdr10settings) | False |  | 

### VideoSelectorColorSpaceUsage
<a name="channels-channelid-channelclass-model-videoselectorcolorspaceusage"></a>

Video Selector Color Space Usage
+ `FALLBACK`
+ `FORCE`

### VideoSelectorPid
<a name="channels-channelid-channelclass-model-videoselectorpid"></a>

Video Selector Pid


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | False | Selects a specific PID from within a video source. | 

### VideoSelectorProgramId
<a name="channels-channelid-channelclass-model-videoselectorprogramid"></a>

Video Selector Program Id


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| programId | integerMinimum: 0Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. | 

### VideoSelectorSettings
<a name="channels-channelid-channelclass-model-videoselectorsettings"></a>

Video Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| videoSelectorPid | [VideoSelectorPid](#channels-channelid-channelclass-model-videoselectorpid) | False |  | 
| videoSelectorProgramId | [VideoSelectorProgramId](#channels-channelid-channelclass-model-videoselectorprogramid) | False |  | 

### VpcOutputSettingsDescription
<a name="channels-channelid-channelclass-model-vpcoutputsettingsdescription"></a>

The properties for a private VPC Output 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet.  | 
| networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC  | 
| securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.  | 
| subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### WavCodingMode
<a name="channels-channelid-channelclass-model-wavcodingmode"></a>

Wav Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_4_0`
+ `CODING_MODE_8_0`

### WavSettings
<a name="channels-channelid-channelclass-model-wavsettings"></a>

Wav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitDepth | number | False | Bits per sample. | 
| codingMode | [WavCodingMode](#channels-channelid-channelclass-model-wavcodingmode) | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | 
| sampleRate | number | False | Sample rate in Hz. | 

### WebvttDestinationSettings
<a name="channels-channelid-channelclass-model-webvttdestinationsettings"></a>

Webvtt Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [WebvttDestinationStyleControl](#channels-channelid-channelclass-model-webvttdestinationstylecontrol) | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\$1STYLE\$1DATA - Don't pass through the style. The output captions will not contain any font styling information. | 

### WebvttDestinationStyleControl
<a name="channels-channelid-channelclass-model-webvttdestinationstylecontrol"></a>

Webvtt Destination Style Control
+ `NO_STYLE_DATA`
+ `PASSTHROUGH`

## See also
<a name="channels-channelid-channelclass-see-also"></a>

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

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

# Channels: schedule
<a name="channels-channelid-schedule"></a>

## URI
<a name="channels-channelid-schedule-url"></a>

`/prod/channels/channelId/schedule`

## HTTP methods
<a name="channels-channelid-schedule-http-methods"></a>

### DELETE
<a name="channels-channelid-scheduledelete"></a>

**Operation ID:** `DeleteSchedule`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

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

### GET
<a name="channels-channelid-scheduleget"></a>

**Operation ID:** `DescribeSchedule`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ScheduleDescribeResultModel | 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="channels-channelid-scheduleput"></a>

**Operation ID:** `BatchUpdateSchedule`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | BatchUpdateScheduleResult | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 422 | ChannelConfigurationValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="channels-channelid-schedule-schemas"></a>

### Request bodies
<a name="channels-channelid-schedule-request-examples"></a>

#### PUT schema
<a name="channels-channelid-schedule-request-body-put-example"></a>

```
{
  "creates": {
    "scheduleActions": [
      {
        "actionName": "string",
        "scheduleActionSettings": {
          "hlsId3SegmentTaggingSettings": {
            "tag": "string"
          },
          "hlsTimedMetadataSettings": {
            "id3": "string"
          },
          "inputPrepareSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "inputSwitchSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "motionGraphicsImageActivateSettings": {
            "duration": integer,
            "passwordParam": "string",
            "url": "string",
            "username": "string"
          },
          "motionGraphicsImageDeactivateSettings": {
          },
          "pauseStateSettings": {
            "pipelines": [
              {
                "pipelineId": enum
              }
            ]
          },
          "scte35ReturnToNetworkSettings": {
            "spliceEventId": integer
          },
          "scte35SpliceInsertSettings": {
            "duration": integer,
            "spliceEventId": integer
          },
          "scte35TimeSignalSettings": {
            "scte35Descriptors": [
              {
                "scte35DescriptorSettings": {
                  "segmentationDescriptorScte35DescriptorSettings": {
                    "deliveryRestrictions": {
                      "archiveAllowedFlag": enum,
                      "deviceRestrictions": enum,
                      "noRegionalBlackoutFlag": enum,
                      "webDeliveryAllowedFlag": enum
                    },
                    "segmentNum": integer,
                    "segmentationCancelIndicator": enum,
                    "segmentationDuration": integer,
                    "segmentationEventId": integer,
                    "segmentationTypeId": integer,
                    "segmentationUpid": "string",
                    "segmentationUpidType": integer,
                    "segmentsExpected": integer,
                    "subSegmentNum": integer,
                    "subSegmentsExpected": integer
                  }
                }
              }
            ]
          },
          "staticImageActivateSettings": {
            "duration": integer,
            "fadeIn": integer,
            "fadeOut": integer,
            "height": integer,
            "image": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "imageX": integer,
            "imageY": integer,
            "layer": integer,
            "opacity": integer,
            "width": integer
          },
          "staticImageDeactivateSettings": {
            "fadeOut": integer,
            "layer": integer
          }
        },
        "scheduleActionStartSettings": {
          "fixedModeScheduleActionStartSettings": {
            "time": "string"
          },
          "followModeScheduleActionStartSettings": {
            "followPoint": enum,
            "referenceActionName": "string"
          },
          "immediateModeScheduleActionStartSettings": {
            "time": "string"
          }
        }
      }
    ]
  },
  "deletes": {
    "actionNames": [
      "string"
    ]
  }
}
```

### Response bodies
<a name="channels-channelid-schedule-response-examples"></a>

#### ScheduleDeleteResultModel schema
<a name="channels-channelid-schedule-response-body-scheduledeleteresultmodel-example"></a>

```
{
}
```

#### ScheduleDescribeResultModel schema
<a name="channels-channelid-schedule-response-body-scheduledescriberesultmodel-example"></a>

```
{
  "nextToken": "string",
  "scheduleActions": [
    {
      "actionName": "string",
      "scheduleActionSettings": {
        "hlsId3SegmentTaggingSettings": {
          "tag": "string"
        },
        "hlsTimedMetadataSettings": {
          "id3": "string"
        },
        "inputPrepareSettings": {
          "inputAttachmentNameReference": "string",
          "inputClippingSettings": {
            "inputTimecodeSource": enum,
            "startTimecode": {
              "timecode": "string"
            },
            "stopTimecode": {
              "lastFrameClippingBehavior": enum,
              "timecode": "string"
            }
          },
          "urlPath": [
            "string"
          ]
        },
        "inputSwitchSettings": {
          "inputAttachmentNameReference": "string",
          "inputClippingSettings": {
            "inputTimecodeSource": enum,
            "startTimecode": {
              "timecode": "string"
            },
            "stopTimecode": {
              "lastFrameClippingBehavior": enum,
              "timecode": "string"
            }
          },
          "urlPath": [
            "string"
          ]
        },
        "motionGraphicsImageActivateSettings": {
          "duration": integer,
          "passwordParam": "string",
          "url": "string",
          "username": "string"
        },
        "motionGraphicsImageDeactivateSettings": {
        },
        "pauseStateSettings": {
          "pipelines": [
            {
              "pipelineId": enum
            }
          ]
        },
        "scte35ReturnToNetworkSettings": {
          "spliceEventId": integer
        },
        "scte35SpliceInsertSettings": {
          "duration": integer,
          "spliceEventId": integer
        },
        "scte35TimeSignalSettings": {
          "scte35Descriptors": [
            {
              "scte35DescriptorSettings": {
                "segmentationDescriptorScte35DescriptorSettings": {
                  "deliveryRestrictions": {
                    "archiveAllowedFlag": enum,
                    "deviceRestrictions": enum,
                    "noRegionalBlackoutFlag": enum,
                    "webDeliveryAllowedFlag": enum
                  },
                  "segmentNum": integer,
                  "segmentationCancelIndicator": enum,
                  "segmentationDuration": integer,
                  "segmentationEventId": integer,
                  "segmentationTypeId": integer,
                  "segmentationUpid": "string",
                  "segmentationUpidType": integer,
                  "segmentsExpected": integer,
                  "subSegmentNum": integer,
                  "subSegmentsExpected": integer
                }
              }
            }
          ]
        },
        "staticImageActivateSettings": {
          "duration": integer,
          "fadeIn": integer,
          "fadeOut": integer,
          "height": integer,
          "image": {
            "passwordParam": "string",
            "uri": "string",
            "username": "string"
          },
          "imageX": integer,
          "imageY": integer,
          "layer": integer,
          "opacity": integer,
          "width": integer
        },
        "staticImageDeactivateSettings": {
          "fadeOut": integer,
          "layer": integer
        }
      },
      "scheduleActionStartSettings": {
        "fixedModeScheduleActionStartSettings": {
          "time": "string"
        },
        "followModeScheduleActionStartSettings": {
          "followPoint": enum,
          "referenceActionName": "string"
        },
        "immediateModeScheduleActionStartSettings": {
          "time": "string"
        }
      }
    }
  ]
}
```

#### BatchUpdateScheduleResult schema
<a name="channels-channelid-schedule-response-body-batchupdatescheduleresult-example"></a>

```
{
  "creates": {
    "scheduleActions": [
      {
        "actionName": "string",
        "scheduleActionSettings": {
          "hlsId3SegmentTaggingSettings": {
            "tag": "string"
          },
          "hlsTimedMetadataSettings": {
            "id3": "string"
          },
          "inputPrepareSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "inputSwitchSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "motionGraphicsImageActivateSettings": {
            "duration": integer,
            "passwordParam": "string",
            "url": "string",
            "username": "string"
          },
          "motionGraphicsImageDeactivateSettings": {
          },
          "pauseStateSettings": {
            "pipelines": [
              {
                "pipelineId": enum
              }
            ]
          },
          "scte35ReturnToNetworkSettings": {
            "spliceEventId": integer
          },
          "scte35SpliceInsertSettings": {
            "duration": integer,
            "spliceEventId": integer
          },
          "scte35TimeSignalSettings": {
            "scte35Descriptors": [
              {
                "scte35DescriptorSettings": {
                  "segmentationDescriptorScte35DescriptorSettings": {
                    "deliveryRestrictions": {
                      "archiveAllowedFlag": enum,
                      "deviceRestrictions": enum,
                      "noRegionalBlackoutFlag": enum,
                      "webDeliveryAllowedFlag": enum
                    },
                    "segmentNum": integer,
                    "segmentationCancelIndicator": enum,
                    "segmentationDuration": integer,
                    "segmentationEventId": integer,
                    "segmentationTypeId": integer,
                    "segmentationUpid": "string",
                    "segmentationUpidType": integer,
                    "segmentsExpected": integer,
                    "subSegmentNum": integer,
                    "subSegmentsExpected": integer
                  }
                }
              }
            ]
          },
          "staticImageActivateSettings": {
            "duration": integer,
            "fadeIn": integer,
            "fadeOut": integer,
            "height": integer,
            "image": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "imageX": integer,
            "imageY": integer,
            "layer": integer,
            "opacity": integer,
            "width": integer
          },
          "staticImageDeactivateSettings": {
            "fadeOut": integer,
            "layer": integer
          }
        },
        "scheduleActionStartSettings": {
          "fixedModeScheduleActionStartSettings": {
            "time": "string"
          },
          "followModeScheduleActionStartSettings": {
            "followPoint": enum,
            "referenceActionName": "string"
          },
          "immediateModeScheduleActionStartSettings": {
            "time": "string"
          }
        }
      }
    ]
  },
  "deletes": {
    "scheduleActions": [
      {
        "actionName": "string",
        "scheduleActionSettings": {
          "hlsId3SegmentTaggingSettings": {
            "tag": "string"
          },
          "hlsTimedMetadataSettings": {
            "id3": "string"
          },
          "inputPrepareSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "inputSwitchSettings": {
            "inputAttachmentNameReference": "string",
            "inputClippingSettings": {
              "inputTimecodeSource": enum,
              "startTimecode": {
                "timecode": "string"
              },
              "stopTimecode": {
                "lastFrameClippingBehavior": enum,
                "timecode": "string"
              }
            },
            "urlPath": [
              "string"
            ]
          },
          "motionGraphicsImageActivateSettings": {
            "duration": integer,
            "passwordParam": "string",
            "url": "string",
            "username": "string"
          },
          "motionGraphicsImageDeactivateSettings": {
          },
          "pauseStateSettings": {
            "pipelines": [
              {
                "pipelineId": enum
              }
            ]
          },
          "scte35ReturnToNetworkSettings": {
            "spliceEventId": integer
          },
          "scte35SpliceInsertSettings": {
            "duration": integer,
            "spliceEventId": integer
          },
          "scte35TimeSignalSettings": {
            "scte35Descriptors": [
              {
                "scte35DescriptorSettings": {
                  "segmentationDescriptorScte35DescriptorSettings": {
                    "deliveryRestrictions": {
                      "archiveAllowedFlag": enum,
                      "deviceRestrictions": enum,
                      "noRegionalBlackoutFlag": enum,
                      "webDeliveryAllowedFlag": enum
                    },
                    "segmentNum": integer,
                    "segmentationCancelIndicator": enum,
                    "segmentationDuration": integer,
                    "segmentationEventId": integer,
                    "segmentationTypeId": integer,
                    "segmentationUpid": "string",
                    "segmentationUpidType": integer,
                    "segmentsExpected": integer,
                    "subSegmentNum": integer,
                    "subSegmentsExpected": integer
                  }
                }
              }
            ]
          },
          "staticImageActivateSettings": {
            "duration": integer,
            "fadeIn": integer,
            "fadeOut": integer,
            "height": integer,
            "image": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "imageX": integer,
            "imageY": integer,
            "layer": integer,
            "opacity": integer,
            "width": integer
          },
          "staticImageDeactivateSettings": {
            "fadeOut": integer,
            "layer": integer
          }
        },
        "scheduleActionStartSettings": {
          "fixedModeScheduleActionStartSettings": {
            "time": "string"
          },
          "followModeScheduleActionStartSettings": {
            "followPoint": enum,
            "referenceActionName": "string"
          },
          "immediateModeScheduleActionStartSettings": {
            "time": "string"
          }
        }
      }
    ]
  }
}
```

#### InvalidRequest schema
<a name="channels-channelid-schedule-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-channelid-schedule-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="channels-channelid-schedule-response-body-resourcenotfound-example"></a>

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

#### ChannelConfigurationValidationError schema
<a name="channels-channelid-schedule-response-body-channelconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="channels-channelid-schedule-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-channelid-schedule-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-channelid-schedule-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-channelid-schedule-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-channelid-schedule-properties"></a>

### AccessDenied
<a name="channels-channelid-schedule-model-accessdenied"></a>


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

### BadGatewayException
<a name="channels-channelid-schedule-model-badgatewayexception"></a>


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

### BatchScheduleActionCreateRequest
<a name="channels-channelid-schedule-model-batchscheduleactioncreaterequest"></a>

A list of schedule actions to create (in a request) or that have been created (in a response).


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scheduleActions | Array of type [ScheduleAction](#channels-channelid-schedule-model-scheduleaction) | True | A list of schedule actions to create. | 

### BatchScheduleActionCreateResult
<a name="channels-channelid-schedule-model-batchscheduleactioncreateresult"></a>

List of actions that have been created in the schedule.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scheduleActions | Array of type [ScheduleAction](#channels-channelid-schedule-model-scheduleaction) | True | List of actions that have been created in the schedule. | 

### BatchScheduleActionDeleteRequest
<a name="channels-channelid-schedule-model-batchscheduleactiondeleterequest"></a>

A list of schedule actions to delete.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| actionNames | Array of type string | True | A list of schedule actions to delete. | 

### BatchScheduleActionDeleteResult
<a name="channels-channelid-schedule-model-batchscheduleactiondeleteresult"></a>

List of actions that have been deleted from the schedule.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scheduleActions | Array of type [ScheduleAction](#channels-channelid-schedule-model-scheduleaction) | True | List of actions that have been deleted from the schedule. | 

### BatchUpdateScheduleRequest
<a name="channels-channelid-schedule-model-batchupdateschedulerequest"></a>

A request to create actions (add actions to the schedule), delete actions (remove actions from the schedule), or both create and delete actions.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| creates | [BatchScheduleActionCreateRequest](#channels-channelid-schedule-model-batchscheduleactioncreaterequest) | False | Schedule actions to create in the schedule. | 
| deletes | [BatchScheduleActionDeleteRequest](#channels-channelid-schedule-model-batchscheduleactiondeleterequest) | False | Schedule actions to delete from the schedule. | 

### BatchUpdateScheduleResult
<a name="channels-channelid-schedule-model-batchupdatescheduleresult"></a>

Results of a batch schedule update.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| creates | [BatchScheduleActionCreateResult](#channels-channelid-schedule-model-batchscheduleactioncreateresult) | False | Schedule actions created in the schedule. | 
| deletes | [BatchScheduleActionDeleteResult](#channels-channelid-schedule-model-batchscheduleactiondeleteresult) | False | Schedule actions deleted from the schedule. | 

### ChannelConfigurationValidationError
<a name="channels-channelid-schedule-model-channelconfigurationvalidationerror"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False |  | 
| validationErrors | Array of type [ValidationError](#channels-channelid-schedule-model-validationerror) | False | A collection of validation error responses. | 

### FixedModeScheduleActionStartSettings
<a name="channels-channelid-schedule-model-fixedmodescheduleactionstartsettings"></a>

Start time for the action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| time | string | True | Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format". | 

### FollowModeScheduleActionStartSettings
<a name="channels-channelid-schedule-model-followmodescheduleactionstartsettings"></a>

Settings to specify if an action follows another.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| followPoint | [FollowPoint](#channels-channelid-schedule-model-followpoint) | True | Identifies whether this action starts relative to the start or relative to the end of the reference action. | 
| referenceActionName | string | True | The action name of another action that this one refers to. | 

### FollowPoint
<a name="channels-channelid-schedule-model-followpoint"></a>

Follow reference point.
+ `END`
+ `START`

### GatewayTimeoutException
<a name="channels-channelid-schedule-model-gatewaytimeoutexception"></a>


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

### HlsId3SegmentTaggingScheduleActionSettings
<a name="channels-channelid-schedule-model-hlsid3segmenttaggingscheduleactionsettings"></a>

Settings for the action to insert a user-defined ID3 tag in each HLS segment


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tag | string | False | ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\$1nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html | 

### HlsTimedMetadataScheduleActionSettings
<a name="channels-channelid-schedule-model-hlstimedmetadatascheduleactionsettings"></a>

Settings for the action to emit HLS metadata


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id3 | string | True | Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure | 

### ImmediateModeScheduleActionStartSettings
<a name="channels-channelid-schedule-model-immediatemodescheduleactionstartsettings"></a>

Settings to configure an action so that it occurs as soon as possible.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| time | string | False | The time that the immediate mode action is scheduled to occur. (MediaLive calculates this time to be as soon as possible after receiving the schedule) | 

### InputClippingSettings
<a name="channels-channelid-schedule-model-inputclippingsettings"></a>

Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputTimecodeSource | [InputTimecodeSource](#channels-channelid-schedule-model-inputtimecodesource) | True | The source of the timecodes in the source being clipped. | 
| startTimecode | [StartTimecode](#channels-channelid-schedule-model-starttimecode) | False | Settings to identify the start of the clip. | 
| stopTimecode | [StopTimecode](#channels-channelid-schedule-model-stoptimecode) | False | Settings to identify the end of the clip. | 

### InputLocation
<a name="channels-channelid-schedule-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputPrepareScheduleActionSettings
<a name="channels-channelid-schedule-model-inputpreparescheduleactionsettings"></a>

Action to prepare an input for a future immediate input switch.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputAttachmentNameReference | string | False | The name of the input attachment that should be prepared by this action. If no name is provided, the action will stop the most recent prepare (if any) when activated. | 
| inputClippingSettings | [InputClippingSettings](#channels-channelid-schedule-model-inputclippingsettings) | False | Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file. | 
| urlPath | Array of type string | False | The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source. | 

### InputSwitchScheduleActionSettings
<a name="channels-channelid-schedule-model-inputswitchscheduleactionsettings"></a>

Settings for the "switch input" action: to switch from ingesting one input to ingesting another input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputAttachmentNameReference | string | True | The name of the input attachment (not the name of the input\$1) to switch to. The name is specified in the channel configuration. | 
| inputClippingSettings | [InputClippingSettings](#channels-channelid-schedule-model-inputclippingsettings) | False | Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file. | 
| urlPath | Array of type string | False | The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source. | 

### InputTimecodeSource
<a name="channels-channelid-schedule-model-inputtimecodesource"></a>

To clip the file, you must specify the timecode for the start and end of the clip. <br>Specify EMBEDDED to use the timecode embedded in the source content. The embedded timecode must exist in the source content, otherwise MediaLive will output black frames until it reaches the end of the source. <br>Specify ZEROBASED to use a timecode that assumes that the first frame in the file has the timestamp 00:00:00.00. <br> There is no default for this field, you must specify a value.
+ `ZEROBASED`
+ `EMBEDDED`

### InternalServiceError
<a name="channels-channelid-schedule-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-channelid-schedule-model-invalidrequest"></a>


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

### LastFrameClippingBehavior
<a name="channels-channelid-schedule-model-lastframeclippingbehavior"></a>

If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.
+ `EXCLUDE_LAST_FRAME`
+ `INCLUDE_LAST_FRAME`

### LimitExceeded
<a name="channels-channelid-schedule-model-limitexceeded"></a>


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

### MotionGraphicsActivateScheduleActionSettings
<a name="channels-channelid-schedule-model-motiongraphicsactivatescheduleactionsettings"></a>

Settings to specify the rendering of motion graphics into the video stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| duration | integerFormat: int64Minimum: 0Maximum: 86400000 | False | Duration (in milliseconds) that motion graphics should render on to the video stream. Leaving out this property or setting to 0 will result in rendering continuing until a deactivate action is processed. | 
| passwordParam | string | False | Key used to extract the password from EC2 Parameter store | 
| url | string | False | URI of the HTML5 content to be rendered into the live stream. | 
| username | string | False | Username if credentials are required to access a file. This must be a reference to an AWS parameter store name from which the password can be retrieved. AWS Parameter store format: \$1"ssm://<parameter name>\$1" | 

### MotionGraphicsDeactivateScheduleActionSettings
<a name="channels-channelid-schedule-model-motiongraphicsdeactivatescheduleactionsettings"></a>

Settings to specify the ending of rendering motion graphics into the video stream.

### PauseStateScheduleActionSettings
<a name="channels-channelid-schedule-model-pausestatescheduleactionsettings"></a>

Settings for the action to set pause state of a channel.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pipelines | Array of type [PipelinePauseStateSettings](#channels-channelid-schedule-model-pipelinepausestatesettings) | False |  | 

### PipelineId
<a name="channels-channelid-schedule-model-pipelineid"></a>

Pipeline ID
+ `PIPELINE_0`
+ `PIPELINE_1`

### PipelinePauseStateSettings
<a name="channels-channelid-schedule-model-pipelinepausestatesettings"></a>

Settings for pausing a pipeline.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pipelineId | [PipelineId](#channels-channelid-schedule-model-pipelineid) | True | Pipeline ID to pause ("PIPELINE\$10" or "PIPELINE\$11"). | 

### ResourceNotFound
<a name="channels-channelid-schedule-model-resourcenotfound"></a>


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

### ScheduleAction
<a name="channels-channelid-schedule-model-scheduleaction"></a>

Contains information on a single schedule action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| actionName | string | True | The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused. | 
| scheduleActionSettings | [ScheduleActionSettings](#channels-channelid-schedule-model-scheduleactionsettings) | True | Settings for this schedule action. | 
| scheduleActionStartSettings | [ScheduleActionStartSettings](#channels-channelid-schedule-model-scheduleactionstartsettings) | True | The time for the action to start in the channel. | 

### ScheduleActionSettings
<a name="channels-channelid-schedule-model-scheduleactionsettings"></a>

Holds the settings for a single schedule action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsId3SegmentTaggingSettings | [HlsId3SegmentTaggingScheduleActionSettings](#channels-channelid-schedule-model-hlsid3segmenttaggingscheduleactionsettings) | False | Action to insert HLS ID3 segment tagging | 
| hlsTimedMetadataSettings | [HlsTimedMetadataScheduleActionSettings](#channels-channelid-schedule-model-hlstimedmetadatascheduleactionsettings) | False | Action to insert HLS metadata | 
| inputPrepareSettings | [InputPrepareScheduleActionSettings](#channels-channelid-schedule-model-inputpreparescheduleactionsettings) | False | Action to prepare an input for a future immediate input switch | 
| inputSwitchSettings | [InputSwitchScheduleActionSettings](#channels-channelid-schedule-model-inputswitchscheduleactionsettings) | False | Action to switch the input | 
| motionGraphicsImageActivateSettings | [MotionGraphicsActivateScheduleActionSettings](#channels-channelid-schedule-model-motiongraphicsactivatescheduleactionsettings) | False | Action to activate a motion graphics image overlay | 
| motionGraphicsImageDeactivateSettings | [MotionGraphicsDeactivateScheduleActionSettings](#channels-channelid-schedule-model-motiongraphicsdeactivatescheduleactionsettings) | False | Action to deactivate a motion graphics image overlay | 
| pauseStateSettings | [PauseStateScheduleActionSettings](#channels-channelid-schedule-model-pausestatescheduleactionsettings) | False | Action to pause or unpause one or both channel pipelines | 
| scte35ReturnToNetworkSettings | [Scte35ReturnToNetworkScheduleActionSettings](#channels-channelid-schedule-model-scte35returntonetworkscheduleactionsettings) | False | Action to insert SCTE-35 return\$1to\$1network message | 
| scte35SpliceInsertSettings | [Scte35SpliceInsertScheduleActionSettings](#channels-channelid-schedule-model-scte35spliceinsertscheduleactionsettings) | False | Action to insert SCTE-35 splice\$1insert message | 
| scte35TimeSignalSettings | [Scte35TimeSignalScheduleActionSettings](#channels-channelid-schedule-model-scte35timesignalscheduleactionsettings) | False | Action to insert SCTE-35 time\$1signal message | 
| staticImageActivateSettings | [StaticImageActivateScheduleActionSettings](#channels-channelid-schedule-model-staticimageactivatescheduleactionsettings) | False | Action to activate a static image overlay | 
| staticImageDeactivateSettings | [StaticImageDeactivateScheduleActionSettings](#channels-channelid-schedule-model-staticimagedeactivatescheduleactionsettings) | False | Action to deactivate a static image overlay | 

### ScheduleActionStartSettings
<a name="channels-channelid-schedule-model-scheduleactionstartsettings"></a>

Settings to specify when an action should occur. Only one of the options must be selected.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| fixedModeScheduleActionStartSettings | [FixedModeScheduleActionStartSettings](#channels-channelid-schedule-model-fixedmodescheduleactionstartsettings) | False | Option for specifying the start time for an action. | 
| followModeScheduleActionStartSettings | [FollowModeScheduleActionStartSettings](#channels-channelid-schedule-model-followmodescheduleactionstartsettings) | False | Option for specifying an action as relative to another action. | 
| immediateModeScheduleActionStartSettings | [ImmediateModeScheduleActionStartSettings](#channels-channelid-schedule-model-immediatemodescheduleactionstartsettings) | False | Option for specifying an action that should be applied immediately. | 

### ScheduleDeleteResultModel
<a name="channels-channelid-schedule-model-scheduledeleteresultmodel"></a>

Result of a schedule deletion.

### ScheduleDescribeResultModel
<a name="channels-channelid-schedule-model-scheduledescriberesultmodel"></a>

Results of a schedule describe.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | The next token; for use in pagination. | 
| scheduleActions | Array of type [ScheduleAction](#channels-channelid-schedule-model-scheduleaction) | True | The list of actions in the schedule. | 

### Scte35ArchiveAllowedFlag
<a name="channels-channelid-schedule-model-scte35archiveallowedflag"></a>

Corresponds to the archive\$1allowed parameter. A value of ARCHIVE\$1NOT\$1ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.
+ `ARCHIVE_NOT_ALLOWED`
+ `ARCHIVE_ALLOWED`

### Scte35DeliveryRestrictions
<a name="channels-channelid-schedule-model-scte35deliveryrestrictions"></a>

Corresponds to SCTE-35 delivery\$1not\$1restricted\$1flag parameter. To declare delivery restrictions, include this element and its four "restriction" flags. To declare that there are no restrictions, omit this element.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveAllowedFlag | [Scte35ArchiveAllowedFlag](#channels-channelid-schedule-model-scte35archiveallowedflag) | True | Corresponds to SCTE-35 archive\$1allowed\$1flag. | 
| deviceRestrictions | [Scte35DeviceRestrictions](#channels-channelid-schedule-model-scte35devicerestrictions) | True | Corresponds to SCTE-35 device\$1restrictions parameter. | 
| noRegionalBlackoutFlag | [Scte35NoRegionalBlackoutFlag](#channels-channelid-schedule-model-scte35noregionalblackoutflag) | True | Corresponds to SCTE-35 no\$1regional\$1blackout\$1flag parameter. | 
| webDeliveryAllowedFlag | [Scte35WebDeliveryAllowedFlag](#channels-channelid-schedule-model-scte35webdeliveryallowedflag) | True | Corresponds to SCTE-35 web\$1delivery\$1allowed\$1flag parameter. | 

### Scte35Descriptor
<a name="channels-channelid-schedule-model-scte35descriptor"></a>

Holds one set of SCTE-35 Descriptor Settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35DescriptorSettings | [Scte35DescriptorSettings](#channels-channelid-schedule-model-scte35descriptorsettings) | True | SCTE-35 Descriptor Settings. | 

### Scte35DescriptorSettings
<a name="channels-channelid-schedule-model-scte35descriptorsettings"></a>

SCTE-35 Descriptor settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| segmentationDescriptorScte35DescriptorSettings | [Scte35SegmentationDescriptor](#channels-channelid-schedule-model-scte35segmentationdescriptor) | True | SCTE-35 Segmentation Descriptor. | 

### Scte35DeviceRestrictions
<a name="channels-channelid-schedule-model-scte35devicerestrictions"></a>

Corresponds to the device\$1restrictions parameter in a segmentation\$1descriptor. If you include one of the "restriction" flags then you must include all four of them.
+ `NONE`
+ `RESTRICT_GROUP0`
+ `RESTRICT_GROUP1`
+ `RESTRICT_GROUP2`

### Scte35NoRegionalBlackoutFlag
<a name="channels-channelid-schedule-model-scte35noregionalblackoutflag"></a>

Corresponds to the no\$1regional\$1blackout\$1flag parameter. A value of REGIONAL\$1BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.
+ `REGIONAL_BLACKOUT`
+ `NO_REGIONAL_BLACKOUT`

### Scte35ReturnToNetworkScheduleActionSettings
<a name="channels-channelid-schedule-model-scte35returntonetworkscheduleactionsettings"></a>

Settings for a SCTE-35 return\$1to\$1network message.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| spliceEventId | integerFormat: int64Minimum: 0Maximum: 4294967295 | True | The splice\$1event\$1id for the SCTE-35 splice\$1insert, as defined in SCTE-35. | 

### Scte35SegmentationCancelIndicator
<a name="channels-channelid-schedule-model-scte35segmentationcancelindicator"></a>

Corresponds to SCTE-35 segmentation\$1event\$1cancel\$1indicator. SEGMENTATION\$1EVENT\$1NOT\$1CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION\$1EVENT\$1CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.
+ `SEGMENTATION_EVENT_NOT_CANCELED`
+ `SEGMENTATION_EVENT_CANCELED`

### Scte35SegmentationDescriptor
<a name="channels-channelid-schedule-model-scte35segmentationdescriptor"></a>

Corresponds to SCTE-35 segmentation\$1descriptor.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| deliveryRestrictions | [Scte35DeliveryRestrictions](#channels-channelid-schedule-model-scte35deliveryrestrictions) | False | Holds the four SCTE-35 delivery restriction parameters. | 
| segmentationCancelIndicator | [Scte35SegmentationCancelIndicator](#channels-channelid-schedule-model-scte35segmentationcancelindicator) | True | Corresponds to SCTE-35 segmentation\$1event\$1cancel\$1indicator. | 
| segmentationDuration | integerFormat: int64Minimum: 0Maximum: 1099511627775 | False | Corresponds to SCTE-35 segmentation\$1duration. Optional. The duration for the time\$1signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time\$1signal will continue until you insert a cancellation message. | 
| segmentationEventId | integerFormat: int64Minimum: 0Maximum: 4294967295 | True | Corresponds to SCTE-35 segmentation\$1event\$1id.  | 
| segmentationTypeId | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 segmentation\$1type\$1id. One of the segmentation\$1type\$1id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52"). | 
| segmentationUpid | string | False | Corresponds to SCTE-35 segmentation\$1upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation\$1upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e. | 
| segmentationUpidType | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 segmentation\$1upid\$1type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12"). | 
| segmentNum | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 segment\$1num. A value that is valid for the specified segmentation\$1type\$1id. | 
| segmentsExpected | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 segments\$1expected. A value that is valid for the specified segmentation\$1type\$1id. | 
| subSegmentNum | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 sub\$1segment\$1num. A value that is valid for the specified segmentation\$1type\$1id. | 
| subSegmentsExpected | integerMinimum: 0Maximum: 255 | False | Corresponds to SCTE-35 sub\$1segments\$1expected. A value that is valid for the specified segmentation\$1type\$1id. | 

### Scte35SpliceInsertScheduleActionSettings
<a name="channels-channelid-schedule-model-scte35spliceinsertscheduleactionsettings"></a>

Settings for a SCTE-35 splice\$1insert message.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| duration | integerFormat: int64Minimum: 0Maximum: 8589934591 | False | Optional, the duration for the splice\$1insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice\$1insert will continue indefinitely and there is an expectation that you will enter a return\$1to\$1network to end the splice\$1insert at the appropriate time. | 
| spliceEventId | integerFormat: int64Minimum: 0Maximum: 4294967295 | True | The splice\$1event\$1id for the SCTE-35 splice\$1insert, as defined in SCTE-35. | 

### Scte35TimeSignalScheduleActionSettings
<a name="channels-channelid-schedule-model-scte35timesignalscheduleactionsettings"></a>

Settings for a SCTE-35 time\$1signal.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35Descriptors | Array of type [Scte35Descriptor](#channels-channelid-schedule-model-scte35descriptor) | True | The list of SCTE-35 descriptors accompanying the SCTE-35 time\$1signal. | 

### Scte35WebDeliveryAllowedFlag
<a name="channels-channelid-schedule-model-scte35webdeliveryallowedflag"></a>

Corresponds to the web\$1delivery\$1allowed\$1flag parameter. A value of WEB\$1DELIVERY\$1NOT\$1ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the "restriction" flags then you must include all four of them.
+ `WEB_DELIVERY_NOT_ALLOWED`
+ `WEB_DELIVERY_ALLOWED`

### StartTimecode
<a name="channels-channelid-schedule-model-starttimecode"></a>

Settings to identify the start of the clip.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| timecode | string | False | The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF. | 

### StaticImageActivateScheduleActionSettings
<a name="channels-channelid-schedule-model-staticimageactivatescheduleactionsettings"></a>

Settings for the action to activate a static image.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| duration | integerMinimum: 0 | False | The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated. | 
| fadeIn | integerMinimum: 0 | False | The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in). | 
| fadeOut | integerMinimum: 0 | False | Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out). | 
| height | integerMinimum: 1 | False | The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay. | 
| image | [InputLocation](#channels-channelid-schedule-model-inputlocation) | True | The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video. | 
| imageX | integerMinimum: 0 | False | Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right. | 
| imageY | integerMinimum: 0 | False | Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom. | 
| layer | integerMinimum: 0Maximum: 7 | False | The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0. | 
| opacity | integerMinimum: 0Maximum: 100 | False | Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100. | 
| width | integerMinimum: 1 | False | The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay. | 

### StaticImageDeactivateScheduleActionSettings
<a name="channels-channelid-schedule-model-staticimagedeactivatescheduleactionsettings"></a>

Settings for the action to deactivate the image in a specific layer.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| fadeOut | integerMinimum: 0 | False | The time in milliseconds for the image to fade out. Default is 0 (no fade-out). | 
| layer | integerMinimum: 0Maximum: 7 | False | The image overlay layer to deactivate, 0 to 7. Default is 0. | 

### StopTimecode
<a name="channels-channelid-schedule-model-stoptimecode"></a>

Settings to identify the end of the clip.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| lastFrameClippingBehavior | [LastFrameClippingBehavior](#channels-channelid-schedule-model-lastframeclippingbehavior) | False | If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode. | 
| timecode | string | False | The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF. | 

### ValidationError
<a name="channels-channelid-schedule-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="channels-channelid-schedule-see-also"></a>

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

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

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

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

# Channels: start
<a name="channels-channelid-start"></a>

## URI
<a name="channels-channelid-start-url"></a>

`/prod/channels/channelId/start`

## HTTP methods
<a name="channels-channelid-start-http-methods"></a>

### POST
<a name="channels-channelid-startpost"></a>

**Operation ID:** `StartChannel`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

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

## Schemas
<a name="channels-channelid-start-schemas"></a>

### Response bodies
<a name="channels-channelid-start-response-examples"></a>

#### Channel schema
<a name="channels-channelid-start-response-body-channel-example"></a>

```
{
  "arn": "string",
  "cdiInputSpecification": {
    "resolution": enum
  },
  "channelClass": enum,
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ],
  "egressEndpoints": [
    {
      "sourceIp": "string"
    }
  ],
  "encoderSettings": {
    "audioDescriptions": [
      {
        "audioNormalizationSettings": {
          "algorithm": enum,
          "algorithmControl": enum,
          "targetLkfs": number
        },
        "audioSelectorName": "string",
        "audioType": enum,
        "audioTypeControl": enum,
        "audioWatermarkingSettings": {
          "nielsenWatermarksSettings": {
            "nielsenCbetSettings": {
              "cbetCheckDigitString": "string",
              "cbetStepaside": enum,
              "csid": "string"
            },
            "nielsenDistributionType": enum,
            "nielsenNaesIiNwSettings": {
              "checkDigitString": "string",
              "sid": number
            }
          }
        },
        "codecSettings": {
          "aacSettings": {
            "bitrate": number,
            "codingMode": enum,
            "inputType": enum,
            "profile": enum,
            "rateControlMode": enum,
            "rawFormat": enum,
            "sampleRate": number,
            "spec": enum,
            "vbrQuality": enum
          },
          "ac3Settings": {
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dialnorm": integer,
            "drcProfile": enum,
            "lfeFilter": enum,
            "metadataControl": enum
          },
          "eac3Settings": {
            "attenuationControl": enum,
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dcFilter": enum,
            "dialnorm": integer,
            "drcLine": enum,
            "drcRf": enum,
            "lfeControl": enum,
            "lfeFilter": enum,
            "loRoCenterMixLevel": number,
            "loRoSurroundMixLevel": number,
            "ltRtCenterMixLevel": number,
            "ltRtSurroundMixLevel": number,
            "metadataControl": enum,
            "passthroughControl": enum,
            "phaseControl": enum,
            "stereoDownmix": enum,
            "surroundExMode": enum,
            "surroundMode": enum
          },
          "mp2Settings": {
            "bitrate": number,
            "codingMode": enum,
            "sampleRate": number
          },
          "passThroughSettings": {
          },
          "wavSettings": {
            "bitDepth": number,
            "codingMode": enum,
            "sampleRate": number
          }
        },
        "languageCode": "string",
        "languageCodeControl": enum,
        "name": "string",
        "remixSettings": {
          "channelMappings": [
            {
              "inputChannelLevels": [
                {
                  "gain": integer,
                  "inputChannel": integer
                }
              ],
              "outputChannel": integer
            }
          ],
          "channelsIn": integer,
          "channelsOut": integer
        },
        "streamName": "string"
      }
    ],
    "availBlanking": {
      "availBlankingImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "state": enum
    },
    "availConfiguration": {
      "availSettings": {
        "scte35SpliceInsert": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        },
        "scte35TimeSignalApos": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        }
      }
    },
    "blackoutSlate": {
      "blackoutSlateImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkEndBlackout": enum,
      "networkEndBlackoutImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkId": "string",
      "state": enum
    },
    "captionDescriptions": [
      {
        "captionSelectorName": "string",
        "destinationSettings": {
          "aribDestinationSettings": {
          },
          "burnInDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "dvbSubDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "ebuTtDDestinationSettings": {
            "copyrightHolder": "string",
            "fillLineGap": enum,
            "fontFamily": "string",
            "styleControl": enum
          },
          "embeddedDestinationSettings": {
          },
          "embeddedPlusScte20DestinationSettings": {
          },
          "rtmpCaptionInfoDestinationSettings": {
          },
          "scte20PlusEmbeddedDestinationSettings": {
          },
          "scte27DestinationSettings": {
          },
          "smpteTtDestinationSettings": {
          },
          "teletextDestinationSettings": {
          },
          "ttmlDestinationSettings": {
            "styleControl": enum
          },
          "webvttDestinationSettings": {
            "styleControl": enum
          }
        },
        "languageCode": "string",
        "languageDescription": "string",
        "name": "string"
      }
    ],
    "featureActivations": {
      "inputPrepareScheduleActions": enum
    },
    "globalConfiguration": {
      "initialAudioGain": integer,
      "inputEndAction": enum,
      "inputLossBehavior": {
        "blackFrameMsec": integer,
        "inputLossImageColor": "string",
        "inputLossImageSlate": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "inputLossImageType": enum,
        "repeatFrameMsec": integer
      },
      "outputLockingMode": enum,
      "outputTimingSource": enum,
      "supportLowFramerateInputs": enum
    },
    "motionGraphicsConfiguration": {
      "motionGraphicsInsertion": enum,
      "motionGraphicsSettings": {
        "htmlMotionGraphicsSettings": {
        }
      }
    },
    "nielsenConfiguration": {
      "distributorId": "string",
      "nielsenPcmToId3Tagging": enum
    },
    "outputGroups": [
      {
        "name": "string",
        "outputGroupSettings": {
          "archiveGroupSettings": {
            "archiveCdnSettings": {
              "archiveS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            },
            "destination": {
              "destinationRefId": "string"
            },
            "rolloverInterval": integer
          },
          "frameCaptureGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            },
            "frameCaptureCdnSettings": {
              "frameCaptureS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            }
          },
          "hlsGroupSettings": {
            "adMarkers": [
              enum
            ],
            "baseUrlContent": "string",
            "baseUrlContent1": "string",
            "baseUrlManifest": "string",
            "baseUrlManifest1": "string",
            "captionLanguageMappings": [
              {
                "captionChannel": integer,
                "languageCode": "string",
                "languageDescription": "string"
              }
            ],
            "captionLanguageSetting": enum,
            "clientCache": enum,
            "codecSpecification": enum,
            "constantIv": "string",
            "destination": {
              "destinationRefId": "string"
            },
            "directoryStructure": enum,
            "discontinuityTags": enum,
            "encryptionType": enum,
            "hlsCdnSettings": {
              "hlsAkamaiSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer,
                "salt": "string",
                "token": "string"
              },
              "hlsBasicPutSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsMediaStoreSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "mediaStoreStorageClass": enum,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              },
              "hlsWebdavSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer
              }
            },
            "hlsId3SegmentTagging": enum,
            "iFrameOnlyPlaylists": enum,
            "incompleteSegmentBehavior": enum,
            "indexNSegments": integer,
            "inputLossAction": enum,
            "ivInManifest": enum,
            "ivSource": enum,
            "keepSegments": integer,
            "keyFormat": "string",
            "keyFormatVersions": "string",
            "keyProviderSettings": {
              "staticKeySettings": {
                "keyProviderServer": {
                  "passwordParam": "string",
                  "uri": "string",
                  "username": "string"
                },
                "staticKeyValue": "string"
              }
            },
            "manifestCompression": enum,
            "manifestDurationFormat": enum,
            "minSegmentLength": integer,
            "mode": enum,
            "outputSelection": enum,
            "programDateTime": enum,
            "programDateTimeClock": enum,
            "programDateTimePeriod": integer,
            "redundantManifest": enum,
            "segmentLength": integer,
            "segmentationMode": enum,
            "segmentsPerSubdirectory": integer,
            "streamInfResolution": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer,
            "timestampDeltaMilliseconds": integer,
            "tsFileMode": enum
          },
          "mediaPackageGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            }
          },
          "msSmoothGroupSettings": {
            "acquisitionPointId": "string",
            "audioOnlyTimecodeControl": enum,
            "certificateMode": enum,
            "connectionRetryInterval": integer,
            "destination": {
              "destinationRefId": "string"
            },
            "eventId": "string",
            "eventIdMode": enum,
            "eventStopBehavior": enum,
            "filecacheDuration": integer,
            "fragmentLength": integer,
            "inputLossAction": enum,
            "numRetries": integer,
            "restartDelay": integer,
            "segmentationMode": enum,
            "sendDelayMs": integer,
            "sparseTrackType": enum,
            "streamManifestBehavior": enum,
            "timestampOffset": "string",
            "timestampOffsetMode": enum
          },
          "multiplexGroupSettings": {
          },
          "rtmpGroupSettings": {
            "adMarkers": [
              enum
            ],
            "authenticationScheme": enum,
            "cacheFullBehavior": enum,
            "cacheLength": integer,
            "captionData": enum,
            "inputLossAction": enum,
            "restartDelay": integer
          },
          "udpGroupSettings": {
            "inputLossAction": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer
          }
        },
        "outputs": [
          {
            "audioDescriptionNames": [
              "string"
            ],
            "captionDescriptionNames": [
              "string"
            ],
            "outputName": "string",
            "outputSettings": {
              "archiveOutputSettings": {
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  },
                  "rawSettings": {
                  }
                },
                "extension": "string",
                "nameModifier": "string"
              },
              "frameCaptureOutputSettings": {
                "nameModifier": "string"
              },
              "hlsOutputSettings": {
                "h265PackagingType": enum,
                "hlsSettings": {
                  "audioOnlyHlsSettings": {
                    "audioGroupId": "string",
                    "audioOnlyImage": {
                      "passwordParam": "string",
                      "uri": "string",
                      "username": "string"
                    },
                    "audioTrackType": enum,
                    "segmentType": enum
                  },
                  "fmp4HlsSettings": {
                    "audioRenditionSets": "string",
                    "nielsenId3Behavior": enum,
                    "timedMetadataBehavior": enum
                  },
                  "frameCaptureHlsSettings": {
                  },
                  "standardHlsSettings": {
                    "audioRenditionSets": "string",
                    "m3u8Settings": {
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "ecmPid": "string",
                      "nielsenId3Behavior": enum,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "scte35Behavior": enum,
                      "scte35Pid": "string",
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  }
                },
                "nameModifier": "string",
                "segmentModifier": "string"
              },
              "mediaPackageOutputSettings": {
              },
              "msSmoothOutputSettings": {
                "h265PackagingType": enum,
                "nameModifier": "string"
              },
              "multiplexOutputSettings": {
                "destination": {
                  "destinationRefId": "string"
                }
              },
              "rtmpOutputSettings": {
                "certificateMode": enum,
                "connectionRetryInterval": integer,
                "destination": {
                  "destinationRefId": "string"
                },
                "numRetries": integer
              },
              "udpOutputSettings": {
                "bufferMsec": integer,
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  }
                },
                "destination": {
                  "destinationRefId": "string"
                },
                "fecOutputSettings": {
                  "columnDepth": integer,
                  "includeFec": enum,
                  "rowLength": integer
                }
              }
            },
            "videoDescriptionName": "string"
          }
        ]
      }
    ],
    "timecodeConfig": {
      "source": enum,
      "syncThreshold": integer
    },
    "videoDescriptions": [
      {
        "codecSettings": {
          "frameCaptureSettings": {
            "captureInterval": integer,
            "captureIntervalUnits": enum
          },
          "h264Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "bitrate": integer,
            "bufFillPct": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "entropyEncoding": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "forceFieldPictures": enum,
            "framerateControl": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopBReference": enum,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "numRefFrames": integer,
            "parControl": enum,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qualityLevel": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "softness": integer,
            "spatialAq": enum,
            "subgopLength": enum,
            "syntax": enum,
            "temporalAq": enum,
            "timecodeInsertion": enum
          },
          "h265Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "alternativeTransferFunction": enum,
            "bitrate": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "tier": enum,
            "timecodeInsertion": enum
          },
          "mpeg2Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "colorMetadata": enum,
            "colorSpace": enum,
            "displayAspectRatio": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "scanType": enum,
            "subgopLength": enum,
            "timecodeInsertion": enum
          }
        },
        "height": integer,
        "name": "string",
        "respondToAfd": enum,
        "scalingBehavior": enum,
        "sharpness": integer,
        "width": integer
      }
    ]
  },
  "id": "string",
  "inputAttachments": [
    {
      "automaticInputFailoverSettings": {
        "errorClearTimeMsec": integer,
        "failoverConditions": [
          {
            "failoverConditionSettings": {
              "audioSilenceSettings": {
                "audioSelectorName": "string",
                "audioSilenceThresholdMsec": integer
              },
              "inputLossSettings": {
                "inputLossThresholdMsec": integer
              },
              "videoBlackSettings": {
                "blackDetectThreshold": number,
                "videoBlackThresholdMsec": integer
              }
            }
          }
        ],
        "inputPreference": enum,
        "secondaryInputId": "string"
      },
      "inputAttachmentName": "string",
      "inputId": "string",
      "inputSettings": {
        "audioSelectors": [
          {
            "name": "string",
            "selectorSettings": {
              "audioHlsRenditionSelection": {
                "groupId": "string",
                "name": "string"
              },
              "audioLanguageSelection": {
                "languageCode": "string",
                "languageSelectionPolicy": enum
              },
              "audioPidSelection": {
                "pid": integer
              },
              "audioTrackSelection": {
                "tracks": [
                  {
                    "track": integer
                  }
                ]
              }
            }
          }
        ],
        "captionSelectors": [
          {
            "languageCode": "string",
            "name": "string",
            "selectorSettings": {
              "ancillarySourceSettings": {
                "sourceAncillaryChannelNumber": integer
              },
              "aribSourceSettings": {
              },
              "dvbSubSourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "embeddedSourceSettings": {
                "convert608To708": enum,
                "scte20Detection": enum,
                "source608ChannelNumber": integer,
                "source608TrackNumber": integer
              },
              "scte20SourceSettings": {
                "convert608To708": enum,
                "source608ChannelNumber": integer
              },
              "scte27SourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "teletextSourceSettings": {
                "outputRectangle": {
                  "height": number,
                  "leftOffset": number,
                  "topOffset": number,
                  "width": number
                },
                "pageNumber": "string"
              }
            }
          }
        ],
        "deblockFilter": enum,
        "denoiseFilter": enum,
        "filterStrength": integer,
        "inputFilter": enum,
        "networkInputSettings": {
          "hlsInputSettings": {
            "bandwidth": integer,
            "bufferSegments": integer,
            "retries": integer,
            "retryInterval": integer,
            "scte35Source": enum
          },
          "serverValidation": enum
        },
        "smpte2038DataPreference": enum,
        "sourceEndBehavior": enum,
        "videoSelector": {
          "colorSpace": enum,
          "colorSpaceSettings": {
            "hdr10Settings": {
              "maxCll": integer,
              "maxFall": integer
            }
          },
          "colorSpaceUsage": enum,
          "selectorSettings": {
            "videoSelectorPid": {
              "pid": integer
            },
            "videoSelectorProgramId": {
              "programId": integer
            }
          }
        }
      }
    }
  ],
  "inputSpecification": {
    "codec": enum,
    "maximumBitrate": enum,
    "resolution": enum
  },
  "logLevel": enum,
  "maintenance": {
    "maintenanceDay": enum,
    "maintenanceDeadline": "string",
    "maintenanceScheduledDate": "string",
    "maintenanceStartTime": "string"
  },
  "name": "string",
  "pipelineDetails": [
    {
      "activeInputAttachmentName": "string",
      "activeInputSwitchActionName": "string",
      "activeMotionGraphicsActionName": "string",
      "activeMotionGraphicsUri": "string",
      "pipelineId": "string"
    }
  ],
  "pipelinesRunningCount": integer,
  "roleArn": "string",
  "state": enum,
  "tags": {
  },
  "vpc": {
    "availabilityZones": [
      "string"
    ],
    "networkInterfaceIds": [
      "string"
    ],
    "securityGroupIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ]
  }
}
```

#### InvalidRequest schema
<a name="channels-channelid-start-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-channelid-start-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="channels-channelid-start-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="channels-channelid-start-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="channels-channelid-start-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-channelid-start-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-channelid-start-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-channelid-start-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-channelid-start-properties"></a>

### AacCodingMode
<a name="channels-channelid-start-model-aaccodingmode"></a>

Aac Coding Mode
+ `AD_RECEIVER_MIX`
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_5_1`

### AacInputType
<a name="channels-channelid-start-model-aacinputtype"></a>

Aac Input Type
+ `BROADCASTER_MIXED_AD`
+ `NORMAL`

### AacProfile
<a name="channels-channelid-start-model-aacprofile"></a>

Aac Profile
+ `HEV1`
+ `HEV2`
+ `LC`

### AacRateControlMode
<a name="channels-channelid-start-model-aacratecontrolmode"></a>

Aac Rate Control Mode
+ `CBR`
+ `VBR`

### AacRawFormat
<a name="channels-channelid-start-model-aacrawformat"></a>

Aac Raw Format
+ `LATM_LOAS`
+ `NONE`

### AacSettings
<a name="channels-channelid-start-model-aacsettings"></a>

Aac Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. | 
| codingMode | [AacCodingMode](#channels-channelid-start-model-aaccodingmode) | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. | 
| inputType | [AacInputType](#channels-channelid-start-model-aacinputtype) | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio \$1 AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio \$1 AD. | 
| profile | [AacProfile](#channels-channelid-start-model-aacprofile) | False | AAC Profile. | 
| rateControlMode | [AacRateControlMode](#channels-channelid-start-model-aacratecontrolmode) | False | Rate Control Mode. | 
| rawFormat | [AacRawFormat](#channels-channelid-start-model-aacrawformat) | False | Sets LATM / LOAS AAC output for raw containers. | 
| sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. | 
| spec | [AacSpec](#channels-channelid-start-model-aacspec) | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | 
| vbrQuality | [AacVbrQuality](#channels-channelid-start-model-aacvbrquality) | False | VBR Quality Level - Only used if rateControlMode is VBR. | 

### AacSpec
<a name="channels-channelid-start-model-aacspec"></a>

Aac Spec
+ `MPEG2`
+ `MPEG4`

### AacVbrQuality
<a name="channels-channelid-start-model-aacvbrquality"></a>

Aac Vbr Quality
+ `HIGH`
+ `LOW`
+ `MEDIUM_HIGH`
+ `MEDIUM_LOW`

### Ac3BitstreamMode
<a name="channels-channelid-start-model-ac3bitstreammode"></a>

Ac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `DIALOGUE`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `MUSIC_AND_EFFECTS`
+ `VISUALLY_IMPAIRED`
+ `VOICE_OVER`

### Ac3CodingMode
<a name="channels-channelid-start-model-ac3codingmode"></a>

Ac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2_LFE`

### Ac3DrcProfile
<a name="channels-channelid-start-model-ac3drcprofile"></a>

Ac3 Drc Profile
+ `FILM_STANDARD`
+ `NONE`

### Ac3LfeFilter
<a name="channels-channelid-start-model-ac3lfefilter"></a>

Ac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Ac3MetadataControl
<a name="channels-channelid-start-model-ac3metadatacontrol"></a>

Ac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Ac3Settings
<a name="channels-channelid-start-model-ac3settings"></a>

Ac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Ac3BitstreamMode](#channels-channelid-start-model-ac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | 
| codingMode | [Ac3CodingMode](#channels-channelid-start-model-ac3codingmode) | False | Dolby Digital coding mode. Determines number of channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. | 
| drcProfile | [Ac3DrcProfile](#channels-channelid-start-model-ac3drcprofile) | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | 
| lfeFilter | [Ac3LfeFilter](#channels-channelid-start-model-ac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | 
| metadataControl | [Ac3MetadataControl](#channels-channelid-start-model-ac3metadatacontrol) | False | When set to "followInput", encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 

### AccessDenied
<a name="channels-channelid-start-model-accessdenied"></a>


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

### AfdSignaling
<a name="channels-channelid-start-model-afdsignaling"></a>

Afd Signaling
+ `AUTO`
+ `FIXED`
+ `NONE`

### AncillarySourceSettings
<a name="channels-channelid-start-model-ancillarysourcesettings"></a>

Ancillary Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceAncillaryChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. | 

### ArchiveCdnSettings
<a name="channels-channelid-start-model-archivecdnsettings"></a>

Archive Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveS3Settings | [ArchiveS3Settings](#channels-channelid-start-model-archives3settings) | False |  | 

### ArchiveContainerSettings
<a name="channels-channelid-start-model-archivecontainersettings"></a>

Archive Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-start-model-m2tssettings) | False |  | 
| rawSettings | [RawSettings](#channels-channelid-start-model-rawsettings) | False |  | 

### ArchiveGroupSettings
<a name="channels-channelid-start-model-archivegroupsettings"></a>

Archive Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveCdnSettings | [ArchiveCdnSettings](#channels-channelid-start-model-archivecdnsettings) | False | Parameters that control interactions with the CDN. | 
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | A directory and base filename where archive files should be written. | 
| rolloverInterval | integerMinimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. | 

### ArchiveOutputSettings
<a name="channels-channelid-start-model-archiveoutputsettings"></a>

Archive Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| containerSettings | [ArchiveContainerSettings](#channels-channelid-start-model-archivecontainersettings) | True | Settings specific to the container type of the file. | 
| extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### ArchiveS3LogUploads
<a name="channels-channelid-start-model-archives3loguploads"></a>

Archive S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### ArchiveS3Settings
<a name="channels-channelid-start-model-archives3settings"></a>

Archive S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-start-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [ArchiveS3LogUploads](#channels-channelid-start-model-archives3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### AribDestinationSettings
<a name="channels-channelid-start-model-aribdestinationsettings"></a>

Arib Destination Settings

### AribSourceSettings
<a name="channels-channelid-start-model-aribsourcesettings"></a>

Arib Source Settings

### AudioChannelMapping
<a name="channels-channelid-start-model-audiochannelmapping"></a>

Audio Channel Mapping


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputChannelLevels | Array of type [InputChannelLevel](#channels-channelid-start-model-inputchannellevel) | True | Indices and gain values for each input channel that should be remixed into this output channel. | 
| outputChannel | integerMinimum: 0Maximum: 7 | True | The index of the output channel being produced. | 

### AudioCodecSettings
<a name="channels-channelid-start-model-audiocodecsettings"></a>

Audio Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aacSettings | [AacSettings](#channels-channelid-start-model-aacsettings) | False |  | 
| ac3Settings | [Ac3Settings](#channels-channelid-start-model-ac3settings) | False |  | 
| eac3Settings | [Eac3Settings](#channels-channelid-start-model-eac3settings) | False |  | 
| mp2Settings | [Mp2Settings](#channels-channelid-start-model-mp2settings) | False |  | 
| passThroughSettings | [PassThroughSettings](#channels-channelid-start-model-passthroughsettings) | False |  | 
| wavSettings | [WavSettings](#channels-channelid-start-model-wavsettings) | False |  | 

### AudioDescription
<a name="channels-channelid-start-model-audiodescription"></a>

Audio Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioNormalizationSettings | [AudioNormalizationSettings](#channels-channelid-start-model-audionormalizationsettings) | False | Advanced audio normalization settings. | 
| audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. | 
| audioType | [AudioType](#channels-channelid-start-model-audiotype) | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | 
| audioTypeControl | [AudioDescriptionAudioTypeControl](#channels-channelid-start-model-audiodescriptionaudiotypecontrol) | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | 
| audioWatermarkingSettings | [AudioWatermarkSettings](#channels-channelid-start-model-audiowatermarksettings) | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | 
| codecSettings | [AudioCodecSettings](#channels-channelid-start-model-audiocodecsettings) | False | Audio codec settings. | 
| languageCode | stringMinLength: 1MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. | 
| languageCodeControl | [AudioDescriptionLanguageCodeControl](#channels-channelid-start-model-audiodescriptionlanguagecodecontrol) | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | 
| name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. | 
| remixSettings | [RemixSettings](#channels-channelid-start-model-remixsettings) | False | Settings that control how input audio channels are remixed into the output audio channels. | 
| streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). | 

### AudioDescriptionAudioTypeControl
<a name="channels-channelid-start-model-audiodescriptionaudiotypecontrol"></a>

Audio Description Audio Type Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioDescriptionLanguageCodeControl
<a name="channels-channelid-start-model-audiodescriptionlanguagecodecontrol"></a>

Audio Description Language Code Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioHlsRenditionSelection
<a name="channels-channelid-start-model-audiohlsrenditionselection"></a>

Audio Hls Rendition Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| groupId | stringMinLength: 1 | True | Specifies the GROUP-ID in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 
| name | stringMinLength: 1 | True | Specifies the NAME in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 

### AudioLanguageSelection
<a name="channels-channelid-start-model-audiolanguageselection"></a>

Audio Language Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | True | Selects a specific three-letter language code from within an audio source. | 
| languageSelectionPolicy | [AudioLanguageSelectionPolicy](#channels-channelid-start-model-audiolanguageselectionpolicy) | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. | 

### AudioLanguageSelectionPolicy
<a name="channels-channelid-start-model-audiolanguageselectionpolicy"></a>

Audio Language Selection Policy
+ `LOOSE`
+ `STRICT`

### AudioNormalizationAlgorithm
<a name="channels-channelid-start-model-audionormalizationalgorithm"></a>

Audio Normalization Algorithm
+ `ITU_1770_1`
+ `ITU_1770_2`

### AudioNormalizationAlgorithmControl
<a name="channels-channelid-start-model-audionormalizationalgorithmcontrol"></a>

Audio Normalization Algorithm Control
+ `CORRECT_AUDIO`

### AudioNormalizationSettings
<a name="channels-channelid-start-model-audionormalizationsettings"></a>

Audio Normalization Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| algorithm | [AudioNormalizationAlgorithm](#channels-channelid-start-model-audionormalizationalgorithm) | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | 
| algorithmControl | [AudioNormalizationAlgorithmControl](#channels-channelid-start-model-audionormalizationalgorithmcontrol) | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | 
| targetLkfs | numberMinimum: -59Maximum: 0 | False | Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. | 

### AudioOnlyHlsSegmentType
<a name="channels-channelid-start-model-audioonlyhlssegmenttype"></a>

Audio Only Hls Segment Type
+ `AAC`
+ `FMP4`

### AudioOnlyHlsSettings
<a name="channels-channelid-start-model-audioonlyhlssettings"></a>

Audio Only Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. | 
| audioOnlyImage | [InputLocation](#channels-channelid-start-model-inputlocation) | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | 
| audioTrackType | [AudioOnlyHlsTrackType](#channels-channelid-start-model-audioonlyhlstracktype) | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | 
| segmentType | [AudioOnlyHlsSegmentType](#channels-channelid-start-model-audioonlyhlssegmenttype) | False | Specifies the segment type. | 

### AudioOnlyHlsTrackType
<a name="channels-channelid-start-model-audioonlyhlstracktype"></a>

Audio Only Hls Track Type
+ `ALTERNATE_AUDIO_AUTO_SELECT`
+ `ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT`
+ `ALTERNATE_AUDIO_NOT_AUTO_SELECT`
+ `AUDIO_ONLY_VARIANT_STREAM`

### AudioPidSelection
<a name="channels-channelid-start-model-audiopidselection"></a>

Audio Pid Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | True | Selects a specific PID from within a source. | 

### AudioSelector
<a name="channels-channelid-start-model-audioselector"></a>

Audio Selector


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. | 
| selectorSettings | [AudioSelectorSettings](#channels-channelid-start-model-audioselectorsettings) | False | The audio selector settings. | 

### AudioSelectorSettings
<a name="channels-channelid-start-model-audioselectorsettings"></a>

Audio Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioHlsRenditionSelection | [AudioHlsRenditionSelection](#channels-channelid-start-model-audiohlsrenditionselection) | False |  | 
| audioLanguageSelection | [AudioLanguageSelection](#channels-channelid-start-model-audiolanguageselection) | False |  | 
| audioPidSelection | [AudioPidSelection](#channels-channelid-start-model-audiopidselection) | False |  | 
| audioTrackSelection | [AudioTrackSelection](#channels-channelid-start-model-audiotrackselection) | False |  | 

### AudioSilenceFailoverSettings
<a name="channels-channelid-start-model-audiosilencefailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. | 
| audioSilenceThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. | 

### AudioTrack
<a name="channels-channelid-start-model-audiotrack"></a>

Audio Track


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| track | integerMinimum: 1 | True | 1-based integer value that maps to a specific audio track | 

### AudioTrackSelection
<a name="channels-channelid-start-model-audiotrackselection"></a>

Audio Track Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tracks | Array of type [AudioTrack](#channels-channelid-start-model-audiotrack) | True | Selects one or more unique audio tracks from within a source. | 

### AudioType
<a name="channels-channelid-start-model-audiotype"></a>

Audio Type
+ `CLEAN_EFFECTS`
+ `HEARING_IMPAIRED`
+ `UNDEFINED`
+ `VISUAL_IMPAIRED_COMMENTARY`

### AudioWatermarkSettings
<a name="channels-channelid-start-model-audiowatermarksettings"></a>

Audio Watermark Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenWatermarksSettings | [NielsenWatermarksSettings](#channels-channelid-start-model-nielsenwatermarkssettings) | False | Settings to configure Nielsen Watermarks in the audio encode | 

### AuthenticationScheme
<a name="channels-channelid-start-model-authenticationscheme"></a>

Authentication Scheme
+ `AKAMAI`
+ `COMMON`

### AutomaticInputFailoverSettings
<a name="channels-channelid-start-model-automaticinputfailoversettings"></a>

The settings for Automatic Input Failover.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| errorClearTimeMsec | integerMinimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input\$1preference for the failover pair is set to PRIMARY\$1INPUT\$1PREFERRED, because after this time, MediaLive will switch back to the primary input. | 
| failoverConditions | Array of type [FailoverCondition](#channels-channelid-start-model-failovercondition) | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. | 
| inputPreference | [InputPreference](#channels-channelid-start-model-inputpreference) | False | Input preference when deciding which input to make active when a previously failed input has recovered. | 
| secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. | 

### AvailBlanking
<a name="channels-channelid-start-model-availblanking"></a>

Avail Blanking


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availBlankingImage | [InputLocation](#channels-channelid-start-model-inputlocation) | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| state | [AvailBlankingState](#channels-channelid-start-model-availblankingstate) | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. | 

### AvailBlankingState
<a name="channels-channelid-start-model-availblankingstate"></a>

Avail Blanking State
+ `DISABLED`
+ `ENABLED`

### AvailConfiguration
<a name="channels-channelid-start-model-availconfiguration"></a>

Avail Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availSettings | [AvailSettings](#channels-channelid-start-model-availsettings) | False | Ad avail settings. | 

### AvailSettings
<a name="channels-channelid-start-model-availsettings"></a>

Avail Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35SpliceInsert | [Scte35SpliceInsert](#channels-channelid-start-model-scte35spliceinsert) | False |  | 
| scte35TimeSignalApos | [Scte35TimeSignalApos](#channels-channelid-start-model-scte35timesignalapos) | False |  | 

### BadGatewayException
<a name="channels-channelid-start-model-badgatewayexception"></a>


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

### BlackoutSlate
<a name="channels-channelid-start-model-blackoutslate"></a>

Blackout Slate


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackoutSlateImage | [InputLocation](#channels-channelid-start-model-inputlocation) | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| networkEndBlackout | [BlackoutSlateNetworkEndBlackout](#channels-channelid-start-model-blackoutslatenetworkendblackout) | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | 
| networkEndBlackoutImage | [InputLocation](#channels-channelid-start-model-inputlocation) | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | 
| networkId | stringMinLength: 34MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). | 
| state | [BlackoutSlateState](#channels-channelid-start-model-blackoutslatestate) | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. | 

### BlackoutSlateNetworkEndBlackout
<a name="channels-channelid-start-model-blackoutslatenetworkendblackout"></a>

Blackout Slate Network End Blackout
+ `DISABLED`
+ `ENABLED`

### BlackoutSlateState
<a name="channels-channelid-start-model-blackoutslatestate"></a>

Blackout Slate State
+ `DISABLED`
+ `ENABLED`

### BurnInAlignment
<a name="channels-channelid-start-model-burninalignment"></a>

Burn In Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### BurnInBackgroundColor
<a name="channels-channelid-start-model-burninbackgroundcolor"></a>

Burn In Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInDestinationSettings
<a name="channels-channelid-start-model-burnindestinationsettings"></a>

Burn In Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [BurnInAlignment](#channels-channelid-start-model-burninalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [BurnInBackgroundColor](#channels-channelid-start-model-burninbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-start-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [BurnInFontColor](#channels-channelid-start-model-burninfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [BurnInOutlineColor](#channels-channelid-start-model-burninoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [BurnInShadowColor](#channels-channelid-start-model-burninshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [BurnInTeletextGridControl](#channels-channelid-start-model-burninteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. | 

### BurnInFontColor
<a name="channels-channelid-start-model-burninfontcolor"></a>

Burn In Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInOutlineColor
<a name="channels-channelid-start-model-burninoutlinecolor"></a>

Burn In Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInShadowColor
<a name="channels-channelid-start-model-burninshadowcolor"></a>

Burn In Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInTeletextGridControl
<a name="channels-channelid-start-model-burninteletextgridcontrol"></a>

Burn In Teletext Grid Control
+ `FIXED`
+ `SCALED`

### CaptionDescription
<a name="channels-channelid-start-model-captiondescription"></a>

Caption Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. | 
| destinationSettings | [CaptionDestinationSettings](#channels-channelid-start-model-captiondestinationsettings) | False | Additional settings for captions destination that depend on the destination type. | 
| languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | 
| languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). | 
| name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. | 

### CaptionDestinationSettings
<a name="channels-channelid-start-model-captiondestinationsettings"></a>

Caption Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aribDestinationSettings | [AribDestinationSettings](#channels-channelid-start-model-aribdestinationsettings) | False |  | 
| burnInDestinationSettings | [BurnInDestinationSettings](#channels-channelid-start-model-burnindestinationsettings) | False |  | 
| dvbSubDestinationSettings | [DvbSubDestinationSettings](#channels-channelid-start-model-dvbsubdestinationsettings) | False |  | 
| ebuTtDDestinationSettings | [EbuTtDDestinationSettings](#channels-channelid-start-model-ebuttddestinationsettings) | False |  | 
| embeddedDestinationSettings | [EmbeddedDestinationSettings](#channels-channelid-start-model-embeddeddestinationsettings) | False |  | 
| embeddedPlusScte20DestinationSettings | [EmbeddedPlusScte20DestinationSettings](#channels-channelid-start-model-embeddedplusscte20destinationsettings) | False |  | 
| rtmpCaptionInfoDestinationSettings | [RtmpCaptionInfoDestinationSettings](#channels-channelid-start-model-rtmpcaptioninfodestinationsettings) | False |  | 
| scte20PlusEmbeddedDestinationSettings | [Scte20PlusEmbeddedDestinationSettings](#channels-channelid-start-model-scte20plusembeddeddestinationsettings) | False |  | 
| scte27DestinationSettings | [Scte27DestinationSettings](#channels-channelid-start-model-scte27destinationsettings) | False |  | 
| smpteTtDestinationSettings | [SmpteTtDestinationSettings](#channels-channelid-start-model-smptettdestinationsettings) | False |  | 
| teletextDestinationSettings | [TeletextDestinationSettings](#channels-channelid-start-model-teletextdestinationsettings) | False |  | 
| ttmlDestinationSettings | [TtmlDestinationSettings](#channels-channelid-start-model-ttmldestinationsettings) | False |  | 
| webvttDestinationSettings | [WebvttDestinationSettings](#channels-channelid-start-model-webvttdestinationsettings) | False |  | 

### CaptionLanguageMapping
<a name="channels-channelid-start-model-captionlanguagemapping"></a>

Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionChannel | integerMinimum: 1Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) | 
| languageCode | stringMinLength: 3MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) | 
| languageDescription | stringMinLength: 1 | True | Textual description of language | 

### CaptionRectangle
<a name="channels-channelid-start-model-captionrectangle"></a>

Caption Rectangle


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| height | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \$1"80\$1" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. | 
| leftOffset | numberMinimum: 0Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. | 
| topOffset | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. | 
| width | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \$1"80\$1" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. | 

### CaptionSelector
<a name="channels-channelid-start-model-captionselector"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. | 
| name | stringMinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. | 
| selectorSettings | [CaptionSelectorSettings](#channels-channelid-start-model-captionselectorsettings) | False | Caption selector settings. | 

### CaptionSelectorSettings
<a name="channels-channelid-start-model-captionselectorsettings"></a>

Caption Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ancillarySourceSettings | [AncillarySourceSettings](#channels-channelid-start-model-ancillarysourcesettings) | False |  | 
| aribSourceSettings | [AribSourceSettings](#channels-channelid-start-model-aribsourcesettings) | False |  | 
| dvbSubSourceSettings | [DvbSubSourceSettings](#channels-channelid-start-model-dvbsubsourcesettings) | False |  | 
| embeddedSourceSettings | [EmbeddedSourceSettings](#channels-channelid-start-model-embeddedsourcesettings) | False |  | 
| scte20SourceSettings | [Scte20SourceSettings](#channels-channelid-start-model-scte20sourcesettings) | False |  | 
| scte27SourceSettings | [Scte27SourceSettings](#channels-channelid-start-model-scte27sourcesettings) | False |  | 
| teletextSourceSettings | [TeletextSourceSettings](#channels-channelid-start-model-teletextsourcesettings) | False |  | 

### CdiInputResolution
<a name="channels-channelid-start-model-cdiinputresolution"></a>

Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### CdiInputSpecification
<a name="channels-channelid-start-model-cdiinputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resolution | [CdiInputResolution](#channels-channelid-start-model-cdiinputresolution) | False | Maximum CDI input resolution | 

### Channel
<a name="channels-channelid-start-model-channel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-channelid-start-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-channelid-start-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-channelid-start-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-channelid-start-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| encoderSettings | [EncoderSettings](#channels-channelid-start-model-encodersettings) | False |  | 
| id | string | False | The unique ID of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-channelid-start-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-channelid-start-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-channelid-start-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-channelid-start-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelineDetails | Array of type [PipelineDetail](#channels-channelid-start-model-pipelinedetail) | False | Runtime details for the pipelines of a running channel. | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-channelid-start-model-channelstate) | False |  | 
| tags | [Tags](#channels-channelid-start-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-channelid-start-model-vpcoutputsettingsdescription) | False | Settings for VPC output | 

### ChannelClass
<a name="channels-channelid-start-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### ChannelEgressEndpoint
<a name="channels-channelid-start-model-channelegressendpoint"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceIp | string | False | Public IP of where a channel's output comes from | 

### ChannelState
<a name="channels-channelid-start-model-channelstate"></a>
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`
+ `UPDATING`
+ `UPDATE_FAILED`

### ColorSpacePassthroughSettings
<a name="channels-channelid-start-model-colorspacepassthroughsettings"></a>

Passthrough applies no color space conversion to the output

### DvbNitSettings
<a name="channels-channelid-start-model-dvbnitsettings"></a>

DVB Network Information Table (NIT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| networkId | integerMinimum: 0Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). | 
| networkName | stringMinLength: 1MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. | 
| repInterval | integerMinimum: 25Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### DvbSdtOutputSdt
<a name="channels-channelid-start-model-dvbsdtoutputsdt"></a>

Dvb Sdt Output Sdt
+ `SDT_FOLLOW`
+ `SDT_FOLLOW_IF_PRESENT`
+ `SDT_MANUAL`
+ `SDT_NONE`

### DvbSdtSettings
<a name="channels-channelid-start-model-dvbsdtsettings"></a>

DVB Service Description Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputSdt | [DvbSdtOutputSdt](#channels-channelid-start-model-dvbsdtoutputsdt) | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | 
| repInterval | integerMinimum: 25Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. | 
| serviceName | stringMinLength: 1MaxLength: 256 | False | The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 
| serviceProviderName | stringMinLength: 1MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 

### DvbSubDestinationAlignment
<a name="channels-channelid-start-model-dvbsubdestinationalignment"></a>

Dvb Sub Destination Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### DvbSubDestinationBackgroundColor
<a name="channels-channelid-start-model-dvbsubdestinationbackgroundcolor"></a>

Dvb Sub Destination Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationFontColor
<a name="channels-channelid-start-model-dvbsubdestinationfontcolor"></a>

Dvb Sub Destination Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationOutlineColor
<a name="channels-channelid-start-model-dvbsubdestinationoutlinecolor"></a>

Dvb Sub Destination Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationSettings
<a name="channels-channelid-start-model-dvbsubdestinationsettings"></a>

Dvb Sub Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [DvbSubDestinationAlignment](#channels-channelid-start-model-dvbsubdestinationalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [DvbSubDestinationBackgroundColor](#channels-channelid-start-model-dvbsubdestinationbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-start-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [DvbSubDestinationFontColor](#channels-channelid-start-model-dvbsubdestinationfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [DvbSubDestinationOutlineColor](#channels-channelid-start-model-dvbsubdestinationoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [DvbSubDestinationShadowColor](#channels-channelid-start-model-dvbsubdestinationshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [DvbSubDestinationTeletextGridControl](#channels-channelid-start-model-dvbsubdestinationteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 

### DvbSubDestinationShadowColor
<a name="channels-channelid-start-model-dvbsubdestinationshadowcolor"></a>

Dvb Sub Destination Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationTeletextGridControl
<a name="channels-channelid-start-model-dvbsubdestinationteletextgridcontrol"></a>

Dvb Sub Destination Teletext Grid Control
+ `FIXED`
+ `SCALED`

### DvbSubOcrLanguage
<a name="channels-channelid-start-model-dvbsubocrlanguage"></a>

Dvb Sub Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### DvbSubSourceSettings
<a name="channels-channelid-start-model-dvbsubsourcesettings"></a>

Dvb Sub Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [DvbSubOcrLanguage](#channels-channelid-start-model-dvbsubocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. | 

### DvbTdtSettings
<a name="channels-channelid-start-model-dvbtdtsettings"></a>

DVB Time and Date Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| repInterval | integerMinimum: 1000Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### Eac3AttenuationControl
<a name="channels-channelid-start-model-eac3attenuationcontrol"></a>

Eac3 Attenuation Control
+ `ATTENUATE_3_DB`
+ `NONE`

### Eac3BitstreamMode
<a name="channels-channelid-start-model-eac3bitstreammode"></a>

Eac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `VISUALLY_IMPAIRED`

### Eac3CodingMode
<a name="channels-channelid-start-model-eac3codingmode"></a>

Eac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2`

### Eac3DcFilter
<a name="channels-channelid-start-model-eac3dcfilter"></a>

Eac3 Dc Filter
+ `DISABLED`
+ `ENABLED`

### Eac3DrcLine
<a name="channels-channelid-start-model-eac3drcline"></a>

Eac3 Drc Line
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3DrcRf
<a name="channels-channelid-start-model-eac3drcrf"></a>

Eac3 Drc Rf
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3LfeControl
<a name="channels-channelid-start-model-eac3lfecontrol"></a>

Eac3 Lfe Control
+ `LFE`
+ `NO_LFE`

### Eac3LfeFilter
<a name="channels-channelid-start-model-eac3lfefilter"></a>

Eac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Eac3MetadataControl
<a name="channels-channelid-start-model-eac3metadatacontrol"></a>

Eac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Eac3PassthroughControl
<a name="channels-channelid-start-model-eac3passthroughcontrol"></a>

Eac3 Passthrough Control
+ `NO_PASSTHROUGH`
+ `WHEN_POSSIBLE`

### Eac3PhaseControl
<a name="channels-channelid-start-model-eac3phasecontrol"></a>

Eac3 Phase Control
+ `NO_SHIFT`
+ `SHIFT_90_DEGREES`

### Eac3Settings
<a name="channels-channelid-start-model-eac3settings"></a>

Eac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| attenuationControl | [Eac3AttenuationControl](#channels-channelid-start-model-eac3attenuationcontrol) | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | 
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Eac3BitstreamMode](#channels-channelid-start-model-eac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. | 
| codingMode | [Eac3CodingMode](#channels-channelid-start-model-eac3codingmode) | False | Dolby Digital Plus coding mode. Determines number of channels. | 
| dcFilter | [Eac3DcFilter](#channels-channelid-start-model-eac3dcfilter) | False | When set to enabled, activates a DC highpass filter for all input channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. | 
| drcLine | [Eac3DrcLine](#channels-channelid-start-model-eac3drcline) | False | Sets the Dolby dynamic range compression profile. | 
| drcRf | [Eac3DrcRf](#channels-channelid-start-model-eac3drcrf) | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | 
| lfeControl | [Eac3LfeControl](#channels-channelid-start-model-eac3lfecontrol) | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | 
| lfeFilter | [Eac3LfeFilter](#channels-channelid-start-model-eac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | 
| loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. | 
| loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. | 
| ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. | 
| ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. | 
| metadataControl | [Eac3MetadataControl](#channels-channelid-start-model-eac3metadatacontrol) | False | When set to followInput, encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 
| passthroughControl | [Eac3PassthroughControl](#channels-channelid-start-model-eac3passthroughcontrol) | False | When set to whenPossible, input DD\$1 audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD\$1 and non-DD\$1 content will have a consistent DD\$1 output as the system alternates between passthrough and encoding. | 
| phaseControl | [Eac3PhaseControl](#channels-channelid-start-model-eac3phasecontrol) | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | 
| stereoDownmix | [Eac3StereoDownmix](#channels-channelid-start-model-eac3stereodownmix) | False | Stereo downmix preference. Only used for 3/2 coding mode. | 
| surroundExMode | [Eac3SurroundExMode](#channels-channelid-start-model-eac3surroundexmode) | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | 
| surroundMode | [Eac3SurroundMode](#channels-channelid-start-model-eac3surroundmode) | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. | 

### Eac3StereoDownmix
<a name="channels-channelid-start-model-eac3stereodownmix"></a>

Eac3 Stereo Downmix
+ `DPL2`
+ `LO_RO`
+ `LT_RT`
+ `NOT_INDICATED`

### Eac3SurroundExMode
<a name="channels-channelid-start-model-eac3surroundexmode"></a>

Eac3 Surround Ex Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### Eac3SurroundMode
<a name="channels-channelid-start-model-eac3surroundmode"></a>

Eac3 Surround Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### EbuTtDDestinationSettings
<a name="channels-channelid-start-model-ebuttddestinationsettings"></a>

Ebu Tt DDestination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyrightHolder | stringMaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML | 
| fillLineGap | [EbuTtDFillLineGapControl](#channels-channelid-start-model-ebuttdfilllinegapcontrol) | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | 
| fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. | 
| styleControl | [EbuTtDDestinationStyleControl](#channels-channelid-start-model-ebuttddestinationstylecontrol) | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. | 

### EbuTtDDestinationStyleControl
<a name="channels-channelid-start-model-ebuttddestinationstylecontrol"></a>

Ebu Tt DDestination Style Control
+ `EXCLUDE`
+ `INCLUDE`

### EbuTtDFillLineGapControl
<a name="channels-channelid-start-model-ebuttdfilllinegapcontrol"></a>

Ebu Tt DFill Line Gap Control
+ `DISABLED`
+ `ENABLED`

### EmbeddedConvert608To708
<a name="channels-channelid-start-model-embeddedconvert608to708"></a>

Embedded Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### EmbeddedDestinationSettings
<a name="channels-channelid-start-model-embeddeddestinationsettings"></a>

Embedded Destination Settings

### EmbeddedPlusScte20DestinationSettings
<a name="channels-channelid-start-model-embeddedplusscte20destinationsettings"></a>

Embedded Plus Scte20 Destination Settings

### EmbeddedScte20Detection
<a name="channels-channelid-start-model-embeddedscte20detection"></a>

Embedded Scte20 Detection
+ `AUTO`
+ `OFF`

### EmbeddedSourceSettings
<a name="channels-channelid-start-model-embeddedsourcesettings"></a>

Embedded Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [EmbeddedConvert608To708](#channels-channelid-start-model-embeddedconvert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| scte20Detection | [EmbeddedScte20Detection](#channels-channelid-start-model-embeddedscte20detection) | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 
| source608TrackNumber | integerMinimum: 1Maximum: 5 | False | This field is unused and deprecated. | 

### EncoderSettings
<a name="channels-channelid-start-model-encodersettings"></a>

Encoder Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptions | Array of type [AudioDescription](#channels-channelid-start-model-audiodescription) | True |  | 
| availBlanking | [AvailBlanking](#channels-channelid-start-model-availblanking) | False | Settings for ad avail blanking. | 
| availConfiguration | [AvailConfiguration](#channels-channelid-start-model-availconfiguration) | False | Event-wide configuration settings for ad avail insertion. | 
| blackoutSlate | [BlackoutSlate](#channels-channelid-start-model-blackoutslate) | False | Settings for blackout slate. | 
| captionDescriptions | Array of type [CaptionDescription](#channels-channelid-start-model-captiondescription) | False | Settings for caption decriptions | 
| featureActivations | [FeatureActivations](#channels-channelid-start-model-featureactivations) | False | Feature Activations | 
| globalConfiguration | [GlobalConfiguration](#channels-channelid-start-model-globalconfiguration) | False | Configuration settings that apply to the event as a whole. | 
| motionGraphicsConfiguration | [MotionGraphicsConfiguration](#channels-channelid-start-model-motiongraphicsconfiguration) | False | Settings for motion graphics. | 
| nielsenConfiguration | [NielsenConfiguration](#channels-channelid-start-model-nielsenconfiguration) | False | Nielsen configuration settings. | 
| outputGroups | Array of type [OutputGroup](#channels-channelid-start-model-outputgroup) | True |  | 
| timecodeConfig | [TimecodeConfig](#channels-channelid-start-model-timecodeconfig) | True | Contains settings used to acquire and adjust timecode information from inputs. | 
| videoDescriptions | Array of type [VideoDescription](#channels-channelid-start-model-videodescription) | True |  | 

### FailoverCondition
<a name="channels-channelid-start-model-failovercondition"></a>

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failoverConditionSettings | [FailoverConditionSettings](#channels-channelid-start-model-failoverconditionsettings) | False | Failover condition type-specific settings. | 

### FailoverConditionSettings
<a name="channels-channelid-start-model-failoverconditionsettings"></a>

Settings for one failover condition.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSilenceSettings | [AudioSilenceFailoverSettings](#channels-channelid-start-model-audiosilencefailoversettings) | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | 
| inputLossSettings | [InputLossFailoverSettings](#channels-channelid-start-model-inputlossfailoversettings) | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | 
| videoBlackSettings | [VideoBlackFailoverSettings](#channels-channelid-start-model-videoblackfailoversettings) | False | MediaLive will perform a failover if content is considered black for the specified period. | 

### FeatureActivations
<a name="channels-channelid-start-model-featureactivations"></a>

Feature Activations


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputPrepareScheduleActions | [FeatureActivationsInputPrepareScheduleActions](#channels-channelid-start-model-featureactivationsinputpreparescheduleactions) | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. | 

### FeatureActivationsInputPrepareScheduleActions
<a name="channels-channelid-start-model-featureactivationsinputpreparescheduleactions"></a>

Feature Activations Input Prepare Schedule Actions
+ `DISABLED`
+ `ENABLED`

### FecOutputIncludeFec
<a name="channels-channelid-start-model-fecoutputincludefec"></a>

Fec Output Include Fec
+ `COLUMN`
+ `COLUMN_AND_ROW`

### FecOutputSettings
<a name="channels-channelid-start-model-fecoutputsettings"></a>

Fec Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| columnDepth | integerMinimum: 4Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. | 
| includeFec | [FecOutputIncludeFec](#channels-channelid-start-model-fecoutputincludefec) | False | Enables column only or column and row based FEC | 
| rowLength | integerMinimum: 1Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. | 

### FixedAfd
<a name="channels-channelid-start-model-fixedafd"></a>

Fixed Afd
+ `AFD_0000`
+ `AFD_0010`
+ `AFD_0011`
+ `AFD_0100`
+ `AFD_1000`
+ `AFD_1001`
+ `AFD_1010`
+ `AFD_1011`
+ `AFD_1101`
+ `AFD_1110`
+ `AFD_1111`

### Fmp4HlsSettings
<a name="channels-channelid-start-model-fmp4hlssettings"></a>

Fmp4 Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| nielsenId3Behavior | [Fmp4NielsenId3Behavior](#channels-channelid-start-model-fmp4nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| timedMetadataBehavior | [Fmp4TimedMetadataBehavior](#channels-channelid-start-model-fmp4timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 

### Fmp4NielsenId3Behavior
<a name="channels-channelid-start-model-fmp4nielsenid3behavior"></a>

Fmp4 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### Fmp4TimedMetadataBehavior
<a name="channels-channelid-start-model-fmp4timedmetadatabehavior"></a>

Fmp4 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### FrameCaptureCdnSettings
<a name="channels-channelid-start-model-framecapturecdnsettings"></a>

Frame Capture Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureS3Settings | [FrameCaptureS3Settings](#channels-channelid-start-model-framecaptures3settings) | False |  | 

### FrameCaptureGroupSettings
<a name="channels-channelid-start-model-framecapturegroupsettings"></a>

Frame Capture Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") \$1 name modifier \$1 the counter (5 digits, starting from 00001) \$1 extension (which is always .jpg). For example, curling-low.00001.jpg | 
| frameCaptureCdnSettings | [FrameCaptureCdnSettings](#channels-channelid-start-model-framecapturecdnsettings) | False | Parameters that control interactions with the CDN. | 

### FrameCaptureHlsSettings
<a name="channels-channelid-start-model-framecapturehlssettings"></a>

Frame Capture Hls Settings

### FrameCaptureIntervalUnit
<a name="channels-channelid-start-model-framecaptureintervalunit"></a>

Frame Capture Interval Unit
+ `MILLISECONDS`
+ `SECONDS`

### FrameCaptureOutputSettings
<a name="channels-channelid-start-model-framecaptureoutputsettings"></a>

Frame Capture Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. | 

### FrameCaptureS3LogUploads
<a name="channels-channelid-start-model-framecaptures3loguploads"></a>

Frame Capture S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### FrameCaptureS3Settings
<a name="channels-channelid-start-model-framecaptures3settings"></a>

Frame Capture S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-start-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [FrameCaptureS3LogUploads](#channels-channelid-start-model-framecaptures3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### FrameCaptureSettings
<a name="channels-channelid-start-model-framecapturesettings"></a>

Frame Capture Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captureInterval | integerMinimum: 1Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. | 
| captureIntervalUnits | [FrameCaptureIntervalUnit](#channels-channelid-start-model-framecaptureintervalunit) | False | Unit for the frame capture interval. | 

### GatewayTimeoutException
<a name="channels-channelid-start-model-gatewaytimeoutexception"></a>


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

### GlobalConfiguration
<a name="channels-channelid-start-model-globalconfiguration"></a>

Global Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| initialAudioGain | integerMinimum: -60Maximum: 60 | False | Value to set the initial audio gain for the Live Event. | 
| inputEndAction | [GlobalConfigurationInputEndAction](#channels-channelid-start-model-globalconfigurationinputendaction) | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | 
| inputLossBehavior | [InputLossBehavior](#channels-channelid-start-model-inputlossbehavior) | False | Settings for system actions when input is lost. | 
| outputLockingMode | [GlobalConfigurationOutputLockingMode](#channels-channelid-start-model-globalconfigurationoutputlockingmode) | False | Indicates how MediaLive pipelines are synchronized. PIPELINE\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | 
| outputTimingSource | [GlobalConfigurationOutputTimingSource](#channels-channelid-start-model-globalconfigurationoutputtimingsource) | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | 
| supportLowFramerateInputs | [GlobalConfigurationLowFramerateInputs](#channels-channelid-start-model-globalconfigurationlowframerateinputs) | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. | 

### GlobalConfigurationInputEndAction
<a name="channels-channelid-start-model-globalconfigurationinputendaction"></a>

Global Configuration Input End Action
+ `NONE`
+ `SWITCH_AND_LOOP_INPUTS`

### GlobalConfigurationLowFramerateInputs
<a name="channels-channelid-start-model-globalconfigurationlowframerateinputs"></a>

Global Configuration Low Framerate Inputs
+ `DISABLED`
+ `ENABLED`

### GlobalConfigurationOutputLockingMode
<a name="channels-channelid-start-model-globalconfigurationoutputlockingmode"></a>

Global Configuration Output Locking Mode
+ `EPOCH_LOCKING`
+ `PIPELINE_LOCKING`

### GlobalConfigurationOutputTimingSource
<a name="channels-channelid-start-model-globalconfigurationoutputtimingsource"></a>

Global Configuration Output Timing Source
+ `INPUT_CLOCK`
+ `SYSTEM_CLOCK`

### H264AdaptiveQuantization
<a name="channels-channelid-start-model-h264adaptivequantization"></a>

H264 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H264ColorMetadata
<a name="channels-channelid-start-model-h264colormetadata"></a>

H264 Color Metadata
+ `IGNORE`
+ `INSERT`

### H264ColorSpaceSettings
<a name="channels-channelid-start-model-h264colorspacesettings"></a>

H264 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-start-model-colorspacepassthroughsettings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-start-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-start-model-rec709settings) | False |  | 

### H264EntropyEncoding
<a name="channels-channelid-start-model-h264entropyencoding"></a>

H264 Entropy Encoding
+ `CABAC`
+ `CAVLC`

### H264FilterSettings
<a name="channels-channelid-start-model-h264filtersettings"></a>

H264 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-start-model-temporalfiltersettings) | False |  | 

### H264FlickerAq
<a name="channels-channelid-start-model-h264flickeraq"></a>

H264 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H264ForceFieldPictures
<a name="channels-channelid-start-model-h264forcefieldpictures"></a>

H264 Force Field Pictures
+ `DISABLED`
+ `ENABLED`

### H264FramerateControl
<a name="channels-channelid-start-model-h264frameratecontrol"></a>

H264 Framerate Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264GopBReference
<a name="channels-channelid-start-model-h264gopbreference"></a>

H264 Gop BReference
+ `DISABLED`
+ `ENABLED`

### H264GopSizeUnits
<a name="channels-channelid-start-model-h264gopsizeunits"></a>

H264 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H264Level
<a name="channels-channelid-start-model-h264level"></a>

H264 Level
+ `H264_LEVEL_1`
+ `H264_LEVEL_1_1`
+ `H264_LEVEL_1_2`
+ `H264_LEVEL_1_3`
+ `H264_LEVEL_2`
+ `H264_LEVEL_2_1`
+ `H264_LEVEL_2_2`
+ `H264_LEVEL_3`
+ `H264_LEVEL_3_1`
+ `H264_LEVEL_3_2`
+ `H264_LEVEL_4`
+ `H264_LEVEL_4_1`
+ `H264_LEVEL_4_2`
+ `H264_LEVEL_5`
+ `H264_LEVEL_5_1`
+ `H264_LEVEL_5_2`
+ `H264_LEVEL_AUTO`

### H264LookAheadRateControl
<a name="channels-channelid-start-model-h264lookaheadratecontrol"></a>

H264 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H264ParControl
<a name="channels-channelid-start-model-h264parcontrol"></a>

H264 Par Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264Profile
<a name="channels-channelid-start-model-h264profile"></a>

H264 Profile
+ `BASELINE`
+ `HIGH`
+ `HIGH_10BIT`
+ `HIGH_422`
+ `HIGH_422_10BIT`
+ `MAIN`

### H264QualityLevel
<a name="channels-channelid-start-model-h264qualitylevel"></a>

H264 Quality Level
+ `ENHANCED_QUALITY`
+ `STANDARD_QUALITY`

### H264RateControlMode
<a name="channels-channelid-start-model-h264ratecontrolmode"></a>

H264 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`
+ `VBR`

### H264ScanType
<a name="channels-channelid-start-model-h264scantype"></a>

H264 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H264SceneChangeDetect
<a name="channels-channelid-start-model-h264scenechangedetect"></a>

H264 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H264Settings
<a name="channels-channelid-start-model-h264settings"></a>

H264 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H264AdaptiveQuantization](#channels-channelid-start-model-h264adaptivequantization) | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | 
| afdSignaling | [AfdSignaling](#channels-channelid-start-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| bitrate | integerMinimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufFillPct | integerMinimum: 0Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). | 
| bufSize | integerMinimum: 0 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H264ColorMetadata](#channels-channelid-start-model-h264colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H264ColorSpaceSettings](#channels-channelid-start-model-h264colorspacesettings) | False | Color Space settings | 
| entropyEncoding | [H264EntropyEncoding](#channels-channelid-start-model-h264entropyencoding) | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | 
| filterSettings | [H264FilterSettings](#channels-channelid-start-model-h264filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-start-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H264FlickerAq](#channels-channelid-start-model-h264flickeraq) | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | 
| forceFieldPictures | [H264ForceFieldPictures](#channels-channelid-start-model-h264forcefieldpictures) | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | 
| framerateControl | [H264FramerateControl](#channels-channelid-start-model-h264frameratecontrol) | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | 
| framerateDenominator | integerMinimum: 1 | False | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopBReference | [H264GopBReference](#channels-channelid-start-model-h264gopbreference) | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Number of B-frames between reference frames. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H264GopSizeUnits](#channels-channelid-start-model-h264gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H264Level](#channels-channelid-start-model-h264level) | False | H.264 Level. | 
| lookAheadRateControl | [H264LookAheadRateControl](#channels-channelid-start-model-h264lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| numRefFrames | integerMinimum: 1Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. | 
| parControl | [H264ParControl](#channels-channelid-start-model-h264parcontrol) | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H264Profile](#channels-channelid-start-model-h264profile) | False | H.264 Profile. | 
| qualityLevel | [H264QualityLevel](#channels-channelid-start-model-h264qualitylevel) | False | Leave as STANDARD\$1QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED\$1QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED\$1QUALITY. - STANDARD\$1QUALITY: Valid for any Rate control mode. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide | 
| rateControlMode | [H264RateControlMode](#channels-channelid-start-model-h264ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H264ScanType](#channels-channelid-start-model-h264scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H264SceneChangeDetect](#channels-channelid-start-model-h264scenechangedetect) | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | 
| slices | integerMinimum: 1Maximum: 32 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| softness | integerMinimum: 0Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. | 
| spatialAq | [H264SpatialAq](#channels-channelid-start-model-h264spatialaq) | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | 
| subgopLength | [H264SubGopLength](#channels-channelid-start-model-h264subgoplength) | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | 
| syntax | [H264Syntax](#channels-channelid-start-model-h264syntax) | False | Produces a bitstream compliant with SMPTE RP-2027. | 
| temporalAq | [H264TemporalAq](#channels-channelid-start-model-h264temporalaq) | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | 
| timecodeInsertion | [H264TimecodeInsertionBehavior](#channels-channelid-start-model-h264timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H264SpatialAq
<a name="channels-channelid-start-model-h264spatialaq"></a>

H264 Spatial Aq
+ `DISABLED`
+ `ENABLED`

### H264SubGopLength
<a name="channels-channelid-start-model-h264subgoplength"></a>

H264 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### H264Syntax
<a name="channels-channelid-start-model-h264syntax"></a>

H264 Syntax
+ `DEFAULT`
+ `RP2027`

### H264TemporalAq
<a name="channels-channelid-start-model-h264temporalaq"></a>

H264 Temporal Aq
+ `DISABLED`
+ `ENABLED`

### H264TimecodeInsertionBehavior
<a name="channels-channelid-start-model-h264timecodeinsertionbehavior"></a>

H264 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### H265AdaptiveQuantization
<a name="channels-channelid-start-model-h265adaptivequantization"></a>

H265 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H265AlternativeTransferFunction
<a name="channels-channelid-start-model-h265alternativetransferfunction"></a>

H265 Alternative Transfer Function
+ `INSERT`
+ `OMIT`

### H265ColorMetadata
<a name="channels-channelid-start-model-h265colormetadata"></a>

H265 Color Metadata
+ `IGNORE`
+ `INSERT`

### H265ColorSpaceSettings
<a name="channels-channelid-start-model-h265colorspacesettings"></a>

H265 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-start-model-colorspacepassthroughsettings) | False |  | 
| hdr10Settings | [Hdr10Settings](#channels-channelid-start-model-hdr10settings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-start-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-start-model-rec709settings) | False |  | 

### H265FilterSettings
<a name="channels-channelid-start-model-h265filtersettings"></a>

H265 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-start-model-temporalfiltersettings) | False |  | 

### H265FlickerAq
<a name="channels-channelid-start-model-h265flickeraq"></a>

H265 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H265GopSizeUnits
<a name="channels-channelid-start-model-h265gopsizeunits"></a>

H265 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H265Level
<a name="channels-channelid-start-model-h265level"></a>

H265 Level
+ `H265_LEVEL_1`
+ `H265_LEVEL_2`
+ `H265_LEVEL_2_1`
+ `H265_LEVEL_3`
+ `H265_LEVEL_3_1`
+ `H265_LEVEL_4`
+ `H265_LEVEL_4_1`
+ `H265_LEVEL_5`
+ `H265_LEVEL_5_1`
+ `H265_LEVEL_5_2`
+ `H265_LEVEL_6`
+ `H265_LEVEL_6_1`
+ `H265_LEVEL_6_2`
+ `H265_LEVEL_AUTO`

### H265LookAheadRateControl
<a name="channels-channelid-start-model-h265lookaheadratecontrol"></a>

H265 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H265Profile
<a name="channels-channelid-start-model-h265profile"></a>

H265 Profile
+ `MAIN`
+ `MAIN_10BIT`

### H265RateControlMode
<a name="channels-channelid-start-model-h265ratecontrolmode"></a>

H265 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`

### H265ScanType
<a name="channels-channelid-start-model-h265scantype"></a>

H265 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H265SceneChangeDetect
<a name="channels-channelid-start-model-h265scenechangedetect"></a>

H265 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H265Settings
<a name="channels-channelid-start-model-h265settings"></a>

H265 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H265AdaptiveQuantization](#channels-channelid-start-model-h265adaptivequantization) | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-start-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| alternativeTransferFunction | [H265AlternativeTransferFunction](#channels-channelid-start-model-h265alternativetransferfunction) | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | 
| bitrate | integerMinimum: 100000Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufSize | integerMinimum: 100000Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H265ColorMetadata](#channels-channelid-start-model-h265colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H265ColorSpaceSettings](#channels-channelid-start-model-h265colorspacesettings) | False | Color Space settings | 
| filterSettings | [H265FilterSettings](#channels-channelid-start-model-h265filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-start-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H265FlickerAq](#channels-channelid-start-model-h265flickeraq) | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | 
| framerateDenominator | integerMinimum: 1Maximum: 3003 | True | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H265GopSizeUnits](#channels-channelid-start-model-h265gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H265Level](#channels-channelid-start-model-h265level) | False | H.265 Level. | 
| lookAheadRateControl | [H265LookAheadRateControl](#channels-channelid-start-model-h265lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 100000Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H265Profile](#channels-channelid-start-model-h265profile) | False | H.265 Profile. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M | 
| rateControlMode | [H265RateControlMode](#channels-channelid-start-model-h265ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H265ScanType](#channels-channelid-start-model-h265scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H265SceneChangeDetect](#channels-channelid-start-model-h265scenechangedetect) | False | Scene change detection. | 
| slices | integerMinimum: 1Maximum: 16 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| tier | [H265Tier](#channels-channelid-start-model-h265tier) | False | H.265 Tier. | 
| timecodeInsertion | [H265TimecodeInsertionBehavior](#channels-channelid-start-model-h265timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H265Tier
<a name="channels-channelid-start-model-h265tier"></a>

H265 Tier
+ `HIGH`
+ `MAIN`

### H265TimecodeInsertionBehavior
<a name="channels-channelid-start-model-h265timecodeinsertionbehavior"></a>

H265 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### Hdr10Settings
<a name="channels-channelid-start-model-hdr10settings"></a>

Hdr10 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxCll | integerMinimum: 0Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. | 
| maxFall | integerMinimum: 0Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. | 

### HlsAdMarkers
<a name="channels-channelid-start-model-hlsadmarkers"></a>

Hls Ad Markers
+ `ADOBE`
+ `ELEMENTAL`
+ `ELEMENTAL_SCTE35`

### HlsAkamaiHttpTransferMode
<a name="channels-channelid-start-model-hlsakamaihttptransfermode"></a>

Hls Akamai Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsAkamaiSettings
<a name="channels-channelid-start-model-hlsakamaisettings"></a>

Hls Akamai Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsAkamaiHttpTransferMode](#channels-channelid-start-model-hlsakamaihttptransfermode) | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 
| salt | string | False | Salt for authenticated Akamai. | 
| token | string | False | Token parameter for authenticated akamai. If not specified, \$1gda\$1 is used. | 

### HlsBasicPutSettings
<a name="channels-channelid-start-model-hlsbasicputsettings"></a>

Hls Basic Put Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsCaptionLanguageSetting
<a name="channels-channelid-start-model-hlscaptionlanguagesetting"></a>

Hls Caption Language Setting
+ `INSERT`
+ `NONE`
+ `OMIT`

### HlsCdnSettings
<a name="channels-channelid-start-model-hlscdnsettings"></a>

Hls Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsAkamaiSettings | [HlsAkamaiSettings](#channels-channelid-start-model-hlsakamaisettings) | False |  | 
| hlsBasicPutSettings | [HlsBasicPutSettings](#channels-channelid-start-model-hlsbasicputsettings) | False |  | 
| hlsMediaStoreSettings | [HlsMediaStoreSettings](#channels-channelid-start-model-hlsmediastoresettings) | False |  | 
| hlsS3Settings | [HlsS3Settings](#channels-channelid-start-model-hlss3settings) | False |  | 
| hlsWebdavSettings | [HlsWebdavSettings](#channels-channelid-start-model-hlswebdavsettings) | False |  | 

### HlsClientCache
<a name="channels-channelid-start-model-hlsclientcache"></a>

Hls Client Cache
+ `DISABLED`
+ `ENABLED`

### HlsCodecSpecification
<a name="channels-channelid-start-model-hlscodecspecification"></a>

Hls Codec Specification
+ `RFC_4281`
+ `RFC_6381`

### HlsDirectoryStructure
<a name="channels-channelid-start-model-hlsdirectorystructure"></a>

Hls Directory Structure
+ `SINGLE_DIRECTORY`
+ `SUBDIRECTORY_PER_STREAM`

### HlsDiscontinuityTags
<a name="channels-channelid-start-model-hlsdiscontinuitytags"></a>

Hls Discontinuity Tags
+ `INSERT`
+ `NEVER_INSERT`

### HlsEncryptionType
<a name="channels-channelid-start-model-hlsencryptiontype"></a>

Hls Encryption Type
+ `AES128`
+ `SAMPLE_AES`

### HlsGroupSettings
<a name="channels-channelid-start-model-hlsgroupsettings"></a>

Hls Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [HlsAdMarkers](#channels-channelid-start-model-hlsadmarkers) | False | Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. | 
| baseUrlContent | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. | 
| baseUrlManifest | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. | 
| captionLanguageMappings | Array of type [CaptionLanguageMapping](#channels-channelid-start-model-captionlanguagemapping) | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". | 
| captionLanguageSetting | [HlsCaptionLanguageSetting](#channels-channelid-start-model-hlscaptionlanguagesetting) | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | 
| clientCache | [HlsClientCache](#channels-channelid-start-model-hlsclientcache) | False | When set to "disabled", sets the \$1EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | 
| codecSpecification | [HlsCodecSpecification](#channels-channelid-start-model-hlscodecspecification) | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | 
| constantIv | stringMinLength: 32MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. | 
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | 
| directoryStructure | [HlsDirectoryStructure](#channels-channelid-start-model-hlsdirectorystructure) | False | Place segments in subdirectories. | 
| discontinuityTags | [HlsDiscontinuityTags](#channels-channelid-start-model-hlsdiscontinuitytags) | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | 
| encryptionType | [HlsEncryptionType](#channels-channelid-start-model-hlsencryptiontype) | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | 
| hlsCdnSettings | [HlsCdnSettings](#channels-channelid-start-model-hlscdnsettings) | False | Parameters that control interactions with the CDN. | 
| hlsId3SegmentTagging | [HlsId3SegmentTaggingState](#channels-channelid-start-model-hlsid3segmenttaggingstate) | False | State of HLS ID3 Segment Tagging | 
| iFrameOnlyPlaylists | [IFrameOnlyPlaylistType](#channels-channelid-start-model-iframeonlyplaylisttype) | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a \$1EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more \$1EXT-X-BYTERANGE entries identifying the I-frame position. For example, \$1EXT-X-BYTERANGE:160364@1461888" | 
| incompleteSegmentBehavior | [HlsIncompleteSegmentBehavior](#channels-channelid-start-model-hlsincompletesegmentbehavior) | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | 
| indexNSegments | integerMinimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. | 
| inputLossAction | [InputLossActionForHlsOut](#channels-channelid-start-model-inputlossactionforhlsout) | False | Parameter that control output group behavior on input loss. | 
| ivInManifest | [HlsIvInManifest](#channels-channelid-start-model-hlsivinmanifest) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | 
| ivSource | [HlsIvSource](#channels-channelid-start-model-hlsivsource) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | 
| keepSegments | integerMinimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) \$1 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. | 
| keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. | 
| keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). | 
| keyProviderSettings | [KeyProviderSettings](#channels-channelid-start-model-keyprovidersettings) | False | The key provider settings. | 
| manifestCompression | [HlsManifestCompression](#channels-channelid-start-model-hlsmanifestcompression) | False | When set to gzip, compresses HLS playlist. | 
| manifestDurationFormat | [HlsManifestDurationFormat](#channels-channelid-start-model-hlsmanifestdurationformat) | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | 
| minSegmentLength | integerMinimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. | 
| mode | [HlsMode](#channels-channelid-start-model-hlsmode) | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | 
| outputSelection | [HlsOutputSelection](#channels-channelid-start-model-hlsoutputselection) | False | MANIFESTS\$1AND\$1SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT\$1MANIFESTS\$1AND\$1SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS\$1ONLY: Does not generate any manifests for this output group. | 
| programDateTime | [HlsProgramDateTime](#channels-channelid-start-model-hlsprogramdatetime) | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | 
| programDateTimeClock | [HlsProgramDateTimeClock](#channels-channelid-start-model-hlsprogramdatetimeclock) | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE\$1FROM\$1OUTPUT\$1TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM\$1CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | 
| programDateTimePeriod | integerMinimum: 0Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | 
| redundantManifest | [HlsRedundantManifest](#channels-channelid-start-model-hlsredundantmanifest) | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | 
| segmentationMode | [HlsSegmentationMode](#channels-channelid-start-model-hlssegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| segmentLength | integerMinimum: 1 | False | Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. | 
| segmentsPerSubdirectory | integerMinimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. | 
| streamInfResolution | [HlsStreamInfResolution](#channels-channelid-start-model-hlsstreaminfresolution) | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | 
| timedMetadataId3Frame | [HlsTimedMetadataId3Frame](#channels-channelid-start-model-hlstimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 
| timestampDeltaMilliseconds | integerMinimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. | 
| tsFileMode | [HlsTsFileMode](#channels-channelid-start-model-hlstsfilemode) | False | SEGMENTED\$1FILES: Emit the program as segments - multiple .ts media files. SINGLE\$1FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes \$1EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. | 

### HlsH265PackagingType
<a name="channels-channelid-start-model-hlsh265packagingtype"></a>

Hls H265 Packaging Type
+ `HEV1`
+ `HVC1`

### HlsId3SegmentTaggingState
<a name="channels-channelid-start-model-hlsid3segmenttaggingstate"></a>

State of HLS ID3 Segment Tagging
+ `DISABLED`
+ `ENABLED`

### HlsIncompleteSegmentBehavior
<a name="channels-channelid-start-model-hlsincompletesegmentbehavior"></a>

Hls Incomplete Segment Behavior
+ `AUTO`
+ `SUPPRESS`

### HlsInputSettings
<a name="channels-channelid-start-model-hlsinputsettings"></a>

Hls Input Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bandwidth | integerMinimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. | 
| bufferSegments | integerMinimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. | 
| retries | integerMinimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. | 
| retryInterval | integerMinimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. | 
| scte35Source | [HlsScte35SourceType](#channels-channelid-start-model-hlsscte35sourcetype) | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. | 

### HlsIvInManifest
<a name="channels-channelid-start-model-hlsivinmanifest"></a>

Hls Iv In Manifest
+ `EXCLUDE`
+ `INCLUDE`

### HlsIvSource
<a name="channels-channelid-start-model-hlsivsource"></a>

Hls Iv Source
+ `EXPLICIT`
+ `FOLLOWS_SEGMENT_NUMBER`

### HlsManifestCompression
<a name="channels-channelid-start-model-hlsmanifestcompression"></a>

Hls Manifest Compression
+ `GZIP`
+ `NONE`

### HlsManifestDurationFormat
<a name="channels-channelid-start-model-hlsmanifestdurationformat"></a>

Hls Manifest Duration Format
+ `FLOATING_POINT`
+ `INTEGER`

### HlsMediaStoreSettings
<a name="channels-channelid-start-model-hlsmediastoresettings"></a>

Hls Media Store Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| mediaStoreStorageClass | [HlsMediaStoreStorageClass](#channels-channelid-start-model-hlsmediastorestorageclass) | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsMediaStoreStorageClass
<a name="channels-channelid-start-model-hlsmediastorestorageclass"></a>

Hls Media Store Storage Class
+ `TEMPORAL`

### HlsMode
<a name="channels-channelid-start-model-hlsmode"></a>

Hls Mode
+ `LIVE`
+ `VOD`

### HlsOutputSelection
<a name="channels-channelid-start-model-hlsoutputselection"></a>

Hls Output Selection
+ `MANIFESTS_AND_SEGMENTS`
+ `SEGMENTS_ONLY`
+ `VARIANT_MANIFESTS_AND_SEGMENTS`

### HlsOutputSettings
<a name="channels-channelid-start-model-hlsoutputsettings"></a>

Hls Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [HlsH265PackagingType](#channels-channelid-start-model-hlsh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| hlsSettings | [HlsSettings](#channels-channelid-start-model-hlssettings) | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | 
| nameModifier | stringMinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \$1"Format Identifiers\$1":\$1formatIdentifierParameters. | 
| segmentModifier | string | False | String concatenated to end of segment filenames. | 

### HlsProgramDateTime
<a name="channels-channelid-start-model-hlsprogramdatetime"></a>

Hls Program Date Time
+ `EXCLUDE`
+ `INCLUDE`

### HlsProgramDateTimeClock
<a name="channels-channelid-start-model-hlsprogramdatetimeclock"></a>

Hls Program Date Time Clock
+ `INITIALIZE_FROM_OUTPUT_TIMECODE`
+ `SYSTEM_CLOCK`

### HlsRedundantManifest
<a name="channels-channelid-start-model-hlsredundantmanifest"></a>

Hls Redundant Manifest
+ `DISABLED`
+ `ENABLED`

### HlsS3LogUploads
<a name="channels-channelid-start-model-hlss3loguploads"></a>

Hls S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### HlsS3Settings
<a name="channels-channelid-start-model-hlss3settings"></a>

Hls S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-start-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [HlsS3LogUploads](#channels-channelid-start-model-hlss3loguploads) | False | When set to enabled, each fragment upload to CDN or server will be logged. | 

### HlsScte35SourceType
<a name="channels-channelid-start-model-hlsscte35sourcetype"></a>

Hls Scte35 Source Type
+ `MANIFEST`
+ `SEGMENTS`

### HlsSegmentationMode
<a name="channels-channelid-start-model-hlssegmentationmode"></a>

Hls Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### HlsSettings
<a name="channels-channelid-start-model-hlssettings"></a>

Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioOnlyHlsSettings | [AudioOnlyHlsSettings](#channels-channelid-start-model-audioonlyhlssettings) | False |  | 
| fmp4HlsSettings | [Fmp4HlsSettings](#channels-channelid-start-model-fmp4hlssettings) | False |  | 
| frameCaptureHlsSettings | [FrameCaptureHlsSettings](#channels-channelid-start-model-framecapturehlssettings) | False |  | 
| standardHlsSettings | [StandardHlsSettings](#channels-channelid-start-model-standardhlssettings) | False |  | 

### HlsStreamInfResolution
<a name="channels-channelid-start-model-hlsstreaminfresolution"></a>

Hls Stream Inf Resolution
+ `EXCLUDE`
+ `INCLUDE`

### HlsTimedMetadataId3Frame
<a name="channels-channelid-start-model-hlstimedmetadataid3frame"></a>

Hls Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### HlsTsFileMode
<a name="channels-channelid-start-model-hlstsfilemode"></a>

Hls Ts File Mode
+ `SEGMENTED_FILES`
+ `SINGLE_FILE`

### HlsWebdavHttpTransferMode
<a name="channels-channelid-start-model-hlswebdavhttptransfermode"></a>

Hls Webdav Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsWebdavSettings
<a name="channels-channelid-start-model-hlswebdavsettings"></a>

Hls Webdav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsWebdavHttpTransferMode](#channels-channelid-start-model-hlswebdavhttptransfermode) | False | Specify whether or not to use chunked transfer encoding to WebDAV. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HtmlMotionGraphicsSettings
<a name="channels-channelid-start-model-htmlmotiongraphicssettings"></a>

Html Motion Graphics Settings

### IFrameOnlyPlaylistType
<a name="channels-channelid-start-model-iframeonlyplaylisttype"></a>

When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
+ `DISABLED`
+ `STANDARD`

### InputAttachment
<a name="channels-channelid-start-model-inputattachment"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| automaticInputFailoverSettings | [AutomaticInputFailoverSettings](#channels-channelid-start-model-automaticinputfailoversettings) | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | 
| inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. | 
| inputId | string | False | The ID of the input | 
| inputSettings | [InputSettings](#channels-channelid-start-model-inputsettings) | False | Settings of an input (caption selector, etc.) | 

### InputChannelLevel
<a name="channels-channelid-start-model-inputchannellevel"></a>

Input Channel Level


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| gain | integerMinimum: -60Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. | 
| inputChannel | integerMinimum: 0Maximum: 15 | True | The index of the input channel used as a source. | 

### InputCodec
<a name="channels-channelid-start-model-inputcodec"></a>

codec in increasing order of complexity
+ `MPEG2`
+ `AVC`
+ `HEVC`

### InputDeblockFilter
<a name="channels-channelid-start-model-inputdeblockfilter"></a>

Input Deblock Filter
+ `DISABLED`
+ `ENABLED`

### InputDenoiseFilter
<a name="channels-channelid-start-model-inputdenoisefilter"></a>

Input Denoise Filter
+ `DISABLED`
+ `ENABLED`

### InputFilter
<a name="channels-channelid-start-model-inputfilter"></a>

Input Filter
+ `AUTO`
+ `DISABLED`
+ `FORCED`

### InputLocation
<a name="channels-channelid-start-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputLossActionForHlsOut
<a name="channels-channelid-start-model-inputlossactionforhlsout"></a>

Input Loss Action For Hls Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForMsSmoothOut
<a name="channels-channelid-start-model-inputlossactionformssmoothout"></a>

Input Loss Action For Ms Smooth Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForRtmpOut
<a name="channels-channelid-start-model-inputlossactionforrtmpout"></a>

Input Loss Action For Rtmp Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForUdpOut
<a name="channels-channelid-start-model-inputlossactionforudpout"></a>

Input Loss Action For Udp Out
+ `DROP_PROGRAM`
+ `DROP_TS`
+ `EMIT_PROGRAM`

### InputLossBehavior
<a name="channels-channelid-start-model-inputlossbehavior"></a>

Input Loss Behavior


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 
| inputLossImageColor | stringMinLength: 6MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. | 
| inputLossImageSlate | [InputLocation](#channels-channelid-start-model-inputlocation) | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | 
| inputLossImageType | [InputLossImageType](#channels-channelid-start-model-inputlossimagetype) | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | 
| repeatFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 

### InputLossFailoverSettings
<a name="channels-channelid-start-model-inputlossfailoversettings"></a>

MediaLive will perform a failover if content is not detected in this input for the specified period.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossThresholdMsec | integerMinimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. | 

### InputLossImageType
<a name="channels-channelid-start-model-inputlossimagetype"></a>

Input Loss Image Type
+ `COLOR`
+ `SLATE`

### InputMaximumBitrate
<a name="channels-channelid-start-model-inputmaximumbitrate"></a>

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### InputPreference
<a name="channels-channelid-start-model-inputpreference"></a>

Input preference when deciding which input to make active when a previously failed input has recovered. If \$1"EQUAL\$1INPUT\$1PREFERENCE\$1", then the active input will stay active as long as it is healthy. If \$1"PRIMARY\$1INPUT\$1PREFERRED\$1", then always switch back to the primary input when it is healthy. 
+ `EQUAL_INPUT_PREFERENCE`
+ `PRIMARY_INPUT_PREFERRED`

### InputResolution
<a name="channels-channelid-start-model-inputresolution"></a>

Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `UHD`

### InputSettings
<a name="channels-channelid-start-model-inputsettings"></a>

Live Event input parameters. There can be multiple inputs in a single Live Event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectors | Array of type [AudioSelector](#channels-channelid-start-model-audioselector) | False | Used to select the audio stream to decode for inputs that have multiple available. | 
| captionSelectors | Array of type [CaptionSelector](#channels-channelid-start-model-captionselector) | False | Used to select the caption input to use for inputs that have multiple available. | 
| deblockFilter | [InputDeblockFilter](#channels-channelid-start-model-inputdeblockfilter) | False | Enable or disable the deblock filter when filtering. | 
| denoiseFilter | [InputDenoiseFilter](#channels-channelid-start-model-inputdenoisefilter) | False | Enable or disable the denoise filter when filtering. | 
| filterStrength | integerMinimum: 1Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). | 
| inputFilter | [InputFilter](#channels-channelid-start-model-inputfilter) | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | 
| networkInputSettings | [NetworkInputSettings](#channels-channelid-start-model-networkinputsettings) | False | Input settings. | 
| smpte2038DataPreference | [Smpte2038DataPreference](#channels-channelid-start-model-smpte2038datapreference) | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | 
| sourceEndBehavior | [InputSourceEndBehavior](#channels-channelid-start-model-inputsourceendbehavior) | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | 
| videoSelector | [VideoSelector](#channels-channelid-start-model-videoselector) | False | Informs which video elementary stream to decode for input types that have multiple available. | 

### InputSourceEndBehavior
<a name="channels-channelid-start-model-inputsourceendbehavior"></a>

Input Source End Behavior
+ `CONTINUE`
+ `LOOP`

### InputSpecification
<a name="channels-channelid-start-model-inputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codec | [InputCodec](#channels-channelid-start-model-inputcodec) | False | Input codec | 
| maximumBitrate | [InputMaximumBitrate](#channels-channelid-start-model-inputmaximumbitrate) | False | Maximum input bitrate, categorized coarsely | 
| resolution | [InputResolution](#channels-channelid-start-model-inputresolution) | False | Input resolution, categorized coarsely | 

### InternalServiceError
<a name="channels-channelid-start-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-channelid-start-model-invalidrequest"></a>


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

### KeyProviderSettings
<a name="channels-channelid-start-model-keyprovidersettings"></a>

Key Provider Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| staticKeySettings | [StaticKeySettings](#channels-channelid-start-model-statickeysettings) | False |  | 

### LimitExceeded
<a name="channels-channelid-start-model-limitexceeded"></a>


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

### LogLevel
<a name="channels-channelid-start-model-loglevel"></a>

The log level the user wants for their channel.
+ `ERROR`
+ `WARNING`
+ `INFO`
+ `DEBUG`
+ `DISABLED`

### M2tsAbsentInputAudioBehavior
<a name="channels-channelid-start-model-m2tsabsentinputaudiobehavior"></a>

M2ts Absent Input Audio Behavior
+ `DROP`
+ `ENCODE_SILENCE`

### M2tsArib
<a name="channels-channelid-start-model-m2tsarib"></a>

M2ts Arib
+ `DISABLED`
+ `ENABLED`

### M2tsAribCaptionsPidControl
<a name="channels-channelid-start-model-m2tsaribcaptionspidcontrol"></a>

M2ts Arib Captions Pid Control
+ `AUTO`
+ `USE_CONFIGURED`

### M2tsAudioBufferModel
<a name="channels-channelid-start-model-m2tsaudiobuffermodel"></a>

M2ts Audio Buffer Model
+ `ATSC`
+ `DVB`

### M2tsAudioInterval
<a name="channels-channelid-start-model-m2tsaudiointerval"></a>

M2ts Audio Interval
+ `VIDEO_AND_FIXED_INTERVALS`
+ `VIDEO_INTERVAL`

### M2tsAudioStreamType
<a name="channels-channelid-start-model-m2tsaudiostreamtype"></a>

M2ts Audio Stream Type
+ `ATSC`
+ `DVB`

### M2tsBufferModel
<a name="channels-channelid-start-model-m2tsbuffermodel"></a>

M2ts Buffer Model
+ `MULTIPLEX`
+ `NONE`

### M2tsCcDescriptor
<a name="channels-channelid-start-model-m2tsccdescriptor"></a>

M2ts Cc Descriptor
+ `DISABLED`
+ `ENABLED`

### M2tsEbifControl
<a name="channels-channelid-start-model-m2tsebifcontrol"></a>

M2ts Ebif Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsEbpPlacement
<a name="channels-channelid-start-model-m2tsebpplacement"></a>

M2ts Ebp Placement
+ `VIDEO_AND_AUDIO_PIDS`
+ `VIDEO_PID`

### M2tsEsRateInPes
<a name="channels-channelid-start-model-m2tsesrateinpes"></a>

M2ts Es Rate In Pes
+ `EXCLUDE`
+ `INCLUDE`

### M2tsKlv
<a name="channels-channelid-start-model-m2tsklv"></a>

M2ts Klv
+ `NONE`
+ `PASSTHROUGH`

### M2tsNielsenId3Behavior
<a name="channels-channelid-start-model-m2tsnielsenid3behavior"></a>

M2ts Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M2tsPcrControl
<a name="channels-channelid-start-model-m2tspcrcontrol"></a>

M2ts Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M2tsRateMode
<a name="channels-channelid-start-model-m2tsratemode"></a>

M2ts Rate Mode
+ `CBR`
+ `VBR`

### M2tsScte35Control
<a name="channels-channelid-start-model-m2tsscte35control"></a>

M2ts Scte35 Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsSegmentationMarkers
<a name="channels-channelid-start-model-m2tssegmentationmarkers"></a>

M2ts Segmentation Markers
+ `EBP`
+ `EBP_LEGACY`
+ `NONE`
+ `PSI_SEGSTART`
+ `RAI_ADAPT`
+ `RAI_SEGSTART`

### M2tsSegmentationStyle
<a name="channels-channelid-start-model-m2tssegmentationstyle"></a>

M2ts Segmentation Style
+ `MAINTAIN_CADENCE`
+ `RESET_CADENCE`

### M2tsSettings
<a name="channels-channelid-start-model-m2tssettings"></a>

M2ts Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| absentInputAudioBehavior | [M2tsAbsentInputAudioBehavior](#channels-channelid-start-model-m2tsabsentinputaudiobehavior) | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | 
| arib | [M2tsArib](#channels-channelid-start-model-m2tsarib) | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | 
| aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| aribCaptionsPidControl | [M2tsAribCaptionsPidControl](#channels-channelid-start-model-m2tsaribcaptionspidcontrol) | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | 
| audioBufferModel | [M2tsAudioBufferModel](#channels-channelid-start-model-m2tsaudiobuffermodel) | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | 
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| audioStreamType | [M2tsAudioStreamType](#channels-channelid-start-model-m2tsaudiostreamtype) | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | 
| bitrate | integerMinimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. | 
| bufferModel | [M2tsBufferModel](#channels-channelid-start-model-m2tsbuffermodel) | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | 
| ccDescriptor | [M2tsCcDescriptor](#channels-channelid-start-model-m2tsccdescriptor) | False | When set to enabled, generates captionServiceDescriptor in PMT. | 
| dvbNitSettings | [DvbNitSettings](#channels-channelid-start-model-dvbnitsettings) | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | 
| dvbSdtSettings | [DvbSdtSettings](#channels-channelid-start-model-dvbsdtsettings) | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | 
| dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| dvbTdtSettings | [DvbTdtSettings](#channels-channelid-start-model-dvbtdtsettings) | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | 
| dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| ebif | [M2tsEbifControl](#channels-channelid-start-model-m2tsebifcontrol) | False | If set to passthrough, passes any EBIF data from the input source to this output. | 
| ebpAudioInterval | [M2tsAudioInterval](#channels-channelid-start-model-m2tsaudiointerval) | False | When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | 
| ebpLookaheadMs | integerMinimum: 0Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. | 
| ebpPlacement | [M2tsEbpPlacement](#channels-channelid-start-model-m2tsebpplacement) | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | 
| ecmPid | string | False | This field is unused and deprecated. | 
| esRateInPes | [M2tsEsRateInPes](#channels-channelid-start-model-m2tsesrateinpes) | False | Include or exclude the ES Rate field in the PES header. | 
| etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| fragmentTime | numberMinimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. | 
| klv | [M2tsKlv](#channels-channelid-start-model-m2tsklv) | False | If set to passthrough, passes any KLV data from the input source to this output. | 
| klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| nielsenId3Behavior | [M2tsNielsenId3Behavior](#channels-channelid-start-model-m2tsnielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| nullPacketBitrate | numberMinimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pcrControl | [M2tsPcrControl](#channels-channelid-start-model-m2tspcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| rateMode | [M2tsRateMode](#channels-channelid-start-model-m2tsratemode) | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | 
| scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| scte35Control | [M2tsScte35Control](#channels-channelid-start-model-m2tsscte35control) | False | Optionally pass SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| segmentationMarkers | [M2tsSegmentationMarkers](#channels-channelid-start-model-m2tssegmentationmarkers) | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | 
| segmentationStyle | [M2tsSegmentationStyle](#channels-channelid-start-model-m2tssegmentationstyle) | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of \$1segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of \$1segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | 
| segmentationTime | numberMinimum: 1 | False | The length in seconds of each segment. Required unless markers is set to \$1none\$1. | 
| timedMetadataBehavior | [M2tsTimedMetadataBehavior](#channels-channelid-start-model-m2tstimedmetadatabehavior) | False | When set to passthrough, timed metadata will be passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 

### M2tsTimedMetadataBehavior
<a name="channels-channelid-start-model-m2tstimedmetadatabehavior"></a>

M2ts Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8NielsenId3Behavior
<a name="channels-channelid-start-model-m3u8nielsenid3behavior"></a>

M3u8 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8PcrControl
<a name="channels-channelid-start-model-m3u8pcrcontrol"></a>

M3u8 Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M3u8Scte35Behavior
<a name="channels-channelid-start-model-m3u8scte35behavior"></a>

M3u8 Scte35 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8Settings
<a name="channels-channelid-start-model-m3u8settings"></a>

Settings information for the .m3u8 container


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. | 
| ecmPid | string | False | This parameter is unused and deprecated. | 
| nielsenId3Behavior | [M3u8NielsenId3Behavior](#channels-channelid-start-model-m3u8nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pcrControl | [M3u8PcrControl](#channels-channelid-start-model-m3u8pcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| scte35Behavior | [M3u8Scte35Behavior](#channels-channelid-start-model-m3u8scte35behavior) | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| timedMetadataBehavior | [M3u8TimedMetadataBehavior](#channels-channelid-start-model-m3u8timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 

### M3u8TimedMetadataBehavior
<a name="channels-channelid-start-model-m3u8timedmetadatabehavior"></a>

M3u8 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### MaintenanceDay
<a name="channels-channelid-start-model-maintenanceday"></a>

The currently selected maintenance day.
+ `MONDAY`
+ `TUESDAY`
+ `WEDNESDAY`
+ `THURSDAY`
+ `FRIDAY`
+ `SATURDAY`
+ `SUNDAY`

### MaintenanceStatus
<a name="channels-channelid-start-model-maintenancestatus"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-channelid-start-model-maintenanceday) | False | The currently selected maintenance day. | 
| maintenanceDeadline | stringFormat: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. | 
| maintenanceScheduledDate | stringFormat: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. | 
| maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. | 

### MediaPackageGroupSettings
<a name="channels-channelid-start-model-mediapackagegroupsettings"></a>

Media Package Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | MediaPackage channel destination. | 

### MediaPackageOutputDestinationSettings
<a name="channels-channelid-start-model-mediapackageoutputdestinationsettings"></a>

MediaPackage Output Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | stringMinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. | 

### MediaPackageOutputSettings
<a name="channels-channelid-start-model-mediapackageoutputsettings"></a>

Media Package Output Settings

### MotionGraphicsConfiguration
<a name="channels-channelid-start-model-motiongraphicsconfiguration"></a>

Motion Graphics Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| motionGraphicsInsertion | [MotionGraphicsInsertion](#channels-channelid-start-model-motiongraphicsinsertion) | False |  | 
| motionGraphicsSettings | [MotionGraphicsSettings](#channels-channelid-start-model-motiongraphicssettings) | True | Motion Graphics Settings | 

### MotionGraphicsInsertion
<a name="channels-channelid-start-model-motiongraphicsinsertion"></a>

Motion Graphics Insertion
+ `DISABLED`
+ `ENABLED`

### MotionGraphicsSettings
<a name="channels-channelid-start-model-motiongraphicssettings"></a>

Motion Graphics Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| htmlMotionGraphicsSettings | [HtmlMotionGraphicsSettings](#channels-channelid-start-model-htmlmotiongraphicssettings) | False |  | 

### Mp2CodingMode
<a name="channels-channelid-start-model-mp2codingmode"></a>

Mp2 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`

### Mp2Settings
<a name="channels-channelid-start-model-mp2settings"></a>

Mp2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. | 
| codingMode | [Mp2CodingMode](#channels-channelid-start-model-mp2codingmode) | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | 
| sampleRate | number | False | Sample rate in Hz. | 

### Mpeg2AdaptiveQuantization
<a name="channels-channelid-start-model-mpeg2adaptivequantization"></a>

Mpeg2 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `LOW`
+ `MEDIUM`
+ `OFF`

### Mpeg2ColorMetadata
<a name="channels-channelid-start-model-mpeg2colormetadata"></a>

Mpeg2 Color Metadata
+ `IGNORE`
+ `INSERT`

### Mpeg2ColorSpace
<a name="channels-channelid-start-model-mpeg2colorspace"></a>

Mpeg2 Color Space
+ `AUTO`
+ `PASSTHROUGH`

### Mpeg2DisplayRatio
<a name="channels-channelid-start-model-mpeg2displayratio"></a>

Mpeg2 Display Ratio
+ `DISPLAYRATIO16X9`
+ `DISPLAYRATIO4X3`

### Mpeg2FilterSettings
<a name="channels-channelid-start-model-mpeg2filtersettings"></a>

Mpeg2 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-start-model-temporalfiltersettings) | False |  | 

### Mpeg2GopSizeUnits
<a name="channels-channelid-start-model-mpeg2gopsizeunits"></a>

Mpeg2 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### Mpeg2ScanType
<a name="channels-channelid-start-model-mpeg2scantype"></a>

Mpeg2 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### Mpeg2Settings
<a name="channels-channelid-start-model-mpeg2settings"></a>

Mpeg2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [Mpeg2AdaptiveQuantization](#channels-channelid-start-model-mpeg2adaptivequantization) | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-start-model-afdsignaling) | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | 
| colorMetadata | [Mpeg2ColorMetadata](#channels-channelid-start-model-mpeg2colormetadata) | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | 
| colorSpace | [Mpeg2ColorSpace](#channels-channelid-start-model-mpeg2colorspace) | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \$1"MediaLive Features - Video - color space\$1" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | 
| displayAspectRatio | [Mpeg2DisplayRatio](#channels-channelid-start-model-mpeg2displayratio) | False | Sets the pixel aspect ratio for the encode. | 
| filterSettings | [Mpeg2FilterSettings](#channels-channelid-start-model-mpeg2filtersettings) | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | 
| fixedAfd | [FixedAfd](#channels-channelid-start-model-fixedafd) | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | 
| framerateDenominator | integerMinimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| framerateNumerator | integerMinimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| gopClosedCadence | integerMinimum: 0 | False | MPEG2: default is open GOP. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. | 
| gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. | 
| gopSizeUnits | [Mpeg2GopSizeUnits](#channels-channelid-start-model-mpeg2gopsizeunits) | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | 
| scanType | [Mpeg2ScanType](#channels-channelid-start-model-mpeg2scantype) | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | 
| subgopLength | [Mpeg2SubGopLength](#channels-channelid-start-model-mpeg2subgoplength) | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | 
| timecodeInsertion | [Mpeg2TimecodeInsertionBehavior](#channels-channelid-start-model-mpeg2timecodeinsertionbehavior) | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \$1"MediaLive Features - Timecode configuration\$1" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP\$1TIMECODE: Include timecode metadata in the GOP header. | 

### Mpeg2SubGopLength
<a name="channels-channelid-start-model-mpeg2subgoplength"></a>

Mpeg2 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### Mpeg2TimecodeInsertionBehavior
<a name="channels-channelid-start-model-mpeg2timecodeinsertionbehavior"></a>

Mpeg2 Timecode Insertion Behavior
+ `DISABLED`
+ `GOP_TIMECODE`

### MsSmoothGroupSettings
<a name="channels-channelid-start-model-mssmoothgroupsettings"></a>

Ms Smooth Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. | 
| audioOnlyTimecodeControl | [SmoothGroupAudioOnlyTimecodeControl](#channels-channelid-start-model-smoothgroupaudioonlytimecodecontrol) | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | 
| certificateMode | [SmoothGroupCertificateMode](#channels-channelid-start-model-smoothgroupcertificatemode) | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. | 
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | 
| eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. | 
| eventIdMode | [SmoothGroupEventIdMode](#channels-channelid-start-model-smoothgroupeventidmode) | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | 
| eventStopBehavior | [SmoothGroupEventStopBehavior](#channels-channelid-start-model-smoothgroupeventstopbehavior) | False | When set to sendEos, send EOS signal to IIS server when stopping the event | 
| filecacheDuration | integerMinimum: 0 | False | Size in seconds of file cache for streaming outputs. | 
| fragmentLength | integerMinimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. | 
| inputLossAction | [InputLossActionForMsSmoothOut](#channels-channelid-start-model-inputlossactionformssmoothout) | False | Parameter that control output group behavior on input loss. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 
| restartDelay | integerMinimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. | 
| segmentationMode | [SmoothGroupSegmentationMode](#channels-channelid-start-model-smoothgroupsegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| sendDelayMs | integerMinimum: 0Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. | 
| sparseTrackType | [SmoothGroupSparseTrackType](#channels-channelid-start-model-smoothgroupsparsetracktype) | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35\$1WITHOUT\$1SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | 
| streamManifestBehavior | [SmoothGroupStreamManifestBehavior](#channels-channelid-start-model-smoothgroupstreammanifestbehavior) | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | 
| timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. | 
| timestampOffsetMode | [SmoothGroupTimestampOffsetMode](#channels-channelid-start-model-smoothgrouptimestampoffsetmode) | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset | 

### MsSmoothH265PackagingType
<a name="channels-channelid-start-model-mssmoothh265packagingtype"></a>

Ms Smooth H265 Packaging Type
+ `HEV1`
+ `HVC1`

### MsSmoothOutputSettings
<a name="channels-channelid-start-model-mssmoothoutputsettings"></a>

Ms Smooth Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [MsSmoothH265PackagingType](#channels-channelid-start-model-mssmoothh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### MultiplexGroupSettings
<a name="channels-channelid-start-model-multiplexgroupsettings"></a>

Multiplex Group Settings

### MultiplexOutputSettings
<a name="channels-channelid-start-model-multiplexoutputsettings"></a>

Multiplex Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | Destination is a Multiplex. | 

### MultiplexProgramChannelDestinationSettings
<a name="channels-channelid-start-model-multiplexprogramchanneldestinationsettings"></a>

Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | stringMinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. | 
| programName | stringMinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. | 

### NetworkInputServerValidation
<a name="channels-channelid-start-model-networkinputservervalidation"></a>

Network Input Server Validation
+ `CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME`
+ `CHECK_CRYPTOGRAPHY_ONLY`

### NetworkInputSettings
<a name="channels-channelid-start-model-networkinputsettings"></a>

Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsInputSettings | [HlsInputSettings](#channels-channelid-start-model-hlsinputsettings) | False | Specifies HLS input settings when the uri is for a HLS manifest. | 
| serverValidation | [NetworkInputServerValidation](#channels-channelid-start-model-networkinputservervalidation) | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. | 

### NielsenCBET
<a name="channels-channelid-start-model-nielsencbet"></a>

Nielsen CBET


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cbetCheckDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. | 
| cbetStepaside | [NielsenWatermarksCbetStepaside](#channels-channelid-start-model-nielsenwatermarkscbetstepaside) | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | 
| csid | stringMinLength: 1MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark | 

### NielsenConfiguration
<a name="channels-channelid-start-model-nielsenconfiguration"></a>

Nielsen Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. | 
| nielsenPcmToId3Tagging | [NielsenPcmToId3TaggingState](#channels-channelid-start-model-nielsenpcmtoid3taggingstate) | False | Enables Nielsen PCM to ID3 tagging | 

### NielsenNaesIiNw
<a name="channels-channelid-start-model-nielsennaesiinw"></a>

Nielsen Naes Ii Nw


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| checkDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the check digit string for the watermark | 
| sid | numberMinimum: 1Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark | 

### NielsenPcmToId3TaggingState
<a name="channels-channelid-start-model-nielsenpcmtoid3taggingstate"></a>

State of Nielsen PCM to ID3 tagging
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksCbetStepaside
<a name="channels-channelid-start-model-nielsenwatermarkscbetstepaside"></a>

Nielsen Watermarks Cbet Stepaside
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksDistributionTypes
<a name="channels-channelid-start-model-nielsenwatermarksdistributiontypes"></a>

Nielsen Watermarks Distribution Types
+ `FINAL_DISTRIBUTOR`
+ `PROGRAM_CONTENT`

### NielsenWatermarksSettings
<a name="channels-channelid-start-model-nielsenwatermarkssettings"></a>

Nielsen Watermarks Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenCbetSettings | [NielsenCBET](#channels-channelid-start-model-nielsencbet) | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | 
| nielsenDistributionType | [NielsenWatermarksDistributionTypes](#channels-channelid-start-model-nielsenwatermarksdistributiontypes) | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM\$1CONTENT - FINAL\$1DISTRIBUTOR | 
| nielsenNaesIiNwSettings | [NielsenNaesIiNw](#channels-channelid-start-model-nielsennaesiinw) | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). | 

### Output
<a name="channels-channelid-start-model-output"></a>

Output settings. There can be multiple outputs within a group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. | 
| captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. | 
| outputName | stringMinLength: 1MaxLength: 255 | False | The name used to identify an output. | 
| outputSettings | [OutputSettings](#channels-channelid-start-model-outputsettings) | True | Output type-specific settings. | 
| videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. | 

### OutputDestination
<a name="channels-channelid-start-model-outputdestination"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | User-specified id. This is used in an output group or an output. | 
| mediaPackageSettings | Array of type [MediaPackageOutputDestinationSettings](#channels-channelid-start-model-mediapackageoutputdestinationsettings) | False | Destination settings for a MediaPackage output; one destination for both encoders. | 
| multiplexSettings | [MultiplexProgramChannelDestinationSettings](#channels-channelid-start-model-multiplexprogramchanneldestinationsettings) | False | Destination settings for a Multiplex output; one destination for both encoders. | 
| settings | Array of type [OutputDestinationSettings](#channels-channelid-start-model-outputdestinationsettings) | False | Destination settings for a standard output; one destination for each redundant encoder. | 

### OutputDestinationSettings
<a name="channels-channelid-start-model-outputdestinationsettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) | 
| url | string | False | A URL specifying a destination | 
| username | string | False | username for destination | 

### OutputGroup
<a name="channels-channelid-start-model-outputgroup"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. | 
| outputGroupSettings | [OutputGroupSettings](#channels-channelid-start-model-outputgroupsettings) | True | Settings associated with the output group. | 
| outputs | Array of type [Output](#channels-channelid-start-model-output) | True |  | 

### OutputGroupSettings
<a name="channels-channelid-start-model-outputgroupsettings"></a>

Output Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveGroupSettings | [ArchiveGroupSettings](#channels-channelid-start-model-archivegroupsettings) | False |  | 
| frameCaptureGroupSettings | [FrameCaptureGroupSettings](#channels-channelid-start-model-framecapturegroupsettings) | False |  | 
| hlsGroupSettings | [HlsGroupSettings](#channels-channelid-start-model-hlsgroupsettings) | False |  | 
| mediaPackageGroupSettings | [MediaPackageGroupSettings](#channels-channelid-start-model-mediapackagegroupsettings) | False |  | 
| msSmoothGroupSettings | [MsSmoothGroupSettings](#channels-channelid-start-model-mssmoothgroupsettings) | False |  | 
| multiplexGroupSettings | [MultiplexGroupSettings](#channels-channelid-start-model-multiplexgroupsettings) | False |  | 
| rtmpGroupSettings | [RtmpGroupSettings](#channels-channelid-start-model-rtmpgroupsettings) | False |  | 
| udpGroupSettings | [UdpGroupSettings](#channels-channelid-start-model-udpgroupsettings) | False |  | 

### OutputLocationRef
<a name="channels-channelid-start-model-outputlocationref"></a>

Reference to an OutputDestination ID defined in the channel


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

### OutputSettings
<a name="channels-channelid-start-model-outputsettings"></a>

Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveOutputSettings | [ArchiveOutputSettings](#channels-channelid-start-model-archiveoutputsettings) | False |  | 
| frameCaptureOutputSettings | [FrameCaptureOutputSettings](#channels-channelid-start-model-framecaptureoutputsettings) | False |  | 
| hlsOutputSettings | [HlsOutputSettings](#channels-channelid-start-model-hlsoutputsettings) | False |  | 
| mediaPackageOutputSettings | [MediaPackageOutputSettings](#channels-channelid-start-model-mediapackageoutputsettings) | False |  | 
| msSmoothOutputSettings | [MsSmoothOutputSettings](#channels-channelid-start-model-mssmoothoutputsettings) | False |  | 
| multiplexOutputSettings | [MultiplexOutputSettings](#channels-channelid-start-model-multiplexoutputsettings) | False |  | 
| rtmpOutputSettings | [RtmpOutputSettings](#channels-channelid-start-model-rtmpoutputsettings) | False |  | 
| udpOutputSettings | [UdpOutputSettings](#channels-channelid-start-model-udpoutputsettings) | False |  | 

### PassThroughSettings
<a name="channels-channelid-start-model-passthroughsettings"></a>

Pass Through Settings

### PipelineDetail
<a name="channels-channelid-start-model-pipelinedetail"></a>

Runtime details of a pipeline when a channel is running.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. | 
| activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. | 
| activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. | 
| activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. | 
| pipelineId | string | False | Pipeline ID | 

### RawSettings
<a name="channels-channelid-start-model-rawsettings"></a>

Raw Settings

### Rec601Settings
<a name="channels-channelid-start-model-rec601settings"></a>

Rec601 Settings

### Rec709Settings
<a name="channels-channelid-start-model-rec709settings"></a>

Rec709 Settings

### RemixSettings
<a name="channels-channelid-start-model-remixsettings"></a>

Remix Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelMappings | Array of type [AudioChannelMapping](#channels-channelid-start-model-audiochannelmapping) | True | Mapping of input channels to output channels, with appropriate gain adjustments. | 
| channelsIn | integerMinimum: 1Maximum: 16 | False | Number of input channels to be used. | 
| channelsOut | integerMinimum: 1Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 | 

### ResourceConflict
<a name="channels-channelid-start-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="channels-channelid-start-model-resourcenotfound"></a>


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

### RtmpAdMarkers
<a name="channels-channelid-start-model-rtmpadmarkers"></a>

Rtmp Ad Markers
+ `ON_CUE_POINT_SCTE35`

### RtmpCacheFullBehavior
<a name="channels-channelid-start-model-rtmpcachefullbehavior"></a>

Rtmp Cache Full Behavior
+ `DISCONNECT_IMMEDIATELY`
+ `WAIT_FOR_SERVER`

### RtmpCaptionData
<a name="channels-channelid-start-model-rtmpcaptiondata"></a>

Rtmp Caption Data
+ `ALL`
+ `FIELD1_608`
+ `FIELD1_AND_FIELD2_608`

### RtmpCaptionInfoDestinationSettings
<a name="channels-channelid-start-model-rtmpcaptioninfodestinationsettings"></a>

Rtmp Caption Info Destination Settings

### RtmpGroupSettings
<a name="channels-channelid-start-model-rtmpgroupsettings"></a>

Rtmp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [RtmpAdMarkers](#channels-channelid-start-model-rtmpadmarkers) | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. | 
| authenticationScheme | [AuthenticationScheme](#channels-channelid-start-model-authenticationscheme) | False | Authentication scheme to use when connecting with CDN | 
| cacheFullBehavior | [RtmpCacheFullBehavior](#channels-channelid-start-model-rtmpcachefullbehavior) | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | 
| cacheLength | integerMinimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. | 
| captionData | [RtmpCaptionData](#channels-channelid-start-model-rtmpcaptiondata) | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | 
| inputLossAction | [InputLossActionForRtmpOut](#channels-channelid-start-model-inputlossactionforrtmpout) | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | 
| restartDelay | integerMinimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### RtmpOutputCertificateMode
<a name="channels-channelid-start-model-rtmpoutputcertificatemode"></a>

Rtmp Output Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### RtmpOutputSettings
<a name="channels-channelid-start-model-rtmpoutputsettings"></a>

Rtmp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| certificateMode | [RtmpOutputCertificateMode](#channels-channelid-start-model-rtmpoutputcertificatemode) | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. | 
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 

### S3CannedAcl
<a name="channels-channelid-start-model-s3cannedacl"></a>

S3 Canned Acl
+ `AUTHENTICATED_READ`
+ `BUCKET_OWNER_FULL_CONTROL`
+ `BUCKET_OWNER_READ`
+ `PUBLIC_READ`

### Scte20Convert608To708
<a name="channels-channelid-start-model-scte20convert608to708"></a>

Scte20 Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### Scte20PlusEmbeddedDestinationSettings
<a name="channels-channelid-start-model-scte20plusembeddeddestinationsettings"></a>

Scte20 Plus Embedded Destination Settings

### Scte20SourceSettings
<a name="channels-channelid-start-model-scte20sourcesettings"></a>

Scte20 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [Scte20Convert608To708](#channels-channelid-start-model-scte20convert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 

### Scte27DestinationSettings
<a name="channels-channelid-start-model-scte27destinationsettings"></a>

Scte27 Destination Settings

### Scte27OcrLanguage
<a name="channels-channelid-start-model-scte27ocrlanguage"></a>

Scte27 Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### Scte27SourceSettings
<a name="channels-channelid-start-model-scte27sourcesettings"></a>

Scte27 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [Scte27OcrLanguage](#channels-channelid-start-model-scte27ocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. | 

### Scte35AposNoRegionalBlackoutBehavior
<a name="channels-channelid-start-model-scte35aposnoregionalblackoutbehavior"></a>

Scte35 Apos No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35AposWebDeliveryAllowedBehavior
<a name="channels-channelid-start-model-scte35aposwebdeliveryallowedbehavior"></a>

Scte35 Apos Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsert
<a name="channels-channelid-start-model-scte35spliceinsert"></a>

Scte35 Splice Insert


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35SpliceInsertNoRegionalBlackoutBehavior](#channels-channelid-start-model-scte35spliceinsertnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35SpliceInsertWebDeliveryAllowedBehavior](#channels-channelid-start-model-scte35spliceinsertwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### Scte35SpliceInsertNoRegionalBlackoutBehavior
<a name="channels-channelid-start-model-scte35spliceinsertnoregionalblackoutbehavior"></a>

Scte35 Splice Insert No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsertWebDeliveryAllowedBehavior
<a name="channels-channelid-start-model-scte35spliceinsertwebdeliveryallowedbehavior"></a>

Scte35 Splice Insert Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35TimeSignalApos
<a name="channels-channelid-start-model-scte35timesignalapos"></a>

Scte35 Time Signal Apos


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35AposNoRegionalBlackoutBehavior](#channels-channelid-start-model-scte35aposnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35AposWebDeliveryAllowedBehavior](#channels-channelid-start-model-scte35aposwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### SmoothGroupAudioOnlyTimecodeControl
<a name="channels-channelid-start-model-smoothgroupaudioonlytimecodecontrol"></a>

Smooth Group Audio Only Timecode Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED_CLOCK`

### SmoothGroupCertificateMode
<a name="channels-channelid-start-model-smoothgroupcertificatemode"></a>

Smooth Group Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### SmoothGroupEventIdMode
<a name="channels-channelid-start-model-smoothgroupeventidmode"></a>

Smooth Group Event Id Mode
+ `NO_EVENT_ID`
+ `USE_CONFIGURED`
+ `USE_TIMESTAMP`

### SmoothGroupEventStopBehavior
<a name="channels-channelid-start-model-smoothgroupeventstopbehavior"></a>

Smooth Group Event Stop Behavior
+ `NONE`
+ `SEND_EOS`

### SmoothGroupSegmentationMode
<a name="channels-channelid-start-model-smoothgroupsegmentationmode"></a>

Smooth Group Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### SmoothGroupSparseTrackType
<a name="channels-channelid-start-model-smoothgroupsparsetracktype"></a>

Smooth Group Sparse Track Type
+ `NONE`
+ `SCTE_35`
+ `SCTE_35_WITHOUT_SEGMENTATION`

### SmoothGroupStreamManifestBehavior
<a name="channels-channelid-start-model-smoothgroupstreammanifestbehavior"></a>

Smooth Group Stream Manifest Behavior
+ `DO_NOT_SEND`
+ `SEND`

### SmoothGroupTimestampOffsetMode
<a name="channels-channelid-start-model-smoothgrouptimestampoffsetmode"></a>

Smooth Group Timestamp Offset Mode
+ `USE_CONFIGURED_OFFSET`
+ `USE_EVENT_START_DATE`

### Smpte2038DataPreference
<a name="channels-channelid-start-model-smpte2038datapreference"></a>

Smpte2038 Data Preference
+ `IGNORE`
+ `PREFER`

### SmpteTtDestinationSettings
<a name="channels-channelid-start-model-smptettdestinationsettings"></a>

Smpte Tt Destination Settings

### StandardHlsSettings
<a name="channels-channelid-start-model-standardhlssettings"></a>

Standard Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| m3u8Settings | [M3u8Settings](#channels-channelid-start-model-m3u8settings) | True |  | 

### StaticKeySettings
<a name="channels-channelid-start-model-statickeysettings"></a>

Static Key Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| keyProviderServer | [InputLocation](#channels-channelid-start-model-inputlocation) | False | The URL of the license server used for protecting content. | 
| staticKeyValue | stringMinLength: 32MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. | 

### Tags
<a name="channels-channelid-start-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TeletextDestinationSettings
<a name="channels-channelid-start-model-teletextdestinationsettings"></a>

Teletext Destination Settings

### TeletextSourceSettings
<a name="channels-channelid-start-model-teletextsourcesettings"></a>

Teletext Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputRectangle | [CaptionRectangle](#channels-channelid-start-model-captionrectangle) | False | Optionally defines a region where TTML style captions will be displayed | 
| pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. | 

### TemporalFilterPostFilterSharpening
<a name="channels-channelid-start-model-temporalfilterpostfiltersharpening"></a>

Temporal Filter Post Filter Sharpening
+ `AUTO`
+ `DISABLED`
+ `ENABLED`

### TemporalFilterSettings
<a name="channels-channelid-start-model-temporalfiltersettings"></a>

Temporal Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| postFilterSharpening | [TemporalFilterPostFilterSharpening](#channels-channelid-start-model-temporalfilterpostfiltersharpening) | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | 
| strength | [TemporalFilterStrength](#channels-channelid-start-model-temporalfilterstrength) | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. | 

### TemporalFilterStrength
<a name="channels-channelid-start-model-temporalfilterstrength"></a>

Temporal Filter Strength
+ `AUTO`
+ `STRENGTH_1`
+ `STRENGTH_2`
+ `STRENGTH_3`
+ `STRENGTH_4`
+ `STRENGTH_5`
+ `STRENGTH_6`
+ `STRENGTH_7`
+ `STRENGTH_8`
+ `STRENGTH_9`
+ `STRENGTH_10`
+ `STRENGTH_11`
+ `STRENGTH_12`
+ `STRENGTH_13`
+ `STRENGTH_14`
+ `STRENGTH_15`
+ `STRENGTH_16`

### TimecodeConfig
<a name="channels-channelid-start-model-timecodeconfig"></a>

Timecode Config


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| source | [TimecodeConfigSource](#channels-channelid-start-model-timecodeconfigsource) | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | 
| syncThreshold | integerMinimum: 1Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. | 

### TimecodeConfigSource
<a name="channels-channelid-start-model-timecodeconfigsource"></a>

Timecode Config Source
+ `EMBEDDED`
+ `SYSTEMCLOCK`
+ `ZEROBASED`

### TtmlDestinationSettings
<a name="channels-channelid-start-model-ttmldestinationsettings"></a>

Ttml Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [TtmlDestinationStyleControl](#channels-channelid-start-model-ttmldestinationstylecontrol) | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. | 

### TtmlDestinationStyleControl
<a name="channels-channelid-start-model-ttmldestinationstylecontrol"></a>

Ttml Destination Style Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED`

### UdpContainerSettings
<a name="channels-channelid-start-model-udpcontainersettings"></a>

Udp Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-start-model-m2tssettings) | False |  | 

### UdpGroupSettings
<a name="channels-channelid-start-model-udpgroupsettings"></a>

Udp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossAction | [InputLossActionForUdpOut](#channels-channelid-start-model-inputlossactionforudpout) | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | 
| timedMetadataId3Frame | [UdpTimedMetadataId3Frame](#channels-channelid-start-model-udptimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 

### UdpOutputSettings
<a name="channels-channelid-start-model-udpoutputsettings"></a>

Udp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bufferMsec | integerMinimum: 0Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. | 
| containerSettings | [UdpContainerSettings](#channels-channelid-start-model-udpcontainersettings) | True |  | 
| destination | [OutputLocationRef](#channels-channelid-start-model-outputlocationref) | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | 
| fecOutputSettings | [FecOutputSettings](#channels-channelid-start-model-fecoutputsettings) | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. | 

### UdpTimedMetadataId3Frame
<a name="channels-channelid-start-model-udptimedmetadataid3frame"></a>

Udp Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### VideoBlackFailoverSettings
<a name="channels-channelid-start-model-videoblackfailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackDetectThreshold | numberMinimum: 0Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\$10.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\$10.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. | 
| videoBlackThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. | 

### VideoCodecSettings
<a name="channels-channelid-start-model-videocodecsettings"></a>

Video Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureSettings | [FrameCaptureSettings](#channels-channelid-start-model-framecapturesettings) | False |  | 
| h264Settings | [H264Settings](#channels-channelid-start-model-h264settings) | False |  | 
| h265Settings | [H265Settings](#channels-channelid-start-model-h265settings) | False |  | 
| mpeg2Settings | [Mpeg2Settings](#channels-channelid-start-model-mpeg2settings) | False |  | 

### VideoDescription
<a name="channels-channelid-start-model-videodescription"></a>

Video settings for this stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codecSettings | [VideoCodecSettings](#channels-channelid-start-model-videocodecsettings) | False | Video codec settings. | 
| height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 
| name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. | 
| respondToAfd | [VideoDescriptionRespondToAfd](#channels-channelid-start-model-videodescriptionrespondtoafd) | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME\$1CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | 
| scalingBehavior | [VideoDescriptionScalingBehavior](#channels-channelid-start-model-videodescriptionscalingbehavior) | False | STRETCH\$1TO\$1OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | 
| sharpness | integerMinimum: 0Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. | 
| width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 

### VideoDescriptionRespondToAfd
<a name="channels-channelid-start-model-videodescriptionrespondtoafd"></a>

Video Description Respond To Afd
+ `NONE`
+ `PASSTHROUGH`
+ `RESPOND`

### VideoDescriptionScalingBehavior
<a name="channels-channelid-start-model-videodescriptionscalingbehavior"></a>

Video Description Scaling Behavior
+ `DEFAULT`
+ `STRETCH_TO_OUTPUT`

### VideoSelector
<a name="channels-channelid-start-model-videoselector"></a>

Specifies a particular video stream within an input source. An input may have only a single video selector.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpace | [VideoSelectorColorSpace](#channels-channelid-start-model-videoselectorcolorspace) | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | 
| colorSpaceSettings | [VideoSelectorColorSpaceSettings](#channels-channelid-start-model-videoselectorcolorspacesettings) | False | Color space settings | 
| colorSpaceUsage | [VideoSelectorColorSpaceUsage](#channels-channelid-start-model-videoselectorcolorspaceusage) | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | 
| selectorSettings | [VideoSelectorSettings](#channels-channelid-start-model-videoselectorsettings) | False | The video selector settings. | 

### VideoSelectorColorSpace
<a name="channels-channelid-start-model-videoselectorcolorspace"></a>

Video Selector Color Space
+ `FOLLOW`
+ `HDR10`
+ `HLG_2020`
+ `REC_601`
+ `REC_709`

### VideoSelectorColorSpaceSettings
<a name="channels-channelid-start-model-videoselectorcolorspacesettings"></a>

Video Selector Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hdr10Settings | [Hdr10Settings](#channels-channelid-start-model-hdr10settings) | False |  | 

### VideoSelectorColorSpaceUsage
<a name="channels-channelid-start-model-videoselectorcolorspaceusage"></a>

Video Selector Color Space Usage
+ `FALLBACK`
+ `FORCE`

### VideoSelectorPid
<a name="channels-channelid-start-model-videoselectorpid"></a>

Video Selector Pid


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | False | Selects a specific PID from within a video source. | 

### VideoSelectorProgramId
<a name="channels-channelid-start-model-videoselectorprogramid"></a>

Video Selector Program Id


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| programId | integerMinimum: 0Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. | 

### VideoSelectorSettings
<a name="channels-channelid-start-model-videoselectorsettings"></a>

Video Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| videoSelectorPid | [VideoSelectorPid](#channels-channelid-start-model-videoselectorpid) | False |  | 
| videoSelectorProgramId | [VideoSelectorProgramId](#channels-channelid-start-model-videoselectorprogramid) | False |  | 

### VpcOutputSettingsDescription
<a name="channels-channelid-start-model-vpcoutputsettingsdescription"></a>

The properties for a private VPC Output 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet.  | 
| networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC  | 
| securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.  | 
| subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### WavCodingMode
<a name="channels-channelid-start-model-wavcodingmode"></a>

Wav Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_4_0`
+ `CODING_MODE_8_0`

### WavSettings
<a name="channels-channelid-start-model-wavsettings"></a>

Wav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitDepth | number | False | Bits per sample. | 
| codingMode | [WavCodingMode](#channels-channelid-start-model-wavcodingmode) | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | 
| sampleRate | number | False | Sample rate in Hz. | 

### WebvttDestinationSettings
<a name="channels-channelid-start-model-webvttdestinationsettings"></a>

Webvtt Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [WebvttDestinationStyleControl](#channels-channelid-start-model-webvttdestinationstylecontrol) | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\$1STYLE\$1DATA - Don't pass through the style. The output captions will not contain any font styling information. | 

### WebvttDestinationStyleControl
<a name="channels-channelid-start-model-webvttdestinationstylecontrol"></a>

Webvtt Destination Style Control
+ `NO_STYLE_DATA`
+ `PASSTHROUGH`

## See also
<a name="channels-channelid-start-see-also"></a>

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

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

# Channels: stop
<a name="channels-channelid-stop"></a>

## URI
<a name="channels-channelid-stop-url"></a>

`/prod/channels/channelId/stop`

## HTTP methods
<a name="channels-channelid-stop-http-methods"></a>

### POST
<a name="channels-channelid-stoppost"></a>

**Operation ID:** `StopChannel`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | String | True |  | 


**Responses**  

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

## Schemas
<a name="channels-channelid-stop-schemas"></a>

### Response bodies
<a name="channels-channelid-stop-response-examples"></a>

#### Channel schema
<a name="channels-channelid-stop-response-body-channel-example"></a>

```
{
  "arn": "string",
  "cdiInputSpecification": {
    "resolution": enum
  },
  "channelClass": enum,
  "destinations": [
    {
      "id": "string",
      "mediaPackageSettings": [
        {
          "channelId": "string"
        }
      ],
      "multiplexSettings": {
        "multiplexId": "string",
        "programName": "string"
      },
      "settings": [
        {
          "passwordParam": "string",
          "streamName": "string",
          "url": "string",
          "username": "string"
        }
      ]
    }
  ],
  "egressEndpoints": [
    {
      "sourceIp": "string"
    }
  ],
  "encoderSettings": {
    "audioDescriptions": [
      {
        "audioNormalizationSettings": {
          "algorithm": enum,
          "algorithmControl": enum,
          "targetLkfs": number
        },
        "audioSelectorName": "string",
        "audioType": enum,
        "audioTypeControl": enum,
        "audioWatermarkingSettings": {
          "nielsenWatermarksSettings": {
            "nielsenCbetSettings": {
              "cbetCheckDigitString": "string",
              "cbetStepaside": enum,
              "csid": "string"
            },
            "nielsenDistributionType": enum,
            "nielsenNaesIiNwSettings": {
              "checkDigitString": "string",
              "sid": number
            }
          }
        },
        "codecSettings": {
          "aacSettings": {
            "bitrate": number,
            "codingMode": enum,
            "inputType": enum,
            "profile": enum,
            "rateControlMode": enum,
            "rawFormat": enum,
            "sampleRate": number,
            "spec": enum,
            "vbrQuality": enum
          },
          "ac3Settings": {
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dialnorm": integer,
            "drcProfile": enum,
            "lfeFilter": enum,
            "metadataControl": enum
          },
          "eac3Settings": {
            "attenuationControl": enum,
            "bitrate": number,
            "bitstreamMode": enum,
            "codingMode": enum,
            "dcFilter": enum,
            "dialnorm": integer,
            "drcLine": enum,
            "drcRf": enum,
            "lfeControl": enum,
            "lfeFilter": enum,
            "loRoCenterMixLevel": number,
            "loRoSurroundMixLevel": number,
            "ltRtCenterMixLevel": number,
            "ltRtSurroundMixLevel": number,
            "metadataControl": enum,
            "passthroughControl": enum,
            "phaseControl": enum,
            "stereoDownmix": enum,
            "surroundExMode": enum,
            "surroundMode": enum
          },
          "mp2Settings": {
            "bitrate": number,
            "codingMode": enum,
            "sampleRate": number
          },
          "passThroughSettings": {
          },
          "wavSettings": {
            "bitDepth": number,
            "codingMode": enum,
            "sampleRate": number
          }
        },
        "languageCode": "string",
        "languageCodeControl": enum,
        "name": "string",
        "remixSettings": {
          "channelMappings": [
            {
              "inputChannelLevels": [
                {
                  "gain": integer,
                  "inputChannel": integer
                }
              ],
              "outputChannel": integer
            }
          ],
          "channelsIn": integer,
          "channelsOut": integer
        },
        "streamName": "string"
      }
    ],
    "availBlanking": {
      "availBlankingImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "state": enum
    },
    "availConfiguration": {
      "availSettings": {
        "scte35SpliceInsert": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        },
        "scte35TimeSignalApos": {
          "adAvailOffset": integer,
          "noRegionalBlackoutFlag": enum,
          "webDeliveryAllowedFlag": enum
        }
      }
    },
    "blackoutSlate": {
      "blackoutSlateImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkEndBlackout": enum,
      "networkEndBlackoutImage": {
        "passwordParam": "string",
        "uri": "string",
        "username": "string"
      },
      "networkId": "string",
      "state": enum
    },
    "captionDescriptions": [
      {
        "captionSelectorName": "string",
        "destinationSettings": {
          "aribDestinationSettings": {
          },
          "burnInDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "dvbSubDestinationSettings": {
            "alignment": enum,
            "backgroundColor": enum,
            "backgroundOpacity": integer,
            "font": {
              "passwordParam": "string",
              "uri": "string",
              "username": "string"
            },
            "fontColor": enum,
            "fontOpacity": integer,
            "fontResolution": integer,
            "fontSize": "string",
            "outlineColor": enum,
            "outlineSize": integer,
            "shadowColor": enum,
            "shadowOpacity": integer,
            "shadowXOffset": integer,
            "shadowYOffset": integer,
            "teletextGridControl": enum,
            "xPosition": integer,
            "yPosition": integer
          },
          "ebuTtDDestinationSettings": {
            "copyrightHolder": "string",
            "fillLineGap": enum,
            "fontFamily": "string",
            "styleControl": enum
          },
          "embeddedDestinationSettings": {
          },
          "embeddedPlusScte20DestinationSettings": {
          },
          "rtmpCaptionInfoDestinationSettings": {
          },
          "scte20PlusEmbeddedDestinationSettings": {
          },
          "scte27DestinationSettings": {
          },
          "smpteTtDestinationSettings": {
          },
          "teletextDestinationSettings": {
          },
          "ttmlDestinationSettings": {
            "styleControl": enum
          },
          "webvttDestinationSettings": {
            "styleControl": enum
          }
        },
        "languageCode": "string",
        "languageDescription": "string",
        "name": "string"
      }
    ],
    "featureActivations": {
      "inputPrepareScheduleActions": enum
    },
    "globalConfiguration": {
      "initialAudioGain": integer,
      "inputEndAction": enum,
      "inputLossBehavior": {
        "blackFrameMsec": integer,
        "inputLossImageColor": "string",
        "inputLossImageSlate": {
          "passwordParam": "string",
          "uri": "string",
          "username": "string"
        },
        "inputLossImageType": enum,
        "repeatFrameMsec": integer
      },
      "outputLockingMode": enum,
      "outputTimingSource": enum,
      "supportLowFramerateInputs": enum
    },
    "motionGraphicsConfiguration": {
      "motionGraphicsInsertion": enum,
      "motionGraphicsSettings": {
        "htmlMotionGraphicsSettings": {
        }
      }
    },
    "nielsenConfiguration": {
      "distributorId": "string",
      "nielsenPcmToId3Tagging": enum
    },
    "outputGroups": [
      {
        "name": "string",
        "outputGroupSettings": {
          "archiveGroupSettings": {
            "archiveCdnSettings": {
              "archiveS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            },
            "destination": {
              "destinationRefId": "string"
            },
            "rolloverInterval": integer
          },
          "frameCaptureGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            },
            "frameCaptureCdnSettings": {
              "frameCaptureS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              }
            }
          },
          "hlsGroupSettings": {
            "adMarkers": [
              enum
            ],
            "baseUrlContent": "string",
            "baseUrlContent1": "string",
            "baseUrlManifest": "string",
            "baseUrlManifest1": "string",
            "captionLanguageMappings": [
              {
                "captionChannel": integer,
                "languageCode": "string",
                "languageDescription": "string"
              }
            ],
            "captionLanguageSetting": enum,
            "clientCache": enum,
            "codecSpecification": enum,
            "constantIv": "string",
            "destination": {
              "destinationRefId": "string"
            },
            "directoryStructure": enum,
            "discontinuityTags": enum,
            "encryptionType": enum,
            "hlsCdnSettings": {
              "hlsAkamaiSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer,
                "salt": "string",
                "token": "string"
              },
              "hlsBasicPutSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsMediaStoreSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "mediaStoreStorageClass": enum,
                "numRetries": integer,
                "restartDelay": integer
              },
              "hlsS3Settings": {
                "cannedAcl": enum,
                "logUploads": enum
              },
              "hlsWebdavSettings": {
                "connectionRetryInterval": integer,
                "filecacheDuration": integer,
                "httpTransferMode": enum,
                "numRetries": integer,
                "restartDelay": integer
              }
            },
            "hlsId3SegmentTagging": enum,
            "iFrameOnlyPlaylists": enum,
            "incompleteSegmentBehavior": enum,
            "indexNSegments": integer,
            "inputLossAction": enum,
            "ivInManifest": enum,
            "ivSource": enum,
            "keepSegments": integer,
            "keyFormat": "string",
            "keyFormatVersions": "string",
            "keyProviderSettings": {
              "staticKeySettings": {
                "keyProviderServer": {
                  "passwordParam": "string",
                  "uri": "string",
                  "username": "string"
                },
                "staticKeyValue": "string"
              }
            },
            "manifestCompression": enum,
            "manifestDurationFormat": enum,
            "minSegmentLength": integer,
            "mode": enum,
            "outputSelection": enum,
            "programDateTime": enum,
            "programDateTimeClock": enum,
            "programDateTimePeriod": integer,
            "redundantManifest": enum,
            "segmentLength": integer,
            "segmentationMode": enum,
            "segmentsPerSubdirectory": integer,
            "streamInfResolution": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer,
            "timestampDeltaMilliseconds": integer,
            "tsFileMode": enum
          },
          "mediaPackageGroupSettings": {
            "destination": {
              "destinationRefId": "string"
            }
          },
          "msSmoothGroupSettings": {
            "acquisitionPointId": "string",
            "audioOnlyTimecodeControl": enum,
            "certificateMode": enum,
            "connectionRetryInterval": integer,
            "destination": {
              "destinationRefId": "string"
            },
            "eventId": "string",
            "eventIdMode": enum,
            "eventStopBehavior": enum,
            "filecacheDuration": integer,
            "fragmentLength": integer,
            "inputLossAction": enum,
            "numRetries": integer,
            "restartDelay": integer,
            "segmentationMode": enum,
            "sendDelayMs": integer,
            "sparseTrackType": enum,
            "streamManifestBehavior": enum,
            "timestampOffset": "string",
            "timestampOffsetMode": enum
          },
          "multiplexGroupSettings": {
          },
          "rtmpGroupSettings": {
            "adMarkers": [
              enum
            ],
            "authenticationScheme": enum,
            "cacheFullBehavior": enum,
            "cacheLength": integer,
            "captionData": enum,
            "inputLossAction": enum,
            "restartDelay": integer
          },
          "udpGroupSettings": {
            "inputLossAction": enum,
            "timedMetadataId3Frame": enum,
            "timedMetadataId3Period": integer
          }
        },
        "outputs": [
          {
            "audioDescriptionNames": [
              "string"
            ],
            "captionDescriptionNames": [
              "string"
            ],
            "outputName": "string",
            "outputSettings": {
              "archiveOutputSettings": {
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  },
                  "rawSettings": {
                  }
                },
                "extension": "string",
                "nameModifier": "string"
              },
              "frameCaptureOutputSettings": {
                "nameModifier": "string"
              },
              "hlsOutputSettings": {
                "h265PackagingType": enum,
                "hlsSettings": {
                  "audioOnlyHlsSettings": {
                    "audioGroupId": "string",
                    "audioOnlyImage": {
                      "passwordParam": "string",
                      "uri": "string",
                      "username": "string"
                    },
                    "audioTrackType": enum,
                    "segmentType": enum
                  },
                  "fmp4HlsSettings": {
                    "audioRenditionSets": "string",
                    "nielsenId3Behavior": enum,
                    "timedMetadataBehavior": enum
                  },
                  "frameCaptureHlsSettings": {
                  },
                  "standardHlsSettings": {
                    "audioRenditionSets": "string",
                    "m3u8Settings": {
                      "audioFramesPerPes": integer,
                      "audioPids": "string",
                      "ecmPid": "string",
                      "nielsenId3Behavior": enum,
                      "patInterval": integer,
                      "pcrControl": enum,
                      "pcrPeriod": integer,
                      "pcrPid": "string",
                      "pmtInterval": integer,
                      "pmtPid": "string",
                      "programNum": integer,
                      "scte35Behavior": enum,
                      "scte35Pid": "string",
                      "timedMetadataBehavior": enum,
                      "timedMetadataPid": "string",
                      "transportStreamId": integer,
                      "videoPid": "string"
                    }
                  }
                },
                "nameModifier": "string",
                "segmentModifier": "string"
              },
              "mediaPackageOutputSettings": {
              },
              "msSmoothOutputSettings": {
                "h265PackagingType": enum,
                "nameModifier": "string"
              },
              "multiplexOutputSettings": {
                "destination": {
                  "destinationRefId": "string"
                }
              },
              "rtmpOutputSettings": {
                "certificateMode": enum,
                "connectionRetryInterval": integer,
                "destination": {
                  "destinationRefId": "string"
                },
                "numRetries": integer
              },
              "udpOutputSettings": {
                "bufferMsec": integer,
                "containerSettings": {
                  "m2tsSettings": {
                    "absentInputAudioBehavior": enum,
                    "arib": enum,
                    "aribCaptionsPid": "string",
                    "aribCaptionsPidControl": enum,
                    "audioBufferModel": enum,
                    "audioFramesPerPes": integer,
                    "audioPids": "string",
                    "audioStreamType": enum,
                    "bitrate": integer,
                    "bufferModel": enum,
                    "ccDescriptor": enum,
                    "dvbNitSettings": {
                      "networkId": integer,
                      "networkName": "string",
                      "repInterval": integer
                    },
                    "dvbSdtSettings": {
                      "outputSdt": enum,
                      "repInterval": integer,
                      "serviceName": "string",
                      "serviceProviderName": "string"
                    },
                    "dvbSubPids": "string",
                    "dvbTdtSettings": {
                      "repInterval": integer
                    },
                    "dvbTeletextPid": "string",
                    "ebif": enum,
                    "ebpAudioInterval": enum,
                    "ebpLookaheadMs": integer,
                    "ebpPlacement": enum,
                    "ecmPid": "string",
                    "esRateInPes": enum,
                    "etvPlatformPid": "string",
                    "etvSignalPid": "string",
                    "fragmentTime": number,
                    "klv": enum,
                    "klvDataPids": "string",
                    "nielsenId3Behavior": enum,
                    "nullPacketBitrate": number,
                    "patInterval": integer,
                    "pcrControl": enum,
                    "pcrPeriod": integer,
                    "pcrPid": "string",
                    "pmtInterval": integer,
                    "pmtPid": "string",
                    "programNum": integer,
                    "rateMode": enum,
                    "scte27Pids": "string",
                    "scte35Control": enum,
                    "scte35Pid": "string",
                    "segmentationMarkers": enum,
                    "segmentationStyle": enum,
                    "segmentationTime": number,
                    "timedMetadataBehavior": enum,
                    "timedMetadataPid": "string",
                    "transportStreamId": integer,
                    "videoPid": "string"
                  }
                },
                "destination": {
                  "destinationRefId": "string"
                },
                "fecOutputSettings": {
                  "columnDepth": integer,
                  "includeFec": enum,
                  "rowLength": integer
                }
              }
            },
            "videoDescriptionName": "string"
          }
        ]
      }
    ],
    "timecodeConfig": {
      "source": enum,
      "syncThreshold": integer
    },
    "videoDescriptions": [
      {
        "codecSettings": {
          "frameCaptureSettings": {
            "captureInterval": integer,
            "captureIntervalUnits": enum
          },
          "h264Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "bitrate": integer,
            "bufFillPct": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "entropyEncoding": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "forceFieldPictures": enum,
            "framerateControl": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopBReference": enum,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "numRefFrames": integer,
            "parControl": enum,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qualityLevel": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "softness": integer,
            "spatialAq": enum,
            "subgopLength": enum,
            "syntax": enum,
            "temporalAq": enum,
            "timecodeInsertion": enum
          },
          "h265Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "alternativeTransferFunction": enum,
            "bitrate": integer,
            "bufSize": integer,
            "colorMetadata": enum,
            "colorSpaceSettings": {
              "colorSpacePassthroughSettings": {
              },
              "hdr10Settings": {
                "maxCll": integer,
                "maxFall": integer
              },
              "rec601Settings": {
              },
              "rec709Settings": {
              }
            },
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "flickerAq": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "level": enum,
            "lookAheadRateControl": enum,
            "maxBitrate": integer,
            "minIInterval": integer,
            "parDenominator": integer,
            "parNumerator": integer,
            "profile": enum,
            "qvbrQualityLevel": integer,
            "rateControlMode": enum,
            "scanType": enum,
            "sceneChangeDetect": enum,
            "slices": integer,
            "tier": enum,
            "timecodeInsertion": enum
          },
          "mpeg2Settings": {
            "adaptiveQuantization": enum,
            "afdSignaling": enum,
            "colorMetadata": enum,
            "colorSpace": enum,
            "displayAspectRatio": enum,
            "filterSettings": {
              "temporalFilterSettings": {
                "postFilterSharpening": enum,
                "strength": enum
              }
            },
            "fixedAfd": enum,
            "framerateDenominator": integer,
            "framerateNumerator": integer,
            "gopClosedCadence": integer,
            "gopNumBFrames": integer,
            "gopSize": number,
            "gopSizeUnits": enum,
            "scanType": enum,
            "subgopLength": enum,
            "timecodeInsertion": enum
          }
        },
        "height": integer,
        "name": "string",
        "respondToAfd": enum,
        "scalingBehavior": enum,
        "sharpness": integer,
        "width": integer
      }
    ]
  },
  "id": "string",
  "inputAttachments": [
    {
      "automaticInputFailoverSettings": {
        "errorClearTimeMsec": integer,
        "failoverConditions": [
          {
            "failoverConditionSettings": {
              "audioSilenceSettings": {
                "audioSelectorName": "string",
                "audioSilenceThresholdMsec": integer
              },
              "inputLossSettings": {
                "inputLossThresholdMsec": integer
              },
              "videoBlackSettings": {
                "blackDetectThreshold": number,
                "videoBlackThresholdMsec": integer
              }
            }
          }
        ],
        "inputPreference": enum,
        "secondaryInputId": "string"
      },
      "inputAttachmentName": "string",
      "inputId": "string",
      "inputSettings": {
        "audioSelectors": [
          {
            "name": "string",
            "selectorSettings": {
              "audioHlsRenditionSelection": {
                "groupId": "string",
                "name": "string"
              },
              "audioLanguageSelection": {
                "languageCode": "string",
                "languageSelectionPolicy": enum
              },
              "audioPidSelection": {
                "pid": integer
              },
              "audioTrackSelection": {
                "tracks": [
                  {
                    "track": integer
                  }
                ]
              }
            }
          }
        ],
        "captionSelectors": [
          {
            "languageCode": "string",
            "name": "string",
            "selectorSettings": {
              "ancillarySourceSettings": {
                "sourceAncillaryChannelNumber": integer
              },
              "aribSourceSettings": {
              },
              "dvbSubSourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "embeddedSourceSettings": {
                "convert608To708": enum,
                "scte20Detection": enum,
                "source608ChannelNumber": integer,
                "source608TrackNumber": integer
              },
              "scte20SourceSettings": {
                "convert608To708": enum,
                "source608ChannelNumber": integer
              },
              "scte27SourceSettings": {
                "ocrLanguage": enum,
                "pid": integer
              },
              "teletextSourceSettings": {
                "outputRectangle": {
                  "height": number,
                  "leftOffset": number,
                  "topOffset": number,
                  "width": number
                },
                "pageNumber": "string"
              }
            }
          }
        ],
        "deblockFilter": enum,
        "denoiseFilter": enum,
        "filterStrength": integer,
        "inputFilter": enum,
        "networkInputSettings": {
          "hlsInputSettings": {
            "bandwidth": integer,
            "bufferSegments": integer,
            "retries": integer,
            "retryInterval": integer,
            "scte35Source": enum
          },
          "serverValidation": enum
        },
        "smpte2038DataPreference": enum,
        "sourceEndBehavior": enum,
        "videoSelector": {
          "colorSpace": enum,
          "colorSpaceSettings": {
            "hdr10Settings": {
              "maxCll": integer,
              "maxFall": integer
            }
          },
          "colorSpaceUsage": enum,
          "selectorSettings": {
            "videoSelectorPid": {
              "pid": integer
            },
            "videoSelectorProgramId": {
              "programId": integer
            }
          }
        }
      }
    }
  ],
  "inputSpecification": {
    "codec": enum,
    "maximumBitrate": enum,
    "resolution": enum
  },
  "logLevel": enum,
  "maintenance": {
    "maintenanceDay": enum,
    "maintenanceDeadline": "string",
    "maintenanceScheduledDate": "string",
    "maintenanceStartTime": "string"
  },
  "name": "string",
  "pipelineDetails": [
    {
      "activeInputAttachmentName": "string",
      "activeInputSwitchActionName": "string",
      "activeMotionGraphicsActionName": "string",
      "activeMotionGraphicsUri": "string",
      "pipelineId": "string"
    }
  ],
  "pipelinesRunningCount": integer,
  "roleArn": "string",
  "state": enum,
  "tags": {
  },
  "vpc": {
    "availabilityZones": [
      "string"
    ],
    "networkInterfaceIds": [
      "string"
    ],
    "securityGroupIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ]
  }
}
```

#### InvalidRequest schema
<a name="channels-channelid-stop-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="channels-channelid-stop-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="channels-channelid-stop-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="channels-channelid-stop-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="channels-channelid-stop-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="channels-channelid-stop-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="channels-channelid-stop-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="channels-channelid-stop-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="channels-channelid-stop-properties"></a>

### AacCodingMode
<a name="channels-channelid-stop-model-aaccodingmode"></a>

Aac Coding Mode
+ `AD_RECEIVER_MIX`
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_5_1`

### AacInputType
<a name="channels-channelid-stop-model-aacinputtype"></a>

Aac Input Type
+ `BROADCASTER_MIXED_AD`
+ `NORMAL`

### AacProfile
<a name="channels-channelid-stop-model-aacprofile"></a>

Aac Profile
+ `HEV1`
+ `HEV2`
+ `LC`

### AacRateControlMode
<a name="channels-channelid-stop-model-aacratecontrolmode"></a>

Aac Rate Control Mode
+ `CBR`
+ `VBR`

### AacRawFormat
<a name="channels-channelid-stop-model-aacrawformat"></a>

Aac Raw Format
+ `LATM_LOAS`
+ `NONE`

### AacSettings
<a name="channels-channelid-stop-model-aacsettings"></a>

Aac Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid values depend on rate control mode and profile. | 
| codingMode | [AacCodingMode](#channels-channelid-stop-model-aaccodingmode) | False | Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. | 
| inputType | [AacInputType](#channels-channelid-stop-model-aacinputtype) | False | Set to "broadcasterMixedAd" when input contains pre-mixed main audio \$1 AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio \$1 AD. | 
| profile | [AacProfile](#channels-channelid-stop-model-aacprofile) | False | AAC Profile. | 
| rateControlMode | [AacRateControlMode](#channels-channelid-stop-model-aacratecontrolmode) | False | Rate Control Mode. | 
| rawFormat | [AacRawFormat](#channels-channelid-stop-model-aacrawformat) | False | Sets LATM / LOAS AAC output for raw containers. | 
| sampleRate | number | False | Sample rate in Hz. Valid values depend on rate control mode and profile. | 
| spec | [AacSpec](#channels-channelid-stop-model-aacspec) | False | Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. | 
| vbrQuality | [AacVbrQuality](#channels-channelid-stop-model-aacvbrquality) | False | VBR Quality Level - Only used if rateControlMode is VBR. | 

### AacSpec
<a name="channels-channelid-stop-model-aacspec"></a>

Aac Spec
+ `MPEG2`
+ `MPEG4`

### AacVbrQuality
<a name="channels-channelid-stop-model-aacvbrquality"></a>

Aac Vbr Quality
+ `HIGH`
+ `LOW`
+ `MEDIUM_HIGH`
+ `MEDIUM_LOW`

### Ac3BitstreamMode
<a name="channels-channelid-stop-model-ac3bitstreammode"></a>

Ac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `DIALOGUE`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `MUSIC_AND_EFFECTS`
+ `VISUALLY_IMPAIRED`
+ `VOICE_OVER`

### Ac3CodingMode
<a name="channels-channelid-stop-model-ac3codingmode"></a>

Ac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_1_1`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2_LFE`

### Ac3DrcProfile
<a name="channels-channelid-stop-model-ac3drcprofile"></a>

Ac3 Drc Profile
+ `FILM_STANDARD`
+ `NONE`

### Ac3LfeFilter
<a name="channels-channelid-stop-model-ac3lfefilter"></a>

Ac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Ac3MetadataControl
<a name="channels-channelid-stop-model-ac3metadatacontrol"></a>

Ac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Ac3Settings
<a name="channels-channelid-stop-model-ac3settings"></a>

Ac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Ac3BitstreamMode](#channels-channelid-stop-model-ac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. | 
| codingMode | [Ac3CodingMode](#channels-channelid-stop-model-ac3codingmode) | False | Dolby Digital coding mode. Determines number of channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through. | 
| drcProfile | [Ac3DrcProfile](#channels-channelid-stop-model-ac3drcprofile) | False | If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. | 
| lfeFilter | [Ac3LfeFilter](#channels-channelid-stop-model-ac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. | 
| metadataControl | [Ac3MetadataControl](#channels-channelid-stop-model-ac3metadatacontrol) | False | When set to "followInput", encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 

### AccessDenied
<a name="channels-channelid-stop-model-accessdenied"></a>


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

### AfdSignaling
<a name="channels-channelid-stop-model-afdsignaling"></a>

Afd Signaling
+ `AUTO`
+ `FIXED`
+ `NONE`

### AncillarySourceSettings
<a name="channels-channelid-stop-model-ancillarysourcesettings"></a>

Ancillary Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceAncillaryChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field. | 

### ArchiveCdnSettings
<a name="channels-channelid-stop-model-archivecdnsettings"></a>

Archive Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveS3Settings | [ArchiveS3Settings](#channels-channelid-stop-model-archives3settings) | False |  | 

### ArchiveContainerSettings
<a name="channels-channelid-stop-model-archivecontainersettings"></a>

Archive Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-stop-model-m2tssettings) | False |  | 
| rawSettings | [RawSettings](#channels-channelid-stop-model-rawsettings) | False |  | 

### ArchiveGroupSettings
<a name="channels-channelid-stop-model-archivegroupsettings"></a>

Archive Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveCdnSettings | [ArchiveCdnSettings](#channels-channelid-stop-model-archivecdnsettings) | False | Parameters that control interactions with the CDN. | 
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | A directory and base filename where archive files should be written. | 
| rolloverInterval | integerMinimum: 1 | False | Number of seconds to write to archive file before closing and starting a new one. | 

### ArchiveOutputSettings
<a name="channels-channelid-stop-model-archiveoutputsettings"></a>

Archive Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| containerSettings | [ArchiveContainerSettings](#channels-channelid-stop-model-archivecontainersettings) | True | Settings specific to the container type of the file. | 
| extension | string | False | Output file extension. If excluded, this will be auto-selected from the container type. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### ArchiveS3LogUploads
<a name="channels-channelid-stop-model-archives3loguploads"></a>

Archive S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### ArchiveS3Settings
<a name="channels-channelid-stop-model-archives3settings"></a>

Archive S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-stop-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [ArchiveS3LogUploads](#channels-channelid-stop-model-archives3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### AribDestinationSettings
<a name="channels-channelid-stop-model-aribdestinationsettings"></a>

Arib Destination Settings

### AribSourceSettings
<a name="channels-channelid-stop-model-aribsourcesettings"></a>

Arib Source Settings

### AudioChannelMapping
<a name="channels-channelid-stop-model-audiochannelmapping"></a>

Audio Channel Mapping


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputChannelLevels | Array of type [InputChannelLevel](#channels-channelid-stop-model-inputchannellevel) | True | Indices and gain values for each input channel that should be remixed into this output channel. | 
| outputChannel | integerMinimum: 0Maximum: 7 | True | The index of the output channel being produced. | 

### AudioCodecSettings
<a name="channels-channelid-stop-model-audiocodecsettings"></a>

Audio Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aacSettings | [AacSettings](#channels-channelid-stop-model-aacsettings) | False |  | 
| ac3Settings | [Ac3Settings](#channels-channelid-stop-model-ac3settings) | False |  | 
| eac3Settings | [Eac3Settings](#channels-channelid-stop-model-eac3settings) | False |  | 
| mp2Settings | [Mp2Settings](#channels-channelid-stop-model-mp2settings) | False |  | 
| passThroughSettings | [PassThroughSettings](#channels-channelid-stop-model-passthroughsettings) | False |  | 
| wavSettings | [WavSettings](#channels-channelid-stop-model-wavsettings) | False |  | 

### AudioDescription
<a name="channels-channelid-stop-model-audiodescription"></a>

Audio Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioNormalizationSettings | [AudioNormalizationSettings](#channels-channelid-stop-model-audionormalizationsettings) | False | Advanced audio normalization settings. | 
| audioSelectorName | string | True | The name of the AudioSelector used as the source for this AudioDescription. | 
| audioType | [AudioType](#channels-channelid-stop-model-audiotype) | False | Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. | 
| audioTypeControl | [AudioDescriptionAudioTypeControl](#channels-channelid-stop-model-audiodescriptionaudiotypecontrol) | False | Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. | 
| audioWatermarkingSettings | [AudioWatermarkSettings](#channels-channelid-stop-model-audiowatermarksettings) | False | Settings to configure one or more solutions that insert audio watermarks in the audio encode | 
| codecSettings | [AudioCodecSettings](#channels-channelid-stop-model-audiocodecsettings) | False | Audio codec settings. | 
| languageCode | stringMinLength: 1MaxLength: 35 | False | RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input. | 
| languageCodeControl | [AudioDescriptionLanguageCodeControl](#channels-channelid-stop-model-audiodescriptionlanguagecodecontrol) | False | Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. | 
| name | string | True | The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event. | 
| remixSettings | [RemixSettings](#channels-channelid-stop-model-remixsettings) | False | Settings that control how input audio channels are remixed into the output audio channels. | 
| streamName | string | False | Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). | 

### AudioDescriptionAudioTypeControl
<a name="channels-channelid-stop-model-audiodescriptionaudiotypecontrol"></a>

Audio Description Audio Type Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioDescriptionLanguageCodeControl
<a name="channels-channelid-stop-model-audiodescriptionlanguagecodecontrol"></a>

Audio Description Language Code Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### AudioHlsRenditionSelection
<a name="channels-channelid-stop-model-audiohlsrenditionselection"></a>

Audio Hls Rendition Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| groupId | stringMinLength: 1 | True | Specifies the GROUP-ID in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 
| name | stringMinLength: 1 | True | Specifies the NAME in the \$1EXT-X-MEDIA tag of the target HLS audio rendition. | 

### AudioLanguageSelection
<a name="channels-channelid-stop-model-audiolanguageselection"></a>

Audio Language Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | True | Selects a specific three-letter language code from within an audio source. | 
| languageSelectionPolicy | [AudioLanguageSelectionPolicy](#channels-channelid-stop-model-audiolanguageselectionpolicy) | False | When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. | 

### AudioLanguageSelectionPolicy
<a name="channels-channelid-stop-model-audiolanguageselectionpolicy"></a>

Audio Language Selection Policy
+ `LOOSE`
+ `STRICT`

### AudioNormalizationAlgorithm
<a name="channels-channelid-stop-model-audionormalizationalgorithm"></a>

Audio Normalization Algorithm
+ `ITU_1770_1`
+ `ITU_1770_2`

### AudioNormalizationAlgorithmControl
<a name="channels-channelid-stop-model-audionormalizationalgorithmcontrol"></a>

Audio Normalization Algorithm Control
+ `CORRECT_AUDIO`

### AudioNormalizationSettings
<a name="channels-channelid-stop-model-audionormalizationsettings"></a>

Audio Normalization Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| algorithm | [AudioNormalizationAlgorithm](#channels-channelid-stop-model-audionormalizationalgorithm) | False | Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. | 
| algorithmControl | [AudioNormalizationAlgorithmControl](#channels-channelid-stop-model-audionormalizationalgorithmcontrol) | False | When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. | 
| targetLkfs | numberMinimum: -59Maximum: 0 | False | Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS. | 

### AudioOnlyHlsSegmentType
<a name="channels-channelid-stop-model-audioonlyhlssegmenttype"></a>

Audio Only Hls Segment Type
+ `AAC`
+ `FMP4`

### AudioOnlyHlsSettings
<a name="channels-channelid-stop-model-audioonlyhlssettings"></a>

Audio Only Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioGroupId | string | False | Specifies the group to which the audio Rendition belongs. | 
| audioOnlyImage | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard. | 
| audioTrackType | [AudioOnlyHlsTrackType](#channels-channelid-stop-model-audioonlyhlstracktype) | False | Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO | 
| segmentType | [AudioOnlyHlsSegmentType](#channels-channelid-stop-model-audioonlyhlssegmenttype) | False | Specifies the segment type. | 

### AudioOnlyHlsTrackType
<a name="channels-channelid-stop-model-audioonlyhlstracktype"></a>

Audio Only Hls Track Type
+ `ALTERNATE_AUDIO_AUTO_SELECT`
+ `ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT`
+ `ALTERNATE_AUDIO_NOT_AUTO_SELECT`
+ `AUDIO_ONLY_VARIANT_STREAM`

### AudioPidSelection
<a name="channels-channelid-stop-model-audiopidselection"></a>

Audio Pid Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | True | Selects a specific PID from within a source. | 

### AudioSelector
<a name="channels-channelid-stop-model-audioselector"></a>

Audio Selector


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMinLength: 1 | True | The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input. | 
| selectorSettings | [AudioSelectorSettings](#channels-channelid-stop-model-audioselectorsettings) | False | The audio selector settings. | 

### AudioSelectorSettings
<a name="channels-channelid-stop-model-audioselectorsettings"></a>

Audio Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioHlsRenditionSelection | [AudioHlsRenditionSelection](#channels-channelid-stop-model-audiohlsrenditionselection) | False |  | 
| audioLanguageSelection | [AudioLanguageSelection](#channels-channelid-stop-model-audiolanguageselection) | False |  | 
| audioPidSelection | [AudioPidSelection](#channels-channelid-stop-model-audiopidselection) | False |  | 
| audioTrackSelection | [AudioTrackSelection](#channels-channelid-stop-model-audiotrackselection) | False |  | 

### AudioSilenceFailoverSettings
<a name="channels-channelid-stop-model-audiosilencefailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectorName | string | True | The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank. | 
| audioSilenceThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS. | 

### AudioTrack
<a name="channels-channelid-stop-model-audiotrack"></a>

Audio Track


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| track | integerMinimum: 1 | True | 1-based integer value that maps to a specific audio track | 

### AudioTrackSelection
<a name="channels-channelid-stop-model-audiotrackselection"></a>

Audio Track Selection


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tracks | Array of type [AudioTrack](#channels-channelid-stop-model-audiotrack) | True | Selects one or more unique audio tracks from within a source. | 

### AudioType
<a name="channels-channelid-stop-model-audiotype"></a>

Audio Type
+ `CLEAN_EFFECTS`
+ `HEARING_IMPAIRED`
+ `UNDEFINED`
+ `VISUAL_IMPAIRED_COMMENTARY`

### AudioWatermarkSettings
<a name="channels-channelid-stop-model-audiowatermarksettings"></a>

Audio Watermark Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenWatermarksSettings | [NielsenWatermarksSettings](#channels-channelid-stop-model-nielsenwatermarkssettings) | False | Settings to configure Nielsen Watermarks in the audio encode | 

### AuthenticationScheme
<a name="channels-channelid-stop-model-authenticationscheme"></a>

Authentication Scheme
+ `AKAMAI`
+ `COMMON`

### AutomaticInputFailoverSettings
<a name="channels-channelid-stop-model-automaticinputfailoversettings"></a>

The settings for Automatic Input Failover.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| errorClearTimeMsec | integerMinimum: 1 | False | This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input\$1preference for the failover pair is set to PRIMARY\$1INPUT\$1PREFERRED, because after this time, MediaLive will switch back to the primary input. | 
| failoverConditions | Array of type [FailoverCondition](#channels-channelid-stop-model-failovercondition) | False | A list of failover conditions. If any of these conditions occur, MediaLive will perform a failover to the other input. | 
| inputPreference | [InputPreference](#channels-channelid-stop-model-inputpreference) | False | Input preference when deciding which input to make active when a previously failed input has recovered. | 
| secondaryInputId | string | True | The input ID of the secondary input in the automatic input failover pair. | 

### AvailBlanking
<a name="channels-channelid-stop-model-availblanking"></a>

Avail Blanking


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availBlankingImage | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| state | [AvailBlankingState](#channels-channelid-stop-model-availblankingstate) | False | When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. | 

### AvailBlankingState
<a name="channels-channelid-stop-model-availblankingstate"></a>

Avail Blanking State
+ `DISABLED`
+ `ENABLED`

### AvailConfiguration
<a name="channels-channelid-stop-model-availconfiguration"></a>

Avail Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availSettings | [AvailSettings](#channels-channelid-stop-model-availsettings) | False | Ad avail settings. | 

### AvailSettings
<a name="channels-channelid-stop-model-availsettings"></a>

Avail Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| scte35SpliceInsert | [Scte35SpliceInsert](#channels-channelid-stop-model-scte35spliceinsert) | False |  | 
| scte35TimeSignalApos | [Scte35TimeSignalApos](#channels-channelid-stop-model-scte35timesignalapos) | False |  | 

### BadGatewayException
<a name="channels-channelid-stop-model-badgatewayexception"></a>


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

### BlackoutSlate
<a name="channels-channelid-stop-model-blackoutslate"></a>

Blackout Slate


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackoutSlateImage | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported. | 
| networkEndBlackout | [BlackoutSlateNetworkEndBlackout](#channels-channelid-stop-model-blackoutslatenetworkendblackout) | False | Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". | 
| networkEndBlackoutImage | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster. | 
| networkId | stringMinLength: 34MaxLength: 34 | False | Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C"). | 
| state | [BlackoutSlateState](#channels-channelid-stop-model-blackoutslatestate) | False | When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. | 

### BlackoutSlateNetworkEndBlackout
<a name="channels-channelid-stop-model-blackoutslatenetworkendblackout"></a>

Blackout Slate Network End Blackout
+ `DISABLED`
+ `ENABLED`

### BlackoutSlateState
<a name="channels-channelid-stop-model-blackoutslatestate"></a>

Blackout Slate State
+ `DISABLED`
+ `ENABLED`

### BurnInAlignment
<a name="channels-channelid-stop-model-burninalignment"></a>

Burn In Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### BurnInBackgroundColor
<a name="channels-channelid-stop-model-burninbackgroundcolor"></a>

Burn In Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInDestinationSettings
<a name="channels-channelid-stop-model-burnindestinationsettings"></a>

Burn In Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [BurnInAlignment](#channels-channelid-stop-model-burninalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [BurnInBackgroundColor](#channels-channelid-stop-model-burninbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [BurnInFontColor](#channels-channelid-stop-model-burninfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [BurnInOutlineColor](#channels-channelid-stop-model-burninoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [BurnInShadowColor](#channels-channelid-stop-model-burninshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [BurnInTeletextGridControl](#channels-channelid-stop-model-burninteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. | 

### BurnInFontColor
<a name="channels-channelid-stop-model-burninfontcolor"></a>

Burn In Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInOutlineColor
<a name="channels-channelid-stop-model-burninoutlinecolor"></a>

Burn In Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### BurnInShadowColor
<a name="channels-channelid-stop-model-burninshadowcolor"></a>

Burn In Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### BurnInTeletextGridControl
<a name="channels-channelid-stop-model-burninteletextgridcontrol"></a>

Burn In Teletext Grid Control
+ `FIXED`
+ `SCALED`

### CaptionDescription
<a name="channels-channelid-stop-model-captiondescription"></a>

Caption Description


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionSelectorName | string | True | Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name. | 
| destinationSettings | [CaptionDestinationSettings](#channels-channelid-stop-model-captiondestinationsettings) | False | Additional settings for captions destination that depend on the destination type. | 
| languageCode | string | False | ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/ | 
| languageDescription | string | False | Human readable information to indicate captions available for players (eg. English, or Spanish). | 
| name | string | True | Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event. | 

### CaptionDestinationSettings
<a name="channels-channelid-stop-model-captiondestinationsettings"></a>

Caption Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| aribDestinationSettings | [AribDestinationSettings](#channels-channelid-stop-model-aribdestinationsettings) | False |  | 
| burnInDestinationSettings | [BurnInDestinationSettings](#channels-channelid-stop-model-burnindestinationsettings) | False |  | 
| dvbSubDestinationSettings | [DvbSubDestinationSettings](#channels-channelid-stop-model-dvbsubdestinationsettings) | False |  | 
| ebuTtDDestinationSettings | [EbuTtDDestinationSettings](#channels-channelid-stop-model-ebuttddestinationsettings) | False |  | 
| embeddedDestinationSettings | [EmbeddedDestinationSettings](#channels-channelid-stop-model-embeddeddestinationsettings) | False |  | 
| embeddedPlusScte20DestinationSettings | [EmbeddedPlusScte20DestinationSettings](#channels-channelid-stop-model-embeddedplusscte20destinationsettings) | False |  | 
| rtmpCaptionInfoDestinationSettings | [RtmpCaptionInfoDestinationSettings](#channels-channelid-stop-model-rtmpcaptioninfodestinationsettings) | False |  | 
| scte20PlusEmbeddedDestinationSettings | [Scte20PlusEmbeddedDestinationSettings](#channels-channelid-stop-model-scte20plusembeddeddestinationsettings) | False |  | 
| scte27DestinationSettings | [Scte27DestinationSettings](#channels-channelid-stop-model-scte27destinationsettings) | False |  | 
| smpteTtDestinationSettings | [SmpteTtDestinationSettings](#channels-channelid-stop-model-smptettdestinationsettings) | False |  | 
| teletextDestinationSettings | [TeletextDestinationSettings](#channels-channelid-stop-model-teletextdestinationsettings) | False |  | 
| ttmlDestinationSettings | [TtmlDestinationSettings](#channels-channelid-stop-model-ttmldestinationsettings) | False |  | 
| webvttDestinationSettings | [WebvttDestinationSettings](#channels-channelid-stop-model-webvttdestinationsettings) | False |  | 

### CaptionLanguageMapping
<a name="channels-channelid-stop-model-captionlanguagemapping"></a>

Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captionChannel | integerMinimum: 1Maximum: 4 | True | The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4) | 
| languageCode | stringMinLength: 3MaxLength: 3 | True | Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2) | 
| languageDescription | stringMinLength: 1 | True | Textual description of language | 

### CaptionRectangle
<a name="channels-channelid-stop-model-captionrectangle"></a>

Caption Rectangle


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| height | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \$1"80\$1" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard. | 
| leftOffset | numberMinimum: 0Maximum: 100 | True | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard. | 
| topOffset | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \$1"10\$1" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard. | 
| width | numberMinimum: 0Maximum: 100 | True | See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \$1"80\$1" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard. | 

### CaptionSelector
<a name="channels-channelid-stop-model-captionselector"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| languageCode | string | False | When specified this field indicates the three letter language code of the caption track to extract from the source. | 
| name | stringMinLength: 1 | True | Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event. | 
| selectorSettings | [CaptionSelectorSettings](#channels-channelid-stop-model-captionselectorsettings) | False | Caption selector settings. | 

### CaptionSelectorSettings
<a name="channels-channelid-stop-model-captionselectorsettings"></a>

Caption Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ancillarySourceSettings | [AncillarySourceSettings](#channels-channelid-stop-model-ancillarysourcesettings) | False |  | 
| aribSourceSettings | [AribSourceSettings](#channels-channelid-stop-model-aribsourcesettings) | False |  | 
| dvbSubSourceSettings | [DvbSubSourceSettings](#channels-channelid-stop-model-dvbsubsourcesettings) | False |  | 
| embeddedSourceSettings | [EmbeddedSourceSettings](#channels-channelid-stop-model-embeddedsourcesettings) | False |  | 
| scte20SourceSettings | [Scte20SourceSettings](#channels-channelid-stop-model-scte20sourcesettings) | False |  | 
| scte27SourceSettings | [Scte27SourceSettings](#channels-channelid-stop-model-scte27sourcesettings) | False |  | 
| teletextSourceSettings | [TeletextSourceSettings](#channels-channelid-stop-model-teletextsourcesettings) | False |  | 

### CdiInputResolution
<a name="channels-channelid-stop-model-cdiinputresolution"></a>

Maximum CDI input resolution; SD is 480i and 576i up to 30 frames-per-second (fps), HD is 720p up to 60 fps / 1080i up to 30 fps, FHD is 1080p up to 60 fps, UHD is 2160p up to 60 fps 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### CdiInputSpecification
<a name="channels-channelid-stop-model-cdiinputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| resolution | [CdiInputResolution](#channels-channelid-stop-model-cdiinputresolution) | False | Maximum CDI input resolution | 

### Channel
<a name="channels-channelid-stop-model-channel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique arn of the channel. | 
| cdiInputSpecification | [CdiInputSpecification](#channels-channelid-stop-model-cdiinputspecification) | False | Specification of CDI inputs for this channel | 
| channelClass | [ChannelClass](#channels-channelid-stop-model-channelclass) | False | The class for this channel. STANDARD for a channel with two pipelines or SINGLE\$1PIPELINE for a channel with one pipeline. | 
| destinations | Array of type [OutputDestination](#channels-channelid-stop-model-outputdestination) | False | A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.  | 
| egressEndpoints | Array of type [ChannelEgressEndpoint](#channels-channelid-stop-model-channelegressendpoint) | False | The endpoints where outgoing connections initiate from | 
| encoderSettings | [EncoderSettings](#channels-channelid-stop-model-encodersettings) | False |  | 
| id | string | False | The unique ID of the channel. | 
| inputAttachments | Array of type [InputAttachment](#channels-channelid-stop-model-inputattachment) | False | List of input attachments for channel. | 
| inputSpecification | [InputSpecification](#channels-channelid-stop-model-inputspecification) | False | Specification of network and file inputs for this channel | 
| logLevel | [LogLevel](#channels-channelid-stop-model-loglevel) | False | The log level being written to CloudWatch Logs. | 
| maintenance | [MaintenanceStatus](#channels-channelid-stop-model-maintenancestatus) | False | Maintenance settings for this channel. | 
| name | string | False | The name of the channel. (user-mutable) | 
| pipelineDetails | Array of type [PipelineDetail](#channels-channelid-stop-model-pipelinedetail) | False | Runtime details for the pipelines of a running channel. | 
| pipelinesRunningCount | integer | False | The number of currently healthy pipelines. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role assumed when running the Channel. | 
| state | [ChannelState](#channels-channelid-stop-model-channelstate) | False |  | 
| tags | [Tags](#channels-channelid-stop-model-tags) | False | A collection of key-value pairs. | 
| vpc | [VpcOutputSettingsDescription](#channels-channelid-stop-model-vpcoutputsettingsdescription) | False | Settings for VPC output | 

### ChannelClass
<a name="channels-channelid-stop-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### ChannelEgressEndpoint
<a name="channels-channelid-stop-model-channelegressendpoint"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| sourceIp | string | False | Public IP of where a channel's output comes from | 

### ChannelState
<a name="channels-channelid-stop-model-channelstate"></a>
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`
+ `UPDATING`
+ `UPDATE_FAILED`

### ColorSpacePassthroughSettings
<a name="channels-channelid-stop-model-colorspacepassthroughsettings"></a>

Passthrough applies no color space conversion to the output

### DvbNitSettings
<a name="channels-channelid-stop-model-dvbnitsettings"></a>

DVB Network Information Table (NIT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| networkId | integerMinimum: 0Maximum: 65536 | True | The numeric value placed in the Network Information Table (NIT). | 
| networkName | stringMinLength: 1MaxLength: 256 | True | The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters. | 
| repInterval | integerMinimum: 25Maximum: 10000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### DvbSdtOutputSdt
<a name="channels-channelid-stop-model-dvbsdtoutputsdt"></a>

Dvb Sdt Output Sdt
+ `SDT_FOLLOW`
+ `SDT_FOLLOW_IF_PRESENT`
+ `SDT_MANUAL`
+ `SDT_NONE`

### DvbSdtSettings
<a name="channels-channelid-stop-model-dvbsdtsettings"></a>

DVB Service Description Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputSdt | [DvbSdtOutputSdt](#channels-channelid-stop-model-dvbsdtoutputsdt) | False | Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. | 
| repInterval | integerMinimum: 25Maximum: 2000 | False | The number of milliseconds between instances of this table in the output transport stream. | 
| serviceName | stringMinLength: 1MaxLength: 256 | False | The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 
| serviceProviderName | stringMinLength: 1MaxLength: 256 | False | The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters. | 

### DvbSubDestinationAlignment
<a name="channels-channelid-stop-model-dvbsubdestinationalignment"></a>

Dvb Sub Destination Alignment
+ `CENTERED`
+ `LEFT`
+ `SMART`

### DvbSubDestinationBackgroundColor
<a name="channels-channelid-stop-model-dvbsubdestinationbackgroundcolor"></a>

Dvb Sub Destination Background Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationFontColor
<a name="channels-channelid-stop-model-dvbsubdestinationfontcolor"></a>

Dvb Sub Destination Font Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationOutlineColor
<a name="channels-channelid-stop-model-dvbsubdestinationoutlinecolor"></a>

Dvb Sub Destination Outline Color
+ `BLACK`
+ `BLUE`
+ `GREEN`
+ `RED`
+ `WHITE`
+ `YELLOW`

### DvbSubDestinationSettings
<a name="channels-channelid-stop-model-dvbsubdestinationsettings"></a>

Dvb Sub Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| alignment | [DvbSubDestinationAlignment](#channels-channelid-stop-model-dvbsubdestinationalignment) | False | If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| backgroundColor | [DvbSubDestinationBackgroundColor](#channels-channelid-stop-model-dvbsubdestinationbackgroundcolor) | False | Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. | 
| backgroundOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| font | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. | 
| fontColor | [DvbSubDestinationFontColor](#channels-channelid-stop-model-dvbsubdestinationfontcolor) | False | Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| fontOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. | 
| fontResolution | integerMinimum: 96Maximum: 600 | False | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. | 
| fontSize | string | False | When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. | 
| outlineColor | [DvbSubDestinationOutlineColor](#channels-channelid-stop-model-dvbsubdestinationoutlinecolor) | False | Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| outlineSize | integerMinimum: 0Maximum: 10 | False | Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| shadowColor | [DvbSubDestinationShadowColor](#channels-channelid-stop-model-dvbsubdestinationshadowcolor) | False | Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. | 
| shadowOpacity | integerMinimum: 0Maximum: 255 | False | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. | 
| shadowXOffset | integer | False | Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. | 
| shadowYOffset | integer | False | Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. | 
| teletextGridControl | [DvbSubDestinationTeletextGridControl](#channels-channelid-stop-model-dvbsubdestinationteletextgridcontrol) | False | Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. | 
| xPosition | integerMinimum: 0 | False | Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 
| yPosition | integerMinimum: 0 | False | Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. | 

### DvbSubDestinationShadowColor
<a name="channels-channelid-stop-model-dvbsubdestinationshadowcolor"></a>

Dvb Sub Destination Shadow Color
+ `BLACK`
+ `NONE`
+ `WHITE`

### DvbSubDestinationTeletextGridControl
<a name="channels-channelid-stop-model-dvbsubdestinationteletextgridcontrol"></a>

Dvb Sub Destination Teletext Grid Control
+ `FIXED`
+ `SCALED`

### DvbSubOcrLanguage
<a name="channels-channelid-stop-model-dvbsubocrlanguage"></a>

Dvb Sub Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### DvbSubSourceSettings
<a name="channels-channelid-stop-model-dvbsubsourcesettings"></a>

Dvb Sub Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [DvbSubOcrLanguage](#channels-channelid-stop-model-dvbsubocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors. | 

### DvbTdtSettings
<a name="channels-channelid-stop-model-dvbtdtsettings"></a>

DVB Time and Date Table (SDT)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| repInterval | integerMinimum: 1000Maximum: 30000 | False | The number of milliseconds between instances of this table in the output transport stream. | 

### Eac3AttenuationControl
<a name="channels-channelid-stop-model-eac3attenuationcontrol"></a>

Eac3 Attenuation Control
+ `ATTENUATE_3_DB`
+ `NONE`

### Eac3BitstreamMode
<a name="channels-channelid-stop-model-eac3bitstreammode"></a>

Eac3 Bitstream Mode
+ `COMMENTARY`
+ `COMPLETE_MAIN`
+ `EMERGENCY`
+ `HEARING_IMPAIRED`
+ `VISUALLY_IMPAIRED`

### Eac3CodingMode
<a name="channels-channelid-stop-model-eac3codingmode"></a>

Eac3 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_3_2`

### Eac3DcFilter
<a name="channels-channelid-stop-model-eac3dcfilter"></a>

Eac3 Dc Filter
+ `DISABLED`
+ `ENABLED`

### Eac3DrcLine
<a name="channels-channelid-stop-model-eac3drcline"></a>

Eac3 Drc Line
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3DrcRf
<a name="channels-channelid-stop-model-eac3drcrf"></a>

Eac3 Drc Rf
+ `FILM_LIGHT`
+ `FILM_STANDARD`
+ `MUSIC_LIGHT`
+ `MUSIC_STANDARD`
+ `NONE`
+ `SPEECH`

### Eac3LfeControl
<a name="channels-channelid-stop-model-eac3lfecontrol"></a>

Eac3 Lfe Control
+ `LFE`
+ `NO_LFE`

### Eac3LfeFilter
<a name="channels-channelid-stop-model-eac3lfefilter"></a>

Eac3 Lfe Filter
+ `DISABLED`
+ `ENABLED`

### Eac3MetadataControl
<a name="channels-channelid-stop-model-eac3metadatacontrol"></a>

Eac3 Metadata Control
+ `FOLLOW_INPUT`
+ `USE_CONFIGURED`

### Eac3PassthroughControl
<a name="channels-channelid-stop-model-eac3passthroughcontrol"></a>

Eac3 Passthrough Control
+ `NO_PASSTHROUGH`
+ `WHEN_POSSIBLE`

### Eac3PhaseControl
<a name="channels-channelid-stop-model-eac3phasecontrol"></a>

Eac3 Phase Control
+ `NO_SHIFT`
+ `SHIFT_90_DEGREES`

### Eac3Settings
<a name="channels-channelid-stop-model-eac3settings"></a>

Eac3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| attenuationControl | [Eac3AttenuationControl](#channels-channelid-stop-model-eac3attenuationcontrol) | False | When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. | 
| bitrate | number | False | Average bitrate in bits/second. Valid bitrates depend on the coding mode. | 
| bitstreamMode | [Eac3BitstreamMode](#channels-channelid-stop-model-eac3bitstreammode) | False | Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. | 
| codingMode | [Eac3CodingMode](#channels-channelid-stop-model-eac3codingmode) | False | Dolby Digital Plus coding mode. Determines number of channels. | 
| dcFilter | [Eac3DcFilter](#channels-channelid-stop-model-eac3dcfilter) | False | When set to enabled, activates a DC highpass filter for all input channels. | 
| dialnorm | integerMinimum: 1Maximum: 31 | False | Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through. | 
| drcLine | [Eac3DrcLine](#channels-channelid-stop-model-eac3drcline) | False | Sets the Dolby dynamic range compression profile. | 
| drcRf | [Eac3DrcRf](#channels-channelid-stop-model-eac3drcrf) | False | Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. | 
| lfeControl | [Eac3LfeControl](#channels-channelid-stop-model-eac3lfecontrol) | False | When encoding 3/2 audio, setting to lfe enables the LFE channel | 
| lfeFilter | [Eac3LfeFilter](#channels-channelid-stop-model-eac3lfefilter) | False | When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. | 
| loRoCenterMixLevel | number | False | Left only/Right only center mix level. Only used for 3/2 coding mode. | 
| loRoSurroundMixLevel | number | False | Left only/Right only surround mix level. Only used for 3/2 coding mode. | 
| ltRtCenterMixLevel | number | False | Left total/Right total center mix level. Only used for 3/2 coding mode. | 
| ltRtSurroundMixLevel | number | False | Left total/Right total surround mix level. Only used for 3/2 coding mode. | 
| metadataControl | [Eac3MetadataControl](#channels-channelid-stop-model-eac3metadatacontrol) | False | When set to followInput, encoder metadata will be sourced from the DD, DD\$1, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. | 
| passthroughControl | [Eac3PassthroughControl](#channels-channelid-stop-model-eac3passthroughcontrol) | False | When set to whenPossible, input DD\$1 audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD\$1 and non-DD\$1 content will have a consistent DD\$1 output as the system alternates between passthrough and encoding. | 
| phaseControl | [Eac3PhaseControl](#channels-channelid-stop-model-eac3phasecontrol) | False | When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. | 
| stereoDownmix | [Eac3StereoDownmix](#channels-channelid-stop-model-eac3stereodownmix) | False | Stereo downmix preference. Only used for 3/2 coding mode. | 
| surroundExMode | [Eac3SurroundExMode](#channels-channelid-stop-model-eac3surroundexmode) | False | When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. | 
| surroundMode | [Eac3SurroundMode](#channels-channelid-stop-model-eac3surroundmode) | False | When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. | 

### Eac3StereoDownmix
<a name="channels-channelid-stop-model-eac3stereodownmix"></a>

Eac3 Stereo Downmix
+ `DPL2`
+ `LO_RO`
+ `LT_RT`
+ `NOT_INDICATED`

### Eac3SurroundExMode
<a name="channels-channelid-stop-model-eac3surroundexmode"></a>

Eac3 Surround Ex Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### Eac3SurroundMode
<a name="channels-channelid-stop-model-eac3surroundmode"></a>

Eac3 Surround Mode
+ `DISABLED`
+ `ENABLED`
+ `NOT_INDICATED`

### EbuTtDDestinationSettings
<a name="channels-channelid-stop-model-ebuttddestinationsettings"></a>

Ebu Tt DDestination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyrightHolder | stringMaxLength: 1000 | False | Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML | 
| fillLineGap | [EbuTtDFillLineGapControl](#channels-channelid-stop-model-ebuttdfilllinegapcontrol) | False | Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. | 
| fontFamily | string | False | Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. | 
| styleControl | [EbuTtDDestinationStyleControl](#channels-channelid-stop-model-ebuttddestinationstylecontrol) | False | Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information. | 

### EbuTtDDestinationStyleControl
<a name="channels-channelid-stop-model-ebuttddestinationstylecontrol"></a>

Ebu Tt DDestination Style Control
+ `EXCLUDE`
+ `INCLUDE`

### EbuTtDFillLineGapControl
<a name="channels-channelid-stop-model-ebuttdfilllinegapcontrol"></a>

Ebu Tt DFill Line Gap Control
+ `DISABLED`
+ `ENABLED`

### EmbeddedConvert608To708
<a name="channels-channelid-stop-model-embeddedconvert608to708"></a>

Embedded Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### EmbeddedDestinationSettings
<a name="channels-channelid-stop-model-embeddeddestinationsettings"></a>

Embedded Destination Settings

### EmbeddedPlusScte20DestinationSettings
<a name="channels-channelid-stop-model-embeddedplusscte20destinationsettings"></a>

Embedded Plus Scte20 Destination Settings

### EmbeddedScte20Detection
<a name="channels-channelid-stop-model-embeddedscte20detection"></a>

Embedded Scte20 Detection
+ `AUTO`
+ `OFF`

### EmbeddedSourceSettings
<a name="channels-channelid-stop-model-embeddedsourcesettings"></a>

Embedded Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [EmbeddedConvert608To708](#channels-channelid-stop-model-embeddedconvert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| scte20Detection | [EmbeddedScte20Detection](#channels-channelid-stop-model-embeddedscte20detection) | False | Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 
| source608TrackNumber | integerMinimum: 1Maximum: 5 | False | This field is unused and deprecated. | 

### EncoderSettings
<a name="channels-channelid-stop-model-encodersettings"></a>

Encoder Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptions | Array of type [AudioDescription](#channels-channelid-stop-model-audiodescription) | True |  | 
| availBlanking | [AvailBlanking](#channels-channelid-stop-model-availblanking) | False | Settings for ad avail blanking. | 
| availConfiguration | [AvailConfiguration](#channels-channelid-stop-model-availconfiguration) | False | Event-wide configuration settings for ad avail insertion. | 
| blackoutSlate | [BlackoutSlate](#channels-channelid-stop-model-blackoutslate) | False | Settings for blackout slate. | 
| captionDescriptions | Array of type [CaptionDescription](#channels-channelid-stop-model-captiondescription) | False | Settings for caption decriptions | 
| featureActivations | [FeatureActivations](#channels-channelid-stop-model-featureactivations) | False | Feature Activations | 
| globalConfiguration | [GlobalConfiguration](#channels-channelid-stop-model-globalconfiguration) | False | Configuration settings that apply to the event as a whole. | 
| motionGraphicsConfiguration | [MotionGraphicsConfiguration](#channels-channelid-stop-model-motiongraphicsconfiguration) | False | Settings for motion graphics. | 
| nielsenConfiguration | [NielsenConfiguration](#channels-channelid-stop-model-nielsenconfiguration) | False | Nielsen configuration settings. | 
| outputGroups | Array of type [OutputGroup](#channels-channelid-stop-model-outputgroup) | True |  | 
| timecodeConfig | [TimecodeConfig](#channels-channelid-stop-model-timecodeconfig) | True | Contains settings used to acquire and adjust timecode information from inputs. | 
| videoDescriptions | Array of type [VideoDescription](#channels-channelid-stop-model-videodescription) | True |  | 

### FailoverCondition
<a name="channels-channelid-stop-model-failovercondition"></a>

Failover Condition settings. There can be multiple failover conditions inside AutomaticInputFailoverSettings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| failoverConditionSettings | [FailoverConditionSettings](#channels-channelid-stop-model-failoverconditionsettings) | False | Failover condition type-specific settings. | 

### FailoverConditionSettings
<a name="channels-channelid-stop-model-failoverconditionsettings"></a>

Settings for one failover condition.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSilenceSettings | [AudioSilenceFailoverSettings](#channels-channelid-stop-model-audiosilencefailoversettings) | False | MediaLive will perform a failover if the specified audio selector is silent for the specified period. | 
| inputLossSettings | [InputLossFailoverSettings](#channels-channelid-stop-model-inputlossfailoversettings) | False | MediaLive will perform a failover if content is not detected in this input for the specified period. | 
| videoBlackSettings | [VideoBlackFailoverSettings](#channels-channelid-stop-model-videoblackfailoversettings) | False | MediaLive will perform a failover if content is considered black for the specified period. | 

### FeatureActivations
<a name="channels-channelid-stop-model-featureactivations"></a>

Feature Activations


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputPrepareScheduleActions | [FeatureActivationsInputPrepareScheduleActions](#channels-channelid-stop-model-featureactivationsinputpreparescheduleactions) | False | Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule. | 

### FeatureActivationsInputPrepareScheduleActions
<a name="channels-channelid-stop-model-featureactivationsinputpreparescheduleactions"></a>

Feature Activations Input Prepare Schedule Actions
+ `DISABLED`
+ `ENABLED`

### FecOutputIncludeFec
<a name="channels-channelid-stop-model-fecoutputincludefec"></a>

Fec Output Include Fec
+ `COLUMN`
+ `COLUMN_AND_ROW`

### FecOutputSettings
<a name="channels-channelid-stop-model-fecoutputsettings"></a>

Fec Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| columnDepth | integerMinimum: 4Maximum: 20 | False | Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive. | 
| includeFec | [FecOutputIncludeFec](#channels-channelid-stop-model-fecoutputincludefec) | False | Enables column only or column and row based FEC | 
| rowLength | integerMinimum: 1Maximum: 20 | False | Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive. | 

### FixedAfd
<a name="channels-channelid-stop-model-fixedafd"></a>

Fixed Afd
+ `AFD_0000`
+ `AFD_0010`
+ `AFD_0011`
+ `AFD_0100`
+ `AFD_1000`
+ `AFD_1001`
+ `AFD_1010`
+ `AFD_1011`
+ `AFD_1101`
+ `AFD_1110`
+ `AFD_1111`

### Fmp4HlsSettings
<a name="channels-channelid-stop-model-fmp4hlssettings"></a>

Fmp4 Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| nielsenId3Behavior | [Fmp4NielsenId3Behavior](#channels-channelid-stop-model-fmp4nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| timedMetadataBehavior | [Fmp4TimedMetadataBehavior](#channels-channelid-stop-model-fmp4timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 

### Fmp4NielsenId3Behavior
<a name="channels-channelid-stop-model-fmp4nielsenid3behavior"></a>

Fmp4 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### Fmp4TimedMetadataBehavior
<a name="channels-channelid-stop-model-fmp4timedmetadatabehavior"></a>

Fmp4 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### FrameCaptureCdnSettings
<a name="channels-channelid-stop-model-framecapturecdnsettings"></a>

Frame Capture Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureS3Settings | [FrameCaptureS3Settings](#channels-channelid-stop-model-framecaptures3settings) | False |  | 

### FrameCaptureGroupSettings
<a name="channels-channelid-stop-model-framecapturegroupsettings"></a>

Frame Capture Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, "curling-") \$1 name modifier \$1 the counter (5 digits, starting from 00001) \$1 extension (which is always .jpg). For example, curling-low.00001.jpg | 
| frameCaptureCdnSettings | [FrameCaptureCdnSettings](#channels-channelid-stop-model-framecapturecdnsettings) | False | Parameters that control interactions with the CDN. | 

### FrameCaptureHlsSettings
<a name="channels-channelid-stop-model-framecapturehlssettings"></a>

Frame Capture Hls Settings

### FrameCaptureIntervalUnit
<a name="channels-channelid-stop-model-framecaptureintervalunit"></a>

Frame Capture Interval Unit
+ `MILLISECONDS`
+ `SECONDS`

### FrameCaptureOutputSettings
<a name="channels-channelid-stop-model-framecaptureoutputsettings"></a>

Frame Capture Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nameModifier | string | False | Required if the output group contains more than one output. This modifier forms part of the output file name. | 

### FrameCaptureS3LogUploads
<a name="channels-channelid-stop-model-framecaptures3loguploads"></a>

Frame Capture S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### FrameCaptureS3Settings
<a name="channels-channelid-stop-model-framecaptures3settings"></a>

Frame Capture S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-stop-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [FrameCaptureS3LogUploads](#channels-channelid-stop-model-framecaptures3loguploads) | False | When set to enabled, each upload to CDN or server will be logged. | 

### FrameCaptureSettings
<a name="channels-channelid-stop-model-framecapturesettings"></a>

Frame Capture Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| captureInterval | integerMinimum: 1Maximum: 3600000 | False | The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits. | 
| captureIntervalUnits | [FrameCaptureIntervalUnit](#channels-channelid-stop-model-framecaptureintervalunit) | False | Unit for the frame capture interval. | 

### GatewayTimeoutException
<a name="channels-channelid-stop-model-gatewaytimeoutexception"></a>


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

### GlobalConfiguration
<a name="channels-channelid-stop-model-globalconfiguration"></a>

Global Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| initialAudioGain | integerMinimum: -60Maximum: 60 | False | Value to set the initial audio gain for the Live Event. | 
| inputEndAction | [GlobalConfigurationInputEndAction](#channels-channelid-stop-model-globalconfigurationinputendaction) | False | Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). | 
| inputLossBehavior | [InputLossBehavior](#channels-channelid-stop-model-inputlossbehavior) | False | Settings for system actions when input is lost. | 
| outputLockingMode | [GlobalConfigurationOutputLockingMode](#channels-channelid-stop-model-globalconfigurationoutputlockingmode) | False | Indicates how MediaLive pipelines are synchronized. PIPELINE\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\$1LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. | 
| outputTimingSource | [GlobalConfigurationOutputTimingSource](#channels-channelid-stop-model-globalconfigurationoutputtimingsource) | False | Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. | 
| supportLowFramerateInputs | [GlobalConfigurationLowFramerateInputs](#channels-channelid-stop-model-globalconfigurationlowframerateinputs) | False | Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. | 

### GlobalConfigurationInputEndAction
<a name="channels-channelid-stop-model-globalconfigurationinputendaction"></a>

Global Configuration Input End Action
+ `NONE`
+ `SWITCH_AND_LOOP_INPUTS`

### GlobalConfigurationLowFramerateInputs
<a name="channels-channelid-stop-model-globalconfigurationlowframerateinputs"></a>

Global Configuration Low Framerate Inputs
+ `DISABLED`
+ `ENABLED`

### GlobalConfigurationOutputLockingMode
<a name="channels-channelid-stop-model-globalconfigurationoutputlockingmode"></a>

Global Configuration Output Locking Mode
+ `EPOCH_LOCKING`
+ `PIPELINE_LOCKING`

### GlobalConfigurationOutputTimingSource
<a name="channels-channelid-stop-model-globalconfigurationoutputtimingsource"></a>

Global Configuration Output Timing Source
+ `INPUT_CLOCK`
+ `SYSTEM_CLOCK`

### H264AdaptiveQuantization
<a name="channels-channelid-stop-model-h264adaptivequantization"></a>

H264 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H264ColorMetadata
<a name="channels-channelid-stop-model-h264colormetadata"></a>

H264 Color Metadata
+ `IGNORE`
+ `INSERT`

### H264ColorSpaceSettings
<a name="channels-channelid-stop-model-h264colorspacesettings"></a>

H264 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-stop-model-colorspacepassthroughsettings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-stop-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-stop-model-rec709settings) | False |  | 

### H264EntropyEncoding
<a name="channels-channelid-stop-model-h264entropyencoding"></a>

H264 Entropy Encoding
+ `CABAC`
+ `CAVLC`

### H264FilterSettings
<a name="channels-channelid-stop-model-h264filtersettings"></a>

H264 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-stop-model-temporalfiltersettings) | False |  | 

### H264FlickerAq
<a name="channels-channelid-stop-model-h264flickeraq"></a>

H264 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H264ForceFieldPictures
<a name="channels-channelid-stop-model-h264forcefieldpictures"></a>

H264 Force Field Pictures
+ `DISABLED`
+ `ENABLED`

### H264FramerateControl
<a name="channels-channelid-stop-model-h264frameratecontrol"></a>

H264 Framerate Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264GopBReference
<a name="channels-channelid-stop-model-h264gopbreference"></a>

H264 Gop BReference
+ `DISABLED`
+ `ENABLED`

### H264GopSizeUnits
<a name="channels-channelid-stop-model-h264gopsizeunits"></a>

H264 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H264Level
<a name="channels-channelid-stop-model-h264level"></a>

H264 Level
+ `H264_LEVEL_1`
+ `H264_LEVEL_1_1`
+ `H264_LEVEL_1_2`
+ `H264_LEVEL_1_3`
+ `H264_LEVEL_2`
+ `H264_LEVEL_2_1`
+ `H264_LEVEL_2_2`
+ `H264_LEVEL_3`
+ `H264_LEVEL_3_1`
+ `H264_LEVEL_3_2`
+ `H264_LEVEL_4`
+ `H264_LEVEL_4_1`
+ `H264_LEVEL_4_2`
+ `H264_LEVEL_5`
+ `H264_LEVEL_5_1`
+ `H264_LEVEL_5_2`
+ `H264_LEVEL_AUTO`

### H264LookAheadRateControl
<a name="channels-channelid-stop-model-h264lookaheadratecontrol"></a>

H264 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H264ParControl
<a name="channels-channelid-stop-model-h264parcontrol"></a>

H264 Par Control
+ `INITIALIZE_FROM_SOURCE`
+ `SPECIFIED`

### H264Profile
<a name="channels-channelid-stop-model-h264profile"></a>

H264 Profile
+ `BASELINE`
+ `HIGH`
+ `HIGH_10BIT`
+ `HIGH_422`
+ `HIGH_422_10BIT`
+ `MAIN`

### H264QualityLevel
<a name="channels-channelid-stop-model-h264qualitylevel"></a>

H264 Quality Level
+ `ENHANCED_QUALITY`
+ `STANDARD_QUALITY`

### H264RateControlMode
<a name="channels-channelid-stop-model-h264ratecontrolmode"></a>

H264 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`
+ `VBR`

### H264ScanType
<a name="channels-channelid-stop-model-h264scantype"></a>

H264 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H264SceneChangeDetect
<a name="channels-channelid-stop-model-h264scenechangedetect"></a>

H264 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H264Settings
<a name="channels-channelid-stop-model-h264settings"></a>

H264 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H264AdaptiveQuantization](#channels-channelid-stop-model-h264adaptivequantization) | False | Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization. | 
| afdSignaling | [AfdSignaling](#channels-channelid-stop-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| bitrate | integerMinimum: 1000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufFillPct | integerMinimum: 0Maximum: 100 | False | Percentage of the buffer that should initially be filled (HRD buffer model). | 
| bufSize | integerMinimum: 0 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H264ColorMetadata](#channels-channelid-stop-model-h264colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H264ColorSpaceSettings](#channels-channelid-stop-model-h264colorspacesettings) | False | Color Space settings | 
| entropyEncoding | [H264EntropyEncoding](#channels-channelid-stop-model-h264entropyencoding) | False | Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. | 
| filterSettings | [H264FilterSettings](#channels-channelid-stop-model-h264filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-stop-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H264FlickerAq](#channels-channelid-stop-model-h264flickeraq) | False | Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ. | 
| forceFieldPictures | [H264ForceFieldPictures](#channels-channelid-stop-model-h264forcefieldpictures) | False | This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content. | 
| framerateControl | [H264FramerateControl](#channels-channelid-stop-model-h264frameratecontrol) | False | This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. | 
| framerateDenominator | integerMinimum: 1 | False | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | False | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopBReference | [H264GopBReference](#channels-channelid-stop-model-h264gopbreference) | False | If enabled, use reference B frames for GOP structures that have B frames > 1. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Number of B-frames between reference frames. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H264GopSizeUnits](#channels-channelid-stop-model-h264gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H264Level](#channels-channelid-stop-model-h264level) | False | H.264 Level. | 
| lookAheadRateControl | [H264LookAheadRateControl](#channels-channelid-stop-model-h264lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 1000 | False | For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video. | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| numRefFrames | integerMinimum: 1Maximum: 6 | False | Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding. | 
| parControl | [H264ParControl](#channels-channelid-stop-model-h264parcontrol) | False | This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H264Profile](#channels-channelid-stop-model-h264profile) | False | H.264 Profile. | 
| qualityLevel | [H264QualityLevel](#channels-channelid-stop-model-h264qualitylevel) | False | Leave as STANDARD\$1QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED\$1QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED\$1QUALITY. - STANDARD\$1QUALITY: Valid for any Rate control mode. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide | 
| rateControlMode | [H264RateControlMode](#channels-channelid-stop-model-h264ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H264ScanType](#channels-channelid-stop-model-h264scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H264SceneChangeDetect](#channels-channelid-stop-model-h264scenechangedetect) | False | Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. | 
| slices | integerMinimum: 1Maximum: 32 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| softness | integerMinimum: 0Maximum: 128 | False | Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15. | 
| spatialAq | [H264SpatialAq](#channels-channelid-stop-model-h264spatialaq) | False | Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ. | 
| subgopLength | [H264SubGopLength](#channels-channelid-stop-model-h264subgoplength) | False | If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. | 
| syntax | [H264Syntax](#channels-channelid-stop-model-h264syntax) | False | Produces a bitstream compliant with SMPTE RP-2027. | 
| temporalAq | [H264TemporalAq](#channels-channelid-stop-model-h264temporalaq) | False | Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ. | 
| timecodeInsertion | [H264TimecodeInsertionBehavior](#channels-channelid-stop-model-h264timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H264SpatialAq
<a name="channels-channelid-stop-model-h264spatialaq"></a>

H264 Spatial Aq
+ `DISABLED`
+ `ENABLED`

### H264SubGopLength
<a name="channels-channelid-stop-model-h264subgoplength"></a>

H264 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### H264Syntax
<a name="channels-channelid-stop-model-h264syntax"></a>

H264 Syntax
+ `DEFAULT`
+ `RP2027`

### H264TemporalAq
<a name="channels-channelid-stop-model-h264temporalaq"></a>

H264 Temporal Aq
+ `DISABLED`
+ `ENABLED`

### H264TimecodeInsertionBehavior
<a name="channels-channelid-stop-model-h264timecodeinsertionbehavior"></a>

H264 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### H265AdaptiveQuantization
<a name="channels-channelid-stop-model-h265adaptivequantization"></a>

H265 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `HIGHER`
+ `LOW`
+ `MAX`
+ `MEDIUM`
+ `OFF`

### H265AlternativeTransferFunction
<a name="channels-channelid-stop-model-h265alternativetransferfunction"></a>

H265 Alternative Transfer Function
+ `INSERT`
+ `OMIT`

### H265ColorMetadata
<a name="channels-channelid-stop-model-h265colormetadata"></a>

H265 Color Metadata
+ `IGNORE`
+ `INSERT`

### H265ColorSpaceSettings
<a name="channels-channelid-stop-model-h265colorspacesettings"></a>

H265 Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpacePassthroughSettings | [ColorSpacePassthroughSettings](#channels-channelid-stop-model-colorspacepassthroughsettings) | False |  | 
| hdr10Settings | [Hdr10Settings](#channels-channelid-stop-model-hdr10settings) | False |  | 
| rec601Settings | [Rec601Settings](#channels-channelid-stop-model-rec601settings) | False |  | 
| rec709Settings | [Rec709Settings](#channels-channelid-stop-model-rec709settings) | False |  | 

### H265FilterSettings
<a name="channels-channelid-stop-model-h265filtersettings"></a>

H265 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-stop-model-temporalfiltersettings) | False |  | 

### H265FlickerAq
<a name="channels-channelid-stop-model-h265flickeraq"></a>

H265 Flicker Aq
+ `DISABLED`
+ `ENABLED`

### H265GopSizeUnits
<a name="channels-channelid-stop-model-h265gopsizeunits"></a>

H265 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### H265Level
<a name="channels-channelid-stop-model-h265level"></a>

H265 Level
+ `H265_LEVEL_1`
+ `H265_LEVEL_2`
+ `H265_LEVEL_2_1`
+ `H265_LEVEL_3`
+ `H265_LEVEL_3_1`
+ `H265_LEVEL_4`
+ `H265_LEVEL_4_1`
+ `H265_LEVEL_5`
+ `H265_LEVEL_5_1`
+ `H265_LEVEL_5_2`
+ `H265_LEVEL_6`
+ `H265_LEVEL_6_1`
+ `H265_LEVEL_6_2`
+ `H265_LEVEL_AUTO`

### H265LookAheadRateControl
<a name="channels-channelid-stop-model-h265lookaheadratecontrol"></a>

H265 Look Ahead Rate Control
+ `HIGH`
+ `LOW`
+ `MEDIUM`

### H265Profile
<a name="channels-channelid-stop-model-h265profile"></a>

H265 Profile
+ `MAIN`
+ `MAIN_10BIT`

### H265RateControlMode
<a name="channels-channelid-stop-model-h265ratecontrolmode"></a>

H265 Rate Control Mode
+ `CBR`
+ `MULTIPLEX`
+ `QVBR`

### H265ScanType
<a name="channels-channelid-stop-model-h265scantype"></a>

H265 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### H265SceneChangeDetect
<a name="channels-channelid-stop-model-h265scenechangedetect"></a>

H265 Scene Change Detect
+ `DISABLED`
+ `ENABLED`

### H265Settings
<a name="channels-channelid-stop-model-h265settings"></a>

H265 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [H265AdaptiveQuantization](#channels-channelid-stop-model-h265adaptivequantization) | False | Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-stop-model-afdsignaling) | False | Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. | 
| alternativeTransferFunction | [H265AlternativeTransferFunction](#channels-channelid-stop-model-h265alternativetransferfunction) | False | Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays. | 
| bitrate | integerMinimum: 100000Maximum: 40000000 | False | Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000. | 
| bufSize | integerMinimum: 100000Maximum: 80000000 | False | Size of buffer (HRD buffer model) in bits. | 
| colorMetadata | [H265ColorMetadata](#channels-channelid-stop-model-h265colormetadata) | False | Includes colorspace metadata in the output. | 
| colorSpaceSettings | [H265ColorSpaceSettings](#channels-channelid-stop-model-h265colorspacesettings) | False | Color Space settings | 
| filterSettings | [H265FilterSettings](#channels-channelid-stop-model-h265filtersettings) | False | Optional filters that you can apply to an encode. | 
| fixedAfd | [FixedAfd](#channels-channelid-stop-model-fixedafd) | False | Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. | 
| flickerAq | [H265FlickerAq](#channels-channelid-stop-model-h265flickeraq) | False | If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. | 
| framerateDenominator | integerMinimum: 1Maximum: 3003 | True | Framerate denominator. | 
| framerateNumerator | integerMinimum: 1 | True | Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps. | 
| gopClosedCadence | integerMinimum: 0 | False | Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting. | 
| gopSize | number | False | GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer. | 
| gopSizeUnits | [H265GopSizeUnits](#channels-channelid-stop-model-h265gopsizeunits) | False | Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. | 
| level | [H265Level](#channels-channelid-stop-model-h265level) | False | H.265 Level. | 
| lookAheadRateControl | [H265LookAheadRateControl](#channels-channelid-stop-model-h265lookaheadratecontrol) | False | Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. | 
| maxBitrate | integerMinimum: 100000Maximum: 40000000 | False | For QVBR: See the tooltip for Quality level | 
| minIInterval | integerMinimum: 0Maximum: 30 | False | Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size \$1 Min-I-interval - 1 | 
| parDenominator | integerMinimum: 1 | False | Pixel Aspect Ratio denominator. | 
| parNumerator | integerMinimum: 1 | False | Pixel Aspect Ratio numerator. | 
| profile | [H265Profile](#channels-channelid-stop-model-h265profile) | False | H.265 Profile. | 
| qvbrQualityLevel | integerMinimum: 1Maximum: 10 | False | Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M | 
| rateControlMode | [H265RateControlMode](#channels-channelid-stop-model-h265ratecontrolmode) | False | Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program. | 
| scanType | [H265ScanType](#channels-channelid-stop-model-h265scantype) | False | Sets the scan type of the output to progressive or top-field-first interlaced. | 
| sceneChangeDetect | [H265SceneChangeDetect](#channels-channelid-stop-model-h265scenechangedetect) | False | Scene change detection. | 
| slices | integerMinimum: 1Maximum: 16 | False | Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution. | 
| tier | [H265Tier](#channels-channelid-stop-model-h265tier) | False | H.265 Tier. | 
| timecodeInsertion | [H265TimecodeInsertionBehavior](#channels-channelid-stop-model-h265timecodeinsertionbehavior) | False | Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config | 

### H265Tier
<a name="channels-channelid-stop-model-h265tier"></a>

H265 Tier
+ `HIGH`
+ `MAIN`

### H265TimecodeInsertionBehavior
<a name="channels-channelid-stop-model-h265timecodeinsertionbehavior"></a>

H265 Timecode Insertion Behavior
+ `DISABLED`
+ `PIC_TIMING_SEI`

### Hdr10Settings
<a name="channels-channelid-stop-model-hdr10settings"></a>

Hdr10 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxCll | integerMinimum: 0Maximum: 32768 | False | Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file. | 
| maxFall | integerMinimum: 0Maximum: 32768 | False | Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file. | 

### HlsAdMarkers
<a name="channels-channelid-stop-model-hlsadmarkers"></a>

Hls Ad Markers
+ `ADOBE`
+ `ELEMENTAL`
+ `ELEMENTAL_SCTE35`

### HlsAkamaiHttpTransferMode
<a name="channels-channelid-stop-model-hlsakamaihttptransfermode"></a>

Hls Akamai Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsAkamaiSettings
<a name="channels-channelid-stop-model-hlsakamaisettings"></a>

Hls Akamai Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsAkamaiHttpTransferMode](#channels-channelid-stop-model-hlsakamaihttptransfermode) | False | Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 
| salt | string | False | Salt for authenticated Akamai. | 
| token | string | False | Token parameter for authenticated akamai. If not specified, \$1gda\$1 is used. | 

### HlsBasicPutSettings
<a name="channels-channelid-stop-model-hlsbasicputsettings"></a>

Hls Basic Put Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsCaptionLanguageSetting
<a name="channels-channelid-stop-model-hlscaptionlanguagesetting"></a>

Hls Caption Language Setting
+ `INSERT`
+ `NONE`
+ `OMIT`

### HlsCdnSettings
<a name="channels-channelid-stop-model-hlscdnsettings"></a>

Hls Cdn Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsAkamaiSettings | [HlsAkamaiSettings](#channels-channelid-stop-model-hlsakamaisettings) | False |  | 
| hlsBasicPutSettings | [HlsBasicPutSettings](#channels-channelid-stop-model-hlsbasicputsettings) | False |  | 
| hlsMediaStoreSettings | [HlsMediaStoreSettings](#channels-channelid-stop-model-hlsmediastoresettings) | False |  | 
| hlsS3Settings | [HlsS3Settings](#channels-channelid-stop-model-hlss3settings) | False |  | 
| hlsWebdavSettings | [HlsWebdavSettings](#channels-channelid-stop-model-hlswebdavsettings) | False |  | 

### HlsClientCache
<a name="channels-channelid-stop-model-hlsclientcache"></a>

Hls Client Cache
+ `DISABLED`
+ `ENABLED`

### HlsCodecSpecification
<a name="channels-channelid-stop-model-hlscodecspecification"></a>

Hls Codec Specification
+ `RFC_4281`
+ `RFC_6381`

### HlsDirectoryStructure
<a name="channels-channelid-stop-model-hlsdirectorystructure"></a>

Hls Directory Structure
+ `SINGLE_DIRECTORY`
+ `SUBDIRECTORY_PER_STREAM`

### HlsDiscontinuityTags
<a name="channels-channelid-stop-model-hlsdiscontinuitytags"></a>

Hls Discontinuity Tags
+ `INSERT`
+ `NEVER_INSERT`

### HlsEncryptionType
<a name="channels-channelid-stop-model-hlsencryptiontype"></a>

Hls Encryption Type
+ `AES128`
+ `SAMPLE_AES`

### HlsGroupSettings
<a name="channels-channelid-stop-model-hlsgroupsettings"></a>

Hls Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [HlsAdMarkers](#channels-channelid-stop-model-hlsadmarkers) | False | Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs. | 
| baseUrlContent | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlContent1 | string | False | Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0. | 
| baseUrlManifest | string | False | A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file. | 
| baseUrlManifest1 | string | False | Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0. | 
| captionLanguageMappings | Array of type [CaptionLanguageMapping](#channels-channelid-stop-model-captionlanguagemapping) | False | Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert". | 
| captionLanguageSetting | [HlsCaptionLanguageSetting](#channels-channelid-stop-model-hlscaptionlanguagesetting) | False | Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. | 
| clientCache | [HlsClientCache](#channels-channelid-stop-model-hlsclientcache) | False | When set to "disabled", sets the \$1EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. | 
| codecSpecification | [HlsCodecSpecification](#channels-channelid-stop-model-hlscodecspecification) | False | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. | 
| constantIv | stringMinLength: 32MaxLength: 32 | False | For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption. | 
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled). | 
| directoryStructure | [HlsDirectoryStructure](#channels-channelid-stop-model-hlsdirectorystructure) | False | Place segments in subdirectories. | 
| discontinuityTags | [HlsDiscontinuityTags](#channels-channelid-stop-model-hlsdiscontinuitytags) | False | Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags. | 
| encryptionType | [HlsEncryptionType](#channels-channelid-stop-model-hlsencryptiontype) | False | Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. | 
| hlsCdnSettings | [HlsCdnSettings](#channels-channelid-stop-model-hlscdnsettings) | False | Parameters that control interactions with the CDN. | 
| hlsId3SegmentTagging | [HlsId3SegmentTaggingState](#channels-channelid-stop-model-hlsid3segmenttaggingstate) | False | State of HLS ID3 Segment Tagging | 
| iFrameOnlyPlaylists | [IFrameOnlyPlaylistType](#channels-channelid-stop-model-iframeonlyplaylisttype) | False | DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a \$1EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more \$1EXT-X-BYTERANGE entries identifying the I-frame position. For example, \$1EXT-X-BYTERANGE:160364@1461888" | 
| incompleteSegmentBehavior | [HlsIncompleteSegmentBehavior](#channels-channelid-stop-model-hlsincompletesegmentbehavior) | False | Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior. | 
| indexNSegments | integerMinimum: 3 | False | Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be smaller than the number in the Keep Segments field. | 
| inputLossAction | [InputLossActionForHlsOut](#channels-channelid-stop-model-inputlossactionforhlsout) | False | Parameter that control output group behavior on input loss. | 
| ivInManifest | [HlsIvInManifest](#channels-channelid-stop-model-hlsivinmanifest) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. | 
| ivSource | [HlsIvSource](#channels-channelid-stop-model-hlsivsource) | False | For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. | 
| keepSegments | integerMinimum: 1 | False | Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) \$1 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player. | 
| keyFormat | string | False | The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given. | 
| keyFormatVersions | string | False | Either a single positive integer version value or a slash delimited list of version values (1/2/3). | 
| keyProviderSettings | [KeyProviderSettings](#channels-channelid-stop-model-keyprovidersettings) | False | The key provider settings. | 
| manifestCompression | [HlsManifestCompression](#channels-channelid-stop-model-hlsmanifestcompression) | False | When set to gzip, compresses HLS playlist. | 
| manifestDurationFormat | [HlsManifestDurationFormat](#channels-channelid-stop-model-hlsmanifestdurationformat) | False | Indicates whether the output manifest should use floating point or integer values for segment duration. | 
| minSegmentLength | integerMinimum: 0 | False | When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed. | 
| mode | [HlsMode](#channels-channelid-stop-model-hlsmode) | False | If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. | 
| outputSelection | [HlsOutputSelection](#channels-channelid-stop-model-hlsoutputselection) | False | MANIFESTS\$1AND\$1SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT\$1MANIFESTS\$1AND\$1SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS\$1ONLY: Does not generate any manifests for this output group. | 
| programDateTime | [HlsProgramDateTime](#channels-channelid-stop-model-hlsprogramdatetime) | False | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. | 
| programDateTimeClock | [HlsProgramDateTimeClock](#channels-channelid-stop-model-hlsprogramdatetimeclock) | False | Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE\$1FROM\$1OUTPUT\$1TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM\$1CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock. | 
| programDateTimePeriod | integerMinimum: 0Maximum: 3600 | False | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | 
| redundantManifest | [HlsRedundantManifest](#channels-channelid-stop-model-hlsredundantmanifest) | False | ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. | 
| segmentationMode | [HlsSegmentationMode](#channels-channelid-stop-model-hlssegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| segmentLength | integerMinimum: 1 | False | Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. | 
| segmentsPerSubdirectory | integerMinimum: 1 | False | Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect. | 
| streamInfResolution | [HlsStreamInfResolution](#channels-channelid-stop-model-hlsstreaminfresolution) | False | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. | 
| timedMetadataId3Frame | [HlsTimedMetadataId3Frame](#channels-channelid-stop-model-hlstimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 
| timestampDeltaMilliseconds | integerMinimum: 0 | False | Provides an extra millisecond delta offset to fine tune the timestamps. | 
| tsFileMode | [HlsTsFileMode](#channels-channelid-stop-model-hlstsfilemode) | False | SEGMENTED\$1FILES: Emit the program as segments - multiple .ts media files. SINGLE\$1FILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes \$1EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. | 

### HlsH265PackagingType
<a name="channels-channelid-stop-model-hlsh265packagingtype"></a>

Hls H265 Packaging Type
+ `HEV1`
+ `HVC1`

### HlsId3SegmentTaggingState
<a name="channels-channelid-stop-model-hlsid3segmenttaggingstate"></a>

State of HLS ID3 Segment Tagging
+ `DISABLED`
+ `ENABLED`

### HlsIncompleteSegmentBehavior
<a name="channels-channelid-stop-model-hlsincompletesegmentbehavior"></a>

Hls Incomplete Segment Behavior
+ `AUTO`
+ `SUPPRESS`

### HlsInputSettings
<a name="channels-channelid-stop-model-hlsinputsettings"></a>

Hls Input Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bandwidth | integerMinimum: 0 | False | When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest. | 
| bufferSegments | integerMinimum: 0 | False | When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8. | 
| retries | integerMinimum: 0 | False | The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable. | 
| retryInterval | integerMinimum: 0 | False | The number of seconds between retries when an attempt to read a manifest or segment fails. | 
| scte35Source | [HlsScte35SourceType](#channels-channelid-stop-model-hlsscte35sourcetype) | False | Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected. | 

### HlsIvInManifest
<a name="channels-channelid-stop-model-hlsivinmanifest"></a>

Hls Iv In Manifest
+ `EXCLUDE`
+ `INCLUDE`

### HlsIvSource
<a name="channels-channelid-stop-model-hlsivsource"></a>

Hls Iv Source
+ `EXPLICIT`
+ `FOLLOWS_SEGMENT_NUMBER`

### HlsManifestCompression
<a name="channels-channelid-stop-model-hlsmanifestcompression"></a>

Hls Manifest Compression
+ `GZIP`
+ `NONE`

### HlsManifestDurationFormat
<a name="channels-channelid-stop-model-hlsmanifestdurationformat"></a>

Hls Manifest Duration Format
+ `FLOATING_POINT`
+ `INTEGER`

### HlsMediaStoreSettings
<a name="channels-channelid-stop-model-hlsmediastoresettings"></a>

Hls Media Store Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| mediaStoreStorageClass | [HlsMediaStoreStorageClass](#channels-channelid-stop-model-hlsmediastorestorageclass) | False | When set to temporal, output files are stored in non-persistent memory for faster reading and writing. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HlsMediaStoreStorageClass
<a name="channels-channelid-stop-model-hlsmediastorestorageclass"></a>

Hls Media Store Storage Class
+ `TEMPORAL`

### HlsMode
<a name="channels-channelid-stop-model-hlsmode"></a>

Hls Mode
+ `LIVE`
+ `VOD`

### HlsOutputSelection
<a name="channels-channelid-stop-model-hlsoutputselection"></a>

Hls Output Selection
+ `MANIFESTS_AND_SEGMENTS`
+ `SEGMENTS_ONLY`
+ `VARIANT_MANIFESTS_AND_SEGMENTS`

### HlsOutputSettings
<a name="channels-channelid-stop-model-hlsoutputsettings"></a>

Hls Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [HlsH265PackagingType](#channels-channelid-stop-model-hlsh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| hlsSettings | [HlsSettings](#channels-channelid-stop-model-hlssettings) | True | Settings regarding the underlying stream. These settings are different for audio-only outputs. | 
| nameModifier | stringMinLength: 1 | False | String concatenated to the end of the destination filename. Accepts \$1"Format Identifiers\$1":\$1formatIdentifierParameters. | 
| segmentModifier | string | False | String concatenated to end of segment filenames. | 

### HlsProgramDateTime
<a name="channels-channelid-stop-model-hlsprogramdatetime"></a>

Hls Program Date Time
+ `EXCLUDE`
+ `INCLUDE`

### HlsProgramDateTimeClock
<a name="channels-channelid-stop-model-hlsprogramdatetimeclock"></a>

Hls Program Date Time Clock
+ `INITIALIZE_FROM_OUTPUT_TIMECODE`
+ `SYSTEM_CLOCK`

### HlsRedundantManifest
<a name="channels-channelid-stop-model-hlsredundantmanifest"></a>

Hls Redundant Manifest
+ `DISABLED`
+ `ENABLED`

### HlsS3LogUploads
<a name="channels-channelid-stop-model-hlss3loguploads"></a>

Hls S3 Log Uploads
+ `DISABLED`
+ `ENABLED`

### HlsS3Settings
<a name="channels-channelid-stop-model-hlss3settings"></a>

Hls S3 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cannedAcl | [S3CannedAcl](#channels-channelid-stop-model-s3cannedacl) | False | Specify the canned ACL to apply to each S3 request. Defaults to none. | 
| logUploads | [HlsS3LogUploads](#channels-channelid-stop-model-hlss3loguploads) | False | When set to enabled, each fragment upload to CDN or server will be logged. | 

### HlsScte35SourceType
<a name="channels-channelid-stop-model-hlsscte35sourcetype"></a>

Hls Scte35 Source Type
+ `MANIFEST`
+ `SEGMENTS`

### HlsSegmentationMode
<a name="channels-channelid-stop-model-hlssegmentationmode"></a>

Hls Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### HlsSettings
<a name="channels-channelid-stop-model-hlssettings"></a>

Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioOnlyHlsSettings | [AudioOnlyHlsSettings](#channels-channelid-stop-model-audioonlyhlssettings) | False |  | 
| fmp4HlsSettings | [Fmp4HlsSettings](#channels-channelid-stop-model-fmp4hlssettings) | False |  | 
| frameCaptureHlsSettings | [FrameCaptureHlsSettings](#channels-channelid-stop-model-framecapturehlssettings) | False |  | 
| standardHlsSettings | [StandardHlsSettings](#channels-channelid-stop-model-standardhlssettings) | False |  | 

### HlsStreamInfResolution
<a name="channels-channelid-stop-model-hlsstreaminfresolution"></a>

Hls Stream Inf Resolution
+ `EXCLUDE`
+ `INCLUDE`

### HlsTimedMetadataId3Frame
<a name="channels-channelid-stop-model-hlstimedmetadataid3frame"></a>

Hls Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### HlsTsFileMode
<a name="channels-channelid-stop-model-hlstsfilemode"></a>

Hls Ts File Mode
+ `SEGMENTED_FILES`
+ `SINGLE_FILE`

### HlsWebdavHttpTransferMode
<a name="channels-channelid-stop-model-hlswebdavhttptransfermode"></a>

Hls Webdav Http Transfer Mode
+ `CHUNKED`
+ `NON_CHUNKED`

### HlsWebdavSettings
<a name="channels-channelid-stop-model-hlswebdavsettings"></a>

Hls Webdav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the CDN if the connection is lost. | 
| filecacheDuration | integerMinimum: 0Maximum: 600 | False | Size in seconds of file cache for streaming outputs. | 
| httpTransferMode | [HlsWebdavHttpTransferMode](#channels-channelid-stop-model-hlswebdavhttptransfermode) | False | Specify whether or not to use chunked transfer encoding to WebDAV. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts that will be made before the Live Event is put into an error state. | 
| restartDelay | integerMinimum: 0Maximum: 15 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### HtmlMotionGraphicsSettings
<a name="channels-channelid-stop-model-htmlmotiongraphicssettings"></a>

Html Motion Graphics Settings

### IFrameOnlyPlaylistType
<a name="channels-channelid-stop-model-iframeonlyplaylisttype"></a>

When set to "standard", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.
+ `DISABLED`
+ `STANDARD`

### InputAttachment
<a name="channels-channelid-stop-model-inputattachment"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| automaticInputFailoverSettings | [AutomaticInputFailoverSettings](#channels-channelid-stop-model-automaticinputfailoversettings) | False | User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input. | 
| inputAttachmentName | string | False | User-specified name for the attachment. This is required if the user wants to use this input in an input switch action. | 
| inputId | string | False | The ID of the input | 
| inputSettings | [InputSettings](#channels-channelid-stop-model-inputsettings) | False | Settings of an input (caption selector, etc.) | 

### InputChannelLevel
<a name="channels-channelid-stop-model-inputchannellevel"></a>

Input Channel Level


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| gain | integerMinimum: -60Maximum: 6 | True | Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB. | 
| inputChannel | integerMinimum: 0Maximum: 15 | True | The index of the input channel used as a source. | 

### InputCodec
<a name="channels-channelid-stop-model-inputcodec"></a>

codec in increasing order of complexity
+ `MPEG2`
+ `AVC`
+ `HEVC`

### InputDeblockFilter
<a name="channels-channelid-stop-model-inputdeblockfilter"></a>

Input Deblock Filter
+ `DISABLED`
+ `ENABLED`

### InputDenoiseFilter
<a name="channels-channelid-stop-model-inputdenoisefilter"></a>

Input Denoise Filter
+ `DISABLED`
+ `ENABLED`

### InputFilter
<a name="channels-channelid-stop-model-inputfilter"></a>

Input Filter
+ `AUTO`
+ `DISABLED`
+ `FORCED`

### InputLocation
<a name="channels-channelid-stop-model-inputlocation"></a>

Input Location


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| uri | string | True | Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live". | 
| username | string | False | Username if credentials are required to access a file or publishing point. This can be either a plaintext username, or a reference to an AWS parameter store name from which the username can be retrieved. AWS Parameter store format: "ssm://<parameter name>" | 

### InputLossActionForHlsOut
<a name="channels-channelid-stop-model-inputlossactionforhlsout"></a>

Input Loss Action For Hls Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForMsSmoothOut
<a name="channels-channelid-stop-model-inputlossactionformssmoothout"></a>

Input Loss Action For Ms Smooth Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForRtmpOut
<a name="channels-channelid-stop-model-inputlossactionforrtmpout"></a>

Input Loss Action For Rtmp Out
+ `EMIT_OUTPUT`
+ `PAUSE_OUTPUT`

### InputLossActionForUdpOut
<a name="channels-channelid-stop-model-inputlossactionforudpout"></a>

Input Loss Action For Udp Out
+ `DROP_PROGRAM`
+ `DROP_TS`
+ `EMIT_PROGRAM`

### InputLossBehavior
<a name="channels-channelid-stop-model-inputlossbehavior"></a>

Input Loss Behavior


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to substitute black into the output before switching to the frame specified by inputLossImageType. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 
| inputLossImageColor | stringMinLength: 6MaxLength: 6 | False | When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB. | 
| inputLossImageSlate | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | When input loss image type is "slate" these fields specify the parameters for accessing the slate. | 
| inputLossImageType | [InputLossImageType](#channels-channelid-stop-model-inputlossimagetype) | False | Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. | 
| repeatFrameMsec | integerMinimum: 0Maximum: 1000000 | False | On input loss, the number of milliseconds to repeat the previous picture before substituting black into the output. A value x, where 0 <= x <= 1,000,000 and a value of 1,000,000 will be interpreted as infinite. | 

### InputLossFailoverSettings
<a name="channels-channelid-stop-model-inputlossfailoversettings"></a>

MediaLive will perform a failover if content is not detected in this input for the specified period.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossThresholdMsec | integerMinimum: 100 | False | The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur. | 

### InputLossImageType
<a name="channels-channelid-stop-model-inputlossimagetype"></a>

Input Loss Image Type
+ `COLOR`
+ `SLATE`

### InputMaximumBitrate
<a name="channels-channelid-stop-model-inputmaximumbitrate"></a>

Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### InputPreference
<a name="channels-channelid-stop-model-inputpreference"></a>

Input preference when deciding which input to make active when a previously failed input has recovered. If \$1"EQUAL\$1INPUT\$1PREFERENCE\$1", then the active input will stay active as long as it is healthy. If \$1"PRIMARY\$1INPUT\$1PREFERRED\$1", then always switch back to the primary input when it is healthy. 
+ `EQUAL_INPUT_PREFERENCE`
+ `PRIMARY_INPUT_PREFERRED`

### InputResolution
<a name="channels-channelid-stop-model-inputresolution"></a>

Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `UHD`

### InputSettings
<a name="channels-channelid-stop-model-inputsettings"></a>

Live Event input parameters. There can be multiple inputs in a single Live Event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioSelectors | Array of type [AudioSelector](#channels-channelid-stop-model-audioselector) | False | Used to select the audio stream to decode for inputs that have multiple available. | 
| captionSelectors | Array of type [CaptionSelector](#channels-channelid-stop-model-captionselector) | False | Used to select the caption input to use for inputs that have multiple available. | 
| deblockFilter | [InputDeblockFilter](#channels-channelid-stop-model-inputdeblockfilter) | False | Enable or disable the deblock filter when filtering. | 
| denoiseFilter | [InputDenoiseFilter](#channels-channelid-stop-model-inputdenoisefilter) | False | Enable or disable the denoise filter when filtering. | 
| filterStrength | integerMinimum: 1Maximum: 5 | False | Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest). | 
| inputFilter | [InputFilter](#channels-channelid-stop-model-inputfilter) | False | Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type | 
| networkInputSettings | [NetworkInputSettings](#channels-channelid-stop-model-networkinputsettings) | False | Input settings. | 
| smpte2038DataPreference | [Smpte2038DataPreference](#channels-channelid-stop-model-smpte2038datapreference) | False | Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038. | 
| sourceEndBehavior | [InputSourceEndBehavior](#channels-channelid-stop-model-inputsourceendbehavior) | False | Loop input if it is a file. This allows a file input to be streamed indefinitely. | 
| videoSelector | [VideoSelector](#channels-channelid-stop-model-videoselector) | False | Informs which video elementary stream to decode for input types that have multiple available. | 

### InputSourceEndBehavior
<a name="channels-channelid-stop-model-inputsourceendbehavior"></a>

Input Source End Behavior
+ `CONTINUE`
+ `LOOP`

### InputSpecification
<a name="channels-channelid-stop-model-inputspecification"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codec | [InputCodec](#channels-channelid-stop-model-inputcodec) | False | Input codec | 
| maximumBitrate | [InputMaximumBitrate](#channels-channelid-stop-model-inputmaximumbitrate) | False | Maximum input bitrate, categorized coarsely | 
| resolution | [InputResolution](#channels-channelid-stop-model-inputresolution) | False | Input resolution, categorized coarsely | 

### InternalServiceError
<a name="channels-channelid-stop-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="channels-channelid-stop-model-invalidrequest"></a>


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

### KeyProviderSettings
<a name="channels-channelid-stop-model-keyprovidersettings"></a>

Key Provider Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| staticKeySettings | [StaticKeySettings](#channels-channelid-stop-model-statickeysettings) | False |  | 

### LimitExceeded
<a name="channels-channelid-stop-model-limitexceeded"></a>


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

### LogLevel
<a name="channels-channelid-stop-model-loglevel"></a>

The log level the user wants for their channel.
+ `ERROR`
+ `WARNING`
+ `INFO`
+ `DEBUG`
+ `DISABLED`

### M2tsAbsentInputAudioBehavior
<a name="channels-channelid-stop-model-m2tsabsentinputaudiobehavior"></a>

M2ts Absent Input Audio Behavior
+ `DROP`
+ `ENCODE_SILENCE`

### M2tsArib
<a name="channels-channelid-stop-model-m2tsarib"></a>

M2ts Arib
+ `DISABLED`
+ `ENABLED`

### M2tsAribCaptionsPidControl
<a name="channels-channelid-stop-model-m2tsaribcaptionspidcontrol"></a>

M2ts Arib Captions Pid Control
+ `AUTO`
+ `USE_CONFIGURED`

### M2tsAudioBufferModel
<a name="channels-channelid-stop-model-m2tsaudiobuffermodel"></a>

M2ts Audio Buffer Model
+ `ATSC`
+ `DVB`

### M2tsAudioInterval
<a name="channels-channelid-stop-model-m2tsaudiointerval"></a>

M2ts Audio Interval
+ `VIDEO_AND_FIXED_INTERVALS`
+ `VIDEO_INTERVAL`

### M2tsAudioStreamType
<a name="channels-channelid-stop-model-m2tsaudiostreamtype"></a>

M2ts Audio Stream Type
+ `ATSC`
+ `DVB`

### M2tsBufferModel
<a name="channels-channelid-stop-model-m2tsbuffermodel"></a>

M2ts Buffer Model
+ `MULTIPLEX`
+ `NONE`

### M2tsCcDescriptor
<a name="channels-channelid-stop-model-m2tsccdescriptor"></a>

M2ts Cc Descriptor
+ `DISABLED`
+ `ENABLED`

### M2tsEbifControl
<a name="channels-channelid-stop-model-m2tsebifcontrol"></a>

M2ts Ebif Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsEbpPlacement
<a name="channels-channelid-stop-model-m2tsebpplacement"></a>

M2ts Ebp Placement
+ `VIDEO_AND_AUDIO_PIDS`
+ `VIDEO_PID`

### M2tsEsRateInPes
<a name="channels-channelid-stop-model-m2tsesrateinpes"></a>

M2ts Es Rate In Pes
+ `EXCLUDE`
+ `INCLUDE`

### M2tsKlv
<a name="channels-channelid-stop-model-m2tsklv"></a>

M2ts Klv
+ `NONE`
+ `PASSTHROUGH`

### M2tsNielsenId3Behavior
<a name="channels-channelid-stop-model-m2tsnielsenid3behavior"></a>

M2ts Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M2tsPcrControl
<a name="channels-channelid-stop-model-m2tspcrcontrol"></a>

M2ts Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M2tsRateMode
<a name="channels-channelid-stop-model-m2tsratemode"></a>

M2ts Rate Mode
+ `CBR`
+ `VBR`

### M2tsScte35Control
<a name="channels-channelid-stop-model-m2tsscte35control"></a>

M2ts Scte35 Control
+ `NONE`
+ `PASSTHROUGH`

### M2tsSegmentationMarkers
<a name="channels-channelid-stop-model-m2tssegmentationmarkers"></a>

M2ts Segmentation Markers
+ `EBP`
+ `EBP_LEGACY`
+ `NONE`
+ `PSI_SEGSTART`
+ `RAI_ADAPT`
+ `RAI_SEGSTART`

### M2tsSegmentationStyle
<a name="channels-channelid-stop-model-m2tssegmentationstyle"></a>

M2ts Segmentation Style
+ `MAINTAIN_CADENCE`
+ `RESET_CADENCE`

### M2tsSettings
<a name="channels-channelid-stop-model-m2tssettings"></a>

M2ts Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| absentInputAudioBehavior | [M2tsAbsentInputAudioBehavior](#channels-channelid-stop-model-m2tsabsentinputaudiobehavior) | False | When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. | 
| arib | [M2tsArib](#channels-channelid-stop-model-m2tsarib) | False | When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. | 
| aribCaptionsPid | string | False | Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| aribCaptionsPidControl | [M2tsAribCaptionsPidControl](#channels-channelid-stop-model-m2tsaribcaptionspidcontrol) | False | If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. | 
| audioBufferModel | [M2tsAudioBufferModel](#channels-channelid-stop-model-m2tsaudiobuffermodel) | False | When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. | 
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| audioStreamType | [M2tsAudioStreamType](#channels-channelid-stop-model-m2tsaudiostreamtype) | False | When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. | 
| bitrate | integerMinimum: 0 | False | The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. | 
| bufferModel | [M2tsBufferModel](#channels-channelid-stop-model-m2tsbuffermodel) | False | Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices. | 
| ccDescriptor | [M2tsCcDescriptor](#channels-channelid-stop-model-m2tsccdescriptor) | False | When set to enabled, generates captionServiceDescriptor in PMT. | 
| dvbNitSettings | [DvbNitSettings](#channels-channelid-stop-model-dvbnitsettings) | False | Inserts DVB Network Information Table (NIT) at the specified table repetition interval. | 
| dvbSdtSettings | [DvbSdtSettings](#channels-channelid-stop-model-dvbsdtsettings) | False | Inserts DVB Service Description Table (SDT) at the specified table repetition interval. | 
| dvbSubPids | string | False | Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| dvbTdtSettings | [DvbTdtSettings](#channels-channelid-stop-model-dvbtdtsettings) | False | Inserts DVB Time and Date Table (TDT) at the specified table repetition interval. | 
| dvbTeletextPid | string | False | Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| ebif | [M2tsEbifControl](#channels-channelid-stop-model-m2tsebifcontrol) | False | If set to passthrough, passes any EBIF data from the input source to this output. | 
| ebpAudioInterval | [M2tsAudioInterval](#channels-channelid-stop-model-m2tsaudiointerval) | False | When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. | 
| ebpLookaheadMs | integerMinimum: 0Maximum: 10000 | False | When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate. | 
| ebpPlacement | [M2tsEbpPlacement](#channels-channelid-stop-model-m2tsebpplacement) | False | Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. | 
| ecmPid | string | False | This field is unused and deprecated. | 
| esRateInPes | [M2tsEsRateInPes](#channels-channelid-stop-model-m2tsesrateinpes) | False | Include or exclude the ES Rate field in the PES header. | 
| etvPlatformPid | string | False | Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| etvSignalPid | string | False | Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| fragmentTime | numberMinimum: 0 | False | The length in seconds of each fragment. Only used with EBP markers. | 
| klv | [M2tsKlv](#channels-channelid-stop-model-m2tsklv) | False | If set to passthrough, passes any KLV data from the input source to this output. | 
| klvDataPids | string | False | Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| nielsenId3Behavior | [M2tsNielsenId3Behavior](#channels-channelid-stop-model-m2tsnielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| nullPacketBitrate | numberMinimum: 0 | False | Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pcrControl | [M2tsPcrControl](#channels-channelid-stop-model-m2tspcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| rateMode | [M2tsRateMode](#channels-channelid-stop-model-m2tsratemode) | False | When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. | 
| scte27Pids | string | False | Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6). | 
| scte35Control | [M2tsScte35Control](#channels-channelid-stop-model-m2tsscte35control) | False | Optionally pass SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| segmentationMarkers | [M2tsSegmentationMarkers](#channels-channelid-stop-model-m2tssegmentationmarkers) | False | Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. | 
| segmentationStyle | [M2tsSegmentationStyle](#channels-channelid-stop-model-m2tssegmentationstyle) | False | The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of \$1segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of \$1segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. | 
| segmentationTime | numberMinimum: 1 | False | The length in seconds of each segment. Required unless markers is set to \$1none\$1. | 
| timedMetadataBehavior | [M2tsTimedMetadataBehavior](#channels-channelid-stop-model-m2tstimedmetadatabehavior) | False | When set to passthrough, timed metadata will be passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 

### M2tsTimedMetadataBehavior
<a name="channels-channelid-stop-model-m2tstimedmetadatabehavior"></a>

M2ts Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8NielsenId3Behavior
<a name="channels-channelid-stop-model-m3u8nielsenid3behavior"></a>

M3u8 Nielsen Id3 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8PcrControl
<a name="channels-channelid-stop-model-m3u8pcrcontrol"></a>

M3u8 Pcr Control
+ `CONFIGURED_PCR_PERIOD`
+ `PCR_EVERY_PES_PACKET`

### M3u8Scte35Behavior
<a name="channels-channelid-stop-model-m3u8scte35behavior"></a>

M3u8 Scte35 Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### M3u8Settings
<a name="channels-channelid-stop-model-m3u8settings"></a>

Settings information for the .m3u8 container


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioFramesPerPes | integerMinimum: 0 | False | The number of audio frames to insert for each PES packet. | 
| audioPids | string | False | Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. | 
| ecmPid | string | False | This parameter is unused and deprecated. | 
| nielsenId3Behavior | [M3u8NielsenId3Behavior](#channels-channelid-stop-model-m3u8nielsenid3behavior) | False | If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output. | 
| patInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pcrControl | [M3u8PcrControl](#channels-channelid-stop-model-m3u8pcrcontrol) | False | When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. | 
| pcrPeriod | integerMinimum: 0Maximum: 500 | False | Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream. | 
| pcrPid | string | False | Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. | 
| pmtInterval | integerMinimum: 0Maximum: 1000 | False | The number of milliseconds between instances of this table in the output transport stream. A value of \$1"0\$1" writes out the PMT once per segment file. | 
| pmtPid | string | False | Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| programNum | integerMinimum: 0Maximum: 65535 | False | The value of the program number field in the Program Map Table. | 
| scte35Behavior | [M3u8Scte35Behavior](#channels-channelid-stop-model-m3u8scte35behavior) | False | If set to passthrough, passes any SCTE-35 signals from the input source to this output. | 
| scte35Pid | string | False | Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 
| timedMetadataBehavior | [M3u8TimedMetadataBehavior](#channels-channelid-stop-model-m3u8timedmetadatabehavior) | False | When set to passthrough, timed metadata is passed through from input to output. | 
| timedMetadataPid | string | False | Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6). | 
| transportStreamId | integerMinimum: 0Maximum: 65535 | False | The value of the transport stream ID field in the Program Map Table. | 
| videoPid | string | False | Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. | 

### M3u8TimedMetadataBehavior
<a name="channels-channelid-stop-model-m3u8timedmetadatabehavior"></a>

M3u8 Timed Metadata Behavior
+ `NO_PASSTHROUGH`
+ `PASSTHROUGH`

### MaintenanceDay
<a name="channels-channelid-stop-model-maintenanceday"></a>

The currently selected maintenance day.
+ `MONDAY`
+ `TUESDAY`
+ `WEDNESDAY`
+ `THURSDAY`
+ `FRIDAY`
+ `SATURDAY`
+ `SUNDAY`

### MaintenanceStatus
<a name="channels-channelid-stop-model-maintenancestatus"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maintenanceDay | [MaintenanceDay](#channels-channelid-stop-model-maintenanceday) | False | The currently selected maintenance day. | 
| maintenanceDeadline | stringFormat: string | False | Maintenance is required by the displayed date and time. Date and time is in ISO. | 
| maintenanceScheduledDate | stringFormat: string | False | The currently scheduled maintenance date and time. Date and time is in ISO. | 
| maintenanceStartTime | string | False | The currently selected maintenance start time. Time is in UTC. | 

### MediaPackageGroupSettings
<a name="channels-channelid-stop-model-mediapackagegroupsettings"></a>

Media Package Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | MediaPackage channel destination. | 

### MediaPackageOutputDestinationSettings
<a name="channels-channelid-stop-model-mediapackageoutputdestinationsettings"></a>

MediaPackage Output Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | stringMinLength: 1 | False | ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region. | 

### MediaPackageOutputSettings
<a name="channels-channelid-stop-model-mediapackageoutputsettings"></a>

Media Package Output Settings

### MotionGraphicsConfiguration
<a name="channels-channelid-stop-model-motiongraphicsconfiguration"></a>

Motion Graphics Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| motionGraphicsInsertion | [MotionGraphicsInsertion](#channels-channelid-stop-model-motiongraphicsinsertion) | False |  | 
| motionGraphicsSettings | [MotionGraphicsSettings](#channels-channelid-stop-model-motiongraphicssettings) | True | Motion Graphics Settings | 

### MotionGraphicsInsertion
<a name="channels-channelid-stop-model-motiongraphicsinsertion"></a>

Motion Graphics Insertion
+ `DISABLED`
+ `ENABLED`

### MotionGraphicsSettings
<a name="channels-channelid-stop-model-motiongraphicssettings"></a>

Motion Graphics Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| htmlMotionGraphicsSettings | [HtmlMotionGraphicsSettings](#channels-channelid-stop-model-htmlmotiongraphicssettings) | False |  | 

### Mp2CodingMode
<a name="channels-channelid-stop-model-mp2codingmode"></a>

Mp2 Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`

### Mp2Settings
<a name="channels-channelid-stop-model-mp2settings"></a>

Mp2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitrate | number | False | Average bitrate in bits/second. | 
| codingMode | [Mp2CodingMode](#channels-channelid-stop-model-mp2codingmode) | False | The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). | 
| sampleRate | number | False | Sample rate in Hz. | 

### Mpeg2AdaptiveQuantization
<a name="channels-channelid-stop-model-mpeg2adaptivequantization"></a>

Mpeg2 Adaptive Quantization
+ `AUTO`
+ `HIGH`
+ `LOW`
+ `MEDIUM`
+ `OFF`

### Mpeg2ColorMetadata
<a name="channels-channelid-stop-model-mpeg2colormetadata"></a>

Mpeg2 Color Metadata
+ `IGNORE`
+ `INSERT`

### Mpeg2ColorSpace
<a name="channels-channelid-stop-model-mpeg2colorspace"></a>

Mpeg2 Color Space
+ `AUTO`
+ `PASSTHROUGH`

### Mpeg2DisplayRatio
<a name="channels-channelid-stop-model-mpeg2displayratio"></a>

Mpeg2 Display Ratio
+ `DISPLAYRATIO16X9`
+ `DISPLAYRATIO4X3`

### Mpeg2FilterSettings
<a name="channels-channelid-stop-model-mpeg2filtersettings"></a>

Mpeg2 Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| temporalFilterSettings | [TemporalFilterSettings](#channels-channelid-stop-model-temporalfiltersettings) | False |  | 

### Mpeg2GopSizeUnits
<a name="channels-channelid-stop-model-mpeg2gopsizeunits"></a>

Mpeg2 Gop Size Units
+ `FRAMES`
+ `SECONDS`

### Mpeg2ScanType
<a name="channels-channelid-stop-model-mpeg2scantype"></a>

Mpeg2 Scan Type
+ `INTERLACED`
+ `PROGRESSIVE`

### Mpeg2Settings
<a name="channels-channelid-stop-model-mpeg2settings"></a>

Mpeg2 Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adaptiveQuantization | [Mpeg2AdaptiveQuantization](#channels-channelid-stop-model-mpeg2adaptivequantization) | False | Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality. | 
| afdSignaling | [AfdSignaling](#channels-channelid-stop-model-afdsignaling) | False | Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD. | 
| colorMetadata | [Mpeg2ColorMetadata](#channels-channelid-stop-model-mpeg2colormetadata) | False | Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata. | 
| colorSpace | [Mpeg2ColorSpace](#channels-channelid-stop-model-mpeg2colorspace) | False | Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \$1"MediaLive Features - Video - color space\$1" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709. | 
| displayAspectRatio | [Mpeg2DisplayRatio](#channels-channelid-stop-model-mpeg2displayratio) | False | Sets the pixel aspect ratio for the encode. | 
| filterSettings | [Mpeg2FilterSettings](#channels-channelid-stop-model-mpeg2filtersettings) | False | Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate. | 
| fixedAfd | [FixedAfd](#channels-channelid-stop-model-fixedafd) | False | Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode. | 
| framerateDenominator | integerMinimum: 1 | True | description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| framerateNumerator | integerMinimum: 1 | True | The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000 / 1001 = 23.976 FPS. | 
| gopClosedCadence | integerMinimum: 0 | False | MPEG2: default is open GOP. | 
| gopNumBFrames | integerMinimum: 0Maximum: 7 | False | Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default. | 
| gopSize | number | False | Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer. | 
| gopSizeUnits | [Mpeg2GopSizeUnits](#channels-channelid-stop-model-mpeg2gopsizeunits) | False | Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count. | 
| scanType | [Mpeg2ScanType](#channels-channelid-stop-model-mpeg2scantype) | False | Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first). | 
| subgopLength | [Mpeg2SubGopLength](#channels-channelid-stop-model-mpeg2subgoplength) | False | Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality. | 
| timecodeInsertion | [Mpeg2TimecodeInsertionBehavior](#channels-channelid-stop-model-mpeg2timecodeinsertionbehavior) | False | Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \$1"MediaLive Features - Timecode configuration\$1" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP\$1TIMECODE: Include timecode metadata in the GOP header. | 

### Mpeg2SubGopLength
<a name="channels-channelid-stop-model-mpeg2subgoplength"></a>

Mpeg2 Sub Gop Length
+ `DYNAMIC`
+ `FIXED`

### Mpeg2TimecodeInsertionBehavior
<a name="channels-channelid-stop-model-mpeg2timecodeinsertionbehavior"></a>

Mpeg2 Timecode Insertion Behavior
+ `DISABLED`
+ `GOP_TIMECODE`

### MsSmoothGroupSettings
<a name="channels-channelid-stop-model-mssmoothgroupsettings"></a>

Ms Smooth Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| acquisitionPointId | string | False | The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE. | 
| audioOnlyTimecodeControl | [SmoothGroupAudioOnlyTimecodeControl](#channels-channelid-stop-model-smoothgroupaudioonlytimecodecontrol) | False | If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. | 
| certificateMode | [SmoothGroupCertificateMode](#channels-channelid-stop-model-smoothgroupcertificatemode) | False | If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 0 | False | Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established. | 
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS. | 
| eventId | string | False | MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured. | 
| eventIdMode | [SmoothGroupEventIdMode](#channels-channelid-stop-model-smoothgroupeventidmode) | False | Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. | 
| eventStopBehavior | [SmoothGroupEventStopBehavior](#channels-channelid-stop-model-smoothgroupeventstopbehavior) | False | When set to sendEos, send EOS signal to IIS server when stopping the event | 
| filecacheDuration | integerMinimum: 0 | False | Size in seconds of file cache for streaming outputs. | 
| fragmentLength | integerMinimum: 1 | False | Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate. | 
| inputLossAction | [InputLossActionForMsSmoothOut](#channels-channelid-stop-model-inputlossactionformssmoothout) | False | Parameter that control output group behavior on input loss. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 
| restartDelay | integerMinimum: 0 | False | Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration. | 
| segmentationMode | [SmoothGroupSegmentationMode](#channels-channelid-stop-model-smoothgroupsegmentationmode) | False | useInputSegmentation has been deprecated. The configured segment size is always used. | 
| sendDelayMs | integerMinimum: 0Maximum: 10000 | False | Number of milliseconds to delay the output from the second pipeline. | 
| sparseTrackType | [SmoothGroupSparseTrackType](#channels-channelid-stop-model-smoothgroupsparsetracktype) | False | Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35\$1WITHOUT\$1SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group. | 
| streamManifestBehavior | [SmoothGroupStreamManifestBehavior](#channels-channelid-stop-model-smoothgroupstreammanifestbehavior) | False | When set to send, send stream manifest so publishing point doesn't start until all streams start. | 
| timestampOffset | string | False | Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset. | 
| timestampOffsetMode | [SmoothGroupTimestampOffsetMode](#channels-channelid-stop-model-smoothgrouptimestampoffsetmode) | False | Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset | 

### MsSmoothH265PackagingType
<a name="channels-channelid-stop-model-mssmoothh265packagingtype"></a>

Ms Smooth H265 Packaging Type
+ `HEV1`
+ `HVC1`

### MsSmoothOutputSettings
<a name="channels-channelid-stop-model-mssmoothoutputsettings"></a>

Ms Smooth Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| h265PackagingType | [MsSmoothH265PackagingType](#channels-channelid-stop-model-mssmoothh265packagingtype) | False | Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1. | 
| nameModifier | string | False | String concatenated to the end of the destination filename. Required for multiple outputs of the same type. | 

### MultiplexGroupSettings
<a name="channels-channelid-stop-model-multiplexgroupsettings"></a>

Multiplex Group Settings

### MultiplexOutputSettings
<a name="channels-channelid-stop-model-multiplexoutputsettings"></a>

Multiplex Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | Destination is a Multiplex. | 

### MultiplexProgramChannelDestinationSettings
<a name="channels-channelid-stop-model-multiplexprogramchanneldestinationsettings"></a>

Multiplex Program Input Destination Settings for outputting a Channel to a Multiplex


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexId | stringMinLength: 1 | False | The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel. | 
| programName | stringMinLength: 1 | False | The program name of the Multiplex program that the encoder is providing output to. | 

### NetworkInputServerValidation
<a name="channels-channelid-stop-model-networkinputservervalidation"></a>

Network Input Server Validation
+ `CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME`
+ `CHECK_CRYPTOGRAPHY_ONLY`

### NetworkInputSettings
<a name="channels-channelid-stop-model-networkinputsettings"></a>

Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hlsInputSettings | [HlsInputSettings](#channels-channelid-stop-model-hlsinputsettings) | False | Specifies HLS input settings when the uri is for a HLS manifest. | 
| serverValidation | [NetworkInputServerValidation](#channels-channelid-stop-model-networkinputservervalidation) | False | Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. | 

### NielsenCBET
<a name="channels-channelid-stop-model-nielsencbet"></a>

Nielsen CBET


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cbetCheckDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the CBET check digits to use in the watermark. | 
| cbetStepaside | [NielsenWatermarksCbetStepaside](#channels-channelid-stop-model-nielsenwatermarkscbetstepaside) | True | Determines the method of CBET insertion mode when prior encoding is detected on the same layer. | 
| csid | stringMinLength: 1MaxLength: 7 | True | Enter the CBET Source ID (CSID) to use in the watermark | 

### NielsenConfiguration
<a name="channels-channelid-stop-model-nielsenconfiguration"></a>

Nielsen Configuration


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| distributorId | string | False | Enter the Distributor ID assigned to your organization by Nielsen. | 
| nielsenPcmToId3Tagging | [NielsenPcmToId3TaggingState](#channels-channelid-stop-model-nielsenpcmtoid3taggingstate) | False | Enables Nielsen PCM to ID3 tagging | 

### NielsenNaesIiNw
<a name="channels-channelid-stop-model-nielsennaesiinw"></a>

Nielsen Naes Ii Nw


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| checkDigitString | stringMinLength: 2MaxLength: 2 | True | Enter the check digit string for the watermark | 
| sid | numberMinimum: 1Maximum: 65535 | True | Enter the Nielsen Source ID (SID) to include in the watermark | 

### NielsenPcmToId3TaggingState
<a name="channels-channelid-stop-model-nielsenpcmtoid3taggingstate"></a>

State of Nielsen PCM to ID3 tagging
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksCbetStepaside
<a name="channels-channelid-stop-model-nielsenwatermarkscbetstepaside"></a>

Nielsen Watermarks Cbet Stepaside
+ `DISABLED`
+ `ENABLED`

### NielsenWatermarksDistributionTypes
<a name="channels-channelid-stop-model-nielsenwatermarksdistributiontypes"></a>

Nielsen Watermarks Distribution Types
+ `FINAL_DISTRIBUTOR`
+ `PROGRAM_CONTENT`

### NielsenWatermarksSettings
<a name="channels-channelid-stop-model-nielsenwatermarkssettings"></a>

Nielsen Watermarks Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nielsenCbetSettings | [NielsenCBET](#channels-channelid-stop-model-nielsencbet) | False | Complete these fields only if you want to insert watermarks of type Nielsen CBET | 
| nielsenDistributionType | [NielsenWatermarksDistributionTypes](#channels-channelid-stop-model-nielsenwatermarksdistributiontypes) | False | Choose the distribution types that you want to assign to the watermarks: - PROGRAM\$1CONTENT - FINAL\$1DISTRIBUTOR | 
| nielsenNaesIiNwSettings | [NielsenNaesIiNw](#channels-channelid-stop-model-nielsennaesiinw) | False | Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW). | 

### Output
<a name="channels-channelid-stop-model-output"></a>

Output settings. There can be multiple outputs within a group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioDescriptionNames | Array of type string | False | The names of the AudioDescriptions used as audio sources for this output. | 
| captionDescriptionNames | Array of type string | False | The names of the CaptionDescriptions used as caption sources for this output. | 
| outputName | stringMinLength: 1MaxLength: 255 | False | The name used to identify an output. | 
| outputSettings | [OutputSettings](#channels-channelid-stop-model-outputsettings) | True | Output type-specific settings. | 
| videoDescriptionName | string | False | The name of the VideoDescription used as the source for this output. | 

### OutputDestination
<a name="channels-channelid-stop-model-outputdestination"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | User-specified id. This is used in an output group or an output. | 
| mediaPackageSettings | Array of type [MediaPackageOutputDestinationSettings](#channels-channelid-stop-model-mediapackageoutputdestinationsettings) | False | Destination settings for a MediaPackage output; one destination for both encoders. | 
| multiplexSettings | [MultiplexProgramChannelDestinationSettings](#channels-channelid-stop-model-multiplexprogramchanneldestinationsettings) | False | Destination settings for a Multiplex output; one destination for both encoders. | 
| settings | Array of type [OutputDestinationSettings](#channels-channelid-stop-model-outputdestinationsettings) | False | Destination settings for a standard output; one destination for each redundant encoder. | 

### OutputDestinationSettings
<a name="channels-channelid-stop-model-outputdestinationsettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | key used to extract the password from EC2 Parameter store | 
| streamName | string | False | Stream name for RTMP destinations (URLs of type rtmp://) | 
| url | string | False | A URL specifying a destination | 
| username | string | False | username for destination | 

### OutputGroup
<a name="channels-channelid-stop-model-outputgroup"></a>

Output groups for this Live Event. Output groups contain information about where streams should be distributed.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | stringMaxLength: 32 | False | Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed. | 
| outputGroupSettings | [OutputGroupSettings](#channels-channelid-stop-model-outputgroupsettings) | True | Settings associated with the output group. | 
| outputs | Array of type [Output](#channels-channelid-stop-model-output) | True |  | 

### OutputGroupSettings
<a name="channels-channelid-stop-model-outputgroupsettings"></a>

Output Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveGroupSettings | [ArchiveGroupSettings](#channels-channelid-stop-model-archivegroupsettings) | False |  | 
| frameCaptureGroupSettings | [FrameCaptureGroupSettings](#channels-channelid-stop-model-framecapturegroupsettings) | False |  | 
| hlsGroupSettings | [HlsGroupSettings](#channels-channelid-stop-model-hlsgroupsettings) | False |  | 
| mediaPackageGroupSettings | [MediaPackageGroupSettings](#channels-channelid-stop-model-mediapackagegroupsettings) | False |  | 
| msSmoothGroupSettings | [MsSmoothGroupSettings](#channels-channelid-stop-model-mssmoothgroupsettings) | False |  | 
| multiplexGroupSettings | [MultiplexGroupSettings](#channels-channelid-stop-model-multiplexgroupsettings) | False |  | 
| rtmpGroupSettings | [RtmpGroupSettings](#channels-channelid-stop-model-rtmpgroupsettings) | False |  | 
| udpGroupSettings | [UdpGroupSettings](#channels-channelid-stop-model-udpgroupsettings) | False |  | 

### OutputLocationRef
<a name="channels-channelid-stop-model-outputlocationref"></a>

Reference to an OutputDestination ID defined in the channel


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

### OutputSettings
<a name="channels-channelid-stop-model-outputsettings"></a>

Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| archiveOutputSettings | [ArchiveOutputSettings](#channels-channelid-stop-model-archiveoutputsettings) | False |  | 
| frameCaptureOutputSettings | [FrameCaptureOutputSettings](#channels-channelid-stop-model-framecaptureoutputsettings) | False |  | 
| hlsOutputSettings | [HlsOutputSettings](#channels-channelid-stop-model-hlsoutputsettings) | False |  | 
| mediaPackageOutputSettings | [MediaPackageOutputSettings](#channels-channelid-stop-model-mediapackageoutputsettings) | False |  | 
| msSmoothOutputSettings | [MsSmoothOutputSettings](#channels-channelid-stop-model-mssmoothoutputsettings) | False |  | 
| multiplexOutputSettings | [MultiplexOutputSettings](#channels-channelid-stop-model-multiplexoutputsettings) | False |  | 
| rtmpOutputSettings | [RtmpOutputSettings](#channels-channelid-stop-model-rtmpoutputsettings) | False |  | 
| udpOutputSettings | [UdpOutputSettings](#channels-channelid-stop-model-udpoutputsettings) | False |  | 

### PassThroughSettings
<a name="channels-channelid-stop-model-passthroughsettings"></a>

Pass Through Settings

### PipelineDetail
<a name="channels-channelid-stop-model-pipelinedetail"></a>

Runtime details of a pipeline when a channel is running.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInputAttachmentName | string | False | The name of the active input attachment currently being ingested by this pipeline. | 
| activeInputSwitchActionName | string | False | The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline. | 
| activeMotionGraphicsActionName | string | False | The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline. | 
| activeMotionGraphicsUri | string | False | The current URI being used for HTML5 motion graphics for this pipeline. | 
| pipelineId | string | False | Pipeline ID | 

### RawSettings
<a name="channels-channelid-stop-model-rawsettings"></a>

Raw Settings

### Rec601Settings
<a name="channels-channelid-stop-model-rec601settings"></a>

Rec601 Settings

### Rec709Settings
<a name="channels-channelid-stop-model-rec709settings"></a>

Rec709 Settings

### RemixSettings
<a name="channels-channelid-stop-model-remixsettings"></a>

Remix Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelMappings | Array of type [AudioChannelMapping](#channels-channelid-stop-model-audiochannelmapping) | True | Mapping of input channels to output channels, with appropriate gain adjustments. | 
| channelsIn | integerMinimum: 1Maximum: 16 | False | Number of input channels to be used. | 
| channelsOut | integerMinimum: 1Maximum: 8 | False | Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8 | 

### ResourceConflict
<a name="channels-channelid-stop-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="channels-channelid-stop-model-resourcenotfound"></a>


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

### RtmpAdMarkers
<a name="channels-channelid-stop-model-rtmpadmarkers"></a>

Rtmp Ad Markers
+ `ON_CUE_POINT_SCTE35`

### RtmpCacheFullBehavior
<a name="channels-channelid-stop-model-rtmpcachefullbehavior"></a>

Rtmp Cache Full Behavior
+ `DISCONNECT_IMMEDIATELY`
+ `WAIT_FOR_SERVER`

### RtmpCaptionData
<a name="channels-channelid-stop-model-rtmpcaptiondata"></a>

Rtmp Caption Data
+ `ALL`
+ `FIELD1_608`
+ `FIELD1_AND_FIELD2_608`

### RtmpCaptionInfoDestinationSettings
<a name="channels-channelid-stop-model-rtmpcaptioninfodestinationsettings"></a>

Rtmp Caption Info Destination Settings

### RtmpGroupSettings
<a name="channels-channelid-stop-model-rtmpgroupsettings"></a>

Rtmp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adMarkers | Array of type [RtmpAdMarkers](#channels-channelid-stop-model-rtmpadmarkers) | False | Choose the ad marker type for this output group. MediaLive will create a message based on the content of each SCTE-35 message, format it for that marker type, and insert it in the datastream. | 
| authenticationScheme | [AuthenticationScheme](#channels-channelid-stop-model-authenticationscheme) | False | Authentication scheme to use when connecting with CDN | 
| cacheFullBehavior | [RtmpCacheFullBehavior](#channels-channelid-stop-model-rtmpcachefullbehavior) | False | Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. | 
| cacheLength | integerMinimum: 30 | False | Cache length, in seconds, is used to calculate buffer size. | 
| captionData | [RtmpCaptionData](#channels-channelid-stop-model-rtmpcaptiondata) | False | Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. | 
| inputLossAction | [InputLossActionForRtmpOut](#channels-channelid-stop-model-inputlossactionforrtmpout) | False | Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. | 
| restartDelay | integerMinimum: 0 | False | If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart. | 

### RtmpOutputCertificateMode
<a name="channels-channelid-stop-model-rtmpoutputcertificatemode"></a>

Rtmp Output Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### RtmpOutputSettings
<a name="channels-channelid-stop-model-rtmpoutputsettings"></a>

Rtmp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| certificateMode | [RtmpOutputCertificateMode](#channels-channelid-stop-model-rtmpoutputcertificatemode) | False | If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. | 
| connectionRetryInterval | integerMinimum: 1 | False | Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost. | 
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers. | 
| numRetries | integerMinimum: 0 | False | Number of retry attempts. | 

### S3CannedAcl
<a name="channels-channelid-stop-model-s3cannedacl"></a>

S3 Canned Acl
+ `AUTHENTICATED_READ`
+ `BUCKET_OWNER_FULL_CONTROL`
+ `BUCKET_OWNER_READ`
+ `PUBLIC_READ`

### Scte20Convert608To708
<a name="channels-channelid-stop-model-scte20convert608to708"></a>

Scte20 Convert608 To708
+ `DISABLED`
+ `UPCONVERT`

### Scte20PlusEmbeddedDestinationSettings
<a name="channels-channelid-stop-model-scte20plusembeddeddestinationsettings"></a>

Scte20 Plus Embedded Destination Settings

### Scte20SourceSettings
<a name="channels-channelid-stop-model-scte20sourcesettings"></a>

Scte20 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| convert608To708 | [Scte20Convert608To708](#channels-channelid-stop-model-scte20convert608to708) | False | If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. | 
| source608ChannelNumber | integerMinimum: 1Maximum: 4 | False | Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. | 

### Scte27DestinationSettings
<a name="channels-channelid-stop-model-scte27destinationsettings"></a>

Scte27 Destination Settings

### Scte27OcrLanguage
<a name="channels-channelid-stop-model-scte27ocrlanguage"></a>

Scte27 Ocr Language
+ `DEU`
+ `ENG`
+ `FRA`
+ `NLD`
+ `POR`
+ `SPA`

### Scte27SourceSettings
<a name="channels-channelid-stop-model-scte27sourcesettings"></a>

Scte27 Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ocrLanguage | [Scte27OcrLanguage](#channels-channelid-stop-model-scte27ocrlanguage) | False | If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text. | 
| pid | integerMinimum: 1 | False | The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through. | 

### Scte35AposNoRegionalBlackoutBehavior
<a name="channels-channelid-stop-model-scte35aposnoregionalblackoutbehavior"></a>

Scte35 Apos No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35AposWebDeliveryAllowedBehavior
<a name="channels-channelid-stop-model-scte35aposwebdeliveryallowedbehavior"></a>

Scte35 Apos Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsert
<a name="channels-channelid-stop-model-scte35spliceinsert"></a>

Scte35 Splice Insert


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35SpliceInsertNoRegionalBlackoutBehavior](#channels-channelid-stop-model-scte35spliceinsertnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35SpliceInsertWebDeliveryAllowedBehavior](#channels-channelid-stop-model-scte35spliceinsertwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### Scte35SpliceInsertNoRegionalBlackoutBehavior
<a name="channels-channelid-stop-model-scte35spliceinsertnoregionalblackoutbehavior"></a>

Scte35 Splice Insert No Regional Blackout Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35SpliceInsertWebDeliveryAllowedBehavior
<a name="channels-channelid-stop-model-scte35spliceinsertwebdeliveryallowedbehavior"></a>

Scte35 Splice Insert Web Delivery Allowed Behavior
+ `FOLLOW`
+ `IGNORE`

### Scte35TimeSignalApos
<a name="channels-channelid-stop-model-scte35timesignalapos"></a>

Scte35 Time Signal Apos


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| adAvailOffset | integerMinimum: -1000Maximum: 1000 | False | When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages. | 
| noRegionalBlackoutFlag | [Scte35AposNoRegionalBlackoutBehavior](#channels-channelid-stop-model-scte35aposnoregionalblackoutbehavior) | False | When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 
| webDeliveryAllowedFlag | [Scte35AposWebDeliveryAllowedBehavior](#channels-channelid-stop-model-scte35aposwebdeliveryallowedbehavior) | False | When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates | 

### SmoothGroupAudioOnlyTimecodeControl
<a name="channels-channelid-stop-model-smoothgroupaudioonlytimecodecontrol"></a>

Smooth Group Audio Only Timecode Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED_CLOCK`

### SmoothGroupCertificateMode
<a name="channels-channelid-stop-model-smoothgroupcertificatemode"></a>

Smooth Group Certificate Mode
+ `SELF_SIGNED`
+ `VERIFY_AUTHENTICITY`

### SmoothGroupEventIdMode
<a name="channels-channelid-stop-model-smoothgroupeventidmode"></a>

Smooth Group Event Id Mode
+ `NO_EVENT_ID`
+ `USE_CONFIGURED`
+ `USE_TIMESTAMP`

### SmoothGroupEventStopBehavior
<a name="channels-channelid-stop-model-smoothgroupeventstopbehavior"></a>

Smooth Group Event Stop Behavior
+ `NONE`
+ `SEND_EOS`

### SmoothGroupSegmentationMode
<a name="channels-channelid-stop-model-smoothgroupsegmentationmode"></a>

Smooth Group Segmentation Mode
+ `USE_INPUT_SEGMENTATION`
+ `USE_SEGMENT_DURATION`

### SmoothGroupSparseTrackType
<a name="channels-channelid-stop-model-smoothgroupsparsetracktype"></a>

Smooth Group Sparse Track Type
+ `NONE`
+ `SCTE_35`
+ `SCTE_35_WITHOUT_SEGMENTATION`

### SmoothGroupStreamManifestBehavior
<a name="channels-channelid-stop-model-smoothgroupstreammanifestbehavior"></a>

Smooth Group Stream Manifest Behavior
+ `DO_NOT_SEND`
+ `SEND`

### SmoothGroupTimestampOffsetMode
<a name="channels-channelid-stop-model-smoothgrouptimestampoffsetmode"></a>

Smooth Group Timestamp Offset Mode
+ `USE_CONFIGURED_OFFSET`
+ `USE_EVENT_START_DATE`

### Smpte2038DataPreference
<a name="channels-channelid-stop-model-smpte2038datapreference"></a>

Smpte2038 Data Preference
+ `IGNORE`
+ `PREFER`

### SmpteTtDestinationSettings
<a name="channels-channelid-stop-model-smptettdestinationsettings"></a>

Smpte Tt Destination Settings

### StandardHlsSettings
<a name="channels-channelid-stop-model-standardhlssettings"></a>

Standard Hls Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| audioRenditionSets | string | False | List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','. | 
| m3u8Settings | [M3u8Settings](#channels-channelid-stop-model-m3u8settings) | True |  | 

### StaticKeySettings
<a name="channels-channelid-stop-model-statickeysettings"></a>

Static Key Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| keyProviderServer | [InputLocation](#channels-channelid-stop-model-inputlocation) | False | The URL of the license server used for protecting content. | 
| staticKeyValue | stringMinLength: 32MaxLength: 32 | True | Static key value as a 32 character hexadecimal string. | 

### Tags
<a name="channels-channelid-stop-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TeletextDestinationSettings
<a name="channels-channelid-stop-model-teletextdestinationsettings"></a>

Teletext Destination Settings

### TeletextSourceSettings
<a name="channels-channelid-stop-model-teletextsourcesettings"></a>

Teletext Source Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| outputRectangle | [CaptionRectangle](#channels-channelid-stop-model-captionrectangle) | False | Optionally defines a region where TTML style captions will be displayed | 
| pageNumber | string | False | Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix. | 

### TemporalFilterPostFilterSharpening
<a name="channels-channelid-stop-model-temporalfilterpostfiltersharpening"></a>

Temporal Filter Post Filter Sharpening
+ `AUTO`
+ `DISABLED`
+ `ENABLED`

### TemporalFilterSettings
<a name="channels-channelid-stop-model-temporalfiltersettings"></a>

Temporal Filter Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| postFilterSharpening | [TemporalFilterPostFilterSharpening](#channels-channelid-stop-model-temporalfilterpostfiltersharpening) | False | If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR. | 
| strength | [TemporalFilterStrength](#channels-channelid-stop-model-temporalfilterstrength) | False | Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft. | 

### TemporalFilterStrength
<a name="channels-channelid-stop-model-temporalfilterstrength"></a>

Temporal Filter Strength
+ `AUTO`
+ `STRENGTH_1`
+ `STRENGTH_2`
+ `STRENGTH_3`
+ `STRENGTH_4`
+ `STRENGTH_5`
+ `STRENGTH_6`
+ `STRENGTH_7`
+ `STRENGTH_8`
+ `STRENGTH_9`
+ `STRENGTH_10`
+ `STRENGTH_11`
+ `STRENGTH_12`
+ `STRENGTH_13`
+ `STRENGTH_14`
+ `STRENGTH_15`
+ `STRENGTH_16`

### TimecodeConfig
<a name="channels-channelid-stop-model-timecodeconfig"></a>

Timecode Config


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| source | [TimecodeConfigSource](#channels-channelid-stop-model-timecodeconfigsource) | True | Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. | 
| syncThreshold | integerMinimum: 1Maximum: 1000000 | False | Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified. | 

### TimecodeConfigSource
<a name="channels-channelid-stop-model-timecodeconfigsource"></a>

Timecode Config Source
+ `EMBEDDED`
+ `SYSTEMCLOCK`
+ `ZEROBASED`

### TtmlDestinationSettings
<a name="channels-channelid-stop-model-ttmldestinationsettings"></a>

Ttml Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [TtmlDestinationStyleControl](#channels-channelid-stop-model-ttmldestinationstylecontrol) | False | When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. | 

### TtmlDestinationStyleControl
<a name="channels-channelid-stop-model-ttmldestinationstylecontrol"></a>

Ttml Destination Style Control
+ `PASSTHROUGH`
+ `USE_CONFIGURED`

### UdpContainerSettings
<a name="channels-channelid-stop-model-udpcontainersettings"></a>

Udp Container Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| m2tsSettings | [M2tsSettings](#channels-channelid-stop-model-m2tssettings) | False |  | 

### UdpGroupSettings
<a name="channels-channelid-stop-model-udpgroupsettings"></a>

Udp Group Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputLossAction | [InputLossActionForUdpOut](#channels-channelid-stop-model-inputlossactionforudpout) | False | Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. | 
| timedMetadataId3Frame | [UdpTimedMetadataId3Frame](#channels-channelid-stop-model-udptimedmetadataid3frame) | False | Indicates ID3 frame that has the timecode. | 
| timedMetadataId3Period | integerMinimum: 0 | False | Timed Metadata interval in seconds. | 

### UdpOutputSettings
<a name="channels-channelid-stop-model-udpoutputsettings"></a>

Udp Output Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bufferMsec | integerMinimum: 0Maximum: 10000 | False | UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc. | 
| containerSettings | [UdpContainerSettings](#channels-channelid-stop-model-udpcontainersettings) | True |  | 
| destination | [OutputLocationRef](#channels-channelid-stop-model-outputlocationref) | True | Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002). | 
| fecOutputSettings | [FecOutputSettings](#channels-channelid-stop-model-fecoutputsettings) | False | Settings for enabling and adjusting Forward Error Correction on UDP outputs. | 

### UdpTimedMetadataId3Frame
<a name="channels-channelid-stop-model-udptimedmetadataid3frame"></a>

Udp Timed Metadata Id3 Frame
+ `NONE`
+ `PRIV`
+ `TDRL`

### VideoBlackFailoverSettings
<a name="channels-channelid-stop-model-videoblackfailoversettings"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| blackDetectThreshold | numberMinimum: 0Maximum: 1 | False | A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023\$10.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255\$10.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places. | 
| videoBlackThresholdMsec | integerMinimum: 1000 | False | The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs. | 

### VideoCodecSettings
<a name="channels-channelid-stop-model-videocodecsettings"></a>

Video Codec Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| frameCaptureSettings | [FrameCaptureSettings](#channels-channelid-stop-model-framecapturesettings) | False |  | 
| h264Settings | [H264Settings](#channels-channelid-stop-model-h264settings) | False |  | 
| h265Settings | [H265Settings](#channels-channelid-stop-model-h265settings) | False |  | 
| mpeg2Settings | [Mpeg2Settings](#channels-channelid-stop-model-mpeg2settings) | False |  | 

### VideoDescription
<a name="channels-channelid-stop-model-videodescription"></a>

Video settings for this stream.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| codecSettings | [VideoCodecSettings](#channels-channelid-stop-model-videocodecsettings) | False | Video codec settings. | 
| height | integer | False | Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 
| name | string | True | The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event. | 
| respondToAfd | [VideoDescriptionRespondToAfd](#channels-channelid-stop-model-videodescriptionrespondtoafd) | False | Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME\$1CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output | 
| scalingBehavior | [VideoDescriptionScalingBehavior](#channels-channelid-stop-model-videodescriptionscalingbehavior) | False | STRETCH\$1TO\$1OUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. | 
| sharpness | integerMinimum: 0Maximum: 100 | False | Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content. | 
| width | integer | False | Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required. | 

### VideoDescriptionRespondToAfd
<a name="channels-channelid-stop-model-videodescriptionrespondtoafd"></a>

Video Description Respond To Afd
+ `NONE`
+ `PASSTHROUGH`
+ `RESPOND`

### VideoDescriptionScalingBehavior
<a name="channels-channelid-stop-model-videodescriptionscalingbehavior"></a>

Video Description Scaling Behavior
+ `DEFAULT`
+ `STRETCH_TO_OUTPUT`

### VideoSelector
<a name="channels-channelid-stop-model-videoselector"></a>

Specifies a particular video stream within an input source. An input may have only a single video selector.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| colorSpace | [VideoSelectorColorSpace](#channels-channelid-stop-model-videoselectorcolorspace) | False | Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed. | 
| colorSpaceSettings | [VideoSelectorColorSpaceSettings](#channels-channelid-stop-model-videoselectorcolorspacesettings) | False | Color space settings | 
| colorSpaceUsage | [VideoSelectorColorSpaceUsage](#channels-channelid-stop-model-videoselectorcolorspaceusage) | False | Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. | 
| selectorSettings | [VideoSelectorSettings](#channels-channelid-stop-model-videoselectorsettings) | False | The video selector settings. | 

### VideoSelectorColorSpace
<a name="channels-channelid-stop-model-videoselectorcolorspace"></a>

Video Selector Color Space
+ `FOLLOW`
+ `HDR10`
+ `HLG_2020`
+ `REC_601`
+ `REC_709`

### VideoSelectorColorSpaceSettings
<a name="channels-channelid-stop-model-videoselectorcolorspacesettings"></a>

Video Selector Color Space Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| hdr10Settings | [Hdr10Settings](#channels-channelid-stop-model-hdr10settings) | False |  | 

### VideoSelectorColorSpaceUsage
<a name="channels-channelid-stop-model-videoselectorcolorspaceusage"></a>

Video Selector Color Space Usage
+ `FALLBACK`
+ `FORCE`

### VideoSelectorPid
<a name="channels-channelid-stop-model-videoselectorpid"></a>

Video Selector Pid


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| pid | integerMinimum: 0Maximum: 8191 | False | Selects a specific PID from within a video source. | 

### VideoSelectorProgramId
<a name="channels-channelid-stop-model-videoselectorprogramid"></a>

Video Selector Program Id


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| programId | integerMinimum: 0Maximum: 65536 | False | Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default. | 

### VideoSelectorSettings
<a name="channels-channelid-stop-model-videoselectorsettings"></a>

Video Selector Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| videoSelectorPid | [VideoSelectorPid](#channels-channelid-stop-model-videoselectorpid) | False |  | 
| videoSelectorProgramId | [VideoSelectorProgramId](#channels-channelid-stop-model-videoselectorprogramid) | False |  | 

### VpcOutputSettingsDescription
<a name="channels-channelid-stop-model-vpcoutputsettingsdescription"></a>

The properties for a private VPC Output 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | False | The Availability Zones where the vpc subnets are located. The first Availability Zone applies to the first subnet in the list of subnets. The second Availability Zone applies to the second subnet.  | 
| networkInterfaceIds | Array of type string | False | A list of Elastic Network Interfaces created by MediaLive in the customer's VPC  | 
| securityGroupIds | Array of type string | False | A list of up EC2 VPC security group IDs attached to the Output VPC network interfaces.  | 
| subnetIds | Array of type string | False | A list of VPC subnet IDs from the same VPC. If STANDARD channel, subnet IDs must be mapped to two unique availability zones (AZ).  | 

### WavCodingMode
<a name="channels-channelid-stop-model-wavcodingmode"></a>

Wav Coding Mode
+ `CODING_MODE_1_0`
+ `CODING_MODE_2_0`
+ `CODING_MODE_4_0`
+ `CODING_MODE_8_0`

### WavSettings
<a name="channels-channelid-stop-model-wavsettings"></a>

Wav Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| bitDepth | number | False | Bits per sample. | 
| codingMode | [WavCodingMode](#channels-channelid-stop-model-wavcodingmode) | False | The audio coding mode for the WAV audio. The mode determines the number of channels in the audio. | 
| sampleRate | number | False | Sample rate in Hz. | 

### WebvttDestinationSettings
<a name="channels-channelid-stop-model-webvttdestinationsettings"></a>

Webvtt Destination Settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| styleControl | [WebvttDestinationStyleControl](#channels-channelid-stop-model-webvttdestinationstylecontrol) | False | Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO\$1STYLE\$1DATA - Don't pass through the style. The output captions will not contain any font styling information. | 

### WebvttDestinationStyleControl
<a name="channels-channelid-stop-model-webvttdestinationstylecontrol"></a>

Webvtt Destination Style Control
+ `NO_STYLE_DATA`
+ `PASSTHROUGH`

## See also
<a name="channels-channelid-stop-see-also"></a>

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

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

# Input devices
<a name="inputdevices"></a>

## URI
<a name="inputdevices-url"></a>

`/prod/inputDevices`

## HTTP methods
<a name="inputdevices-http-methods"></a>

### GET
<a name="inputdevicesget"></a>

**Operation ID:** `ListInputDevices`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

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

## Schemas
<a name="inputdevices-schemas"></a>

### Response bodies
<a name="inputdevices-response-examples"></a>

#### ListInputDevicesResultModel schema
<a name="inputdevices-response-body-listinputdevicesresultmodel-example"></a>

```
{
  "inputDevices": [
    {
      "arn": "string",
      "availabilityZone": "string",
      "connectionState": enum,
      "deviceSettingsSyncState": enum,
      "deviceUpdateStatus": enum,
      "hdDeviceSettings": {
        "activeInput": enum,
        "configuredInput": enum,
        "deviceState": enum,
        "framerate": number,
        "height": integer,
        "maxBitrate": integer,
        "scanType": enum,
        "width": integer
      },
      "id": "string",
      "macAddress": "string",
      "name": "string",
      "networkSettings": {
        "dnsAddresses": [
          "string"
        ],
        "gateway": "string",
        "ipAddress": "string",
        "ipScheme": enum,
        "subnetMask": "string"
      },
      "serialNumber": "string",
      "type": enum,
      "uhdDeviceSettings": {
        "activeInput": enum,
        "configuredInput": enum,
        "deviceState": enum,
        "framerate": number,
        "height": integer,
        "maxBitrate": integer,
        "scanType": enum,
        "width": integer
      }
    }
  ],
  "nextToken": "string"
}
```

#### InvalidRequest schema
<a name="inputdevices-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="inputdevices-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-properties"></a>

### AccessDenied
<a name="inputdevices-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-model-badgatewayexception"></a>


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

### DeviceSettingsSyncState
<a name="inputdevices-model-devicesettingssyncstate"></a>

The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
+ `SYNCED`
+ `SYNCING`

### DeviceUpdateStatus
<a name="inputdevices-model-deviceupdatestatus"></a>

The status of software on the input device.
+ `UP_TO_DATE`
+ `NOT_UP_TO_DATE`
+ `UPDATING`

### GatewayTimeoutException
<a name="inputdevices-model-gatewaytimeoutexception"></a>


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

### InputDeviceActiveInput
<a name="inputdevices-model-inputdeviceactiveinput"></a>

The source at the input device that is currently active.
+ `HDMI`
+ `SDI`

### InputDeviceConfiguredInput
<a name="inputdevices-model-inputdeviceconfiguredinput"></a>

The source to activate (use) from the input device.
+ `AUTO`
+ `HDMI`
+ `SDI`

### InputDeviceConnectionState
<a name="inputdevices-model-inputdeviceconnectionstate"></a>

The state of the connection between the input device and AWS.
+ `DISCONNECTED`
+ `CONNECTED`

### InputDeviceHdSettings
<a name="inputdevices-model-inputdevicehdsettings"></a>

Settings that describe the active source from the input device, and the video characteristics of that source.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInput | [InputDeviceActiveInput](#inputdevices-model-inputdeviceactiveinput) | False | If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). | 
| configuredInput | [InputDeviceConfiguredInput](#inputdevices-model-inputdeviceconfiguredinput) | False | The source at the input device that is currently active. You can specify this source. | 
| deviceState | [InputDeviceState](#inputdevices-model-inputdevicestate) | False | The state of the input device. | 
| framerate | number | False | The frame rate of the video source. | 
| height | integer | False | The height of the video source, in pixels. | 
| maxBitrate | integer | False | The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. | 
| scanType | [InputDeviceScanType](#inputdevices-model-inputdevicescantype) | False | The scan type of the video source. | 
| width | integer | False | The width of the video source, in pixels. | 

### InputDeviceIpScheme
<a name="inputdevices-model-inputdeviceipscheme"></a>

Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.
+ `STATIC`
+ `DHCP`

### InputDeviceNetworkSettings
<a name="inputdevices-model-inputdevicenetworksettings"></a>

The network settings for the input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| dnsAddresses | Array of type string | False | The DNS addresses of the input device. | 
| gateway | string | False | The network gateway IP address. | 
| ipAddress | string | False | The IP address of the input device. | 
| ipScheme | [InputDeviceIpScheme](#inputdevices-model-inputdeviceipscheme) | False | Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address. | 
| subnetMask | string | False | The subnet mask of the input device. | 

### InputDeviceScanType
<a name="inputdevices-model-inputdevicescantype"></a>

The scan type of the video source.
+ `INTERLACED`
+ `PROGRESSIVE`

### InputDeviceState
<a name="inputdevices-model-inputdevicestate"></a>

The state of the input device.
+ `IDLE`
+ `STREAMING`

### InputDeviceSummary
<a name="inputdevices-model-inputdevicesummary"></a>

Details of the input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique ARN of the input device. | 
| availabilityZone | string | False | The Availability Zone associated with this input device. | 
| connectionState | [InputDeviceConnectionState](#inputdevices-model-inputdeviceconnectionstate) | False | The state of the connection between the input device and AWS. | 
| deviceSettingsSyncState | [DeviceSettingsSyncState](#inputdevices-model-devicesettingssyncstate) | False | The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. | 
| deviceUpdateStatus | [DeviceUpdateStatus](#inputdevices-model-deviceupdatestatus) | False | The status of software on the input device. | 
| hdDeviceSettings | [InputDeviceHdSettings](#inputdevices-model-inputdevicehdsettings) | False | Settings that describe an input device that is type HD. | 
| id | string | False | The unique ID of the input device. | 
| macAddress | string | False | The network MAC address of the input device. | 
| name | string | False | A name that you specify for the input device. | 
| networkSettings | [InputDeviceNetworkSettings](#inputdevices-model-inputdevicenetworksettings) | False | Network settings for the input device. | 
| serialNumber | string | False | The unique serial number of the input device. | 
| type | [InputDeviceType](#inputdevices-model-inputdevicetype) | False | The type of the input device. | 
| uhdDeviceSettings | [InputDeviceUhdSettings](#inputdevices-model-inputdeviceuhdsettings) | False | Settings that describe an input device that is type UHD. | 

### InputDeviceType
<a name="inputdevices-model-inputdevicetype"></a>

The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose "HD".
+ `HD`
+ `UHD`

### InputDeviceUhdSettings
<a name="inputdevices-model-inputdeviceuhdsettings"></a>

Settings that describe the active source from the input device, and the video characteristics of that source.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInput | [InputDeviceActiveInput](#inputdevices-model-inputdeviceactiveinput) | False | If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). | 
| configuredInput | [InputDeviceConfiguredInput](#inputdevices-model-inputdeviceconfiguredinput) | False | The source at the input device that is currently active. You can specify this source. | 
| deviceState | [InputDeviceState](#inputdevices-model-inputdevicestate) | False | The state of the input device. | 
| framerate | number | False | The frame rate of the video source. | 
| height | integer | False | The height of the video source, in pixels. | 
| maxBitrate | integer | False | The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. | 
| scanType | [InputDeviceScanType](#inputdevices-model-inputdevicescantype) | False | The scan type of the video source. | 
| width | integer | False | The width of the video source, in pixels. | 

### InternalServiceError
<a name="inputdevices-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-model-limitexceeded"></a>


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

### ListInputDevicesResultModel
<a name="inputdevices-model-listinputdevicesresultmodel"></a>

The list of input devices owned by the AWS account.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDevices | Array of type [InputDeviceSummary](#inputdevices-model-inputdevicesummary) | False | The list of input devices. | 
| nextToken | string | False | A token to get additional list results. | 

## See also
<a name="inputdevices-see-also"></a>

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

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

# Input devices: accept device transfer
<a name="inputdevices-inputdeviceid-accept"></a>

## URI
<a name="inputdevices-inputdeviceid-accept-url"></a>

`/prod/inputDevices/inputDeviceId/accept`

## HTTP methods
<a name="inputdevices-inputdeviceid-accept-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-acceptpost"></a>

**Operation ID:** `AcceptInputDeviceTransfer`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-accept-schemas"></a>

### Response bodies
<a name="inputdevices-inputdeviceid-accept-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-accept-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-accept-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-accept-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputdevices-inputdeviceid-accept-response-body-resourceconflict-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-accept-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-accept-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-accept-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-accept-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-accept-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-accept-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-accept-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-accept-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-accept-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-accept-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-accept-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-accept-model-limitexceeded"></a>


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

### ResourceConflict
<a name="inputdevices-inputdeviceid-accept-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-accept-model-resourcenotfound"></a>


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

### ValidationError
<a name="inputdevices-inputdeviceid-accept-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="inputdevices-inputdeviceid-accept-see-also"></a>

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

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

# Input devices: cancel device transfer
<a name="inputdevices-inputdeviceid-cancel"></a>

## URI
<a name="inputdevices-inputdeviceid-cancel-url"></a>

`/prod/inputDevices/inputDeviceId/cancel`

## HTTP methods
<a name="inputdevices-inputdeviceid-cancel-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-cancelpost"></a>

**Operation ID:** `CancelInputDeviceTransfer`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-cancel-schemas"></a>

### Response bodies
<a name="inputdevices-inputdeviceid-cancel-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-cancel-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-cancel-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-cancel-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputdevices-inputdeviceid-cancel-response-body-resourceconflict-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-cancel-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-cancel-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-cancel-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-cancel-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-cancel-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-cancel-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-cancel-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-cancel-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-cancel-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-cancel-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-cancel-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-cancel-model-limitexceeded"></a>


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

### ResourceConflict
<a name="inputdevices-inputdeviceid-cancel-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-cancel-model-resourcenotfound"></a>


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

### ValidationError
<a name="inputdevices-inputdeviceid-cancel-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="inputdevices-inputdeviceid-cancel-see-also"></a>

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

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

# Input devices: claim device
<a name="claimdevice"></a>

## URI
<a name="claimdevice-url"></a>

`/prod/claimDevice`

## HTTP methods
<a name="claimdevice-http-methods"></a>

### POST
<a name="claimdevicepost"></a>

**Operation ID:** `ClaimDevice`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="claimdevice-schemas"></a>

### Request bodies
<a name="claimdevice-request-examples"></a>

#### POST schema
<a name="claimdevice-request-body-post-example"></a>

```
{
  "id": "string"
}
```

### Response bodies
<a name="claimdevice-response-examples"></a>

#### InvalidRequest schema
<a name="claimdevice-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="claimdevice-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="claimdevice-response-body-resourcenotfound-example"></a>

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

#### ValidationError schema
<a name="claimdevice-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="claimdevice-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="claimdevice-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="claimdevice-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="claimdevice-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="claimdevice-properties"></a>

### AccessDenied
<a name="claimdevice-model-accessdenied"></a>


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

### BadGatewayException
<a name="claimdevice-model-badgatewayexception"></a>


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

### ClaimDeviceRequest
<a name="claimdevice-model-claimdevicerequest"></a>

Request to claim an AWS Elemental device that you have purchased from a third-party vendor.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The id of the device you want to claim. | 

### GatewayTimeoutException
<a name="claimdevice-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="claimdevice-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="claimdevice-model-invalidrequest"></a>


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

### LimitExceeded
<a name="claimdevice-model-limitexceeded"></a>


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

### ResourceNotFound
<a name="claimdevice-model-resourcenotfound"></a>


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

### ValidationError
<a name="claimdevice-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="claimdevice-see-also"></a>

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

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

# Input devices: device ID
<a name="inputdevices-inputdeviceid"></a>

## URI
<a name="inputdevices-inputdeviceid-url"></a>

`/prod/inputDevices/inputDeviceId`

## HTTP methods
<a name="inputdevices-inputdeviceid-http-methods"></a>

### GET
<a name="inputdevices-inputdeviceidget"></a>

**Operation ID:** `DescribeInputDevice`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | InputDevice | 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="inputdevices-inputdeviceidput"></a>

**Operation ID:** `UpdateInputDevice`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | InputDevice | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 422 | InputDeviceConfigurationValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-schemas"></a>

### Request bodies
<a name="inputdevices-inputdeviceid-request-examples"></a>

#### PUT schema
<a name="inputdevices-inputdeviceid-request-body-put-example"></a>

```
{
  "availabilityZone": "string",
  "hdDeviceSettings": {
    "configuredInput": enum,
    "maxBitrate": integer
  },
  "name": "string",
  "uhdDeviceSettings": {
    "configuredInput": enum,
    "maxBitrate": integer
  }
}
```

### Response bodies
<a name="inputdevices-inputdeviceid-response-examples"></a>

#### InputDevice schema
<a name="inputdevices-inputdeviceid-response-body-inputdevice-example"></a>

```
{
  "arn": "string",
  "availabilityZone": "string",
  "connectionState": enum,
  "deviceSettingsSyncState": enum,
  "deviceUpdateStatus": enum,
  "hdDeviceSettings": {
    "activeInput": enum,
    "configuredInput": enum,
    "deviceState": enum,
    "framerate": number,
    "height": integer,
    "maxBitrate": integer,
    "scanType": enum,
    "width": integer
  },
  "id": "string",
  "macAddress": "string",
  "name": "string",
  "networkSettings": {
    "dnsAddresses": [
      "string"
    ],
    "gateway": "string",
    "ipAddress": "string",
    "ipScheme": enum,
    "subnetMask": "string"
  },
  "serialNumber": "string",
  "type": enum,
  "uhdDeviceSettings": {
    "activeInput": enum,
    "configuredInput": enum,
    "deviceState": enum,
    "framerate": number,
    "height": integer,
    "maxBitrate": integer,
    "scanType": enum,
    "width": integer
  }
}
```

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-response-body-resourcenotfound-example"></a>

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

#### InputDeviceConfigurationValidationError schema
<a name="inputdevices-inputdeviceid-response-body-inputdeviceconfigurationvalidationerror-example"></a>

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

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-model-badgatewayexception"></a>


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

### DeviceSettingsSyncState
<a name="inputdevices-inputdeviceid-model-devicesettingssyncstate"></a>

The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration.
+ `SYNCED`
+ `SYNCING`

### DeviceUpdateStatus
<a name="inputdevices-inputdeviceid-model-deviceupdatestatus"></a>

The status of software on the input device.
+ `UP_TO_DATE`
+ `NOT_UP_TO_DATE`
+ `UPDATING`

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-model-gatewaytimeoutexception"></a>


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

### InputDevice
<a name="inputdevices-inputdeviceid-model-inputdevice"></a>

An input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The unique ARN of the input device. | 
| availabilityZone | string | False | The Availability Zone associated with this input device.  | 
| connectionState | [InputDeviceConnectionState](#inputdevices-inputdeviceid-model-inputdeviceconnectionstate) | False | The state of the connection between the input device and AWS. | 
| deviceSettingsSyncState | [DeviceSettingsSyncState](#inputdevices-inputdeviceid-model-devicesettingssyncstate) | False | The status of the action to synchronize the device configuration. If you change the configuration of the input device (for example, the maximum bitrate), MediaLive sends the new data to the device. The device might not update itself immediately. SYNCED means the device has updated its configuration. SYNCING means that it has not updated its configuration. | 
| deviceUpdateStatus | [DeviceUpdateStatus](#inputdevices-inputdeviceid-model-deviceupdatestatus) | False | The status of software on the input device. | 
| hdDeviceSettings | [InputDeviceHdSettings](#inputdevices-inputdeviceid-model-inputdevicehdsettings) | False | Settings that describe an input device that is type HD. | 
| id | string | False | The unique ID of the input device. | 
| macAddress | string | False | The network MAC address of the input device. | 
| name | string | False | A name that you specify for the input device. | 
| networkSettings | [InputDeviceNetworkSettings](#inputdevices-inputdeviceid-model-inputdevicenetworksettings) | False | The network settings for the input device. | 
| serialNumber | string | False | The unique serial number of the input device. | 
| type | [InputDeviceType](#inputdevices-inputdeviceid-model-inputdevicetype) | False | The type of the input device. | 
| uhdDeviceSettings | [InputDeviceUhdSettings](#inputdevices-inputdeviceid-model-inputdeviceuhdsettings) | False | Settings that describe an input device that is type UHD. | 

### InputDeviceActiveInput
<a name="inputdevices-inputdeviceid-model-inputdeviceactiveinput"></a>

The source at the input device that is currently active.
+ `HDMI`
+ `SDI`

### InputDeviceConfigurableSettings
<a name="inputdevices-inputdeviceid-model-inputdeviceconfigurablesettings"></a>

Configurable settings for the input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| configuredInput | [InputDeviceConfiguredInput](#inputdevices-inputdeviceid-model-inputdeviceconfiguredinput) | False | The input source that you want to use. If the device has a source connected to only one of its input ports, or if you don't care which source the device sends, specify Auto. If the device has sources connected to both its input ports, and you want to use a specific source, specify the source. | 
| maxBitrate | integer | False | The maximum bitrate in bits per second. Set a value here to throttle the bitrate of the source video. | 

### InputDeviceConfigurationValidationError
<a name="inputdevices-inputdeviceid-model-inputdeviceconfigurationvalidationerror"></a>


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

### InputDeviceConfiguredInput
<a name="inputdevices-inputdeviceid-model-inputdeviceconfiguredinput"></a>

The source to activate (use) from the input device.
+ `AUTO`
+ `HDMI`
+ `SDI`

### InputDeviceConnectionState
<a name="inputdevices-inputdeviceid-model-inputdeviceconnectionstate"></a>

The state of the connection between the input device and AWS.
+ `DISCONNECTED`
+ `CONNECTED`

### InputDeviceHdSettings
<a name="inputdevices-inputdeviceid-model-inputdevicehdsettings"></a>

Settings that describe the active source from the input device, and the video characteristics of that source.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInput | [InputDeviceActiveInput](#inputdevices-inputdeviceid-model-inputdeviceactiveinput) | False | If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). | 
| configuredInput | [InputDeviceConfiguredInput](#inputdevices-inputdeviceid-model-inputdeviceconfiguredinput) | False | The source at the input device that is currently active. You can specify this source. | 
| deviceState | [InputDeviceState](#inputdevices-inputdeviceid-model-inputdevicestate) | False | The state of the input device. | 
| framerate | number | False | The frame rate of the video source. | 
| height | integer | False | The height of the video source, in pixels. | 
| maxBitrate | integer | False | The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. | 
| scanType | [InputDeviceScanType](#inputdevices-inputdeviceid-model-inputdevicescantype) | False | The scan type of the video source. | 
| width | integer | False | The width of the video source, in pixels. | 

### InputDeviceIpScheme
<a name="inputdevices-inputdeviceid-model-inputdeviceipscheme"></a>

Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address.
+ `STATIC`
+ `DHCP`

### InputDeviceNetworkSettings
<a name="inputdevices-inputdeviceid-model-inputdevicenetworksettings"></a>

The network settings for the input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| dnsAddresses | Array of type string | False | The DNS addresses of the input device. | 
| gateway | string | False | The network gateway IP address. | 
| ipAddress | string | False | The IP address of the input device. | 
| ipScheme | [InputDeviceIpScheme](#inputdevices-inputdeviceid-model-inputdeviceipscheme) | False | Specifies whether the input device has been configured (outside of MediaLive) to use a dynamic IP address assignment (DHCP) or a static IP address. | 
| subnetMask | string | False | The subnet mask of the input device. | 

### InputDeviceScanType
<a name="inputdevices-inputdeviceid-model-inputdevicescantype"></a>

The scan type of the video source.
+ `INTERLACED`
+ `PROGRESSIVE`

### InputDeviceState
<a name="inputdevices-inputdeviceid-model-inputdevicestate"></a>

The state of the input device.
+ `IDLE`
+ `STREAMING`

### InputDeviceType
<a name="inputdevices-inputdeviceid-model-inputdevicetype"></a>

The type of the input device. For an AWS Elemental Link device that outputs resolutions up to 1080, choose "HD".
+ `HD`
+ `UHD`

### InputDeviceUhdSettings
<a name="inputdevices-inputdeviceid-model-inputdeviceuhdsettings"></a>

Settings that describe the active source from the input device, and the video characteristics of that source.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| activeInput | [InputDeviceActiveInput](#inputdevices-inputdeviceid-model-inputdeviceactiveinput) | False | If you specified Auto as the configured input, specifies which of the sources is currently active (SDI or HDMI). | 
| configuredInput | [InputDeviceConfiguredInput](#inputdevices-inputdeviceid-model-inputdeviceconfiguredinput) | False | The source at the input device that is currently active. You can specify this source. | 
| deviceState | [InputDeviceState](#inputdevices-inputdeviceid-model-inputdevicestate) | False | The state of the input device. | 
| framerate | number | False | The frame rate of the video source. | 
| height | integer | False | The height of the video source, in pixels. | 
| maxBitrate | integer | False | The current maximum bitrate for ingesting this source, in bits per second. You can specify this maximum. | 
| scanType | [InputDeviceScanType](#inputdevices-inputdeviceid-model-inputdevicescantype) | False | The scan type of the video source. | 
| width | integer | False | The width of the video source, in pixels. | 

### InternalServiceError
<a name="inputdevices-inputdeviceid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-model-limitexceeded"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-model-resourcenotfound"></a>


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

### UpdateInputDevice
<a name="inputdevices-inputdeviceid-model-updateinputdevice"></a>

Updates an input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZone | string | False | The Availability Zone you want to associate with this input device.  | 
| hdDeviceSettings | [InputDeviceConfigurableSettings](#inputdevices-inputdeviceid-model-inputdeviceconfigurablesettings) | False | The settings that you want to apply to the HD input device. | 
| name | string | False | The name that you assigned to this input device (not the unique ID). | 
| uhdDeviceSettings | [InputDeviceConfigurableSettings](#inputdevices-inputdeviceid-model-inputdeviceconfigurablesettings) | False | The settings that you want to apply to the UHD input device. | 

### ValidationError
<a name="inputdevices-inputdeviceid-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="inputdevices-inputdeviceid-see-also"></a>

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

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

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

# Input devices: input device transfers
<a name="inputdevicetransfers"></a>

## URI
<a name="inputdevicetransfers-url"></a>

`/prod/inputDeviceTransfers`

## HTTP methods
<a name="inputdevicetransfers-http-methods"></a>

### GET
<a name="inputdevicetransfersget"></a>

**Operation ID:** `ListInputDeviceTransfers`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| transferType | String | True |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListInputDeviceTransfersResultModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevicetransfers-schemas"></a>

### Response bodies
<a name="inputdevicetransfers-response-examples"></a>

#### ListInputDeviceTransfersResultModel schema
<a name="inputdevicetransfers-response-body-listinputdevicetransfersresultmodel-example"></a>

```
{
  "inputDeviceTransfers": [
    {
      "id": "string",
      "message": "string",
      "targetCustomerId": "string",
      "transferType": enum
    }
  ],
  "nextToken": "string"
}
```

#### InvalidRequest schema
<a name="inputdevicetransfers-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevicetransfers-response-body-accessdenied-example"></a>

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

#### ValidationError schema
<a name="inputdevicetransfers-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevicetransfers-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevicetransfers-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevicetransfers-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevicetransfers-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevicetransfers-properties"></a>

### AccessDenied
<a name="inputdevicetransfers-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevicetransfers-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevicetransfers-model-gatewaytimeoutexception"></a>


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

### InputDeviceTransferType
<a name="inputdevicetransfers-model-inputdevicetransfertype"></a>

The type of device transfer. INCOMING for an input device that is being transferred to you, OUTGOING for an input device that you are transferring to another AWS account.
+ `OUTGOING`
+ `INCOMING`

### InternalServiceError
<a name="inputdevicetransfers-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevicetransfers-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevicetransfers-model-limitexceeded"></a>


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

### ListInputDeviceTransfersResultModel
<a name="inputdevicetransfers-model-listinputdevicetransfersresultmodel"></a>

The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceTransfers | Array of type [TransferringInputDeviceSummary](#inputdevicetransfers-model-transferringinputdevicesummary) | False | The list of devices that you are transferring or are being transferred to you. | 
| nextToken | string | False | A token to get additional list results. | 

### TransferringInputDeviceSummary
<a name="inputdevicetransfers-model-transferringinputdevicesummary"></a>

Details about the input device that is being transferred.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The unique ID of the input device. | 
| message | string | False | The optional message that the sender has attached to the transfer. | 
| targetCustomerId | string | False | The AWS account ID for the recipient of the input device transfer. | 
| transferType | [InputDeviceTransferType](#inputdevicetransfers-model-inputdevicetransfertype) | False | The type (direction) of the input device transfer. | 

### ValidationError
<a name="inputdevicetransfers-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="inputdevicetransfers-see-also"></a>

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

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

# Input devices: reboot
<a name="inputdevices-inputdeviceid-reboot"></a>

## URI
<a name="inputdevices-inputdeviceid-reboot-url"></a>

`/prod/inputDevices/inputDeviceId/reboot`

## HTTP methods
<a name="inputdevices-inputdeviceid-reboot-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-rebootpost"></a>

**Operation ID:** `RebootInputDevice`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-reboot-schemas"></a>

### Request bodies
<a name="inputdevices-inputdeviceid-reboot-request-examples"></a>

#### POST schema
<a name="inputdevices-inputdeviceid-reboot-request-body-post-example"></a>

```
{
  "force": enum
}
```

### Response bodies
<a name="inputdevices-inputdeviceid-reboot-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-reboot-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-reboot-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-reboot-response-body-resourcenotfound-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-reboot-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-reboot-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-reboot-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-reboot-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-reboot-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-reboot-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-reboot-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-reboot-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-reboot-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-reboot-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-reboot-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-reboot-model-limitexceeded"></a>


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

### RebootInputDevice
<a name="inputdevices-inputdeviceid-reboot-model-rebootinputdevice"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| force | [RebootInputDeviceForce](#inputdevices-inputdeviceid-reboot-model-rebootinputdeviceforce) | False | Force a reboot of an input device. If the device is streaming, it will stop streaming and begin rebooting within a few seconds of sending the command. If the device was streaming prior to the reboot, the device will resume streaming when the reboot completes. | 

### RebootInputDeviceForce
<a name="inputdevices-inputdeviceid-reboot-model-rebootinputdeviceforce"></a>

Whether or not to force reboot the input device.
+ `NO`
+ `YES`

### ResourceNotFound
<a name="inputdevices-inputdeviceid-reboot-model-resourcenotfound"></a>


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

### ValidationError
<a name="inputdevices-inputdeviceid-reboot-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="inputdevices-inputdeviceid-reboot-see-also"></a>

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

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

# Input devices: reject device transfer
<a name="inputdevices-inputdeviceid-reject"></a>

## URI
<a name="inputdevices-inputdeviceid-reject-url"></a>

`/prod/inputDevices/inputDeviceId/reject`

## HTTP methods
<a name="inputdevices-inputdeviceid-reject-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-rejectpost"></a>

**Operation ID:** `RejectInputDeviceTransfer`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-reject-schemas"></a>

### Response bodies
<a name="inputdevices-inputdeviceid-reject-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-reject-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-reject-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-reject-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputdevices-inputdeviceid-reject-response-body-resourceconflict-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-reject-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-reject-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-reject-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-reject-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-reject-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-reject-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-reject-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-reject-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-reject-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-reject-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-reject-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-reject-model-limitexceeded"></a>


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

### ResourceConflict
<a name="inputdevices-inputdeviceid-reject-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-reject-model-resourcenotfound"></a>


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

### ValidationError
<a name="inputdevices-inputdeviceid-reject-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="inputdevices-inputdeviceid-reject-see-also"></a>

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

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

# Input devices: thumbnail data
<a name="inputdevices-inputdeviceid-thumbnaildata"></a>

## URI
<a name="inputdevices-inputdeviceid-thumbnaildata-url"></a>

`/prod/inputDevices/inputDeviceId/thumbnailData`

## HTTP methods
<a name="inputdevices-inputdeviceid-thumbnaildata-http-methods"></a>

### GET
<a name="inputdevices-inputdeviceid-thumbnaildataget"></a>

**Operation ID:** `DescribeInputDeviceThumbnail`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Header parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| Accept | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ThumbnailData | 200 response | 
| 204 | None | 204 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 | 

## Schemas
<a name="inputdevices-inputdeviceid-thumbnaildata-schemas"></a>

### Response bodies
<a name="inputdevices-inputdeviceid-thumbnaildata-response-examples"></a>

#### ThumbnailData schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-thumbnaildata-example"></a>

```
{
  "body": "string"
}
```

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-resourcenotfound-example"></a>

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

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-thumbnaildata-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-thumbnaildata-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-thumbnaildata-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-thumbnaildata-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-thumbnaildata-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-thumbnaildata-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-thumbnaildata-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-thumbnaildata-model-limitexceeded"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-thumbnaildata-model-resourcenotfound"></a>


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

### ThumbnailData
<a name="inputdevices-inputdeviceid-thumbnaildata-model-thumbnaildata"></a>

The binary data for the thumbnail that the Link device has most recently sent to MediaLive.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| body | stringFormat: byte | False | The binary data for the thumbnail that the Link device has most recently sent to MediaLive. | 

## See also
<a name="inputdevices-inputdeviceid-thumbnaildata-see-also"></a>

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

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

# Input devices: transfer device
<a name="inputdevices-inputdeviceid-transfer"></a>

## URI
<a name="inputdevices-inputdeviceid-transfer-url"></a>

`/prod/inputDevices/inputDeviceId/transfer`

## HTTP methods
<a name="inputdevices-inputdeviceid-transfer-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-transferpost"></a>

**Operation ID:** `TransferInputDevice`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-transfer-schemas"></a>

### Request bodies
<a name="inputdevices-inputdeviceid-transfer-request-examples"></a>

#### POST schema
<a name="inputdevices-inputdeviceid-transfer-request-body-post-example"></a>

```
{
  "targetCustomerId": "string",
  "targetRegion": "string",
  "transferMessage": "string"
}
```

### Response bodies
<a name="inputdevices-inputdeviceid-transfer-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-transfer-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-transfer-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-transfer-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputdevices-inputdeviceid-transfer-response-body-resourceconflict-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-transfer-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-transfer-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-transfer-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-transfer-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-transfer-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-transfer-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-transfer-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-transfer-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-transfer-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-transfer-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-transfer-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-transfer-model-limitexceeded"></a>


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

### ResourceConflict
<a name="inputdevices-inputdeviceid-transfer-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-transfer-model-resourcenotfound"></a>


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

### TransferInputDevice
<a name="inputdevices-inputdeviceid-transfer-model-transferinputdevice"></a>

The transfer details of the input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| targetCustomerId | string | False | The AWS account ID (12 digits) for the recipient of the device transfer. | 
| targetRegion | string | False | The target AWS Region to transfer the device. | 
| transferMessage | string | False | An optional message for the recipient. Maximum 280 characters. | 

### ValidationError
<a name="inputdevices-inputdeviceid-transfer-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="inputdevices-inputdeviceid-transfer-see-also"></a>

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

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

# Input devices: update
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow"></a>

## URI
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-url"></a>

`/prod/inputDevices/inputDeviceId/startInputDeviceMaintenanceWindow`

## HTTP methods
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-http-methods"></a>

### POST
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindowpost"></a>

**Operation ID:** `StartInputDeviceMaintenanceWindow`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputDeviceId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 422 | ValidationError | 422 response | 
| 429 | LimitExceeded | 429 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-schemas"></a>

### Response bodies
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-examples"></a>

#### InvalidRequest schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-resourcenotfound-example"></a>

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

#### ValidationError schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-validationerror-example"></a>

```
{
  "elementPath": "string",
  "errorMessage": "string"
}
```

#### LimitExceeded schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-properties"></a>

### AccessDenied
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-badgatewayexception"></a>


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

### GatewayTimeoutException
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-limitexceeded"></a>


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

### ResourceNotFound
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-model-resourcenotfound"></a>


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

### ValidationError
<a name="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-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="inputdevices-inputdeviceid-startinputdevicemaintenancewindow-see-also"></a>

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

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

# Input security groups
<a name="inputsecuritygroups"></a>

## URI
<a name="inputsecuritygroups-url"></a>

`/prod/inputSecurityGroups`

## HTTP methods
<a name="inputsecuritygroups-http-methods"></a>

### GET
<a name="inputsecuritygroupsget"></a>

**Operation ID:** `ListInputSecurityGroups`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListInputSecurityGroupsResultModel | 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
<a name="inputsecuritygroupspost"></a>

**Operation ID:** `CreateInputSecurityGroup`


**Responses**  

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

## Schemas
<a name="inputsecuritygroups-schemas"></a>

### Request bodies
<a name="inputsecuritygroups-request-examples"></a>

#### POST schema
<a name="inputsecuritygroups-request-body-post-example"></a>

```
{
  "tags": {
  },
  "whitelistRules": [
    {
      "cidr": "string"
    }
  ]
}
```

### Response bodies
<a name="inputsecuritygroups-response-examples"></a>

#### ListInputSecurityGroupsResultModel schema
<a name="inputsecuritygroups-response-body-listinputsecuritygroupsresultmodel-example"></a>

```
{
  "inputSecurityGroups": [
    {
      "arn": "string",
      "id": "string",
      "inputs": [
        "string"
      ],
      "state": enum,
      "tags": {
      },
      "whitelistRules": [
        {
          "cidr": "string"
        }
      ]
    }
  ],
  "nextToken": "string"
}
```

#### CreateInputSecurityGroupResultModel schema
<a name="inputsecuritygroups-response-body-createinputsecuritygroupresultmodel-example"></a>

```
{
  "securityGroup": {
    "arn": "string",
    "id": "string",
    "inputs": [
      "string"
    ],
    "state": enum,
    "tags": {
    },
    "whitelistRules": [
      {
        "cidr": "string"
      }
    ]
  }
}
```

#### InvalidRequest schema
<a name="inputsecuritygroups-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputsecuritygroups-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="inputsecuritygroups-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputsecuritygroups-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputsecuritygroups-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputsecuritygroups-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputsecuritygroups-properties"></a>

### AccessDenied
<a name="inputsecuritygroups-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputsecuritygroups-model-badgatewayexception"></a>


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

### CreateInputSecurityGroupResultModel
<a name="inputsecuritygroups-model-createinputsecuritygroupresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| securityGroup | [InputSecurityGroup](#inputsecuritygroups-model-inputsecuritygroup) | False |  | 

### GatewayTimeoutException
<a name="inputsecuritygroups-model-gatewaytimeoutexception"></a>


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

### InputSecurityGroup
<a name="inputsecuritygroups-model-inputsecuritygroup"></a>

An Input Security Group


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique ARN of Input Security Group | 
| id | string | False | The Id of the Input Security Group | 
| inputs | Array of type string | False | The list of inputs currently using this Input Security Group. | 
| state | [InputSecurityGroupState](#inputsecuritygroups-model-inputsecuritygroupstate) | False | The current state of the Input Security Group. | 
| tags | [Tags](#inputsecuritygroups-model-tags) | False | A collection of key-value pairs. | 
| whitelistRules | Array of type [InputWhitelistRule](#inputsecuritygroups-model-inputwhitelistrule) | False | Whitelist rules and their sync status | 

### InputSecurityGroupState
<a name="inputsecuritygroups-model-inputsecuritygroupstate"></a>
+ `IDLE`
+ `IN_USE`
+ `UPDATING`
+ `DELETED`

### InputSecurityGroupWhitelistRequest
<a name="inputsecuritygroups-model-inputsecuritygroupwhitelistrequest"></a>

Request of IPv4 CIDR addresses to whitelist in a security group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tags | [Tags](#inputsecuritygroups-model-tags) | False | A collection of key-value pairs. | 
| whitelistRules | Array of type [InputWhitelistRuleCidr](#inputsecuritygroups-model-inputwhitelistrulecidr) | False | List of IPv4 CIDR addresses to whitelist | 

### InputWhitelistRule
<a name="inputsecuritygroups-model-inputwhitelistrule"></a>

Whitelist rule


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cidr | string | False | The IPv4 CIDR that's whitelisted. | 

### InputWhitelistRuleCidr
<a name="inputsecuritygroups-model-inputwhitelistrulecidr"></a>

An IPv4 CIDR to whitelist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cidr | string | False | The IPv4 CIDR to whitelist. | 

### InternalServiceError
<a name="inputsecuritygroups-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputsecuritygroups-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputsecuritygroups-model-limitexceeded"></a>


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

### ListInputSecurityGroupsResultModel
<a name="inputsecuritygroups-model-listinputsecuritygroupsresultmodel"></a>

Result of input security group list request


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputSecurityGroups | Array of type [InputSecurityGroup](#inputsecuritygroups-model-inputsecuritygroup) | False | List of input security groups | 
| nextToken | string | False |  | 

### Tags
<a name="inputsecuritygroups-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="inputsecuritygroups-see-also"></a>

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

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

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

# Input security groups: group ID
<a name="inputsecuritygroups-inputsecuritygroupid"></a>

## URI
<a name="inputsecuritygroups-inputsecuritygroupid-url"></a>

`/prod/inputSecurityGroups/inputSecurityGroupId`

## HTTP methods
<a name="inputsecuritygroups-inputsecuritygroupid-http-methods"></a>

### DELETE
<a name="inputsecuritygroups-inputsecuritygroupiddelete"></a>

**Operation ID:** `DeleteInputSecurityGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputSecurityGroupId | String | True |  | 


**Responses**  

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

### GET
<a name="inputsecuritygroups-inputsecuritygroupidget"></a>

**Operation ID:** `DescribeInputSecurityGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputSecurityGroupId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | InputSecurityGroup | 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="inputsecuritygroups-inputsecuritygroupidput"></a>

**Operation ID:** `UpdateInputSecurityGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputSecurityGroupId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateInputSecurityGroupResultModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputsecuritygroups-inputsecuritygroupid-schemas"></a>

### Request bodies
<a name="inputsecuritygroups-inputsecuritygroupid-request-examples"></a>

#### PUT schema
<a name="inputsecuritygroups-inputsecuritygroupid-request-body-put-example"></a>

```
{
  "tags": {
  },
  "whitelistRules": [
    {
      "cidr": "string"
    }
  ]
}
```

### Response bodies
<a name="inputsecuritygroups-inputsecuritygroupid-response-examples"></a>

#### Empty schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-empty-example"></a>

```
{
}
```

#### InputSecurityGroup schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-inputsecuritygroup-example"></a>

```
{
  "arn": "string",
  "id": "string",
  "inputs": [
    "string"
  ],
  "state": enum,
  "tags": {
  },
  "whitelistRules": [
    {
      "cidr": "string"
    }
  ]
}
```

#### UpdateInputSecurityGroupResultModel schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-updateinputsecuritygroupresultmodel-example"></a>

```
{
  "securityGroup": {
    "arn": "string",
    "id": "string",
    "inputs": [
      "string"
    ],
    "state": enum,
    "tags": {
    },
    "whitelistRules": [
      {
        "cidr": "string"
      }
    ]
  }
}
```

#### InvalidRequest schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputsecuritygroups-inputsecuritygroupid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputsecuritygroups-inputsecuritygroupid-properties"></a>

### AccessDenied
<a name="inputsecuritygroups-inputsecuritygroupid-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputsecuritygroups-inputsecuritygroupid-model-badgatewayexception"></a>


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

### Empty
<a name="inputsecuritygroups-inputsecuritygroupid-model-empty"></a>

### GatewayTimeoutException
<a name="inputsecuritygroups-inputsecuritygroupid-model-gatewaytimeoutexception"></a>


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

### InputSecurityGroup
<a name="inputsecuritygroups-inputsecuritygroupid-model-inputsecuritygroup"></a>

An Input Security Group


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique ARN of Input Security Group | 
| id | string | False | The Id of the Input Security Group | 
| inputs | Array of type string | False | The list of inputs currently using this Input Security Group. | 
| state | [InputSecurityGroupState](#inputsecuritygroups-inputsecuritygroupid-model-inputsecuritygroupstate) | False | The current state of the Input Security Group. | 
| tags | [Tags](#inputsecuritygroups-inputsecuritygroupid-model-tags) | False | A collection of key-value pairs. | 
| whitelistRules | Array of type [InputWhitelistRule](#inputsecuritygroups-inputsecuritygroupid-model-inputwhitelistrule) | False | Whitelist rules and their sync status | 

### InputSecurityGroupState
<a name="inputsecuritygroups-inputsecuritygroupid-model-inputsecuritygroupstate"></a>
+ `IDLE`
+ `IN_USE`
+ `UPDATING`
+ `DELETED`

### InputSecurityGroupWhitelistRequest
<a name="inputsecuritygroups-inputsecuritygroupid-model-inputsecuritygroupwhitelistrequest"></a>

Request of IPv4 CIDR addresses to whitelist in a security group.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tags | [Tags](#inputsecuritygroups-inputsecuritygroupid-model-tags) | False | A collection of key-value pairs. | 
| whitelistRules | Array of type [InputWhitelistRuleCidr](#inputsecuritygroups-inputsecuritygroupid-model-inputwhitelistrulecidr) | False | List of IPv4 CIDR addresses to whitelist | 

### InputWhitelistRule
<a name="inputsecuritygroups-inputsecuritygroupid-model-inputwhitelistrule"></a>

Whitelist rule


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cidr | string | False | The IPv4 CIDR that's whitelisted. | 

### InputWhitelistRuleCidr
<a name="inputsecuritygroups-inputsecuritygroupid-model-inputwhitelistrulecidr"></a>

An IPv4 CIDR to whitelist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cidr | string | False | The IPv4 CIDR to whitelist. | 

### InternalServiceError
<a name="inputsecuritygroups-inputsecuritygroupid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputsecuritygroups-inputsecuritygroupid-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputsecuritygroups-inputsecuritygroupid-model-limitexceeded"></a>


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

### ResourceConflict
<a name="inputsecuritygroups-inputsecuritygroupid-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputsecuritygroups-inputsecuritygroupid-model-resourcenotfound"></a>


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

### Tags
<a name="inputsecuritygroups-inputsecuritygroupid-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### UpdateInputSecurityGroupResultModel
<a name="inputsecuritygroups-inputsecuritygroupid-model-updateinputsecuritygroupresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| securityGroup | [InputSecurityGroup](#inputsecuritygroups-inputsecuritygroupid-model-inputsecuritygroup) | False |  | 

## See also
<a name="inputsecuritygroups-inputsecuritygroupid-see-also"></a>

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

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

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

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

# Inputs
<a name="inputs"></a>

## URI
<a name="inputs-url"></a>

`/prod/inputs`

## HTTP methods
<a name="inputs-http-methods"></a>

### GET
<a name="inputsget"></a>

**Operation ID:** `ListInputs`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListInputsResultModel | 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
<a name="inputspost"></a>

**Operation ID:** `CreateInput`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateInputResultModel | 201 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 | 

## Schemas
<a name="inputs-schemas"></a>

### Request bodies
<a name="inputs-request-examples"></a>

#### POST schema
<a name="inputs-request-body-post-example"></a>

```
{
  "destinations": [
    {
      "streamName": "string"
    }
  ],
  "inputDevices": [
    {
      "id": "string"
    }
  ],
  "inputSecurityGroups": [
    "string"
  ],
  "mediaConnectFlows": [
    {
      "flowArn": "string"
    }
  ],
  "name": "string",
  "requestId": "string",
  "roleArn": "string",
  "sources": [
    {
      "passwordParam": "string",
      "url": "string",
      "username": "string"
    }
  ],
  "tags": {
  },
  "type": enum,
  "vpc": {
    "securityGroupIds": [
      "string"
    ],
    "subnetIds": [
      "string"
    ]
  }
}
```

### Response bodies
<a name="inputs-response-examples"></a>

#### ListInputsResultModel schema
<a name="inputs-response-body-listinputsresultmodel-example"></a>

```
{
  "inputs": [
    {
      "arn": "string",
      "attachedChannels": [
        "string"
      ],
      "destinations": [
        {
          "ip": "string",
          "port": "string",
          "url": "string",
          "vpc": {
            "availabilityZone": "string",
            "networkInterfaceId": "string"
          }
        }
      ],
      "id": "string",
      "inputClass": enum,
      "inputDevices": [
        {
          "id": "string"
        }
      ],
      "inputPartnerIds": [
        "string"
      ],
      "inputSourceType": enum,
      "mediaConnectFlows": [
        {
          "flowArn": "string"
        }
      ],
      "name": "string",
      "roleArn": "string",
      "securityGroups": [
        "string"
      ],
      "sources": [
        {
          "passwordParam": "string",
          "url": "string",
          "username": "string"
        }
      ],
      "state": enum,
      "tags": {
      },
      "type": enum
    }
  ],
  "nextToken": "string"
}
```

#### CreateInputResultModel schema
<a name="inputs-response-body-createinputresultmodel-example"></a>

```
{
  "input": {
    "arn": "string",
    "attachedChannels": [
      "string"
    ],
    "destinations": [
      {
        "ip": "string",
        "port": "string",
        "url": "string",
        "vpc": {
          "availabilityZone": "string",
          "networkInterfaceId": "string"
        }
      }
    ],
    "id": "string",
    "inputClass": enum,
    "inputDevices": [
      {
        "id": "string"
      }
    ],
    "inputPartnerIds": [
      "string"
    ],
    "inputSourceType": enum,
    "mediaConnectFlows": [
      {
        "flowArn": "string"
      }
    ],
    "name": "string",
    "roleArn": "string",
    "securityGroups": [
      "string"
    ],
    "sources": [
      {
        "passwordParam": "string",
        "url": "string",
        "username": "string"
      }
    ],
    "state": enum,
    "tags": {
    },
    "type": enum
  }
}
```

#### InvalidRequest schema
<a name="inputs-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputs-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="inputs-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputs-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputs-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputs-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputs-properties"></a>

### AccessDenied
<a name="inputs-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputs-model-badgatewayexception"></a>


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

### CreateInput
<a name="inputs-model-createinput"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinations | Array of type [InputDestinationRequest](#inputs-model-inputdestinationrequest) | False | Destination settings for PUSH type inputs. | 
| inputDevices | Array of type [InputDeviceSettings](#inputs-model-inputdevicesettings) | False | Settings for the devices. | 
| inputSecurityGroups | Array of type string | False | A list of security groups referenced by IDs to attach to the input. | 
| mediaConnectFlows | Array of type [MediaConnectFlowRequest](#inputs-model-mediaconnectflowrequest) | False | A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.  | 
| name | string | False | Name of the input. | 
| requestId | string | False | Unique identifier of the request to ensure the request is handled exactly once in case of retries.  | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. | 
| sources | Array of type [InputSourceRequest](#inputs-model-inputsourcerequest) | False | The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.  | 
| tags | [Tags](#inputs-model-tags) | False | A collection of key-value pairs. | 
| type | [InputType](#inputs-model-inputtype) | False |  | 
| vpc | [InputVpcRequest](#inputs-model-inputvpcrequest) | False |  | 

### CreateInputResultModel
<a name="inputs-model-createinputresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| input | [Input](#inputs-model-input) | False |  | 

### GatewayTimeoutException
<a name="inputs-model-gatewaytimeoutexception"></a>


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

### Input
<a name="inputs-model-input"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Unique ARN of the input (generated, immutable). | 
| attachedChannels | Array of type string | False | A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). | 
| destinations | Array of type [InputDestination](#inputs-model-inputdestination) | False | A list of the destinations of the input (PUSH-type). | 
| id | string | False | Read-only ID for the input. Unique in the AWS account. | 
| inputClass | [InputClass](#inputs-model-inputclass) | False | STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE\$1PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE\$1PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE\$1PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.  | 
| inputDevices | Array of type [InputDeviceSettings](#inputs-model-inputdevicesettings) | False | Settings for the input devices. | 
| inputPartnerIds | Array of type string | False | A list of IDs for all Inputs which are partners of this one. | 
| inputSourceType | [InputSourceType](#inputs-model-inputsourcetype) | False | Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4\$1FILE and TS\$1FILE inputs.  | 
| mediaConnectFlows | Array of type [MediaConnectFlow](#inputs-model-mediaconnectflow) | False | A list of MediaConnect Flows for this input. | 
| name | string | False | A modifiable ID for the input. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. | 
| securityGroups | Array of type string | False | A list of IDs for all the Input Security Groups attached to the input. | 
| sources | Array of type [InputSource](#inputs-model-inputsource) | False | A list of the sources of the input (PULL-type). | 
| state | [InputState](#inputs-model-inputstate) | False |  | 
| tags | [Tags](#inputs-model-tags) | False | A collection of key-value pairs. | 
| type | [InputType](#inputs-model-inputtype) | False |  | 

### InputClass
<a name="inputs-model-inputclass"></a>

A standard input has two sources and a single pipeline input only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### InputDestination
<a name="inputs-model-inputdestination"></a>

The settings for a PUSH type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ip | string | False | The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.  | 
| port | string | False | The port number for the input. | 
| url | string | False | This represents the endpoint that the customer stream will be pushed to.  | 
| vpc | [InputDestinationVpc](#inputs-model-inputdestinationvpc) | False |  | 

### InputDestinationRequest
<a name="inputs-model-inputdestinationrequest"></a>

Endpoint settings for a PUSH type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| streamName | string | False | A unique name for the location the RTMP stream is being pushed to.  | 

### InputDestinationVpc
<a name="inputs-model-inputdestinationvpc"></a>

The properties for a VPC type input destination.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZone | string | False | The availability zone of the Input destination.  | 
| networkInterfaceId | string | False | The network interface ID of the Input destination in the VPC.  | 

### InputDeviceSettings
<a name="inputs-model-inputdevicesettings"></a>

Settings for an input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The unique ID for the device. | 

### InputSource
<a name="inputs-model-inputsource"></a>

The settings for a PULL type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | The key used to extract the password from EC2 Parameter store. | 
| url | string | False | This represents the customer's source URL where stream is pulled from.  | 
| username | string | False | The username for the input source. | 

### InputSourceRequest
<a name="inputs-model-inputsourcerequest"></a>

Settings for for a PULL type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | The key used to extract the password from EC2 Parameter store. | 
| url | string | False | This represents the customer's source URL where stream is pulled from.  | 
| username | string | False | The username for the input source. | 

### InputSourceType
<a name="inputs-model-inputsourcetype"></a>

There are two types of input sources, static and dynamic. If an input source is dynamic you can change the source url of the input dynamically using an input switch action. Currently, two input types support a dynamic url at this time, MP4\$1FILE and TS\$1FILE. By default all input sources are static. 
+ `STATIC`
+ `DYNAMIC`

### InputState
<a name="inputs-model-inputstate"></a>
+ `CREATING`
+ `DETACHED`
+ `ATTACHED`
+ `DELETING`
+ `DELETED`

### InputType
<a name="inputs-model-inputtype"></a>

The different types of inputs that AWS Elemental MediaLive supports.
+ `UDP_PUSH`
+ `RTP_PUSH`
+ `RTMP_PUSH`
+ `RTMP_PULL`
+ `URL_PULL`
+ `MP4_FILE`
+ `MEDIACONNECT`
+ `MULTICAST`
+ `INPUT_DEVICE`
+ `AWS_CDI`
+ `TS_FILE`
+ `SRT_CALLER`
+ `SDI`

### InputVpcRequest
<a name="inputs-model-inputvpcrequest"></a>

Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property. 


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| securityGroupIds | Array of type string | False | A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. Requires subnetIds. If none are specified then the VPC default security group will be used.  | 
| subnetIds | Array of type string | True | A list of 2 VPC subnet IDs from the same VPC. Subnet IDs must be mapped to two unique availability zones (AZ).  | 

### InternalServiceError
<a name="inputs-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputs-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputs-model-limitexceeded"></a>


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

### ListInputsResultModel
<a name="inputs-model-listinputsresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| inputs | Array of type [Input](#inputs-model-input) | False |  | 
| nextToken | string | False |  | 

### MediaConnectFlow
<a name="inputs-model-mediaconnectflow"></a>

The settings for a MediaConnect Flow.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| flowArn | string | False | The unique ARN of the MediaConnect Flow being used as a source. | 

### MediaConnectFlowRequest
<a name="inputs-model-mediaconnectflowrequest"></a>

The settings for a MediaConnect Flow.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| flowArn | string | False | The ARN of the MediaConnect Flow that you want to use as a source. | 

### Tags
<a name="inputs-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="inputs-see-also"></a>

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

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

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

# Inputs: input ID
<a name="inputs-inputid"></a>

## URI
<a name="inputs-inputid-url"></a>

`/prod/inputs/inputId`

## HTTP methods
<a name="inputs-inputid-http-methods"></a>

### DELETE
<a name="inputs-inputiddelete"></a>

**Operation ID:** `DeleteInput`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Empty | 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="inputs-inputidget"></a>

**Operation ID:** `DescribeInput`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Input | 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="inputs-inputidput"></a>

**Operation ID:** `UpdateInput`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateInputResultModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 409 | ResourceConflict | 409 response | 
| 500 | InternalServiceError | 500 response | 
| 502 | BadGatewayException | 502 response | 
| 504 | GatewayTimeoutException | 504 response | 

## Schemas
<a name="inputs-inputid-schemas"></a>

### Request bodies
<a name="inputs-inputid-request-examples"></a>

#### PUT schema
<a name="inputs-inputid-request-body-put-example"></a>

```
{
  "destinations": [
    {
      "streamName": "string"
    }
  ],
  "inputDevices": [
    {
      "id": "string"
    }
  ],
  "inputSecurityGroups": [
    "string"
  ],
  "mediaConnectFlows": [
    {
      "flowArn": "string"
    }
  ],
  "name": "string",
  "roleArn": "string",
  "sources": [
    {
      "passwordParam": "string",
      "url": "string",
      "username": "string"
    }
  ]
}
```

### Response bodies
<a name="inputs-inputid-response-examples"></a>

#### Empty schema
<a name="inputs-inputid-response-body-empty-example"></a>

```
{
}
```

#### Input schema
<a name="inputs-inputid-response-body-input-example"></a>

```
{
  "arn": "string",
  "attachedChannels": [
    "string"
  ],
  "destinations": [
    {
      "ip": "string",
      "port": "string",
      "url": "string",
      "vpc": {
        "availabilityZone": "string",
        "networkInterfaceId": "string"
      }
    }
  ],
  "id": "string",
  "inputClass": enum,
  "inputDevices": [
    {
      "id": "string"
    }
  ],
  "inputPartnerIds": [
    "string"
  ],
  "inputSourceType": enum,
  "mediaConnectFlows": [
    {
      "flowArn": "string"
    }
  ],
  "name": "string",
  "roleArn": "string",
  "securityGroups": [
    "string"
  ],
  "sources": [
    {
      "passwordParam": "string",
      "url": "string",
      "username": "string"
    }
  ],
  "state": enum,
  "tags": {
  },
  "type": enum
}
```

#### UpdateInputResultModel schema
<a name="inputs-inputid-response-body-updateinputresultmodel-example"></a>

```
{
  "input": {
    "arn": "string",
    "attachedChannels": [
      "string"
    ],
    "destinations": [
      {
        "ip": "string",
        "port": "string",
        "url": "string",
        "vpc": {
          "availabilityZone": "string",
          "networkInterfaceId": "string"
        }
      }
    ],
    "id": "string",
    "inputClass": enum,
    "inputDevices": [
      {
        "id": "string"
      }
    ],
    "inputPartnerIds": [
      "string"
    ],
    "inputSourceType": enum,
    "mediaConnectFlows": [
      {
        "flowArn": "string"
      }
    ],
    "name": "string",
    "roleArn": "string",
    "securityGroups": [
      "string"
    ],
    "sources": [
      {
        "passwordParam": "string",
        "url": "string",
        "username": "string"
      }
    ],
    "state": enum,
    "tags": {
    },
    "type": enum
  }
}
```

#### InvalidRequest schema
<a name="inputs-inputid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputs-inputid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="inputs-inputid-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="inputs-inputid-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="inputs-inputid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputs-inputid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputs-inputid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputs-inputid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputs-inputid-properties"></a>

### AccessDenied
<a name="inputs-inputid-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputs-inputid-model-badgatewayexception"></a>


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

### Empty
<a name="inputs-inputid-model-empty"></a>

### GatewayTimeoutException
<a name="inputs-inputid-model-gatewaytimeoutexception"></a>


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

### Input
<a name="inputs-inputid-model-input"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Unique ARN of the input (generated, immutable). | 
| attachedChannels | Array of type string | False | A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). | 
| destinations | Array of type [InputDestination](#inputs-inputid-model-inputdestination) | False | A list of the destinations of the input (PUSH-type). | 
| id | string | False | Read-only ID for the input. Unique in the AWS account. | 
| inputClass | [InputClass](#inputs-inputid-model-inputclass) | False | STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE\$1PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE\$1PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE\$1PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.  | 
| inputDevices | Array of type [InputDeviceSettings](#inputs-inputid-model-inputdevicesettings) | False | Settings for the input devices. | 
| inputPartnerIds | Array of type string | False | A list of IDs for all Inputs which are partners of this one. | 
| inputSourceType | [InputSourceType](#inputs-inputid-model-inputsourcetype) | False | Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4\$1FILE and TS\$1FILE inputs.  | 
| mediaConnectFlows | Array of type [MediaConnectFlow](#inputs-inputid-model-mediaconnectflow) | False | A list of MediaConnect Flows for this input. | 
| name | string | False | A modifiable ID for the input. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. | 
| securityGroups | Array of type string | False | A list of IDs for all the Input Security Groups attached to the input. | 
| sources | Array of type [InputSource](#inputs-inputid-model-inputsource) | False | A list of the sources of the input (PULL-type). | 
| state | [InputState](#inputs-inputid-model-inputstate) | False |  | 
| tags | [Tags](#inputs-inputid-model-tags) | False | A collection of key-value pairs. | 
| type | [InputType](#inputs-inputid-model-inputtype) | False |  | 

### InputClass
<a name="inputs-inputid-model-inputclass"></a>

A standard input has two sources and a single pipeline input only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### InputDestination
<a name="inputs-inputid-model-inputdestination"></a>

The settings for a PUSH type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ip | string | False | The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.  | 
| port | string | False | The port number for the input. | 
| url | string | False | This represents the endpoint that the customer stream will be pushed to.  | 
| vpc | [InputDestinationVpc](#inputs-inputid-model-inputdestinationvpc) | False |  | 

### InputDestinationRequest
<a name="inputs-inputid-model-inputdestinationrequest"></a>

Endpoint settings for a PUSH type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| streamName | string | False | A unique name for the location the RTMP stream is being pushed to.  | 

### InputDestinationVpc
<a name="inputs-inputid-model-inputdestinationvpc"></a>

The properties for a VPC type input destination.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZone | string | False | The availability zone of the Input destination.  | 
| networkInterfaceId | string | False | The network interface ID of the Input destination in the VPC.  | 

### InputDeviceRequest
<a name="inputs-inputid-model-inputdevicerequest"></a>

Settings for an input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The unique ID for the device. | 

### InputDeviceSettings
<a name="inputs-inputid-model-inputdevicesettings"></a>

Settings for an input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The unique ID for the device. | 

### InputSource
<a name="inputs-inputid-model-inputsource"></a>

The settings for a PULL type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | The key used to extract the password from EC2 Parameter store. | 
| url | string | False | This represents the customer's source URL where stream is pulled from.  | 
| username | string | False | The username for the input source. | 

### InputSourceRequest
<a name="inputs-inputid-model-inputsourcerequest"></a>

Settings for for a PULL type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | The key used to extract the password from EC2 Parameter store. | 
| url | string | False | This represents the customer's source URL where stream is pulled from.  | 
| username | string | False | The username for the input source. | 

### InputSourceType
<a name="inputs-inputid-model-inputsourcetype"></a>

There are two types of input sources, static and dynamic. If an input source is dynamic you can change the source url of the input dynamically using an input switch action. Currently, two input types support a dynamic url at this time, MP4\$1FILE and TS\$1FILE. By default all input sources are static. 
+ `STATIC`
+ `DYNAMIC`

### InputState
<a name="inputs-inputid-model-inputstate"></a>
+ `CREATING`
+ `DETACHED`
+ `ATTACHED`
+ `DELETING`
+ `DELETED`

### InputType
<a name="inputs-inputid-model-inputtype"></a>

The different types of inputs that AWS Elemental MediaLive supports.
+ `UDP_PUSH`
+ `RTP_PUSH`
+ `RTMP_PUSH`
+ `RTMP_PULL`
+ `URL_PULL`
+ `MP4_FILE`
+ `MEDIACONNECT`
+ `MULTICAST`
+ `INPUT_DEVICE`
+ `AWS_CDI`
+ `TS_FILE`
+ `SRT_CALLER`
+ `SDI`

### InternalServiceError
<a name="inputs-inputid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputs-inputid-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputs-inputid-model-limitexceeded"></a>


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

### MediaConnectFlow
<a name="inputs-inputid-model-mediaconnectflow"></a>

The settings for a MediaConnect Flow.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| flowArn | string | False | The unique ARN of the MediaConnect Flow being used as a source. | 

### MediaConnectFlowRequest
<a name="inputs-inputid-model-mediaconnectflowrequest"></a>

The settings for a MediaConnect Flow.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| flowArn | string | False | The ARN of the MediaConnect Flow that you want to use as a source. | 

### ResourceConflict
<a name="inputs-inputid-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="inputs-inputid-model-resourcenotfound"></a>


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

### Tags
<a name="inputs-inputid-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### UpdateInput
<a name="inputs-inputid-model-updateinput"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinations | Array of type [InputDestinationRequest](#inputs-inputid-model-inputdestinationrequest) | False | Destination settings for PUSH type inputs. | 
| inputDevices | Array of type [InputDeviceRequest](#inputs-inputid-model-inputdevicerequest) | False | Settings for the devices. | 
| inputSecurityGroups | Array of type string | False | A list of security groups referenced by IDs to attach to the input. | 
| mediaConnectFlows | Array of type [MediaConnectFlowRequest](#inputs-inputid-model-mediaconnectflowrequest) | False | A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.  | 
| name | string | False | Name of the input. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. | 
| sources | Array of type [InputSourceRequest](#inputs-inputid-model-inputsourcerequest) | False | The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.  | 

### UpdateInputResultModel
<a name="inputs-inputid-model-updateinputresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| input | [Input](#inputs-inputid-model-input) | False |  | 

## See also
<a name="inputs-inputid-see-also"></a>

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

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

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

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

# Inputs: partners
<a name="inputs-inputid-partners"></a>

## URI
<a name="inputs-inputid-partners-url"></a>

`/prod/inputs/inputId/partners`

## HTTP methods
<a name="inputs-inputid-partners-http-methods"></a>

### POST
<a name="inputs-inputid-partnerspost"></a>

**Operation ID:** `CreatePartnerInput`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| inputId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreatePartnerInputResultModel | 201 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 | 

## Schemas
<a name="inputs-inputid-partners-schemas"></a>

### Request bodies
<a name="inputs-inputid-partners-request-examples"></a>

#### POST schema
<a name="inputs-inputid-partners-request-body-post-example"></a>

```
{
  "requestId": "string",
  "tags": {
  }
}
```

### Response bodies
<a name="inputs-inputid-partners-response-examples"></a>

#### CreatePartnerInputResultModel schema
<a name="inputs-inputid-partners-response-body-createpartnerinputresultmodel-example"></a>

```
{
  "input": {
    "arn": "string",
    "attachedChannels": [
      "string"
    ],
    "destinations": [
      {
        "ip": "string",
        "port": "string",
        "url": "string",
        "vpc": {
          "availabilityZone": "string",
          "networkInterfaceId": "string"
        }
      }
    ],
    "id": "string",
    "inputClass": enum,
    "inputDevices": [
      {
        "id": "string"
      }
    ],
    "inputPartnerIds": [
      "string"
    ],
    "inputSourceType": enum,
    "mediaConnectFlows": [
      {
        "flowArn": "string"
      }
    ],
    "name": "string",
    "roleArn": "string",
    "securityGroups": [
      "string"
    ],
    "sources": [
      {
        "passwordParam": "string",
        "url": "string",
        "username": "string"
      }
    ],
    "state": enum,
    "tags": {
    },
    "type": enum
  }
}
```

#### InvalidRequest schema
<a name="inputs-inputid-partners-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="inputs-inputid-partners-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="inputs-inputid-partners-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="inputs-inputid-partners-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="inputs-inputid-partners-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="inputs-inputid-partners-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="inputs-inputid-partners-properties"></a>

### AccessDenied
<a name="inputs-inputid-partners-model-accessdenied"></a>


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

### BadGatewayException
<a name="inputs-inputid-partners-model-badgatewayexception"></a>


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

### CreatePartnerInput
<a name="inputs-inputid-partners-model-createpartnerinput"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| requestId | string | False | Unique identifier of the request to ensure the request is handled exactly once in case of retries.  | 
| tags | [Tags](#inputs-inputid-partners-model-tags) | False | A collection of key-value pairs. | 

### CreatePartnerInputResultModel
<a name="inputs-inputid-partners-model-createpartnerinputresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| input | [Input](#inputs-inputid-partners-model-input) | False |  | 

### GatewayTimeoutException
<a name="inputs-inputid-partners-model-gatewaytimeoutexception"></a>


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

### Input
<a name="inputs-inputid-partners-model-input"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Unique ARN of the input (generated, immutable). | 
| attachedChannels | Array of type string | False | A list of channel IDs that that input is attached to (currently an input can only be attached to one channel). | 
| destinations | Array of type [InputDestination](#inputs-inputid-partners-model-inputdestination) | False | A list of the destinations of the input (PUSH-type). | 
| id | string | False | Read-only ID for the input. Unique in the AWS account. | 
| inputClass | [InputClass](#inputs-inputid-partners-model-inputclass) | False | STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE\$1PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE\$1PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE\$1PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.  | 
| inputDevices | Array of type [InputDeviceSettings](#inputs-inputid-partners-model-inputdevicesettings) | False | Settings for the input devices. | 
| inputPartnerIds | Array of type string | False | A list of IDs for all Inputs which are partners of this one. | 
| inputSourceType | [InputSourceType](#inputs-inputid-partners-model-inputsourcetype) | False | Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during input switch actions. Presently, this functionality only works with MP4\$1FILE and TS\$1FILE inputs.  | 
| mediaConnectFlows | Array of type [MediaConnectFlow](#inputs-inputid-partners-model-mediaconnectflow) | False | A list of MediaConnect Flows for this input. | 
| name | string | False | A modifiable ID for the input. | 
| roleArn | string | False | The Amazon Resource Name (ARN) of the role this input assumes during and after creation. | 
| securityGroups | Array of type string | False | A list of IDs for all the Input Security Groups attached to the input. | 
| sources | Array of type [InputSource](#inputs-inputid-partners-model-inputsource) | False | A list of the sources of the input (PULL-type). | 
| state | [InputState](#inputs-inputid-partners-model-inputstate) | False |  | 
| tags | [Tags](#inputs-inputid-partners-model-tags) | False | A collection of key-value pairs. | 
| type | [InputType](#inputs-inputid-partners-model-inputtype) | False |  | 

### InputClass
<a name="inputs-inputid-partners-model-inputclass"></a>

A standard input has two sources and a single pipeline input only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### InputDestination
<a name="inputs-inputid-partners-model-inputdestination"></a>

The settings for a PUSH type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| ip | string | False | The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.  | 
| port | string | False | The port number for the input. | 
| url | string | False | This represents the endpoint that the customer stream will be pushed to.  | 
| vpc | [InputDestinationVpc](#inputs-inputid-partners-model-inputdestinationvpc) | False |  | 

### InputDestinationVpc
<a name="inputs-inputid-partners-model-inputdestinationvpc"></a>

The properties for a VPC type input destination.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZone | string | False | The availability zone of the Input destination.  | 
| networkInterfaceId | string | False | The network interface ID of the Input destination in the VPC.  | 

### InputDeviceSettings
<a name="inputs-inputid-partners-model-inputdevicesettings"></a>

Settings for an input device.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| id | string | False | The unique ID for the device. | 

### InputSource
<a name="inputs-inputid-partners-model-inputsource"></a>

The settings for a PULL type input.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| passwordParam | string | False | The key used to extract the password from EC2 Parameter store. | 
| url | string | False | This represents the customer's source URL where stream is pulled from.  | 
| username | string | False | The username for the input source. | 

### InputSourceType
<a name="inputs-inputid-partners-model-inputsourcetype"></a>

There are two types of input sources, static and dynamic. If an input source is dynamic you can change the source url of the input dynamically using an input switch action. Currently, two input types support a dynamic url at this time, MP4\$1FILE and TS\$1FILE. By default all input sources are static. 
+ `STATIC`
+ `DYNAMIC`

### InputState
<a name="inputs-inputid-partners-model-inputstate"></a>
+ `CREATING`
+ `DETACHED`
+ `ATTACHED`
+ `DELETING`
+ `DELETED`

### InputType
<a name="inputs-inputid-partners-model-inputtype"></a>

The different types of inputs that AWS Elemental MediaLive supports.
+ `UDP_PUSH`
+ `RTP_PUSH`
+ `RTMP_PUSH`
+ `RTMP_PULL`
+ `URL_PULL`
+ `MP4_FILE`
+ `MEDIACONNECT`
+ `MULTICAST`
+ `INPUT_DEVICE`
+ `AWS_CDI`
+ `TS_FILE`
+ `SRT_CALLER`
+ `SDI`

### InternalServiceError
<a name="inputs-inputid-partners-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="inputs-inputid-partners-model-invalidrequest"></a>


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

### LimitExceeded
<a name="inputs-inputid-partners-model-limitexceeded"></a>


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

### MediaConnectFlow
<a name="inputs-inputid-partners-model-mediaconnectflow"></a>

The settings for a MediaConnect Flow.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| flowArn | string | False | The unique ARN of the MediaConnect Flow being used as a source. | 

### Tags
<a name="inputs-inputid-partners-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="inputs-inputid-partners-see-also"></a>

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

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

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

# Multiplex: list programs
<a name="multiplexes-multiplexid-programs"></a>

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

`/prod/multiplexes/multiplexId/programs`

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

### GET
<a name="multiplexes-multiplexid-programsget"></a>

**Operation ID:** `ListMultiplexPrograms`


**Path parameters**  

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


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**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
<a name="multiplexes-multiplexid-programspost"></a>

**Operation ID:** `CreateMultiplexProgram`


**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
<a name="multiplexes-multiplexid-programs-schemas"></a>

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

#### POST schema
<a name="multiplexes-multiplexid-programs-request-body-post-example"></a>

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

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

#### ListMultiplexProgramsResultModel schema
<a name="multiplexes-multiplexid-programs-response-body-listmultiplexprogramsresultmodel-example"></a>

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

#### CreateMultiplexProgramResultModel schema
<a name="multiplexes-multiplexid-programs-response-body-createmultiplexprogramresultmodel-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-response-body-invalidrequest-example"></a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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


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

### CreateMultiplexProgram
<a name="multiplexes-multiplexid-programs-model-createmultiplexprogram"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexProgramSettings | [MultiplexProgramSettings](#multiplexes-multiplexid-programs-model-multiplexprogramsettings) | True | The settings for this multiplex program. | 
| programName | string | True | Name of multiplex program. | 
| requestId | string | True | Unique request ID. This prevents retries from creating multiple resources.  | 

### CreateMultiplexProgramResultModel
<a name="multiplexes-multiplexid-programs-model-createmultiplexprogramresultmodel"></a>


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

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


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

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


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

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


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

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


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

### ListMultiplexProgramsResultModel
<a name="multiplexes-multiplexid-programs-model-listmultiplexprogramsresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexPrograms | Array of type [MultiplexProgramSummary](#multiplexes-multiplexid-programs-model-multiplexprogramsummary) | False | List of multiplex programs. | 
| nextToken | string | False | Token for the next ListMultiplexProgram request. | 

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


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

### MultiplexProgram
<a name="multiplexes-multiplexid-programs-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-model-multiplexprogramsettings) | False | The settings for this multiplex program. | 
| packetIdentifiersMap | [MultiplexProgramPacketIdentifiersMap](#multiplexes-multiplexid-programs-model-multiplexprogrampacketidentifiersmap) | False | The packet identifier map for this multiplex program. | 
| pipelineDetails | Array of type [MultiplexProgramPipelineDetail](#multiplexes-multiplexid-programs-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-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-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-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-model-multiplexprogramsettings"></a>

Multiplex Program settings configuration.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| preferredChannelPipeline | [PreferredChannelPipeline](#multiplexes-multiplexid-programs-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-model-multiplexprogramservicedescriptor) | False | Transport stream service descriptor configuration for the Multiplex program. | 
| videoSettings | [MultiplexVideoSettings](#multiplexes-multiplexid-programs-model-multiplexvideosettings) | False | Program video settings configuration. | 

### MultiplexProgramSummary
<a name="multiplexes-multiplexid-programs-model-multiplexprogramsummary"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelId | string | False | The MediaLive Channel associated with the program. | 
| programName | string | False | The name of the multiplex program. | 

### MultiplexStatmuxVideoSettings
<a name="multiplexes-multiplexid-programs-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-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-model-multiplexstatmuxvideosettings) | False | Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined. | 

### PreferredChannelPipeline
<a name="multiplexes-multiplexid-programs-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-model-resourceconflict"></a>


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

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


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

### ValidationError
<a name="multiplexes-multiplexid-programs-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-see-also"></a>

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

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

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

# Multiplex: start
<a name="multiplexes-multiplexid-start"></a>

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

`/prod/multiplexes/multiplexId/start`

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

### POST
<a name="multiplexes-multiplexid-startpost"></a>

**Operation ID:** `StartMultiplex`


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

## Schemas
<a name="multiplexes-multiplexid-start-schemas"></a>

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

#### Multiplex schema
<a name="multiplexes-multiplexid-start-response-body-multiplex-example"></a>

```
{
  "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
<a name="multiplexes-multiplexid-start-response-body-invalidrequest-example"></a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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


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

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


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

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


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

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


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

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


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

### Multiplex
<a name="multiplexes-multiplexid-start-model-multiplex"></a>

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-start-model-multiplexoutputdestination) | False | A list of the multiplex output destinations. | 
| id | string | False | The unique id of the multiplex. | 
| multiplexSettings | [MultiplexSettings](#multiplexes-multiplexid-start-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-start-model-multiplexstate) | False | The current state of the multiplex. | 
| tags | [Tags](#multiplexes-multiplexid-start-model-tags) | False | A collection of key-value pairs. | 

### MultiplexMediaConnectOutputDestinationSettings
<a name="multiplexes-multiplexid-start-model-multiplexmediaconnectoutputdestinationsettings"></a>

Multiplex MediaConnect output destination settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| entitlementArn | stringMinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. | 

### MultiplexOutputDestination
<a name="multiplexes-multiplexid-start-model-multiplexoutputdestination"></a>

Multiplex output destination settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| mediaConnectSettings | [MultiplexMediaConnectOutputDestinationSettings](#multiplexes-multiplexid-start-model-multiplexmediaconnectoutputdestinationsettings) | False | Multiplex MediaConnect output destination settings. | 

### MultiplexSettings
<a name="multiplexes-multiplexid-start-model-multiplexsettings"></a>

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
<a name="multiplexes-multiplexid-start-model-multiplexstate"></a>

The current state of the multiplex.
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`

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


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

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


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

### Tags
<a name="multiplexes-multiplexid-start-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

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

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

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

# Multiplex: stop
<a name="multiplexes-multiplexid-stop"></a>

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

`/prod/multiplexes/multiplexId/stop`

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

### POST
<a name="multiplexes-multiplexid-stoppost"></a>

**Operation ID:** `StopMultiplex`


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

## Schemas
<a name="multiplexes-multiplexid-stop-schemas"></a>

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

#### Multiplex schema
<a name="multiplexes-multiplexid-stop-response-body-multiplex-example"></a>

```
{
  "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
<a name="multiplexes-multiplexid-stop-response-body-invalidrequest-example"></a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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


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

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


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

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


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

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


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

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


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

### Multiplex
<a name="multiplexes-multiplexid-stop-model-multiplex"></a>

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-stop-model-multiplexoutputdestination) | False | A list of the multiplex output destinations. | 
| id | string | False | The unique id of the multiplex. | 
| multiplexSettings | [MultiplexSettings](#multiplexes-multiplexid-stop-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-stop-model-multiplexstate) | False | The current state of the multiplex. | 
| tags | [Tags](#multiplexes-multiplexid-stop-model-tags) | False | A collection of key-value pairs. | 

### MultiplexMediaConnectOutputDestinationSettings
<a name="multiplexes-multiplexid-stop-model-multiplexmediaconnectoutputdestinationsettings"></a>

Multiplex MediaConnect output destination settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| entitlementArn | stringMinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. | 

### MultiplexOutputDestination
<a name="multiplexes-multiplexid-stop-model-multiplexoutputdestination"></a>

Multiplex output destination settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| mediaConnectSettings | [MultiplexMediaConnectOutputDestinationSettings](#multiplexes-multiplexid-stop-model-multiplexmediaconnectoutputdestinationsettings) | False | Multiplex MediaConnect output destination settings. | 

### MultiplexSettings
<a name="multiplexes-multiplexid-stop-model-multiplexsettings"></a>

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
<a name="multiplexes-multiplexid-stop-model-multiplexstate"></a>

The current state of the multiplex.
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`

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


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

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


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

### Tags
<a name="multiplexes-multiplexid-stop-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

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

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

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

# Multiplexes
<a name="multiplexes"></a>

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

`/prod/multiplexes`

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

### GET
<a name="multiplexesget"></a>

**Operation ID:** `ListMultiplexes`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| 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
<a name="multiplexespost"></a>

**Operation ID:** `CreateMultiplex`


**Responses**  

| 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
<a name="multiplexes-schemas"></a>

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

#### POST schema
<a name="multiplexes-request-body-post-example"></a>

```
{
  "availabilityZones": [
    "string"
  ],
  "multiplexSettings": {
    "maximumVideoBufferDelayMilliseconds": integer,
    "transportStreamBitrate": integer,
    "transportStreamId": integer,
    "transportStreamReservedBitrate": integer
  },
  "name": "string",
  "requestId": "string",
  "tags": {
  }
}
```

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

#### ListMultiplexesResultModel schema
<a name="multiplexes-response-body-listmultiplexesresultmodel-example"></a>

```
{
  "multiplexes": [
    {
      "arn": "string",
      "availabilityZones": [
        "string"
      ],
      "id": "string",
      "multiplexSettings": {
        "transportStreamBitrate": integer
      },
      "name": "string",
      "pipelinesRunningCount": integer,
      "programCount": integer,
      "state": enum,
      "tags": {
      }
    }
  ],
  "nextToken": "string"
}
```

#### CreateMultiplexResultModel schema
<a name="multiplexes-response-body-createmultiplexresultmodel-example"></a>

```
{
  "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
<a name="multiplexes-response-body-invalidrequest-example"></a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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


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

### CreateMultiplex
<a name="multiplexes-model-createmultiplex"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| availabilityZones | Array of type string | True | A list of availability zones for the multiplex. You must specify exactly two. | 
| multiplexSettings | [MultiplexSettings](#multiplexes-model-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 | [Tags](#multiplexes-model-tags) | False | A collection of key-value pairs. | 

### CreateMultiplexResultModel
<a name="multiplexes-model-createmultiplexresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplex | [Multiplex](#multiplexes-model-multiplex) | False | The newly created multiplex. | 

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


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

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


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

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


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

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


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

### ListMultiplexesResultModel
<a name="multiplexes-model-listmultiplexesresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplexes | Array of type [MultiplexSummary](#multiplexes-model-multiplexsummary) | False | List of multiplexes. | 
| nextToken | string | False | Token for the next ListMultiplexes request. | 

### Multiplex
<a name="multiplexes-model-multiplex"></a>

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-model-multiplexoutputdestination) | False | A list of the multiplex output destinations. | 
| id | string | False | The unique id of the multiplex. | 
| multiplexSettings | [MultiplexSettings](#multiplexes-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-model-multiplexstate) | False | The current state of the multiplex. | 
| tags | [Tags](#multiplexes-model-tags) | False | A collection of key-value pairs. | 

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


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

### MultiplexMediaConnectOutputDestinationSettings
<a name="multiplexes-model-multiplexmediaconnectoutputdestinationsettings"></a>

Multiplex MediaConnect output destination settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| entitlementArn | stringMinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. | 

### MultiplexOutputDestination
<a name="multiplexes-model-multiplexoutputdestination"></a>

Multiplex output destination settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| mediaConnectSettings | [MultiplexMediaConnectOutputDestinationSettings](#multiplexes-model-multiplexmediaconnectoutputdestinationsettings) | False | Multiplex MediaConnect output destination settings. | 

### MultiplexSettings
<a name="multiplexes-model-multiplexsettings"></a>

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

### MultiplexSettingsSummary
<a name="multiplexes-model-multiplexsettingssummary"></a>

Contains summary configuration for a Multiplex event.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| transportStreamBitrate | integerMinimum: 1000000Maximum: 100000000 | False | Transport stream bit rate. | 

### MultiplexState
<a name="multiplexes-model-multiplexstate"></a>

The current state of the multiplex.
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`

### MultiplexSummary
<a name="multiplexes-model-multiplexsummary"></a>


| 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 | [MultiplexSettingsSummary](#multiplexes-model-multiplexsettingssummary) | 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-model-multiplexstate) | False | The current state of the multiplex. | 
| tags | [Tags](#multiplexes-model-tags) | False | A collection of key-value pairs. | 

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


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

### Tags
<a name="multiplexes-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### ValidationError
<a name="multiplexes-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-see-also"></a>

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

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

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

# Multiplexes: multiplex ID
<a name="multiplexes-multiplexid"></a>

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

`/prod/multiplexes/multiplexId`

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

### DELETE
<a name="multiplexes-multiplexiddelete"></a>

**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
<a name="multiplexes-multiplexidget"></a>

**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
<a name="multiplexes-multiplexidput"></a>

**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
<a name="multiplexes-multiplexid-schemas"></a>

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

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

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

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

#### UpdateMultiplexResultModel schema
<a name="multiplexes-multiplexid-response-body-updatemultiplexresultmodel-example"></a>

```
{
  "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
<a name="multiplexes-multiplexid-response-body-multiplex-example"></a>

```
{
  "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
<a name="multiplexes-multiplexid-response-body-invalidrequest-example"></a>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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


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

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


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

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


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

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


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

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


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

### Multiplex
<a name="multiplexes-multiplexid-model-multiplex"></a>

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
<a name="multiplexes-multiplexid-model-multiplexconfigurationvalidationerror"></a>


| 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
<a name="multiplexes-multiplexid-model-multiplexmediaconnectoutputdestinationsettings"></a>

Multiplex MediaConnect output destination settings.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| entitlementArn | stringMinLength: 1 | False | The MediaConnect entitlement ARN available as a Flow source. | 

### MultiplexOutputDestination
<a name="multiplexes-multiplexid-model-multiplexoutputdestination"></a>

Multiplex output destination settings


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| mediaConnectSettings | [MultiplexMediaConnectOutputDestinationSettings](#multiplexes-multiplexid-model-multiplexmediaconnectoutputdestinationsettings) | False | Multiplex MediaConnect output destination settings. | 

### MultiplexSettings
<a name="multiplexes-multiplexid-model-multiplexsettings"></a>

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
<a name="multiplexes-multiplexid-model-multiplexstate"></a>

The current state of the multiplex.
+ `CREATING`
+ `CREATE_FAILED`
+ `IDLE`
+ `STARTING`
+ `RUNNING`
+ `RECOVERING`
+ `STOPPING`
+ `DELETING`
+ `DELETED`

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


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

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


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

### Tags
<a name="multiplexes-multiplexid-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### UpdateMultiplex
<a name="multiplexes-multiplexid-model-updatemultiplex"></a>


| 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
<a name="multiplexes-multiplexid-model-updatemultiplexresultmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| multiplex | [Multiplex](#multiplexes-multiplexid-model-multiplex) | False | The updated multiplex. | 

### ValidationError
<a name="multiplexes-multiplexid-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-see-also"></a>

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

### DeleteMultiplex
<a name="DeleteMultiplex-see-also"></a>
+ [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
<a name="DescribeMultiplex-see-also"></a>
+ [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
<a name="UpdateMultiplex-see-also"></a>
+ [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)

# Offerings: describe offering
<a name="offerings-offeringid"></a>

## URI
<a name="offerings-offeringid-url"></a>

`/prod/offerings/offeringId`

## HTTP methods
<a name="offerings-offeringid-http-methods"></a>

### GET
<a name="offerings-offeringidget"></a>

**Operation ID:** `DescribeOffering`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| offeringId | String | True |  | 


**Responses**  

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

## Schemas
<a name="offerings-offeringid-schemas"></a>

### Response bodies
<a name="offerings-offeringid-response-examples"></a>

#### Offering schema
<a name="offerings-offeringid-response-body-offering-example"></a>

```
{
  "arn": "string",
  "currencyCode": "string",
  "duration": integer,
  "durationUnits": enum,
  "fixedPrice": number,
  "offeringDescription": "string",
  "offeringId": "string",
  "offeringType": enum,
  "region": "string",
  "resourceSpecification": {
    "channelClass": enum,
    "codec": enum,
    "maximumBitrate": enum,
    "maximumFramerate": enum,
    "resolution": enum,
    "resourceType": enum,
    "specialFeature": enum,
    "videoQuality": enum
  },
  "usagePrice": number
}
```

#### InvalidRequest schema
<a name="offerings-offeringid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="offerings-offeringid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="offerings-offeringid-response-body-resourcenotfound-example"></a>

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

#### LimitExceeded schema
<a name="offerings-offeringid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="offerings-offeringid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="offerings-offeringid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="offerings-offeringid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="offerings-offeringid-properties"></a>

### AccessDenied
<a name="offerings-offeringid-model-accessdenied"></a>


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

### BadGatewayException
<a name="offerings-offeringid-model-badgatewayexception"></a>


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

### ChannelClass
<a name="offerings-offeringid-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### GatewayTimeoutException
<a name="offerings-offeringid-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="offerings-offeringid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="offerings-offeringid-model-invalidrequest"></a>


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

### LimitExceeded
<a name="offerings-offeringid-model-limitexceeded"></a>


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

### Offering
<a name="offerings-offeringid-model-offering"></a>

Reserved resources available for purchase


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' | 
| currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | 
| duration | integer | False | Lease duration, e.g. '12' | 
| durationUnits | [OfferingDurationUnits](#offerings-offeringid-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | 
| fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | 
| offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | 
| offeringId | string | False | Unique offering ID, e.g. '87654321' | 
| offeringType | [OfferingType](#offerings-offeringid-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | 
| region | string | False | AWS Region, e.g. 'us-west-2' | 
| resourceSpecification | [ReservationResourceSpecification](#offerings-offeringid-model-reservationresourcespecification) | False | Resource configuration details | 
| usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | 

### OfferingDurationUnits
<a name="offerings-offeringid-model-offeringdurationunits"></a>

Units for duration, e.g. 'MONTHS'
+ `MONTHS`

### OfferingType
<a name="offerings-offeringid-model-offeringtype"></a>

Offering type, e.g. 'NO\$1UPFRONT'
+ `NO_UPFRONT`

### ReservationCodec
<a name="offerings-offeringid-model-reservationcodec"></a>

Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
+ `MPEG2`
+ `AVC`
+ `HEVC`
+ `AUDIO`
+ `LINK`

### ReservationMaximumBitrate
<a name="offerings-offeringid-model-reservationmaximumbitrate"></a>

Maximum bitrate in megabits per second
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### ReservationMaximumFramerate
<a name="offerings-offeringid-model-reservationmaximumframerate"></a>

Maximum framerate in frames per second (Outputs only)
+ `MAX_30_FPS`
+ `MAX_60_FPS`

### ReservationResolution
<a name="offerings-offeringid-model-reservationresolution"></a>

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### ReservationResourceSpecification
<a name="offerings-offeringid-model-reservationresourcespecification"></a>

Resource configuration (codec, resolution, bitrate, ...)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#offerings-offeringid-model-channelclass) | False | Channel class, e.g. 'STANDARD' | 
| codec | [ReservationCodec](#offerings-offeringid-model-reservationcodec) | False | Codec, e.g. 'AVC' | 
| maximumBitrate | [ReservationMaximumBitrate](#offerings-offeringid-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | 
| maximumFramerate | [ReservationMaximumFramerate](#offerings-offeringid-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | 
| resolution | [ReservationResolution](#offerings-offeringid-model-reservationresolution) | False | Resolution, e.g. 'HD' | 
| resourceType | [ReservationResourceType](#offerings-offeringid-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | 
| specialFeature | [ReservationSpecialFeature](#offerings-offeringid-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | 
| videoQuality | [ReservationVideoQuality](#offerings-offeringid-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | 

### ReservationResourceType
<a name="offerings-offeringid-model-reservationresourcetype"></a>

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
+ `INPUT`
+ `OUTPUT`
+ `MULTIPLEX`
+ `CHANNEL`

### ReservationSpecialFeature
<a name="offerings-offeringid-model-reservationspecialfeature"></a>

Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD'
+ `ADVANCED_AUDIO`
+ `AUDIO_NORMALIZATION`
+ `MGHD`
+ `MGUHD`

### ReservationVideoQuality
<a name="offerings-offeringid-model-reservationvideoquality"></a>

Video quality, e.g. 'STANDARD' (Outputs only)
+ `STANDARD`
+ `ENHANCED`
+ `PREMIUM`

### ResourceNotFound
<a name="offerings-offeringid-model-resourcenotfound"></a>


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

## See also
<a name="offerings-offeringid-see-also"></a>

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

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

# Offerings: list offerings
<a name="offerings"></a>

## URI
<a name="offerings-url"></a>

`/prod/offerings`

## HTTP methods
<a name="offerings-http-methods"></a>

### GET
<a name="offeringsget"></a>

**Operation ID:** `ListOfferings`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceType | String | False |  | 
| nextToken | String | False |  | 
| channelConfiguration | String | False |  | 
| duration | String | False |  | 
| codec | String | False |  | 
| videoQuality | String | False |  | 
| resolution | String | False |  | 
| maximumFramerate | String | False |  | 
| channelClass | String | False |  | 
| maxResults | String | False |  | 
| maximumBitrate | String | False |  | 
| specialFeature | String | False |  | 


**Responses**  

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

## Schemas
<a name="offerings-schemas"></a>

### Response bodies
<a name="offerings-response-examples"></a>

#### ListOfferingsResultModel schema
<a name="offerings-response-body-listofferingsresultmodel-example"></a>

```
{
  "nextToken": "string",
  "offerings": [
    {
      "arn": "string",
      "currencyCode": "string",
      "duration": integer,
      "durationUnits": enum,
      "fixedPrice": number,
      "offeringDescription": "string",
      "offeringId": "string",
      "offeringType": enum,
      "region": "string",
      "resourceSpecification": {
        "channelClass": enum,
        "codec": enum,
        "maximumBitrate": enum,
        "maximumFramerate": enum,
        "resolution": enum,
        "resourceType": enum,
        "specialFeature": enum,
        "videoQuality": enum
      },
      "usagePrice": number
    }
  ]
}
```

#### InvalidRequest schema
<a name="offerings-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="offerings-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="offerings-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="offerings-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="offerings-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="offerings-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="offerings-properties"></a>

### AccessDenied
<a name="offerings-model-accessdenied"></a>


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

### BadGatewayException
<a name="offerings-model-badgatewayexception"></a>


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

### ChannelClass
<a name="offerings-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### GatewayTimeoutException
<a name="offerings-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="offerings-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="offerings-model-invalidrequest"></a>


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

### LimitExceeded
<a name="offerings-model-limitexceeded"></a>


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

### ListOfferingsResultModel
<a name="offerings-model-listofferingsresultmodel"></a>

ListOfferings response


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | Token to retrieve the next page of results | 
| offerings | Array of type [Offering](#offerings-model-offering) | False | List of offerings | 

### Offering
<a name="offerings-model-offering"></a>

Reserved resources available for purchase


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321' | 
| currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | 
| duration | integer | False | Lease duration, e.g. '12' | 
| durationUnits | [OfferingDurationUnits](#offerings-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | 
| fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | 
| offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | 
| offeringId | string | False | Unique offering ID, e.g. '87654321' | 
| offeringType | [OfferingType](#offerings-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | 
| region | string | False | AWS Region, e.g. 'us-west-2' | 
| resourceSpecification | [ReservationResourceSpecification](#offerings-model-reservationresourcespecification) | False | Resource configuration details | 
| usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | 

### OfferingDurationUnits
<a name="offerings-model-offeringdurationunits"></a>

Units for duration, e.g. 'MONTHS'
+ `MONTHS`

### OfferingType
<a name="offerings-model-offeringtype"></a>

Offering type, e.g. 'NO\$1UPFRONT'
+ `NO_UPFRONT`

### ReservationCodec
<a name="offerings-model-reservationcodec"></a>

Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
+ `MPEG2`
+ `AVC`
+ `HEVC`
+ `AUDIO`
+ `LINK`

### ReservationMaximumBitrate
<a name="offerings-model-reservationmaximumbitrate"></a>

Maximum bitrate in megabits per second
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### ReservationMaximumFramerate
<a name="offerings-model-reservationmaximumframerate"></a>

Maximum framerate in frames per second (Outputs only)
+ `MAX_30_FPS`
+ `MAX_60_FPS`

### ReservationResolution
<a name="offerings-model-reservationresolution"></a>

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### ReservationResourceSpecification
<a name="offerings-model-reservationresourcespecification"></a>

Resource configuration (codec, resolution, bitrate, ...)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#offerings-model-channelclass) | False | Channel class, e.g. 'STANDARD' | 
| codec | [ReservationCodec](#offerings-model-reservationcodec) | False | Codec, e.g. 'AVC' | 
| maximumBitrate | [ReservationMaximumBitrate](#offerings-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | 
| maximumFramerate | [ReservationMaximumFramerate](#offerings-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | 
| resolution | [ReservationResolution](#offerings-model-reservationresolution) | False | Resolution, e.g. 'HD' | 
| resourceType | [ReservationResourceType](#offerings-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | 
| specialFeature | [ReservationSpecialFeature](#offerings-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | 
| videoQuality | [ReservationVideoQuality](#offerings-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | 

### ReservationResourceType
<a name="offerings-model-reservationresourcetype"></a>

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
+ `INPUT`
+ `OUTPUT`
+ `MULTIPLEX`
+ `CHANNEL`

### ReservationSpecialFeature
<a name="offerings-model-reservationspecialfeature"></a>

Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD'
+ `ADVANCED_AUDIO`
+ `AUDIO_NORMALIZATION`
+ `MGHD`
+ `MGUHD`

### ReservationVideoQuality
<a name="offerings-model-reservationvideoquality"></a>

Video quality, e.g. 'STANDARD' (Outputs only)
+ `STANDARD`
+ `ENHANCED`
+ `PREMIUM`

## See also
<a name="offerings-see-also"></a>

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

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

# Offerings: purchase offering
<a name="offerings-offeringid-purchase"></a>

## URI
<a name="offerings-offeringid-purchase-url"></a>

`/prod/offerings/offeringId/purchase`

## HTTP methods
<a name="offerings-offeringid-purchase-http-methods"></a>

### POST
<a name="offerings-offeringid-purchasepost"></a>

**Operation ID:** `PurchaseOffering`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| offeringId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | PurchaseOfferingResultModel | 201 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 | 

## Schemas
<a name="offerings-offeringid-purchase-schemas"></a>

### Request bodies
<a name="offerings-offeringid-purchase-request-examples"></a>

#### POST schema
<a name="offerings-offeringid-purchase-request-body-post-example"></a>

```
{
  "count": integer,
  "name": "string",
  "requestId": "string",
  "start": "string",
  "tags": {
  }
}
```

### Response bodies
<a name="offerings-offeringid-purchase-response-examples"></a>

#### PurchaseOfferingResultModel schema
<a name="offerings-offeringid-purchase-response-body-purchaseofferingresultmodel-example"></a>

```
{
  "reservation": {
    "arn": "string",
    "count": integer,
    "currencyCode": "string",
    "duration": integer,
    "durationUnits": enum,
    "end": "string",
    "fixedPrice": number,
    "name": "string",
    "offeringDescription": "string",
    "offeringId": "string",
    "offeringType": enum,
    "region": "string",
    "reservationId": "string",
    "resourceSpecification": {
      "channelClass": enum,
      "codec": enum,
      "maximumBitrate": enum,
      "maximumFramerate": enum,
      "resolution": enum,
      "resourceType": enum,
      "specialFeature": enum,
      "videoQuality": enum
    },
    "start": "string",
    "state": enum,
    "tags": {
    },
    "usagePrice": number
  }
}
```

#### InvalidRequest schema
<a name="offerings-offeringid-purchase-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="offerings-offeringid-purchase-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="offerings-offeringid-purchase-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="offerings-offeringid-purchase-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="offerings-offeringid-purchase-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="offerings-offeringid-purchase-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="offerings-offeringid-purchase-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="offerings-offeringid-purchase-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="offerings-offeringid-purchase-properties"></a>

### AccessDenied
<a name="offerings-offeringid-purchase-model-accessdenied"></a>


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

### BadGatewayException
<a name="offerings-offeringid-purchase-model-badgatewayexception"></a>


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

### ChannelClass
<a name="offerings-offeringid-purchase-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### GatewayTimeoutException
<a name="offerings-offeringid-purchase-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="offerings-offeringid-purchase-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="offerings-offeringid-purchase-model-invalidrequest"></a>


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

### LimitExceeded
<a name="offerings-offeringid-purchase-model-limitexceeded"></a>


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

### OfferingDurationUnits
<a name="offerings-offeringid-purchase-model-offeringdurationunits"></a>

Units for duration, e.g. 'MONTHS'
+ `MONTHS`

### OfferingType
<a name="offerings-offeringid-purchase-model-offeringtype"></a>

Offering type, e.g. 'NO\$1UPFRONT'
+ `NO_UPFRONT`

### PurchaseOffering
<a name="offerings-offeringid-purchase-model-purchaseoffering"></a>

PurchaseOffering request


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| count | integerMinimum: 1 | True | Number of resources | 
| name | string | False | Name for the new reservation | 
| requestId | string | False | Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. | 
| start | string | False | Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now. | 
| tags | [Tags](#offerings-offeringid-purchase-model-tags) | False | A collection of key-value pairs | 

### PurchaseOfferingResultModel
<a name="offerings-offeringid-purchase-model-purchaseofferingresultmodel"></a>

PurchaseOffering response


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| reservation | [Reservation](#offerings-offeringid-purchase-model-reservation) | False |  | 

### Reservation
<a name="offerings-offeringid-purchase-model-reservation"></a>

Reserved resources available to use


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' | 
| count | integer | False | Number of reserved resources | 
| currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | 
| duration | integer | False | Lease duration, e.g. '12' | 
| durationUnits | [OfferingDurationUnits](#offerings-offeringid-purchase-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | 
| end | string | False | Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' | 
| fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | 
| name | string | False | User specified reservation name | 
| offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | 
| offeringId | string | False | Unique offering ID, e.g. '87654321' | 
| offeringType | [OfferingType](#offerings-offeringid-purchase-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | 
| region | string | False | AWS Region, e.g. 'us-west-2' | 
| reservationId | string | False | Unique reservation ID, e.g. '1234567' | 
| resourceSpecification | [ReservationResourceSpecification](#offerings-offeringid-purchase-model-reservationresourcespecification) | False | Resource configuration details | 
| start | string | False | Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' | 
| state | [ReservationState](#offerings-offeringid-purchase-model-reservationstate) | False | Current state of reservation, e.g. 'ACTIVE' | 
| tags | [Tags](#offerings-offeringid-purchase-model-tags) | False | A collection of key-value pairs | 
| usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | 

### ReservationCodec
<a name="offerings-offeringid-purchase-model-reservationcodec"></a>

Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
+ `MPEG2`
+ `AVC`
+ `HEVC`
+ `AUDIO`
+ `LINK`

### ReservationMaximumBitrate
<a name="offerings-offeringid-purchase-model-reservationmaximumbitrate"></a>

Maximum bitrate in megabits per second
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### ReservationMaximumFramerate
<a name="offerings-offeringid-purchase-model-reservationmaximumframerate"></a>

Maximum framerate in frames per second (Outputs only)
+ `MAX_30_FPS`
+ `MAX_60_FPS`

### ReservationResolution
<a name="offerings-offeringid-purchase-model-reservationresolution"></a>

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### ReservationResourceSpecification
<a name="offerings-offeringid-purchase-model-reservationresourcespecification"></a>

Resource configuration (codec, resolution, bitrate, ...)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#offerings-offeringid-purchase-model-channelclass) | False | Channel class, e.g. 'STANDARD' | 
| codec | [ReservationCodec](#offerings-offeringid-purchase-model-reservationcodec) | False | Codec, e.g. 'AVC' | 
| maximumBitrate | [ReservationMaximumBitrate](#offerings-offeringid-purchase-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | 
| maximumFramerate | [ReservationMaximumFramerate](#offerings-offeringid-purchase-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | 
| resolution | [ReservationResolution](#offerings-offeringid-purchase-model-reservationresolution) | False | Resolution, e.g. 'HD' | 
| resourceType | [ReservationResourceType](#offerings-offeringid-purchase-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | 
| specialFeature | [ReservationSpecialFeature](#offerings-offeringid-purchase-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | 
| videoQuality | [ReservationVideoQuality](#offerings-offeringid-purchase-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | 

### ReservationResourceType
<a name="offerings-offeringid-purchase-model-reservationresourcetype"></a>

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
+ `INPUT`
+ `OUTPUT`
+ `MULTIPLEX`
+ `CHANNEL`

### ReservationSpecialFeature
<a name="offerings-offeringid-purchase-model-reservationspecialfeature"></a>

Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD'
+ `ADVANCED_AUDIO`
+ `AUDIO_NORMALIZATION`
+ `MGHD`
+ `MGUHD`

### ReservationState
<a name="offerings-offeringid-purchase-model-reservationstate"></a>

Current reservation state
+ `ACTIVE`
+ `EXPIRED`
+ `CANCELED`
+ `DELETED`

### ReservationVideoQuality
<a name="offerings-offeringid-purchase-model-reservationvideoquality"></a>

Video quality, e.g. 'STANDARD' (Outputs only)
+ `STANDARD`
+ `ENHANCED`
+ `PREMIUM`

### ResourceConflict
<a name="offerings-offeringid-purchase-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="offerings-offeringid-purchase-model-resourcenotfound"></a>


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

### Tags
<a name="offerings-offeringid-purchase-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="offerings-offeringid-purchase-see-also"></a>

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

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

# Reservations: describe reservation
<a name="reservations-reservationid"></a>

## URI
<a name="reservations-reservationid-url"></a>

`/prod/reservations/reservationId`

## HTTP methods
<a name="reservations-reservationid-http-methods"></a>

### DELETE
<a name="reservations-reservationiddelete"></a>

**Operation ID:** `DeleteReservation`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| reservationId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Reservation | 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="reservations-reservationidget"></a>

**Operation ID:** `DescribeReservation`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| reservationId | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | Reservation | 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="reservations-reservationidput"></a>

**Operation ID:** `UpdateReservation`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| reservationId | String | True |  | 


**Responses**  

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

## Schemas
<a name="reservations-reservationid-schemas"></a>

### Request bodies
<a name="reservations-reservationid-request-examples"></a>

#### PUT schema
<a name="reservations-reservationid-request-body-put-example"></a>

```
{
  "name": "string"
}
```

### Response bodies
<a name="reservations-reservationid-response-examples"></a>

#### Reservation schema
<a name="reservations-reservationid-response-body-reservation-example"></a>

```
{
  "arn": "string",
  "count": integer,
  "currencyCode": "string",
  "duration": integer,
  "durationUnits": enum,
  "end": "string",
  "fixedPrice": number,
  "name": "string",
  "offeringDescription": "string",
  "offeringId": "string",
  "offeringType": enum,
  "region": "string",
  "reservationId": "string",
  "resourceSpecification": {
    "channelClass": enum,
    "codec": enum,
    "maximumBitrate": enum,
    "maximumFramerate": enum,
    "resolution": enum,
    "resourceType": enum,
    "specialFeature": enum,
    "videoQuality": enum
  },
  "start": "string",
  "state": enum,
  "tags": {
  },
  "usagePrice": number
}
```

#### UpdateReservationResultModel schema
<a name="reservations-reservationid-response-body-updatereservationresultmodel-example"></a>

```
{
  "reservation": {
    "arn": "string",
    "count": integer,
    "currencyCode": "string",
    "duration": integer,
    "durationUnits": enum,
    "end": "string",
    "fixedPrice": number,
    "name": "string",
    "offeringDescription": "string",
    "offeringId": "string",
    "offeringType": enum,
    "region": "string",
    "reservationId": "string",
    "resourceSpecification": {
      "channelClass": enum,
      "codec": enum,
      "maximumBitrate": enum,
      "maximumFramerate": enum,
      "resolution": enum,
      "resourceType": enum,
      "specialFeature": enum,
      "videoQuality": enum
    },
    "start": "string",
    "state": enum,
    "tags": {
    },
    "usagePrice": number
  }
}
```

#### InvalidRequest schema
<a name="reservations-reservationid-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="reservations-reservationid-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="reservations-reservationid-response-body-resourcenotfound-example"></a>

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

#### ResourceConflict schema
<a name="reservations-reservationid-response-body-resourceconflict-example"></a>

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

#### LimitExceeded schema
<a name="reservations-reservationid-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="reservations-reservationid-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="reservations-reservationid-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="reservations-reservationid-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="reservations-reservationid-properties"></a>

### AccessDenied
<a name="reservations-reservationid-model-accessdenied"></a>


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

### BadGatewayException
<a name="reservations-reservationid-model-badgatewayexception"></a>


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

### ChannelClass
<a name="reservations-reservationid-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### GatewayTimeoutException
<a name="reservations-reservationid-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="reservations-reservationid-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="reservations-reservationid-model-invalidrequest"></a>


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

### LimitExceeded
<a name="reservations-reservationid-model-limitexceeded"></a>


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

### OfferingDurationUnits
<a name="reservations-reservationid-model-offeringdurationunits"></a>

Units for duration, e.g. 'MONTHS'
+ `MONTHS`

### OfferingType
<a name="reservations-reservationid-model-offeringtype"></a>

Offering type, e.g. 'NO\$1UPFRONT'
+ `NO_UPFRONT`

### Reservation
<a name="reservations-reservationid-model-reservation"></a>

Reserved resources available to use


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' | 
| count | integer | False | Number of reserved resources | 
| currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | 
| duration | integer | False | Lease duration, e.g. '12' | 
| durationUnits | [OfferingDurationUnits](#reservations-reservationid-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | 
| end | string | False | Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' | 
| fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | 
| name | string | False | User specified reservation name | 
| offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | 
| offeringId | string | False | Unique offering ID, e.g. '87654321' | 
| offeringType | [OfferingType](#reservations-reservationid-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | 
| region | string | False | AWS Region, e.g. 'us-west-2' | 
| reservationId | string | False | Unique reservation ID, e.g. '1234567' | 
| resourceSpecification | [ReservationResourceSpecification](#reservations-reservationid-model-reservationresourcespecification) | False | Resource configuration details | 
| start | string | False | Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' | 
| state | [ReservationState](#reservations-reservationid-model-reservationstate) | False | Current state of reservation, e.g. 'ACTIVE' | 
| tags | [Tags](#reservations-reservationid-model-tags) | False | A collection of key-value pairs | 
| usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | 

### ReservationCodec
<a name="reservations-reservationid-model-reservationcodec"></a>

Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
+ `MPEG2`
+ `AVC`
+ `HEVC`
+ `AUDIO`
+ `LINK`

### ReservationMaximumBitrate
<a name="reservations-reservationid-model-reservationmaximumbitrate"></a>

Maximum bitrate in megabits per second
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### ReservationMaximumFramerate
<a name="reservations-reservationid-model-reservationmaximumframerate"></a>

Maximum framerate in frames per second (Outputs only)
+ `MAX_30_FPS`
+ `MAX_60_FPS`

### ReservationResolution
<a name="reservations-reservationid-model-reservationresolution"></a>

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### ReservationResourceSpecification
<a name="reservations-reservationid-model-reservationresourcespecification"></a>

Resource configuration (codec, resolution, bitrate, ...)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#reservations-reservationid-model-channelclass) | False | Channel class, e.g. 'STANDARD' | 
| codec | [ReservationCodec](#reservations-reservationid-model-reservationcodec) | False | Codec, e.g. 'AVC' | 
| maximumBitrate | [ReservationMaximumBitrate](#reservations-reservationid-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | 
| maximumFramerate | [ReservationMaximumFramerate](#reservations-reservationid-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | 
| resolution | [ReservationResolution](#reservations-reservationid-model-reservationresolution) | False | Resolution, e.g. 'HD' | 
| resourceType | [ReservationResourceType](#reservations-reservationid-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | 
| specialFeature | [ReservationSpecialFeature](#reservations-reservationid-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | 
| videoQuality | [ReservationVideoQuality](#reservations-reservationid-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | 

### ReservationResourceType
<a name="reservations-reservationid-model-reservationresourcetype"></a>

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
+ `INPUT`
+ `OUTPUT`
+ `MULTIPLEX`
+ `CHANNEL`

### ReservationSpecialFeature
<a name="reservations-reservationid-model-reservationspecialfeature"></a>

Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD'
+ `ADVANCED_AUDIO`
+ `AUDIO_NORMALIZATION`
+ `MGHD`
+ `MGUHD`

### ReservationState
<a name="reservations-reservationid-model-reservationstate"></a>

Current reservation state
+ `ACTIVE`
+ `EXPIRED`
+ `CANCELED`
+ `DELETED`

### ReservationVideoQuality
<a name="reservations-reservationid-model-reservationvideoquality"></a>

Video quality, e.g. 'STANDARD' (Outputs only)
+ `STANDARD`
+ `ENHANCED`
+ `PREMIUM`

### ResourceConflict
<a name="reservations-reservationid-model-resourceconflict"></a>


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

### ResourceNotFound
<a name="reservations-reservationid-model-resourcenotfound"></a>


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

### Tags
<a name="reservations-reservationid-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### UpdateReservation
<a name="reservations-reservationid-model-updatereservation"></a>

UpdateReservation request


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| name | string | False | Name of the reservation | 

### UpdateReservationResultModel
<a name="reservations-reservationid-model-updatereservationresultmodel"></a>

UpdateReservation response


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| reservation | [Reservation](#reservations-reservationid-model-reservation) | False |  | 

## See also
<a name="reservations-reservationid-see-also"></a>

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

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

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

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

# Reservations: list reservations
<a name="reservations"></a>

## URI
<a name="reservations-url"></a>

`/prod/reservations`

## HTTP methods
<a name="reservations-http-methods"></a>

### GET
<a name="reservationsget"></a>

**Operation ID:** `ListReservations`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resourceType | String | False |  | 
| nextToken | String | False |  | 
| codec | String | False |  | 
| videoQuality | String | False |  | 
| resolution | String | False |  | 
| maximumFramerate | String | False |  | 
| channelClass | String | False |  | 
| maxResults | String | False |  | 
| maximumBitrate | String | False |  | 
| specialFeature | String | False |  | 


**Responses**  

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

## Schemas
<a name="reservations-schemas"></a>

### Response bodies
<a name="reservations-response-examples"></a>

#### ListReservationsResultModel schema
<a name="reservations-response-body-listreservationsresultmodel-example"></a>

```
{
  "nextToken": "string",
  "reservations": [
    {
      "arn": "string",
      "count": integer,
      "currencyCode": "string",
      "duration": integer,
      "durationUnits": enum,
      "end": "string",
      "fixedPrice": number,
      "name": "string",
      "offeringDescription": "string",
      "offeringId": "string",
      "offeringType": enum,
      "region": "string",
      "reservationId": "string",
      "resourceSpecification": {
        "channelClass": enum,
        "codec": enum,
        "maximumBitrate": enum,
        "maximumFramerate": enum,
        "resolution": enum,
        "resourceType": enum,
        "specialFeature": enum,
        "videoQuality": enum
      },
      "start": "string",
      "state": enum,
      "tags": {
      },
      "usagePrice": number
    }
  ]
}
```

#### InvalidRequest schema
<a name="reservations-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="reservations-response-body-accessdenied-example"></a>

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

#### LimitExceeded schema
<a name="reservations-response-body-limitexceeded-example"></a>

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

#### InternalServiceError schema
<a name="reservations-response-body-internalserviceerror-example"></a>

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

#### BadGatewayException schema
<a name="reservations-response-body-badgatewayexception-example"></a>

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

#### GatewayTimeoutException schema
<a name="reservations-response-body-gatewaytimeoutexception-example"></a>

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

## Properties
<a name="reservations-properties"></a>

### AccessDenied
<a name="reservations-model-accessdenied"></a>


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

### BadGatewayException
<a name="reservations-model-badgatewayexception"></a>


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

### ChannelClass
<a name="reservations-model-channelclass"></a>

A standard channel has two encoding pipelines and a single pipeline channel only has one.
+ `STANDARD`
+ `SINGLE_PIPELINE`

### GatewayTimeoutException
<a name="reservations-model-gatewaytimeoutexception"></a>


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

### InternalServiceError
<a name="reservations-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="reservations-model-invalidrequest"></a>


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

### LimitExceeded
<a name="reservations-model-limitexceeded"></a>


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

### ListReservationsResultModel
<a name="reservations-model-listreservationsresultmodel"></a>

ListReservations response


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | string | False | Token to retrieve the next page of results | 
| reservations | Array of type [Reservation](#reservations-model-reservation) | False | List of reservations | 

### OfferingDurationUnits
<a name="reservations-model-offeringdurationunits"></a>

Units for duration, e.g. 'MONTHS'
+ `MONTHS`

### OfferingType
<a name="reservations-model-offeringtype"></a>

Offering type, e.g. 'NO\$1UPFRONT'
+ `NO_UPFRONT`

### Reservation
<a name="reservations-model-reservation"></a>

Reserved resources available to use


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567' | 
| count | integer | False | Number of reserved resources | 
| currencyCode | string | False | Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD' | 
| duration | integer | False | Lease duration, e.g. '12' | 
| durationUnits | [OfferingDurationUnits](#reservations-model-offeringdurationunits) | False | Units for duration, e.g. 'MONTHS' | 
| end | string | False | Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00' | 
| fixedPrice | number | False | One-time charge for each reserved resource, e.g. '0.0' for a NO\$1UPFRONT offering | 
| name | string | False | User specified reservation name | 
| offeringDescription | string | False | Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)' | 
| offeringId | string | False | Unique offering ID, e.g. '87654321' | 
| offeringType | [OfferingType](#reservations-model-offeringtype) | False | Offering type, e.g. 'NO\$1UPFRONT' | 
| region | string | False | AWS Region, e.g. 'us-west-2' | 
| reservationId | string | False | Unique reservation ID, e.g. '1234567' | 
| resourceSpecification | [ReservationResourceSpecification](#reservations-model-reservationresourcespecification) | False | Resource configuration details | 
| start | string | False | Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00' | 
| state | [ReservationState](#reservations-model-reservationstate) | False | Current state of reservation, e.g. 'ACTIVE' | 
| tags | [Tags](#reservations-model-tags) | False | A collection of key-value pairs | 
| usagePrice | number | False | Recurring usage charge for each reserved resource, e.g. '157.0' | 

### ReservationCodec
<a name="reservations-model-reservationcodec"></a>

Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'
+ `MPEG2`
+ `AVC`
+ `HEVC`
+ `AUDIO`
+ `LINK`

### ReservationMaximumBitrate
<a name="reservations-model-reservationmaximumbitrate"></a>

Maximum bitrate in megabits per second
+ `MAX_10_MBPS`
+ `MAX_20_MBPS`
+ `MAX_50_MBPS`

### ReservationMaximumFramerate
<a name="reservations-model-reservationmaximumframerate"></a>

Maximum framerate in frames per second (Outputs only)
+ `MAX_30_FPS`
+ `MAX_60_FPS`

### ReservationResolution
<a name="reservations-model-reservationresolution"></a>

Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, FHD is 1080 lines, UHD is greater than 1080 lines 
+ `SD`
+ `HD`
+ `FHD`
+ `UHD`

### ReservationResourceSpecification
<a name="reservations-model-reservationresourcespecification"></a>

Resource configuration (codec, resolution, bitrate, ...)


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| channelClass | [ChannelClass](#reservations-model-channelclass) | False | Channel class, e.g. 'STANDARD' | 
| codec | [ReservationCodec](#reservations-model-reservationcodec) | False | Codec, e.g. 'AVC' | 
| maximumBitrate | [ReservationMaximumBitrate](#reservations-model-reservationmaximumbitrate) | False | Maximum bitrate, e.g. 'MAX\$120\$1MBPS' | 
| maximumFramerate | [ReservationMaximumFramerate](#reservations-model-reservationmaximumframerate) | False | Maximum framerate, e.g. 'MAX\$130\$1FPS' (Outputs only) | 
| resolution | [ReservationResolution](#reservations-model-reservationresolution) | False | Resolution, e.g. 'HD' | 
| resourceType | [ReservationResourceType](#reservations-model-reservationresourcetype) | False | Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL' | 
| specialFeature | [ReservationSpecialFeature](#reservations-model-reservationspecialfeature) | False | Special feature, e.g. 'AUDIO\$1NORMALIZATION' (Channels only) | 
| videoQuality | [ReservationVideoQuality](#reservations-model-reservationvideoquality) | False | Video quality, e.g. 'STANDARD' (Outputs only) | 

### ReservationResourceType
<a name="reservations-model-reservationresourcetype"></a>

Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
+ `INPUT`
+ `OUTPUT`
+ `MULTIPLEX`
+ `CHANNEL`

### ReservationSpecialFeature
<a name="reservations-model-reservationspecialfeature"></a>

Special features, 'ADVANCED\$1AUDIO' 'AUDIO\$1NORMALIZATION' 'MGHD' or 'MGUHD'
+ `ADVANCED_AUDIO`
+ `AUDIO_NORMALIZATION`
+ `MGHD`
+ `MGUHD`

### ReservationState
<a name="reservations-model-reservationstate"></a>

Current reservation state
+ `ACTIVE`
+ `EXPIRED`
+ `CANCELED`
+ `DELETED`

### ReservationVideoQuality
<a name="reservations-model-reservationvideoquality"></a>

Video quality, e.g. 'STANDARD' (Outputs only)
+ `STANDARD`
+ `ENHANCED`
+ `PREMIUM`

### Tags
<a name="reservations-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

## See also
<a name="reservations-see-also"></a>

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

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

# Tags: list tags
<a name="tags-resource-arn"></a>

## URI
<a name="tags-resource-arn-url"></a>

`/prod/tags/resource-arn`

## HTTP methods
<a name="tags-resource-arn-http-methods"></a>

### DELETE
<a name="tags-resource-arndelete"></a>

**Operation ID:** `DeleteTags`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True |  | 


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| tagKeys | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 500 | InternalServiceError | 500 response | 

### GET
<a name="tags-resource-arnget"></a>

**Operation ID:** `ListTagsForResource`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | TagsModel | 200 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 500 | InternalServiceError | 500 response | 

### POST
<a name="tags-resource-arnpost"></a>

**Operation ID:** `CreateTags`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| resource-arn | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | InvalidRequest | 400 response | 
| 403 | AccessDenied | 403 response | 
| 404 | ResourceNotFound | 404 response | 
| 500 | InternalServiceError | 500 response | 

## Schemas
<a name="tags-resource-arn-schemas"></a>

### Request bodies
<a name="tags-resource-arn-request-examples"></a>

#### POST schema
<a name="tags-resource-arn-request-body-post-example"></a>

```
{
  "tags": {
  }
}
```

### Response bodies
<a name="tags-resource-arn-response-examples"></a>

#### TagsModel schema
<a name="tags-resource-arn-response-body-tagsmodel-example"></a>

```
{
  "tags": {
  }
}
```

#### InvalidRequest schema
<a name="tags-resource-arn-response-body-invalidrequest-example"></a>

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

#### AccessDenied schema
<a name="tags-resource-arn-response-body-accessdenied-example"></a>

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

#### ResourceNotFound schema
<a name="tags-resource-arn-response-body-resourcenotfound-example"></a>

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

#### InternalServiceError schema
<a name="tags-resource-arn-response-body-internalserviceerror-example"></a>

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

## Properties
<a name="tags-resource-arn-properties"></a>

### AccessDenied
<a name="tags-resource-arn-model-accessdenied"></a>


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

### InternalServiceError
<a name="tags-resource-arn-model-internalserviceerror"></a>


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

### InvalidRequest
<a name="tags-resource-arn-model-invalidrequest"></a>


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

### ResourceNotFound
<a name="tags-resource-arn-model-resourcenotfound"></a>


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

### Tags
<a name="tags-resource-arn-model-tags"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | string | False |  | 

### TagsModel
<a name="tags-resource-arn-model-tagsmodel"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| tags | [Tags](#tags-resource-arn-model-tags) | False |  | 

## See also
<a name="tags-resource-arn-see-also"></a>

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

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

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

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

# Workflow monitor: CloudWatch alarm template groups
<a name="cloudwatch-alarm-template-groups"></a>

## URI
<a name="cloudwatch-alarm-template-groups-url"></a>

`/prod/cloudwatch-alarm-template-groups`

## HTTP methods
<a name="cloudwatch-alarm-template-groups-http-methods"></a>

### GET
<a name="cloudwatch-alarm-template-groupsget"></a>

**Operation ID:** `ListCloudWatchAlarmTemplateGroups`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| signalMapIdentifier | String | False |  | 
| scope | String | False |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListCloudWatchAlarmTemplateGroupsResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="cloudwatch-alarm-template-groupsoptions"></a>

**Operation ID:** `CorsCloudwatch_alarm_template_groups`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="cloudwatch-alarm-template-groupspost"></a>

**Operation ID:** `CreateCloudWatchAlarmTemplateGroup`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateCloudWatchAlarmTemplateGroupResponseContent | 201 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="cloudwatch-alarm-template-groups-schemas"></a>

### Request bodies
<a name="cloudwatch-alarm-template-groups-request-examples"></a>

#### POST schema
<a name="cloudwatch-alarm-template-groups-request-body-post-example"></a>

```
{
  "description": "string",
  "name": "string"
}
```

### Response bodies
<a name="cloudwatch-alarm-template-groups-response-examples"></a>

#### ListCloudWatchAlarmTemplateGroupsResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-listcloudwatchalarmtemplategroupsresponsecontent-example"></a>

```
{
  "cloudWatchAlarmTemplateGroups": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "templateCount": number
    }
  ],
  "nextToken": "string"
}
```

#### CreateCloudWatchAlarmTemplateGroupResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-createcloudwatchalarmtemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-notfoundexceptionresponsecontent-example"></a>

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

#### ConflictExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-conflictexceptionresponsecontent-example"></a>

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

#### TooManyRequestsExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

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

#### InternalServerErrorExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-response-body-internalservererrorexceptionresponsecontent-example"></a>

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

## Properties
<a name="cloudwatch-alarm-template-groups-properties"></a>

### BadRequestExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CloudWatchAlarmTemplateGroupSummary
<a name="cloudwatch-alarm-template-groups-model-cloudwatchalarmtemplategroupsummary"></a>

A summary of the alarm template groups.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$` | True | A cloudwatch alarm template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| templateCount | number | True | The number of templates in the group. | 

### ConflictExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateCloudWatchAlarmTemplateGroupRequestContent
<a name="cloudwatch-alarm-template-groups-model-createcloudwatchalarmtemplategrouprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### CreateCloudWatchAlarmTemplateGroupResponseContent
<a name="cloudwatch-alarm-template-groups-model-createcloudwatchalarmtemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$` | True | A cloudwatch alarm template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### ForbiddenExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListCloudWatchAlarmTemplateGroupsResponseContent
<a name="cloudwatch-alarm-template-groups-model-listcloudwatchalarmtemplategroupsresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cloudWatchAlarmTemplateGroups | Array of type [CloudWatchAlarmTemplateGroupSummary](#cloudwatch-alarm-template-groups-model-cloudwatchalarmtemplategroupsummary) | True | A summary of the alarm template groups. | 
| nextToken | stringMinLength: 1MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. | 

### NotFoundExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="cloudwatch-alarm-template-groups-see-also"></a>

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

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

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

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

# Workflow monitor: CloudWatch alarm template groups ID
<a name="cloudwatch-alarm-template-groups-identifier"></a>

## URI
<a name="cloudwatch-alarm-template-groups-identifier-url"></a>

`/prod/cloudwatch-alarm-template-groups/identifier`

## HTTP methods
<a name="cloudwatch-alarm-template-groups-identifier-http-methods"></a>

### DELETE
<a name="cloudwatch-alarm-template-groups-identifierdelete"></a>

**Operation ID:** `DeleteCloudWatchAlarmTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### GET
<a name="cloudwatch-alarm-template-groups-identifierget"></a>

**Operation ID:** `GetCloudWatchAlarmTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetCloudWatchAlarmTemplateGroupResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="cloudwatch-alarm-template-groups-identifieroptions"></a>

**Operation ID:** `CorsCloudwatch_alarm_template_groupsIdentifier`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### PATCH
<a name="cloudwatch-alarm-template-groups-identifierpatch"></a>

**Operation ID:** `UpdateCloudWatchAlarmTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateCloudWatchAlarmTemplateGroupResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="cloudwatch-alarm-template-groups-identifier-schemas"></a>

### Request bodies
<a name="cloudwatch-alarm-template-groups-identifier-request-examples"></a>

#### PATCH schema
<a name="cloudwatch-alarm-template-groups-identifier-request-body-patch-example"></a>

```
{
  "description": "string"
}
```

### Response bodies
<a name="cloudwatch-alarm-template-groups-identifier-response-examples"></a>

#### GetCloudWatchAlarmTemplateGroupResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-getcloudwatchalarmtemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### UpdateCloudWatchAlarmTemplateGroupResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-updatecloudwatchalarmtemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-notfoundexceptionresponsecontent-example"></a>

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

#### ConflictExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-conflictexceptionresponsecontent-example"></a>

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

#### TooManyRequestsExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

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

#### InternalServerErrorExceptionResponseContent schema
<a name="cloudwatch-alarm-template-groups-identifier-response-body-internalservererrorexceptionresponsecontent-example"></a>

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

## Properties
<a name="cloudwatch-alarm-template-groups-identifier-properties"></a>

### BadRequestExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ForbiddenExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### GetCloudWatchAlarmTemplateGroupResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-getcloudwatchalarmtemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$` | True | A cloudwatch alarm template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### InternalServerErrorExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### NotFoundExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### UpdateCloudWatchAlarmTemplateGroupRequestContent
<a name="cloudwatch-alarm-template-groups-identifier-model-updatecloudwatchalarmtemplategrouprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 

### UpdateCloudWatchAlarmTemplateGroupResponseContent
<a name="cloudwatch-alarm-template-groups-identifier-model-updatecloudwatchalarmtemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template-group:.+$` | True | A cloudwatch alarm template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

## See also
<a name="cloudwatch-alarm-template-groups-identifier-see-also"></a>

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

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

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

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

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

# Workflow monitor: CloudWatch alarm templates
<a name="cloudwatch-alarm-templates"></a>

## URI
<a name="cloudwatch-alarm-templates-url"></a>

`/prod/cloudwatch-alarm-templates`

## HTTP methods
<a name="cloudwatch-alarm-templates-http-methods"></a>

### GET
<a name="cloudwatch-alarm-templatesget"></a>

**Operation ID:** `ListCloudWatchAlarmTemplates`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| groupIdentifier | String | False |  | 
| signalMapIdentifier | String | False |  | 
| scope | String | False |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListCloudWatchAlarmTemplatesResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="cloudwatch-alarm-templatesoptions"></a>

**Operation ID:** `CorsCloudwatch_alarm_templates`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="cloudwatch-alarm-templatespost"></a>

**Operation ID:** `CreateCloudWatchAlarmTemplate`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateCloudWatchAlarmTemplateResponseContent | 201 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="cloudwatch-alarm-templates-schemas"></a>

### Request bodies
<a name="cloudwatch-alarm-templates-request-examples"></a>

#### POST schema
<a name="cloudwatch-alarm-templates-request-body-post-example"></a>

```
{
  "comparisonOperator": enum,
  "datapointsToAlarm": number,
  "description": "string",
  "evaluationPeriods": number,
  "groupIdentifier": "string",
  "metricName": "string",
  "name": "string",
  "period": number,
  "standardDeviationThreshold": number,
  "statistic": enum,
  "targetResourceType": enum,
  "threshold": number,
  "treatMissingData": enum
}
```

### Response bodies
<a name="cloudwatch-alarm-templates-response-examples"></a>

#### ListCloudWatchAlarmTemplatesResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-listcloudwatchalarmtemplatesresponsecontent-example"></a>

```
{
  "cloudWatchAlarmTemplates": [
    {
      "arn": "string",
      "comparisonOperator": enum,
      "createdAt": "string",
      "datapointsToAlarm": number,
      "description": "string",
      "evaluationPeriods": number,
      "groupId": "string",
      "id": "string",
      "metricName": "string",
      "modifiedAt": "string",
      "name": "string",
      "period": number,
      "standardDeviationThreshold": number,
      "statistic": enum,
      "targetResourceType": enum,
      "threshold": number,
      "treatMissingData": enum
    }
  ],
  "nextToken": "string"
}
```

#### CreateCloudWatchAlarmTemplateResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-createcloudwatchalarmtemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "comparisonOperator": enum,
  "createdAt": "string",
  "datapointsToAlarm": number,
  "description": "string",
  "evaluationPeriods": number,
  "groupId": "string",
  "id": "string",
  "metricName": "string",
  "modifiedAt": "string",
  "name": "string",
  "period": number,
  "standardDeviationThreshold": number,
  "statistic": enum,
  "targetResourceType": enum,
  "threshold": number,
  "treatMissingData": enum
}
```

#### BadRequestExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-notfoundexceptionresponsecontent-example"></a>

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

#### ConflictExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-conflictexceptionresponsecontent-example"></a>

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

#### TooManyRequestsExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

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

#### InternalServerErrorExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-response-body-internalservererrorexceptionresponsecontent-example"></a>

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

## Properties
<a name="cloudwatch-alarm-templates-properties"></a>

### BadRequestExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CloudWatchAlarmTemplateComparisonOperator
<a name="cloudwatch-alarm-templates-model-cloudwatchalarmtemplatecomparisonoperator"></a>

The comparison operator used to compare the specified statistic and the threshold.
+ `GreaterThanOrEqualToThreshold`
+ `GreaterThanThreshold`
+ `LessThanThreshold`
+ `LessThanOrEqualToThreshold`
+ `LessThanLowerOrGreaterThanUpperThreshold`
+ `LessThanLowerThreshold`
+ `GreaterThanUpperThreshold`

### CloudWatchAlarmTemplateStatistic
<a name="cloudwatch-alarm-templates-model-cloudwatchalarmtemplatestatistic"></a>

The statistic to apply to the alarm's metric data.
+ `SampleCount`
+ `Average`
+ `Sum`
+ `Minimum`
+ `Maximum`

### CloudWatchAlarmTemplateSummary
<a name="cloudwatch-alarm-templates-model-cloudwatchalarmtemplatesummary"></a>

A summary of the alarm templates.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$` | True | A cloudwatch alarm template's ARN (Amazon Resource Name) | 
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatecomparisonoperator) | True | The comparison operator used to compare the specified statistic and the threshold. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | True | The number of periods over which data is compared to the specified threshold. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. | 
| metricName | stringMaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatestatistic) | True | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetargetresourcetype) | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetreatmissingdata) | True | Specifies how missing data points are treated when evaluating the alarm's condition. | 

### CloudWatchAlarmTemplateTargetResourceType
<a name="cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetargetresourcetype"></a>

The resource type this template should dynamically generate cloudwatch metric alarms for.
+ `CLOUDFRONT_DISTRIBUTION`
+ `MEDIALIVE_MULTIPLEX`
+ `MEDIALIVE_CHANNEL`
+ `MEDIALIVE_INPUT_DEVICE`
+ `MEDIAPACKAGE_CHANNEL`
+ `MEDIAPACKAGE_ORIGIN_ENDPOINT`
+ `MEDIACONNECT_FLOW`
+ `S3_BUCKET`

### CloudWatchAlarmTemplateTreatMissingData
<a name="cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetreatmissingdata"></a>

Specifies how missing data points are treated when evaluating the alarm's condition.
+ `notBreaching`
+ `breaching`
+ `ignore`
+ `missing`

### ConflictExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateCloudWatchAlarmTemplateRequestContent
<a name="cloudwatch-alarm-templates-model-createcloudwatchalarmtemplaterequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatecomparisonoperator) | True | The comparison operator used to compare the specified statistic and the threshold. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | True | The number of periods over which data is compared to the specified threshold. | 
| groupIdentifier | stringPattern: `^[^\s]+$` | True | A cloudwatch alarm template group's identifier. Can be either be its id or current name. | 
| metricName | stringMaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatestatistic) | True | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetargetresourcetype) | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetreatmissingdata) | True | Specifies how missing data points are treated when evaluating the alarm's condition. | 

### CreateCloudWatchAlarmTemplateResponseContent
<a name="cloudwatch-alarm-templates-model-createcloudwatchalarmtemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$` | True | A cloudwatch alarm template's ARN (Amazon Resource Name) | 
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatecomparisonoperator) | True | The comparison operator used to compare the specified statistic and the threshold. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | True | The number of periods over which data is compared to the specified threshold. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. | 
| metricName | stringMaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatestatistic) | True | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetargetresourcetype) | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatetreatmissingdata) | True | Specifies how missing data points are treated when evaluating the alarm's condition. | 

### ForbiddenExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListCloudWatchAlarmTemplatesResponseContent
<a name="cloudwatch-alarm-templates-model-listcloudwatchalarmtemplatesresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cloudWatchAlarmTemplates | Array of type [CloudWatchAlarmTemplateSummary](#cloudwatch-alarm-templates-model-cloudwatchalarmtemplatesummary) | True | A summary of the alarm templates. | 
| nextToken | stringMinLength: 1MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. | 

### NotFoundExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="cloudwatch-alarm-templates-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="cloudwatch-alarm-templates-see-also"></a>

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

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

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

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

# Workflow monitor: CloudWatch alarm templates ID
<a name="cloudwatch-alarm-templates-identifier"></a>

## URI
<a name="cloudwatch-alarm-templates-identifier-url"></a>

`/prod/cloudwatch-alarm-templates/identifier`

## HTTP methods
<a name="cloudwatch-alarm-templates-identifier-http-methods"></a>

### DELETE
<a name="cloudwatch-alarm-templates-identifierdelete"></a>

**Operation ID:** `DeleteCloudWatchAlarmTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### GET
<a name="cloudwatch-alarm-templates-identifierget"></a>

**Operation ID:** `GetCloudWatchAlarmTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetCloudWatchAlarmTemplateResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="cloudwatch-alarm-templates-identifieroptions"></a>

**Operation ID:** `CorsCloudwatch_alarm_templatesIdentifier`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### PATCH
<a name="cloudwatch-alarm-templates-identifierpatch"></a>

**Operation ID:** `UpdateCloudWatchAlarmTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateCloudWatchAlarmTemplateResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="cloudwatch-alarm-templates-identifier-schemas"></a>

### Request bodies
<a name="cloudwatch-alarm-templates-identifier-request-examples"></a>

#### PATCH schema
<a name="cloudwatch-alarm-templates-identifier-request-body-patch-example"></a>

```
{
  "comparisonOperator": enum,
  "datapointsToAlarm": number,
  "description": "string",
  "evaluationPeriods": number,
  "groupIdentifier": "string",
  "metricName": "string",
  "name": "string",
  "period": number,
  "standardDeviationThreshold": number,
  "statistic": enum,
  "targetResourceType": enum,
  "threshold": number,
  "treatMissingData": enum
}
```

### Response bodies
<a name="cloudwatch-alarm-templates-identifier-response-examples"></a>

#### GetCloudWatchAlarmTemplateResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-getcloudwatchalarmtemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "comparisonOperator": enum,
  "createdAt": "string",
  "datapointsToAlarm": number,
  "description": "string",
  "evaluationPeriods": number,
  "groupId": "string",
  "id": "string",
  "metricName": "string",
  "modifiedAt": "string",
  "name": "string",
  "period": number,
  "standardDeviationThreshold": number,
  "statistic": enum,
  "targetResourceType": enum,
  "threshold": number,
  "treatMissingData": enum
}
```

#### UpdateCloudWatchAlarmTemplateResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-updatecloudwatchalarmtemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "comparisonOperator": enum,
  "createdAt": "string",
  "datapointsToAlarm": number,
  "description": "string",
  "evaluationPeriods": number,
  "groupId": "string",
  "id": "string",
  "metricName": "string",
  "modifiedAt": "string",
  "name": "string",
  "period": number,
  "standardDeviationThreshold": number,
  "statistic": enum,
  "targetResourceType": enum,
  "threshold": number,
  "treatMissingData": enum
}
```

#### BadRequestExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-notfoundexceptionresponsecontent-example"></a>

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

#### ConflictExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-conflictexceptionresponsecontent-example"></a>

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

#### TooManyRequestsExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

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

#### InternalServerErrorExceptionResponseContent schema
<a name="cloudwatch-alarm-templates-identifier-response-body-internalservererrorexceptionresponsecontent-example"></a>

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

## Properties
<a name="cloudwatch-alarm-templates-identifier-properties"></a>

### BadRequestExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CloudWatchAlarmTemplateComparisonOperator
<a name="cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatecomparisonoperator"></a>

The comparison operator used to compare the specified statistic and the threshold.
+ `GreaterThanOrEqualToThreshold`
+ `GreaterThanThreshold`
+ `LessThanThreshold`
+ `LessThanOrEqualToThreshold`
+ `LessThanLowerOrGreaterThanUpperThreshold`
+ `LessThanLowerThreshold`
+ `GreaterThanUpperThreshold`

### CloudWatchAlarmTemplateStatistic
<a name="cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatestatistic"></a>

The statistic to apply to the alarm's metric data.
+ `SampleCount`
+ `Average`
+ `Sum`
+ `Minimum`
+ `Maximum`

### CloudWatchAlarmTemplateTargetResourceType
<a name="cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetargetresourcetype"></a>

The resource type this template should dynamically generate cloudwatch metric alarms for.
+ `CLOUDFRONT_DISTRIBUTION`
+ `MEDIALIVE_MULTIPLEX`
+ `MEDIALIVE_CHANNEL`
+ `MEDIALIVE_INPUT_DEVICE`
+ `MEDIAPACKAGE_CHANNEL`
+ `MEDIAPACKAGE_ORIGIN_ENDPOINT`
+ `MEDIACONNECT_FLOW`
+ `S3_BUCKET`

### CloudWatchAlarmTemplateTreatMissingData
<a name="cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetreatmissingdata"></a>

Specifies how missing data points are treated when evaluating the alarm's condition.
+ `notBreaching`
+ `breaching`
+ `ignore`
+ `missing`

### ConflictExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ForbiddenExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### GetCloudWatchAlarmTemplateResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-getcloudwatchalarmtemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$` | True | A cloudwatch alarm template's ARN (Amazon Resource Name) | 
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatecomparisonoperator) | True | The comparison operator used to compare the specified statistic and the threshold. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | True | The number of periods over which data is compared to the specified threshold. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. | 
| metricName | stringMaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatestatistic) | True | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetargetresourcetype) | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetreatmissingdata) | True | Specifies how missing data points are treated when evaluating the alarm's condition. | 

### InternalServerErrorExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### NotFoundExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### UpdateCloudWatchAlarmTemplateRequestContent
<a name="cloudwatch-alarm-templates-identifier-model-updatecloudwatchalarmtemplaterequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatecomparisonoperator) | False | The comparison operator used to compare the specified statistic and the threshold. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | False | The number of periods over which data is compared to the specified threshold. | 
| groupIdentifier | stringPattern: `^[^\s]+$` | False | A cloudwatch alarm template group's identifier. Can be either be its id or current name. | 
| metricName | stringMaxLength: 64 | False | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | False | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | False | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatestatistic) | False | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetargetresourcetype) | False | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetreatmissingdata) | False | Specifies how missing data points are treated when evaluating the alarm's condition. | 

### UpdateCloudWatchAlarmTemplateResponseContent
<a name="cloudwatch-alarm-templates-identifier-model-updatecloudwatchalarmtemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:cloudwatch-alarm-template:.+$` | True | A cloudwatch alarm template's ARN (Amazon Resource Name) | 
| comparisonOperator | [CloudWatchAlarmTemplateComparisonOperator](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatecomparisonoperator) | True | The comparison operator used to compare the specified statistic and the threshold. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| datapointsToAlarm | numberMinimum: 1 | False | The number of datapoints within the evaluation period that must be breaching to trigger the alarm. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| evaluationPeriods | numberMinimum: 1 | True | The number of periods over which data is compared to the specified threshold. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A CloudWatch alarm template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code> | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A cloudwatch alarm template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code>. | 
| metricName | stringMaxLength: 64 | True | The name of the metric associated with the alarm. Must be compatible with targetResourceType. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| period | numberMinimum: 10Maximum: 86400 | True | The period, in seconds, over which the specified statistic is applied. | 
| standardDeviationThreshold | numberMinimum: 1 | False | The number of standard deviations by which the metric value can deviate from the expected value before the alarm is triggered. | 
| statistic | [CloudWatchAlarmTemplateStatistic](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatestatistic) | True | The statistic to apply to the alarm's metric data. | 
| targetResourceType | [CloudWatchAlarmTemplateTargetResourceType](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetargetresourcetype) | True | The resource type this template should dynamically generate CloudWatch metric alarms for. | 
| threshold | numberFormat: double | False | The threshold value to compare with the specified statistic. | 
| treatMissingData | [CloudWatchAlarmTemplateTreatMissingData](#cloudwatch-alarm-templates-identifier-model-cloudwatchalarmtemplatetreatmissingdata) | True | Specifies how missing data points are treated when evaluating the alarm's condition. | 

## See also
<a name="cloudwatch-alarm-templates-identifier-see-also"></a>

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

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

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

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

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

# Workflow monitor: EventBridge rule template groups
<a name="eventbridge-rule-template-groups"></a>

## URI
<a name="eventbridge-rule-template-groups-url"></a>

`/prod/eventbridge-rule-template-groups`

## HTTP methods
<a name="eventbridge-rule-template-groups-http-methods"></a>

### GET
<a name="eventbridge-rule-template-groupsget"></a>

**Operation ID:** `ListEventBridgeRuleTemplateGroups`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| signalMapIdentifier | String | False |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListEventBridgeRuleTemplateGroupsResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="eventbridge-rule-template-groupsoptions"></a>

**Operation ID:** `CorsEventbridge_rule_template_groups`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="eventbridge-rule-template-groupspost"></a>

**Operation ID:** `CreateEventBridgeRuleTemplateGroup`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateEventBridgeRuleTemplateGroupResponseContent | 201 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="eventbridge-rule-template-groups-schemas"></a>

### Request bodies
<a name="eventbridge-rule-template-groups-request-examples"></a>

#### POST schema
<a name="eventbridge-rule-template-groups-request-body-post-example"></a>

```
{
  "description": "string",
  "name": "string"
}
```

### Response bodies
<a name="eventbridge-rule-template-groups-response-examples"></a>

#### ListEventBridgeRuleTemplateGroupsResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-listeventbridgeruletemplategroupsresponsecontent-example"></a>

```
{
  "eventBridgeRuleTemplateGroups": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string",
      "templateCount": number
    }
  ],
  "nextToken": "string"
}
```

#### CreateEventBridgeRuleTemplateGroupResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-createeventbridgeruletemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-badrequestexceptionresponsecontent-example"></a>

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

#### ForbiddenExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-forbiddenexceptionresponsecontent-example"></a>

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

#### NotFoundExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="eventbridge-rule-template-groups-properties"></a>

### BadRequestExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateEventBridgeRuleTemplateGroupRequestContent
<a name="eventbridge-rule-template-groups-model-createeventbridgeruletemplategrouprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### CreateEventBridgeRuleTemplateGroupResponseContent
<a name="eventbridge-rule-template-groups-model-createeventbridgeruletemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$` | True | An eventbridge rule template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### EventBridgeRuleTemplateGroupSummary
<a name="eventbridge-rule-template-groups-model-eventbridgeruletemplategroupsummary"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$` | True | An eventbridge rule template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| templateCount | number | True | The number of templates in the group. | 

### ForbiddenExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListEventBridgeRuleTemplateGroupsResponseContent
<a name="eventbridge-rule-template-groups-model-listeventbridgeruletemplategroupsresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| eventBridgeRuleTemplateGroups | Array of type [EventBridgeRuleTemplateGroupSummary](#eventbridge-rule-template-groups-model-eventbridgeruletemplategroupsummary) | True | A list of EventBridge rule template groups. | 
| nextToken | stringMinLength: 1MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. | 

### NotFoundExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="eventbridge-rule-template-groups-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="eventbridge-rule-template-groups-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListEventBridgeRuleTemplateGroups
<a name="ListEventBridgeRuleTemplateGroups-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/ListEventBridgeRuleTemplateGroups)

### CorsEventbridge\$1rule\$1template\$1groups
<a name="CorsEventbridge_rule_template_groups-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsEventbridge_rule_template_groups)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsEventbridge_rule_template_groups)

### CreateEventBridgeRuleTemplateGroup
<a name="CreateEventBridgeRuleTemplateGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CreateEventBridgeRuleTemplateGroup)

# Workflow monitor: EventBridge rule template groups ID
<a name="eventbridge-rule-template-groups-identifier"></a>

## URI
<a name="eventbridge-rule-template-groups-identifier-url"></a>

`/prod/eventbridge-rule-template-groups/identifier`

## HTTP methods
<a name="eventbridge-rule-template-groups-identifier-http-methods"></a>

### DELETE
<a name="eventbridge-rule-template-groups-identifierdelete"></a>

**Operation ID:** `DeleteEventBridgeRuleTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### GET
<a name="eventbridge-rule-template-groups-identifierget"></a>

**Operation ID:** `GetEventBridgeRuleTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetEventBridgeRuleTemplateGroupResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="eventbridge-rule-template-groups-identifieroptions"></a>

**Operation ID:** `CorsEventbridge_rule_template_groupsIdentifier`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### PATCH
<a name="eventbridge-rule-template-groups-identifierpatch"></a>

**Operation ID:** `UpdateEventBridgeRuleTemplateGroup`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateEventBridgeRuleTemplateGroupResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="eventbridge-rule-template-groups-identifier-schemas"></a>

### Request bodies
<a name="eventbridge-rule-template-groups-identifier-request-examples"></a>

#### PATCH schema
<a name="eventbridge-rule-template-groups-identifier-request-body-patch-example"></a>

```
{
  "description": "string"
}
```

### Response bodies
<a name="eventbridge-rule-template-groups-identifier-response-examples"></a>

#### GetEventBridgeRuleTemplateGroupResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-geteventbridgeruletemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### UpdateEventBridgeRuleTemplateGroupResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-updateeventbridgeruletemplategroupresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="eventbridge-rule-template-groups-identifier-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="eventbridge-rule-template-groups-identifier-properties"></a>

### BadRequestExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ForbiddenExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### GetEventBridgeRuleTemplateGroupResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-geteventbridgeruletemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$` | True | An eventbridge rule template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### InternalServerErrorExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### NotFoundExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### UpdateEventBridgeRuleTemplateGroupRequestContent
<a name="eventbridge-rule-template-groups-identifier-model-updateeventbridgeruletemplategrouprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 

### UpdateEventBridgeRuleTemplateGroupResponseContent
<a name="eventbridge-rule-template-groups-identifier-model-updateeventbridgeruletemplategroupresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template-group:.+$` | True | An eventbridge rule template group's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

## See also
<a name="eventbridge-rule-template-groups-identifier-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### DeleteEventBridgeRuleTemplateGroup
<a name="DeleteEventBridgeRuleTemplateGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplateGroup)

### GetEventBridgeRuleTemplateGroup
<a name="GetEventBridgeRuleTemplateGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/GetEventBridgeRuleTemplateGroup)

### CorsEventbridge\$1rule\$1template\$1groupsIdentifier
<a name="CorsEventbridge_rule_template_groupsIdentifier-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsEventbridge_rule_template_groupsIdentifier)

### UpdateEventBridgeRuleTemplateGroup
<a name="UpdateEventBridgeRuleTemplateGroup-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplateGroup)

# Workflow monitor: EventBridge rule templates
<a name="eventbridge-rule-templates"></a>

## URI
<a name="eventbridge-rule-templates-url"></a>

`/prod/eventbridge-rule-templates`

## HTTP methods
<a name="eventbridge-rule-templates-http-methods"></a>

### GET
<a name="eventbridge-rule-templatesget"></a>

**Operation ID:** `ListEventBridgeRuleTemplates`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| groupIdentifier | String | False |  | 
| signalMapIdentifier | String | False |  | 
| nextToken | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListEventBridgeRuleTemplatesResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="eventbridge-rule-templatesoptions"></a>

**Operation ID:** `CorsEventbridge_rule_templates`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="eventbridge-rule-templatespost"></a>

**Operation ID:** `CreateEventBridgeRuleTemplate`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateEventBridgeRuleTemplateResponseContent | 201 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="eventbridge-rule-templates-schemas"></a>

### Request bodies
<a name="eventbridge-rule-templates-request-examples"></a>

#### POST schema
<a name="eventbridge-rule-templates-request-body-post-example"></a>

```
{
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupIdentifier": "string",
  "name": "string"
}
```

### Response bodies
<a name="eventbridge-rule-templates-response-examples"></a>

#### ListEventBridgeRuleTemplatesResponseContent schema
<a name="eventbridge-rule-templates-response-body-listeventbridgeruletemplatesresponsecontent-example"></a>

```
{
  "eventBridgeRuleTemplates": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "eventTargetCount": number,
      "eventType": enum,
      "groupId": "string",
      "id": "string",
      "modifiedAt": "string",
      "name": "string"
    }
  ],
  "nextToken": "string"
}
```

#### CreateEventBridgeRuleTemplateResponseContent schema
<a name="eventbridge-rule-templates-response-body-createeventbridgeruletemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupId": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="eventbridge-rule-templates-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="eventbridge-rule-templates-properties"></a>

### BadRequestExceptionResponseContent
<a name="eventbridge-rule-templates-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="eventbridge-rule-templates-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateEventBridgeRuleTemplateRequestContent
<a name="eventbridge-rule-templates-model-createeventbridgeruletemplaterequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupIdentifier | stringPattern: `^[^\s]+$` | True | An eventbridge rule template group's identifier. Can be either be its id or current name. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### CreateEventBridgeRuleTemplateResponseContent
<a name="eventbridge-rule-templates-model-createeventbridgeruletemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### EventBridgeRuleTemplateEventType
<a name="eventbridge-rule-templates-model-eventbridgeruletemplateeventtype"></a>

The type of event to match with the rule.
+ `MEDIALIVE_MULTIPLEX_ALERT`
+ `MEDIALIVE_MULTIPLEX_STATE_CHANGE`
+ `MEDIALIVE_CHANNEL_ALERT`
+ `MEDIALIVE_CHANNEL_INPUT_CHANGE`
+ `MEDIALIVE_CHANNEL_STATE_CHANGE`
+ `MEDIAPACKAGE_INPUT_NOTIFICATION`
+ `MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION`
+ `MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION`
+ `SIGNAL_MAP_ACTIVE_ALARM`
+ `MEDIACONNECT_ALERT`
+ `MEDIACONNECT_SOURCE_HEALTH`
+ `MEDIACONNECT_OUTPUT_HEALTH`
+ `MEDIACONNECT_FLOW_STATUS_CHANGE`

### EventBridgeRuleTemplateSummary
<a name="eventbridge-rule-templates-model-eventbridgeruletemplatesummary"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargetCount | number | True | The number of event targets. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### EventBridgeRuleTemplateTarget
<a name="eventbridge-rule-templates-model-eventbridgeruletemplatetarget"></a>

The target to which to send matching events.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | Target ARNs must be either an SNS topic or CloudWatch log group. | 

### ForbiddenExceptionResponseContent
<a name="eventbridge-rule-templates-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="eventbridge-rule-templates-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListEventBridgeRuleTemplatesResponseContent
<a name="eventbridge-rule-templates-model-listeventbridgeruletemplatesresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| eventBridgeRuleTemplates | Array of type [EventBridgeRuleTemplateSummary](#eventbridge-rule-templates-model-eventbridgeruletemplatesummary) | True | A list of the EventBridge rule templates. | 
| nextToken | stringMinLength: 1MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. | 

### NotFoundExceptionResponseContent
<a name="eventbridge-rule-templates-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="eventbridge-rule-templates-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="eventbridge-rule-templates-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListEventBridgeRuleTemplates
<a name="ListEventBridgeRuleTemplates-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/ListEventBridgeRuleTemplates)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/ListEventBridgeRuleTemplates)

### CorsEventbridge\$1rule\$1templates
<a name="CorsEventbridge_rule_templates-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsEventbridge_rule_templates)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsEventbridge_rule_templates)

### CreateEventBridgeRuleTemplate
<a name="CreateEventBridgeRuleTemplate-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CreateEventBridgeRuleTemplate)

# Workflow monitor: EventBridge rule templates ID
<a name="eventbridge-rule-templates-identifier"></a>

## URI
<a name="eventbridge-rule-templates-identifier-url"></a>

`/prod/eventbridge-rule-templates/identifier`

## HTTP methods
<a name="eventbridge-rule-templates-identifier-http-methods"></a>

### DELETE
<a name="eventbridge-rule-templates-identifierdelete"></a>

**Operation ID:** `DeleteEventBridgeRuleTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### GET
<a name="eventbridge-rule-templates-identifierget"></a>

**Operation ID:** `GetEventBridgeRuleTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetEventBridgeRuleTemplateResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="eventbridge-rule-templates-identifieroptions"></a>

**Operation ID:** `CorsEventbridge_rule_templatesIdentifier`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### PATCH
<a name="eventbridge-rule-templates-identifierpatch"></a>

**Operation ID:** `UpdateEventBridgeRuleTemplate`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | UpdateEventBridgeRuleTemplateResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="eventbridge-rule-templates-identifier-schemas"></a>

### Request bodies
<a name="eventbridge-rule-templates-identifier-request-examples"></a>

#### PATCH schema
<a name="eventbridge-rule-templates-identifier-request-body-patch-example"></a>

```
{
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupIdentifier": "string",
  "name": "string"
}
```

### Response bodies
<a name="eventbridge-rule-templates-identifier-response-examples"></a>

#### GetEventBridgeRuleTemplateResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-geteventbridgeruletemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupId": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### UpdateEventBridgeRuleTemplateResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-updateeventbridgeruletemplateresponsecontent-example"></a>

```
{
  "arn": "string",
  "createdAt": "string",
  "description": "string",
  "eventTargets": [
    {
      "arn": "string"
    }
  ],
  "eventType": enum,
  "groupId": "string",
  "id": "string",
  "modifiedAt": "string",
  "name": "string"
}
```

#### BadRequestExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="eventbridge-rule-templates-identifier-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="eventbridge-rule-templates-identifier-properties"></a>

### BadRequestExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### EventBridgeRuleTemplateEventType
<a name="eventbridge-rule-templates-identifier-model-eventbridgeruletemplateeventtype"></a>

The type of event to match with the rule.
+ `MEDIALIVE_MULTIPLEX_ALERT`
+ `MEDIALIVE_MULTIPLEX_STATE_CHANGE`
+ `MEDIALIVE_CHANNEL_ALERT`
+ `MEDIALIVE_CHANNEL_INPUT_CHANGE`
+ `MEDIALIVE_CHANNEL_STATE_CHANGE`
+ `MEDIAPACKAGE_INPUT_NOTIFICATION`
+ `MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION`
+ `MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION`
+ `SIGNAL_MAP_ACTIVE_ALARM`
+ `MEDIACONNECT_ALERT`
+ `MEDIACONNECT_SOURCE_HEALTH`
+ `MEDIACONNECT_OUTPUT_HEALTH`
+ `MEDIACONNECT_FLOW_STATUS_CHANGE`

### EventBridgeRuleTemplateTarget
<a name="eventbridge-rule-templates-identifier-model-eventbridgeruletemplatetarget"></a>

The target to which to send matching events.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | Target ARNs must be either an SNS topic or CloudWatch log group. | 

### ForbiddenExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### GetEventBridgeRuleTemplateResponseContent
<a name="eventbridge-rule-templates-identifier-model-geteventbridgeruletemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### InternalServerErrorExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### NotFoundExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### TooManyRequestsExceptionResponseContent
<a name="eventbridge-rule-templates-identifier-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### UpdateEventBridgeRuleTemplateRequestContent
<a name="eventbridge-rule-templates-identifier-model-updateeventbridgeruletemplaterequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplatetarget) | False | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplateeventtype) | False | The type of event to match with the rule. | 
| groupIdentifier | stringPattern: `^[^\s]+$` | False | An eventbridge rule template group's identifier. Can be either be its id or current name. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | False | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### UpdateEventBridgeRuleTemplateResponseContent
<a name="eventbridge-rule-templates-identifier-model-updateeventbridgeruletemplateresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:eventbridge-rule-template:.+$` | True | An eventbridge rule template's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| eventTargets | Array of type [EventBridgeRuleTemplateTarget](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplatetarget) | True | The destinations that will receive the event notifications. | 
| eventType | [EventBridgeRuleTemplateEventType](#eventbridge-rule-templates-identifier-model-eventbridgeruletemplateeventtype) | True | The type of event to match with the rule. | 
| groupId | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | An eventbridge rule template's id. Amazon Web Services provided templates have ids that start with <code>`aws-`</code> | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

## See also
<a name="eventbridge-rule-templates-identifier-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### DeleteEventBridgeRuleTemplate
<a name="DeleteEventBridgeRuleTemplate-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DeleteEventBridgeRuleTemplate)

### GetEventBridgeRuleTemplate
<a name="GetEventBridgeRuleTemplate-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/GetEventBridgeRuleTemplate)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/GetEventBridgeRuleTemplate)

### CorsEventbridge\$1rule\$1templatesIdentifier
<a name="CorsEventbridge_rule_templatesIdentifier-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsEventbridge_rule_templatesIdentifier)

### UpdateEventBridgeRuleTemplate
<a name="UpdateEventBridgeRuleTemplate-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/UpdateEventBridgeRuleTemplate)

# Workflow monitor: Signal map monitor deployment
<a name="signal-maps-identifier-monitor-deployment"></a>

## URI
<a name="signal-maps-identifier-monitor-deployment-url"></a>

`/prod/signal-maps/identifier/monitor-deployment`

## HTTP methods
<a name="signal-maps-identifier-monitor-deployment-http-methods"></a>

### DELETE
<a name="signal-maps-identifier-monitor-deploymentdelete"></a>

**Operation ID:** `StartDeleteMonitorDeployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | StartDeleteMonitorDeploymentResponseContent | 202 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="signal-maps-identifier-monitor-deploymentoptions"></a>

**Operation ID:** `CorsSignal_mapsIdentifierMonitor_deployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="signal-maps-identifier-monitor-deploymentpost"></a>

**Operation ID:** `StartMonitorDeployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | StartMonitorDeploymentResponseContent | 202 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="signal-maps-identifier-monitor-deployment-schemas"></a>

### Request bodies
<a name="signal-maps-identifier-monitor-deployment-request-examples"></a>

#### POST schema
<a name="signal-maps-identifier-monitor-deployment-request-body-post-example"></a>

```
{
  "dryRun": boolean
}
```

### Response bodies
<a name="signal-maps-identifier-monitor-deployment-response-examples"></a>

#### StartDeleteMonitorDeploymentResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-startdeletemonitordeploymentresponsecontent-example"></a>

```
{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}
```

#### StartMonitorDeploymentResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-startmonitordeploymentresponsecontent-example"></a>

```
{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}
```

#### BadRequestExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="signal-maps-identifier-monitor-deployment-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="signal-maps-identifier-monitor-deployment-properties"></a>

### BadRequestExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### FailedMediaResourceMap
<a name="signal-maps-identifier-monitor-deployment-model-failedmediaresourcemap"></a>

A map representing an incomplete Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### ForbiddenExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### MediaResource
<a name="signal-maps-identifier-monitor-deployment-model-mediaresource"></a>

An Amazon Web Services resource used in media workflows.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinations | Array of type [MediaResourceNeighbor](#signal-maps-identifier-monitor-deployment-model-mediaresourceneighbor) | False | A direct destination neighbor to an Amazon Web Services media resource. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 
| sources | Array of type [MediaResourceNeighbor](#signal-maps-identifier-monitor-deployment-model-mediaresourceneighbor) | False | A direct source neighbor to an Amazon Web Services media resource. | 

### MediaResourceMap
<a name="signal-maps-identifier-monitor-deployment-model-mediaresourcemap"></a>

A map representing an Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### MediaResourceNeighbor
<a name="signal-maps-identifier-monitor-deployment-model-mediaresourceneighbor"></a>

A direct source or destination neighbor to an Amazon Web Services media resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | The ARN of a resource used in Amazon Web Services media workflows. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 

### MonitorDeployment
<a name="signal-maps-identifier-monitor-deployment-model-monitordeployment"></a>

Represents the latest monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | False | URI associated with a signal map's monitor deployment. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed monitor deployment of a signal map. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-monitor-deployment-model-signalmapmonitordeploymentstatus) | True | The signal map monitor deployment status. | 

### NotFoundExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### SignalMapMonitorDeploymentStatus
<a name="signal-maps-identifier-monitor-deployment-model-signalmapmonitordeploymentstatus"></a>

A signal map's monitor deployment status.
+ `NOT_DEPLOYED`
+ `DRY_RUN_DEPLOYMENT_COMPLETE`
+ `DRY_RUN_DEPLOYMENT_FAILED`
+ `DRY_RUN_DEPLOYMENT_IN_PROGRESS`
+ `DEPLOYMENT_COMPLETE`
+ `DEPLOYMENT_FAILED`
+ `DEPLOYMENT_IN_PROGRESS`
+ `DELETE_COMPLETE`
+ `DELETE_FAILED`
+ `DELETE_IN_PROGRESS`

### SignalMapStatus
<a name="signal-maps-identifier-monitor-deployment-model-signalmapstatus"></a>

A signal map's current status which is dependent on its lifecycle actions or associated jobs.
+ `CREATE_IN_PROGRESS`
+ `CREATE_COMPLETE`
+ `CREATE_FAILED`
+ `UPDATE_IN_PROGRESS`
+ `UPDATE_COMPLETE`
+ `UPDATE_REVERTED`
+ `UPDATE_FAILED`
+ `READY`
+ `NOT_READY`

### StartDeleteMonitorDeploymentResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-startdeletemonitordeploymentresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-monitor-deployment-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-monitor-deployment-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-monitor-deployment-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorChangesPendingDeployment | boolean | True | If true, there are pending monitor changes for this signal map that can be deployed. | 
| monitorDeployment | [MonitorDeployment](#signal-maps-identifier-monitor-deployment-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-monitor-deployment-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### StartMonitorDeploymentRequestContent
<a name="signal-maps-identifier-monitor-deployment-model-startmonitordeploymentrequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| dryRun | boolean | False |  | 

### StartMonitorDeploymentResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-startmonitordeploymentresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-monitor-deployment-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-monitor-deployment-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-monitor-deployment-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorChangesPendingDeployment | boolean | True | If true, there are pending monitor changes for this signal map that can be deployed. | 
| monitorDeployment | [MonitorDeployment](#signal-maps-identifier-monitor-deployment-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-monitor-deployment-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### SuccessfulMonitorDeployment
<a name="signal-maps-identifier-monitor-deployment-model-successfulmonitordeployment"></a>

Represents the latest successful monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | True | URI associated with a signal map's monitor deployment. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-monitor-deployment-model-signalmapmonitordeploymentstatus) | True | A signal map's monitor deployment status. | 

### TooManyRequestsExceptionResponseContent
<a name="signal-maps-identifier-monitor-deployment-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="signal-maps-identifier-monitor-deployment-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### StartDeleteMonitorDeployment
<a name="StartDeleteMonitorDeployment-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/StartDeleteMonitorDeployment)

### CorsSignal\$1mapsIdentifierMonitor\$1deployment
<a name="CorsSignal_mapsIdentifierMonitor_deployment-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)

### StartMonitorDeployment
<a name="StartMonitorDeployment-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/StartMonitorDeployment)

# Workflow monitor: Signal maps
<a name="signal-maps"></a>

## URI
<a name="signal-maps-url"></a>

`/prod/signal-maps`

## HTTP methods
<a name="signal-maps-http-methods"></a>

### GET
<a name="signal-mapsget"></a>

**Operation ID:** `ListSignalMaps`


**Query parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| eventBridgeRuleTemplateGroupIdentifier | String | False |  | 
| nextToken | String | False |  | 
| cloudWatchAlarmTemplateGroupIdentifier | String | False |  | 
| maxResults | String | False |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListSignalMapsResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="signal-mapsoptions"></a>

**Operation ID:** `CorsSignal_maps`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST
<a name="signal-mapspost"></a>

**Operation ID:** `CreateSignalMap`


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 201 | CreateSignalMapResponseContent | 201 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="signal-maps-schemas"></a>

### Request bodies
<a name="signal-maps-request-examples"></a>

#### POST schema
<a name="signal-maps-request-body-post-example"></a>

```
{
  "cloudWatchAlarmTemplateGroupIdentifiers": [
    "string"
  ],
  "description": "string",
  "discoveryEntryPointArn": "string",
  "eventBridgeRuleTemplateGroupIdentifiers": [
    "string"
  ],
  "name": "string"
}
```

### Response bodies
<a name="signal-maps-response-examples"></a>

#### ListSignalMapsResponseContent schema
<a name="signal-maps-response-body-listsignalmapsresponsecontent-example"></a>

```
{
  "nextToken": "string",
  "signalMaps": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "id": "string",
      "modifiedAt": "string",
      "monitorDeploymentStatus": enum,
      "name": "string",
      "status": enum
    }
  ]
}
```

#### CreateSignalMapResponseContent schema
<a name="signal-maps-response-body-createsignalmapresponsecontent-example"></a>

```
{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}
```

#### BadRequestExceptionResponseContent schema
<a name="signal-maps-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="signal-maps-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="signal-maps-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="signal-maps-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="signal-maps-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="signal-maps-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="signal-maps-properties"></a>

### BadRequestExceptionResponseContent
<a name="signal-maps-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="signal-maps-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### CreateSignalMapRequestContent
<a name="signal-maps-model-createsignalmaprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cloudWatchAlarmTemplateGroupIdentifiers | Array of type stringPattern: `^[^\s]+$` | False | A cloudwatch alarm template group's identifier. Can be either be its id or current name. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| eventBridgeRuleTemplateGroupIdentifiers | Array of type stringPattern: `^[^\s]+$` | False | An eventbridge rule template group's identifier. Can be either be its id or current name. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### CreateSignalMapResponseContent
<a name="signal-maps-model-createsignalmapresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with `aws-`. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorChangesPendingDeployment | boolean | True | If true, there are pending monitor changes for this signal map that can be deployed. | 
| monitorDeployment | [MonitorDeployment](#signal-maps-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### FailedMediaResourceMap
<a name="signal-maps-model-failedmediaresourcemap"></a>

A map representing an incomplete Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### ForbiddenExceptionResponseContent
<a name="signal-maps-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### InternalServerErrorExceptionResponseContent
<a name="signal-maps-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ListSignalMapsResponseContent
<a name="signal-maps-model-listsignalmapsresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| nextToken | stringMinLength: 1MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. | 
| signalMaps | Array of type [SignalMapSummary](#signal-maps-model-signalmapsummary) | True | Details of the signal map | 

### MediaResource
<a name="signal-maps-model-mediaresource"></a>

An Amazon Web Services resource used in media workflows.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinations | Array of type [MediaResourceNeighbor](#signal-maps-model-mediaresourceneighbor) | False | A direct destination neighbor to an Amazon Web Services media resource. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 
| sources | Array of type [MediaResourceNeighbor](#signal-maps-model-mediaresourceneighbor) | False | A direct source neighbor to an Amazon Web Services media resource. | 

### MediaResourceMap
<a name="signal-maps-model-mediaresourcemap"></a>

A map representing an Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### MediaResourceNeighbor
<a name="signal-maps-model-mediaresourceneighbor"></a>

A direct source or destination neighbor to an Amazon Web Services media resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | The ARN of a resource used in Amazon Web Services media workflows. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 

### MonitorDeployment
<a name="signal-maps-model-monitordeployment"></a>

Represents the latest monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | False | URI associated with a signal map's monitor deployment. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed monitor deployment of a signal map. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-model-signalmapmonitordeploymentstatus) | True | The signal map monitor deployment status. | 

### NotFoundExceptionResponseContent
<a name="signal-maps-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### SignalMapMonitorDeploymentStatus
<a name="signal-maps-model-signalmapmonitordeploymentstatus"></a>

A signal map's monitor deployment status.
+ `NOT_DEPLOYED`
+ `DRY_RUN_DEPLOYMENT_COMPLETE`
+ `DRY_RUN_DEPLOYMENT_FAILED`
+ `DRY_RUN_DEPLOYMENT_IN_PROGRESS`
+ `DEPLOYMENT_COMPLETE`
+ `DEPLOYMENT_FAILED`
+ `DEPLOYMENT_IN_PROGRESS`
+ `DELETE_COMPLETE`
+ `DELETE_FAILED`
+ `DELETE_IN_PROGRESS`

### SignalMapStatus
<a name="signal-maps-model-signalmapstatus"></a>

A signal map's current status which is dependent on its lifecycle actions or associated jobs.
+ `CREATE_IN_PROGRESS`
+ `CREATE_COMPLETE`
+ `CREATE_FAILED`
+ `UPDATE_IN_PROGRESS`
+ `UPDATE_COMPLETE`
+ `UPDATE_REVERTED`
+ `UPDATE_FAILED`
+ `READY`
+ `NOT_READY`

### SignalMapSummary
<a name="signal-maps-model-signalmapsummary"></a>

Details of the signal map


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorDeploymentStatus | [SignalMapMonitorDeploymentStatus](#signal-maps-model-signalmapmonitordeploymentstatus) | True | A signal map's monitor deployment status. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### SuccessfulMonitorDeployment
<a name="signal-maps-model-successfulmonitordeployment"></a>

Represents the latest successful monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | True | URI associated with a signal map's monitor deployment. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-model-signalmapmonitordeploymentstatus) | True | A signal map's monitor deployment status. | 

### TooManyRequestsExceptionResponseContent
<a name="signal-maps-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="signal-maps-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListSignalMaps
<a name="ListSignalMaps-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/ListSignalMaps)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/ListSignalMaps)

### CorsSignal\$1maps
<a name="CorsSignal_maps-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsSignal_maps)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsSignal_maps)

### CreateSignalMap
<a name="CreateSignalMap-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CreateSignalMap)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CreateSignalMap)

# Workflow monitor: Signal maps ID
<a name="signal-maps-identifier"></a>

## URI
<a name="signal-maps-identifier-url"></a>

`/prod/signal-maps/identifier`

## HTTP methods
<a name="signal-maps-identifier-http-methods"></a>

### DELETE
<a name="signal-maps-identifierdelete"></a>

**Operation ID:** `DeleteSignalMap`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 204 | None | 204 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### GET
<a name="signal-maps-identifierget"></a>

**Operation ID:** `GetSignalMap`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | GetSignalMapResponseContent | 200 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

### OPTIONS
<a name="signal-maps-identifieroptions"></a>

**Operation ID:** `CorsSignal_mapsIdentifier`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### PATCH
<a name="signal-maps-identifierpatch"></a>

**Operation ID:** `StartUpdateSignalMap`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | StartUpdateSignalMapResponseContent | 202 response | 
| 400 | BadRequestExceptionResponseContent | 400 response | 
| 403 | ForbiddenExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | 404 response | 
| 409 | ConflictExceptionResponseContent | 409 response | 
| 429 | TooManyRequestsExceptionResponseContent | 429 response | 
| 500 | InternalServerErrorExceptionResponseContent | 500 response | 

## Schemas
<a name="signal-maps-identifier-schemas"></a>

### Request bodies
<a name="signal-maps-identifier-request-examples"></a>

#### PATCH schema
<a name="signal-maps-identifier-request-body-patch-example"></a>

```
{
  "cloudWatchAlarmTemplateGroupIdentifiers": [
    "string"
  ],
  "description": "string",
  "discoveryEntryPointArn": "string",
  "eventBridgeRuleTemplateGroupIdentifiers": [
    "string"
  ],
  "forceRediscovery": boolean,
  "name": "string"
}
```

### Response bodies
<a name="signal-maps-identifier-response-examples"></a>

#### GetSignalMapResponseContent schema
<a name="signal-maps-identifier-response-body-getsignalmapresponsecontent-example"></a>

```
{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}
```

#### StartUpdateSignalMapResponseContent schema
<a name="signal-maps-identifier-response-body-startupdatesignalmapresponsecontent-example"></a>

```
{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}
```

#### BadRequestExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-forbiddenexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-toomanyrequestsexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
<a name="signal-maps-identifier-response-body-internalservererrorexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

## Properties
<a name="signal-maps-identifier-properties"></a>

### BadRequestExceptionResponseContent
<a name="signal-maps-identifier-model-badrequestexceptionresponsecontent"></a>

The input fails to satisfy the constraints specified by an Amazon Web Services service.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### ConflictExceptionResponseContent
<a name="signal-maps-identifier-model-conflictexceptionresponsecontent"></a>

Updating or deleting a resource can cause an inconsistent state.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### FailedMediaResourceMap
<a name="signal-maps-identifier-model-failedmediaresourcemap"></a>

A map representing an incomplete Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### ForbiddenExceptionResponseContent
<a name="signal-maps-identifier-model-forbiddenexceptionresponsecontent"></a>

User does not have sufficient access to perform this action.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### GetSignalMapResponseContent
<a name="signal-maps-identifier-model-getsignalmapresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorChangesPendingDeployment | boolean | True | If true, there are pending monitor changes for this signal map that can be deployed. | 
| monitorDeployment | [MonitorDeployment](#signal-maps-identifier-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### InternalServerErrorExceptionResponseContent
<a name="signal-maps-identifier-model-internalservererrorexceptionresponsecontent"></a>

Unexpected error during processing of request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### MediaResource
<a name="signal-maps-identifier-model-mediaresource"></a>

An Amazon Web Services resource used in media workflows.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| destinations | Array of type [MediaResourceNeighbor](#signal-maps-identifier-model-mediaresourceneighbor) | False | A direct destination neighbor to an Amazon Web Services media resource. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 
| sources | Array of type [MediaResourceNeighbor](#signal-maps-identifier-model-mediaresourceneighbor) | False | A direct source neighbor to an Amazon Web Services media resource. | 

### MediaResourceMap
<a name="signal-maps-identifier-model-mediaresourcemap"></a>

A map representing an Amazon Web Services media workflow as a graph.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| `*` | object | False |  | 

### MediaResourceNeighbor
<a name="signal-maps-identifier-model-mediaresourceneighbor"></a>

A direct source or destination neighbor to an Amazon Web Services media resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | The ARN of a resource used in Amazon Web Services media workflows. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 

### MonitorDeployment
<a name="signal-maps-identifier-model-monitordeployment"></a>

Represents the latest monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | False | URI associated with a signal map's monitor deployment. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed monitor deployment of a signal map. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-model-signalmapmonitordeploymentstatus) | True | The signal map monitor deployment status. | 

### NotFoundExceptionResponseContent
<a name="signal-maps-identifier-model-notfoundexceptionresponsecontent"></a>

Request references a resource which does not exist.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

### SignalMapMonitorDeploymentStatus
<a name="signal-maps-identifier-model-signalmapmonitordeploymentstatus"></a>

A signal map's monitor deployment status.
+ `NOT_DEPLOYED`
+ `DRY_RUN_DEPLOYMENT_COMPLETE`
+ `DRY_RUN_DEPLOYMENT_FAILED`
+ `DRY_RUN_DEPLOYMENT_IN_PROGRESS`
+ `DEPLOYMENT_COMPLETE`
+ `DEPLOYMENT_FAILED`
+ `DEPLOYMENT_IN_PROGRESS`
+ `DELETE_COMPLETE`
+ `DELETE_FAILED`
+ `DELETE_IN_PROGRESS`

### SignalMapStatus
<a name="signal-maps-identifier-model-signalmapstatus"></a>

A signal map's current status which is dependent on its lifecycle actions or associated jobs.
+ `CREATE_IN_PROGRESS`
+ `CREATE_COMPLETE`
+ `CREATE_FAILED`
+ `UPDATE_IN_PROGRESS`
+ `UPDATE_COMPLETE`
+ `UPDATE_REVERTED`
+ `UPDATE_FAILED`
+ `READY`
+ `NOT_READY`

### StartUpdateSignalMapRequestContent
<a name="signal-maps-identifier-model-startupdatesignalmaprequestcontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| cloudWatchAlarmTemplateGroupIdentifiers | Array of type stringPattern: `^[^\s]+$` | False | A cloudwatch alarm template group's identifier. Can be either be its id or current name. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | False | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| eventBridgeRuleTemplateGroupIdentifiers | Array of type stringPattern: `^[^\s]+$` | False | An eventbridge rule template group's identifier. Can be either be its id or current name. | 
| forceRediscovery | boolean | False | If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | False | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 

### StartUpdateSignalMapResponseContent
<a name="signal-maps-identifier-model-startupdatesignalmapresponsecontent"></a>


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: date-time | False | The date and time of latest resource modification. | 
| monitorChangesPendingDeployment | boolean | True | If true, there are pending monitor changes for this signal map that can be deployed. | 
| monitorDeployment | [MonitorDeployment](#signal-maps-identifier-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### SuccessfulMonitorDeployment
<a name="signal-maps-identifier-model-successfulmonitordeployment"></a>

Represents the latest successful monitor deployment of a signal map.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| detailsUri | stringMinLength: 1MaxLength: 2048 | True | URI associated with a signal map's monitor deployment. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-model-signalmapmonitordeploymentstatus) | True | A signal map's monitor deployment status. | 

### TooManyRequestsExceptionResponseContent
<a name="signal-maps-identifier-model-toomanyrequestsexceptionresponsecontent"></a>

Request was denied due to request throttling.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | Exception error message. | 

## See also
<a name="signal-maps-identifier-see-also"></a>

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### DeleteSignalMap
<a name="DeleteSignalMap-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/DeleteSignalMap)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/DeleteSignalMap)

### GetSignalMap
<a name="GetSignalMap-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/GetSignalMap)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/GetSignalMap)

### CorsSignal\$1mapsIdentifier
<a name="CorsSignal_mapsIdentifier-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsSignal_mapsIdentifier)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsSignal_mapsIdentifier)

### StartUpdateSignalMap
<a name="StartUpdateSignalMap-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/StartUpdateSignalMap)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/StartUpdateSignalMap)