

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ConfigureLogsForChannel](API_ConfigureLogsForChannel.md) 
+  [ConfigureLogsForPlaybackConfiguration](API_ConfigureLogsForPlaybackConfiguration.md) 
+  [CreateChannel](API_CreateChannel.md) 
+  [CreateLiveSource](API_CreateLiveSource.md) 
+  [CreatePrefetchSchedule](API_CreatePrefetchSchedule.md) 
+  [CreateProgram](API_CreateProgram.md) 
+  [CreateSourceLocation](API_CreateSourceLocation.md) 
+  [CreateVodSource](API_CreateVodSource.md) 
+  [DeleteChannel](API_DeleteChannel.md) 
+  [DeleteChannelPolicy](API_DeleteChannelPolicy.md) 
+  [DeleteLiveSource](API_DeleteLiveSource.md) 
+  [DeletePlaybackConfiguration](API_DeletePlaybackConfiguration.md) 
+  [DeletePrefetchSchedule](API_DeletePrefetchSchedule.md) 
+  [DeleteProgram](API_DeleteProgram.md) 
+  [DeleteSourceLocation](API_DeleteSourceLocation.md) 
+  [DeleteVodSource](API_DeleteVodSource.md) 
+  [DescribeChannel](API_DescribeChannel.md) 
+  [DescribeLiveSource](API_DescribeLiveSource.md) 
+  [DescribeProgram](API_DescribeProgram.md) 
+  [DescribeSourceLocation](API_DescribeSourceLocation.md) 
+  [DescribeVodSource](API_DescribeVodSource.md) 
+  [GetChannelPolicy](API_GetChannelPolicy.md) 
+  [GetChannelSchedule](API_GetChannelSchedule.md) 
+  [GetPlaybackConfiguration](API_GetPlaybackConfiguration.md) 
+  [GetPrefetchSchedule](API_GetPrefetchSchedule.md) 
+  [ListAlerts](API_ListAlerts.md) 
+  [ListChannels](API_ListChannels.md) 
+  [ListLiveSources](API_ListLiveSources.md) 
+  [ListPlaybackConfigurations](API_ListPlaybackConfigurations.md) 
+  [ListPrefetchSchedules](API_ListPrefetchSchedules.md) 
+  [ListSourceLocations](API_ListSourceLocations.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListVodSources](API_ListVodSources.md) 
+  [PutChannelPolicy](API_PutChannelPolicy.md) 
+  [PutPlaybackConfiguration](API_PutPlaybackConfiguration.md) 
+  [StartChannel](API_StartChannel.md) 
+  [StopChannel](API_StopChannel.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateChannel](API_UpdateChannel.md) 
+  [UpdateLiveSource](API_UpdateLiveSource.md) 
+  [UpdateProgram](API_UpdateProgram.md) 
+  [UpdateSourceLocation](API_UpdateSourceLocation.md) 
+  [UpdateVodSource](API_UpdateVodSource.md) 

# ConfigureLogsForChannel
<a name="API_ConfigureLogsForChannel"></a>

Configures Amazon CloudWatch log settings for a channel.

## Request Syntax
<a name="API_ConfigureLogsForChannel_RequestSyntax"></a>

```
PUT /configureLogs/channel HTTP/1.1
Content-type: application/json

{
   "ChannelName": "string",
   "LogTypes": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ConfigureLogsForChannel_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ConfigureLogsForChannel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ChannelName](#API_ConfigureLogsForChannel_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForChannel-request-ChannelName"></a>
The name of the channel.  
Type: String  
Required: Yes

 ** [LogTypes](#API_ConfigureLogsForChannel_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForChannel-request-LogTypes"></a>
The types of logs to collect.  
Type: Array of strings  
Valid Values: `AS_RUN`   
Required: Yes

## Response Syntax
<a name="API_ConfigureLogsForChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ChannelName": "string",
   "LogTypes": [ "string" ]
}
```

## Response Elements
<a name="API_ConfigureLogsForChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelName](#API_ConfigureLogsForChannel_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForChannel-response-ChannelName"></a>
The name of the channel.  
Type: String

 ** [LogTypes](#API_ConfigureLogsForChannel_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForChannel-response-LogTypes"></a>
The types of logs collected.  
Type: Array of strings  
Valid Values: `AS_RUN` 

## Errors
<a name="API_ConfigureLogsForChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ConfigureLogsForChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ConfigureLogsForChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ConfigureLogsForChannel) 

# ConfigureLogsForPlaybackConfiguration
<a name="API_ConfigureLogsForPlaybackConfiguration"></a>

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

## Request Syntax
<a name="API_ConfigureLogsForPlaybackConfiguration_RequestSyntax"></a>

```
PUT /configureLogs/playbackConfiguration HTTP/1.1
Content-type: application/json

{
   "AdsInteractionLog": { 
      "ExcludeEventTypes": [ "string" ],
      "PublishOptInEventTypes": [ "string" ]
   },
   "EnabledLoggingStrategies": [ "string" ],
   "ManifestServiceInteractionLog": { 
      "ExcludeEventTypes": [ "string" ]
   },
   "PercentEnabled": number,
   "PlaybackConfigurationName": "string"
}
```

## URI Request Parameters
<a name="API_ConfigureLogsForPlaybackConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ConfigureLogsForPlaybackConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdsInteractionLog](#API_ConfigureLogsForPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-request-AdsInteractionLog"></a>
The event types that MediaTailor emits in logs for interactions with the ADS.  
Type: [AdsInteractionLog](API_AdsInteractionLog.md) object  
Required: No

 ** [EnabledLoggingStrategies](#API_ConfigureLogsForPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-request-EnabledLoggingStrategies"></a>
The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose `LEGACY_CLOUDWATCH`. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose `VENDED_LOGS`. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.  
To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in [Enable logging from AWS services, Logging that requires additional permissions [V2]](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions-V2).  
Type: Array of strings  
Valid Values: `VENDED_LOGS | LEGACY_CLOUDWATCH`   
Required: No

 ** [ManifestServiceInteractionLog](#API_ConfigureLogsForPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-request-ManifestServiceInteractionLog"></a>
The event types that MediaTailor emits in logs for interactions with the origin server.  
Type: [ManifestServiceInteractionLog](API_ManifestServiceInteractionLog.md) object  
Required: No

 ** [PercentEnabled](#API_ConfigureLogsForPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-request-PercentEnabled"></a>
The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to `60`, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the [debug log mode](https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html).  
Valid values: `0` - `100`   
Type: Integer  
Required: Yes

 ** [PlaybackConfigurationName](#API_ConfigureLogsForPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-request-PlaybackConfigurationName"></a>
The name of the playback configuration.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdsInteractionLog": { 
      "ExcludeEventTypes": [ "string" ],
      "PublishOptInEventTypes": [ "string" ]
   },
   "EnabledLoggingStrategies": [ "string" ],
   "ManifestServiceInteractionLog": { 
      "ExcludeEventTypes": [ "string" ]
   },
   "PercentEnabled": number,
   "PlaybackConfigurationName": "string"
}
```

## Response Elements
<a name="API_ConfigureLogsForPlaybackConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdsInteractionLog](#API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-response-AdsInteractionLog"></a>
The event types that MediaTailor emits in logs for interactions with the ADS.  
Type: [AdsInteractionLog](API_AdsInteractionLog.md) object

 ** [EnabledLoggingStrategies](#API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-response-EnabledLoggingStrategies"></a>
The method used for collecting logs from AWS Elemental MediaTailor. `LEGACY_CLOUDWATCH` indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. `VENDED_LOGS` indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.   
Type: Array of strings  
Valid Values: `VENDED_LOGS | LEGACY_CLOUDWATCH` 

 ** [ManifestServiceInteractionLog](#API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-response-ManifestServiceInteractionLog"></a>
The event types that MediaTailor emits in logs for interactions with the origin server.  
Type: [ManifestServiceInteractionLog](API_ManifestServiceInteractionLog.md) object

 ** [PercentEnabled](#API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-response-PercentEnabled"></a>
The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.  
Type: Integer

 ** [PlaybackConfigurationName](#API_ConfigureLogsForPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-ConfigureLogsForPlaybackConfiguration-response-PlaybackConfigurationName"></a>
The name of the playback configuration.  
Type: String

## Errors
<a name="API_ConfigureLogsForPlaybackConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ConfigureLogsForPlaybackConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ConfigureLogsForPlaybackConfiguration) 

# CreateChannel
<a name="API_CreateChannel"></a>

Creates a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_CreateChannel_RequestSyntax"></a>

```
POST /channel/ChannelName HTTP/1.1
Content-type: application/json

{
   "Audiences": [ "string" ],
   "FillerSlate": { 
      "SourceLocationName": "string",
      "VodSourceName": "string"
   },
   "Outputs": [ 
      { 
         "DashPlaylistSettings": { 
            "ManifestWindowSeconds": number,
            "MinBufferTimeSeconds": number,
            "MinUpdatePeriodSeconds": number,
            "SuggestedPresentationDelaySeconds": number
         },
         "HlsPlaylistSettings": { 
            "AdMarkupType": [ "string" ],
            "ManifestWindowSeconds": number
         },
         "ManifestName": "string",
         "SourceGroup": "string"
      }
   ],
   "PlaybackMode": "string",
   "tags": { 
      "string" : "string" 
   },
   "Tier": "string",
   "TimeShiftConfiguration": { 
      "MaxTimeDelaySeconds": number
   }
}
```

## URI Request Parameters
<a name="API_CreateChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_CreateChannel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Audiences](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings  
Required: No

 ** [FillerSlate](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-FillerSlate"></a>
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the `LINEAR` `PlaybackMode`. MediaTailor doesn't support filler slate for channels using the `LOOP` `PlaybackMode`.  
Type: [SlateSource](API_SlateSource.md) object  
Required: No

 ** [Outputs](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-Outputs"></a>
The channel's output properties.  
Type: Array of [RequestOutputItem](API_RequestOutputItem.md) objects  
Required: Yes

 ** [PlaybackMode](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-PlaybackMode"></a>
The type of playback mode to use for this channel.  
 `LINEAR` - The programs in the schedule play once back-to-back in the schedule.  
 `LOOP` - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.  
Type: String  
Valid Values: `LOOP | LINEAR`   
Required: Yes

 ** [tags](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-tags"></a>
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: No

 ** [Tier](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-Tier"></a>
The tier of the channel.  
Type: String  
Valid Values: `BASIC | STANDARD`   
Required: No

 ** [TimeShiftConfiguration](#API_CreateChannel_RequestSyntax) **   <a name="mediatailor-CreateChannel-request-TimeShiftConfiguration"></a>
 The time-shifted viewing configuration you want to associate to the channel.   
Type: [TimeShiftConfiguration](API_TimeShiftConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_CreateChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Audiences": [ "string" ],
   "ChannelName": "string",
   "ChannelState": "string",
   "CreationTime": number,
   "FillerSlate": { 
      "SourceLocationName": "string",
      "VodSourceName": "string"
   },
   "LastModifiedTime": number,
   "Outputs": [ 
      { 
         "DashPlaylistSettings": { 
            "ManifestWindowSeconds": number,
            "MinBufferTimeSeconds": number,
            "MinUpdatePeriodSeconds": number,
            "SuggestedPresentationDelaySeconds": number
         },
         "HlsPlaylistSettings": { 
            "AdMarkupType": [ "string" ],
            "ManifestWindowSeconds": number
         },
         "ManifestName": "string",
         "PlaybackUrl": "string",
         "SourceGroup": "string"
      }
   ],
   "PlaybackMode": "string",
   "tags": { 
      "string" : "string" 
   },
   "Tier": "string",
   "TimeShiftConfiguration": { 
      "MaxTimeDelaySeconds": number
   }
}
```

## Response Elements
<a name="API_CreateChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-Arn"></a>
The Amazon Resource Name (ARN) to assign to the channel.  
Type: String

 ** [Audiences](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings

 ** [ChannelName](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-ChannelName"></a>
The name to assign to the channel.  
Type: String

 ** [ChannelState](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-ChannelState"></a>
Indicates whether the channel is in a running state or not.  
Type: String  
Valid Values: `RUNNING | STOPPED` 

 ** [CreationTime](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-CreationTime"></a>
The timestamp of when the channel was created.  
Type: Timestamp

 ** [FillerSlate](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-FillerSlate"></a>
Contains information about the slate used to fill gaps between programs in the schedule.  
Type: [SlateSource](API_SlateSource.md) object

 ** [LastModifiedTime](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-LastModifiedTime"></a>
The timestamp of when the channel was last modified.  
Type: Timestamp

 ** [Outputs](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-Outputs"></a>
The output properties to assign to the channel.  
Type: Array of [ResponseOutputItem](API_ResponseOutputItem.md) objects

 ** [PlaybackMode](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-PlaybackMode"></a>
The playback mode to assign to the channel.  
Type: String

 ** [tags](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-tags"></a>
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [Tier](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-Tier"></a>
The tier of the channel.  
Type: String

 ** [TimeShiftConfiguration](#API_CreateChannel_ResponseSyntax) **   <a name="mediatailor-CreateChannel-response-TimeShiftConfiguration"></a>
 The time-shifted viewing configuration assigned to the channel.   
Type: [TimeShiftConfiguration](API_TimeShiftConfiguration.md) object

## Errors
<a name="API_CreateChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreateChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreateChannel) 

# CreateLiveSource
<a name="API_CreateLiveSource"></a>

The live source configuration.

## Request Syntax
<a name="API_CreateLiveSource_RequestSyntax"></a>

```
POST /sourceLocation/SourceLocationName/liveSource/LiveSourceName HTTP/1.1
Content-type: application/json

{
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateLiveSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [LiveSourceName](#API_CreateLiveSource_RequestSyntax) **   <a name="mediatailor-CreateLiveSource-request-uri-LiveSourceName"></a>
The name of the live source.  
Required: Yes

 ** [SourceLocationName](#API_CreateLiveSource_RequestSyntax) **   <a name="mediatailor-CreateLiveSource-request-uri-SourceLocationName"></a>
The name of the source location.  
Required: Yes

## Request Body
<a name="API_CreateLiveSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HttpPackageConfigurations](#API_CreateLiveSource_RequestSyntax) **   <a name="mediatailor-CreateLiveSource-request-HttpPackageConfigurations"></a>
A list of HTTP package configuration parameters for this live source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

 ** [tags](#API_CreateLiveSource_RequestSyntax) **   <a name="mediatailor-CreateLiveSource-request-tags"></a>
The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateLiveSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "LiveSourceName": "string",
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateLiveSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-Arn"></a>
The ARN to assign to the live source.  
Type: String

 ** [CreationTime](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-CreationTime"></a>
The time the live source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-HttpPackageConfigurations"></a>
A list of HTTP package configuration parameters for this live source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-LastModifiedTime"></a>
The time the live source was last modified.  
Type: Timestamp

 ** [LiveSourceName](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-LiveSourceName"></a>
The name to assign to the live source.  
Type: String

 ** [SourceLocationName](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-SourceLocationName"></a>
The name to assign to the source location of the live source.  
Type: String

 ** [tags](#API_CreateLiveSource_ResponseSyntax) **   <a name="mediatailor-CreateLiveSource-response-tags"></a>
The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_CreateLiveSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateLiveSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreateLiveSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreateLiveSource) 

# CreatePrefetchSchedule
<a name="API_CreatePrefetchSchedule"></a>

Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching](https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_CreatePrefetchSchedule_RequestSyntax"></a>

```
POST /prefetchSchedule/PlaybackConfigurationName/Name HTTP/1.1
Content-type: application/json

{
   "Consumption": { 
      "AvailMatchingCriteria": [ 
         { 
            "DynamicVariable": "string",
            "Operator": "string"
         }
      ],
      "EndTime": number,
      "StartTime": number
   },
   "RecurringPrefetchConfiguration": { 
      "EndTime": number,
      "RecurringConsumption": { 
         "AvailMatchingCriteria": [ 
            { 
               "DynamicVariable": "string",
               "Operator": "string"
            }
         ],
         "RetrievedAdExpirationSeconds": number
      },
      "RecurringRetrieval": { 
         "DelayAfterAvailEndSeconds": number,
         "DynamicVariables": { 
            "string" : "string" 
         },
         "TrafficShapingRetrievalWindow": { 
            "RetrievalWindowDurationSeconds": number
         },
         "TrafficShapingType": "string"
      },
      "StartTime": number
   },
   "Retrieval": { 
      "DynamicVariables": { 
         "string" : "string" 
      },
      "EndTime": number,
      "StartTime": number,
      "TrafficShapingRetrievalWindow": { 
         "RetrievalWindowDurationSeconds": number
      },
      "TrafficShapingType": "string"
   },
   "ScheduleType": "string",
   "StreamId": "string"
}
```

## URI Request Parameters
<a name="API_CreatePrefetchSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-uri-Name"></a>
The name to assign to the schedule request.  
Required: Yes

 ** [PlaybackConfigurationName](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-uri-PlaybackConfigurationName"></a>
The name to assign to the playback configuration.  
Required: Yes

## Request Body
<a name="API_CreatePrefetchSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Consumption](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-Consumption"></a>
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the *consumption window*. Prefetch schedules automatically expire no earlier than seven days after the end time.  
Type: [PrefetchConsumption](API_PrefetchConsumption.md) object  
Required: No

 ** [RecurringPrefetchConfiguration](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-RecurringPrefetchConfiguration"></a>
The configuration that defines how and when MediaTailor performs ad prefetching in a live event.  
Type: [RecurringPrefetchConfiguration](API_RecurringPrefetchConfiguration.md) object  
Required: No

 ** [Retrieval](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-Retrieval"></a>
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.  
Type: [PrefetchRetrieval](API_PrefetchRetrieval.md) object  
Required: No

 ** [ScheduleType](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-ScheduleType"></a>
The frequency that MediaTailor creates prefetch schedules. `SINGLE` indicates that this schedule applies to one ad break. `RECURRING` indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.  
For more information about the prefetch types and when you might use each, see [Prefetching ads in AWS Elemental MediaTailor.](https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html)   
Type: String  
Valid Values: `SINGLE | RECURRING`   
Required: No

 ** [StreamId](#API_CreatePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-request-StreamId"></a>
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If `StreamId` is specified, MediaTailor returns all of the prefetch schedules with an exact match on `StreamId`. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of `StreamId`.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreatePrefetchSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Consumption": { 
      "AvailMatchingCriteria": [ 
         { 
            "DynamicVariable": "string",
            "Operator": "string"
         }
      ],
      "EndTime": number,
      "StartTime": number
   },
   "Name": "string",
   "PlaybackConfigurationName": "string",
   "RecurringPrefetchConfiguration": { 
      "EndTime": number,
      "RecurringConsumption": { 
         "AvailMatchingCriteria": [ 
            { 
               "DynamicVariable": "string",
               "Operator": "string"
            }
         ],
         "RetrievedAdExpirationSeconds": number
      },
      "RecurringRetrieval": { 
         "DelayAfterAvailEndSeconds": number,
         "DynamicVariables": { 
            "string" : "string" 
         },
         "TrafficShapingRetrievalWindow": { 
            "RetrievalWindowDurationSeconds": number
         },
         "TrafficShapingType": "string"
      },
      "StartTime": number
   },
   "Retrieval": { 
      "DynamicVariables": { 
         "string" : "string" 
      },
      "EndTime": number,
      "StartTime": number,
      "TrafficShapingRetrievalWindow": { 
         "RetrievalWindowDurationSeconds": number
      },
      "TrafficShapingType": "string"
   },
   "ScheduleType": "string",
   "StreamId": "string"
}
```

## Response Elements
<a name="API_CreatePrefetchSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-Arn"></a>
The ARN to assign to the prefetch schedule.  
Type: String

 ** [Consumption](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-Consumption"></a>
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the *consumption window*. Prefetch schedules automatically expire no earlier than seven days after the end time.  
Type: [PrefetchConsumption](API_PrefetchConsumption.md) object

 ** [Name](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-Name"></a>
The name to assign to the prefetch schedule.  
Type: String

 ** [PlaybackConfigurationName](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-PlaybackConfigurationName"></a>
The name to assign to the playback configuration.  
Type: String

 ** [RecurringPrefetchConfiguration](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-RecurringPrefetchConfiguration"></a>
The configuration that defines how MediaTailor performs recurring prefetch.   
Type: [RecurringPrefetchConfiguration](API_RecurringPrefetchConfiguration.md) object

 ** [Retrieval](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-Retrieval"></a>
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.  
Type: [PrefetchRetrieval](API_PrefetchRetrieval.md) object

 ** [ScheduleType](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-ScheduleType"></a>
The frequency that MediaTailor creates prefetch schedules. `SINGLE` indicates that this schedule applies to one ad break. `RECURRING` indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.  
Type: String  
Valid Values: `SINGLE | RECURRING` 

 ** [StreamId](#API_CreatePrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-CreatePrefetchSchedule-response-StreamId"></a>
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If `StreamId` is specified, MediaTailor returns all of the prefetch schedules with an exact match on `StreamId`. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of `StreamId`.  
Type: String

## Errors
<a name="API_CreatePrefetchSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreatePrefetchSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreatePrefetchSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreatePrefetchSchedule) 

# CreateProgram
<a name="API_CreateProgram"></a>

Creates a program within a channel. For information about programs, see [Working with programs](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_CreateProgram_RequestSyntax"></a>

```
POST /channel/ChannelName/program/ProgramName HTTP/1.1
Content-type: application/json

{
   "AdBreaks": [ 
      { 
         "AdBreakMetadata": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "MessageType": "string",
         "OffsetMillis": number,
         "Slate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "SpliceInsertMessage": { 
            "AvailNum": number,
            "AvailsExpected": number,
            "SpliceEventId": number,
            "UniqueProgramId": number
         },
         "TimeSignalMessage": { 
            "SegmentationDescriptors": [ 
               { 
                  "SegmentationEventId": number,
                  "SegmentationTypeId": number,
                  "SegmentationUpid": "string",
                  "SegmentationUpidType": number,
                  "SegmentNum": number,
                  "SegmentsExpected": number,
                  "SubSegmentNum": number,
                  "SubSegmentsExpected": number
               }
            ]
         }
      }
   ],
   "AudienceMedia": [ 
      { 
         "AlternateMedia": [ 
            { 
               "AdBreaks": [ 
                  { 
                     "AdBreakMetadata": [ 
                        { 
                           "Key": "string",
                           "Value": "string"
                        }
                     ],
                     "MessageType": "string",
                     "OffsetMillis": number,
                     "Slate": { 
                        "SourceLocationName": "string",
                        "VodSourceName": "string"
                     },
                     "SpliceInsertMessage": { 
                        "AvailNum": number,
                        "AvailsExpected": number,
                        "SpliceEventId": number,
                        "UniqueProgramId": number
                     },
                     "TimeSignalMessage": { 
                        "SegmentationDescriptors": [ 
                           { 
                              "SegmentationEventId": number,
                              "SegmentationTypeId": number,
                              "SegmentationUpid": "string",
                              "SegmentationUpidType": number,
                              "SegmentNum": number,
                              "SegmentsExpected": number,
                              "SubSegmentNum": number,
                              "SubSegmentsExpected": number
                           }
                        ]
                     }
                  }
               ],
               "ClipRange": { 
                  "EndOffsetMillis": number,
                  "StartOffsetMillis": number
               },
               "DurationMillis": number,
               "LiveSourceName": "string",
               "ScheduledStartTimeMillis": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "Audience": "string"
      }
   ],
   "LiveSourceName": "string",
   "ScheduleConfiguration": { 
      "ClipRange": { 
         "EndOffsetMillis": number,
         "StartOffsetMillis": number
      },
      "Transition": { 
         "DurationMillis": number,
         "RelativePosition": "string",
         "RelativeProgram": "string",
         "ScheduledStartTimeMillis": number,
         "Type": "string"
      }
   },
   "SourceLocationName": "string",
   "VodSourceName": "string"
}
```

## URI Request Parameters
<a name="API_CreateProgram_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-uri-ChannelName"></a>
The name of the channel for this Program.  
Required: Yes

 ** [ProgramName](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-uri-ProgramName"></a>
The name of the Program.  
Required: Yes

## Request Body
<a name="API_CreateProgram_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdBreaks](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-AdBreaks"></a>
The ad break configuration settings.  
Type: Array of [AdBreak](API_AdBreak.md) objects  
Required: No

 ** [AudienceMedia](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-AudienceMedia"></a>
The list of AudienceMedia defined in program.  
Type: Array of [AudienceMedia](API_AudienceMedia.md) objects  
Required: No

 ** [LiveSourceName](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-LiveSourceName"></a>
The name of the LiveSource for this Program.  
Type: String  
Required: No

 ** [ScheduleConfiguration](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-ScheduleConfiguration"></a>
The schedule configuration settings.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object  
Required: Yes

 ** [SourceLocationName](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-SourceLocationName"></a>
The name of the source location.  
Type: String  
Required: Yes

 ** [VodSourceName](#API_CreateProgram_RequestSyntax) **   <a name="mediatailor-CreateProgram-request-VodSourceName"></a>
The name that's used to refer to a VOD source.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateProgram_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdBreaks": [ 
      { 
         "AdBreakMetadata": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "MessageType": "string",
         "OffsetMillis": number,
         "Slate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "SpliceInsertMessage": { 
            "AvailNum": number,
            "AvailsExpected": number,
            "SpliceEventId": number,
            "UniqueProgramId": number
         },
         "TimeSignalMessage": { 
            "SegmentationDescriptors": [ 
               { 
                  "SegmentationEventId": number,
                  "SegmentationTypeId": number,
                  "SegmentationUpid": "string",
                  "SegmentationUpidType": number,
                  "SegmentNum": number,
                  "SegmentsExpected": number,
                  "SubSegmentNum": number,
                  "SubSegmentsExpected": number
               }
            ]
         }
      }
   ],
   "Arn": "string",
   "AudienceMedia": [ 
      { 
         "AlternateMedia": [ 
            { 
               "AdBreaks": [ 
                  { 
                     "AdBreakMetadata": [ 
                        { 
                           "Key": "string",
                           "Value": "string"
                        }
                     ],
                     "MessageType": "string",
                     "OffsetMillis": number,
                     "Slate": { 
                        "SourceLocationName": "string",
                        "VodSourceName": "string"
                     },
                     "SpliceInsertMessage": { 
                        "AvailNum": number,
                        "AvailsExpected": number,
                        "SpliceEventId": number,
                        "UniqueProgramId": number
                     },
                     "TimeSignalMessage": { 
                        "SegmentationDescriptors": [ 
                           { 
                              "SegmentationEventId": number,
                              "SegmentationTypeId": number,
                              "SegmentationUpid": "string",
                              "SegmentationUpidType": number,
                              "SegmentNum": number,
                              "SegmentsExpected": number,
                              "SubSegmentNum": number,
                              "SubSegmentsExpected": number
                           }
                        ]
                     }
                  }
               ],
               "ClipRange": { 
                  "EndOffsetMillis": number,
                  "StartOffsetMillis": number
               },
               "DurationMillis": number,
               "LiveSourceName": "string",
               "ScheduledStartTimeMillis": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "Audience": "string"
      }
   ],
   "ChannelName": "string",
   "ClipRange": { 
      "EndOffsetMillis": number,
      "StartOffsetMillis": number
   },
   "CreationTime": number,
   "DurationMillis": number,
   "LiveSourceName": "string",
   "ProgramName": "string",
   "ScheduledStartTime": number,
   "SourceLocationName": "string",
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_CreateProgram_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdBreaks](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-AdBreaks"></a>
The ad break configuration settings.  
Type: Array of [AdBreak](API_AdBreak.md) objects

 ** [Arn](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-Arn"></a>
The ARN to assign to the program.  
Type: String

 ** [AudienceMedia](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-AudienceMedia"></a>
The list of AudienceMedia defined in program.  
Type: Array of [AudienceMedia](API_AudienceMedia.md) objects

 ** [ChannelName](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-ChannelName"></a>
The name to assign to the channel for this program.  
Type: String

 ** [ClipRange](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-ClipRange"></a>
The clip range configuration settings.  
Type: [ClipRange](API_ClipRange.md) object

 ** [CreationTime](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-CreationTime"></a>
The time the program was created.  
Type: Timestamp

 ** [DurationMillis](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-DurationMillis"></a>
The duration of the live program in milliseconds.  
Type: Long

 ** [LiveSourceName](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-LiveSourceName"></a>
The name of the LiveSource for this Program.  
Type: String

 ** [ProgramName](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-ProgramName"></a>
The name to assign to this program.  
Type: String

 ** [ScheduledStartTime](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-ScheduledStartTime"></a>
The scheduled start time for this Program.  
Type: Timestamp

 ** [SourceLocationName](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-SourceLocationName"></a>
The name to assign to the source location for this program.  
Type: String

 ** [VodSourceName](#API_CreateProgram_ResponseSyntax) **   <a name="mediatailor-CreateProgram-response-VodSourceName"></a>
The name that's used to refer to a VOD source.  
Type: String

## Errors
<a name="API_CreateProgram_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateProgram_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreateProgram) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreateProgram) 

# CreateSourceLocation
<a name="API_CreateSourceLocation"></a>

Creates a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_CreateSourceLocation_RequestSyntax"></a>

```
POST /sourceLocation/SourceLocationName HTTP/1.1
Content-type: application/json

{
   "AccessConfiguration": { 
      "AccessType": "string",
      "SecretsManagerAccessTokenConfiguration": { 
         "HeaderName": "string",
         "SecretArn": "string",
         "SecretStringKey": "string"
      }
   },
   "DefaultSegmentDeliveryConfiguration": { 
      "BaseUrl": "string"
   },
   "HttpConfiguration": { 
      "BaseUrl": "string"
   },
   "SegmentDeliveryConfigurations": [ 
      { 
         "BaseUrl": "string",
         "Name": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateSourceLocation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-uri-SourceLocationName"></a>
The name associated with the source location.  
Required: Yes

## Request Body
<a name="API_CreateSourceLocation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AccessConfiguration](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-AccessConfiguration"></a>
Access configuration parameters. Configures the type of authentication used to access content from your source location.  
Type: [AccessConfiguration](API_AccessConfiguration.md) object  
Required: No

 ** [DefaultSegmentDeliveryConfiguration](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-DefaultSegmentDeliveryConfiguration"></a>
The optional configuration for the server that serves segments.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object  
Required: No

 ** [HttpConfiguration](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-HttpConfiguration"></a>
The source's HTTP package configurations.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object  
Required: Yes

 ** [SegmentDeliveryConfigurations](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-SegmentDeliveryConfigurations"></a>
A list of the segment delivery configurations associated with this resource.  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects  
Required: No

 ** [tags](#API_CreateSourceLocation_RequestSyntax) **   <a name="mediatailor-CreateSourceLocation-request-tags"></a>
The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateSourceLocation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AccessConfiguration": { 
      "AccessType": "string",
      "SecretsManagerAccessTokenConfiguration": { 
         "HeaderName": "string",
         "SecretArn": "string",
         "SecretStringKey": "string"
      }
   },
   "Arn": "string",
   "CreationTime": number,
   "DefaultSegmentDeliveryConfiguration": { 
      "BaseUrl": "string"
   },
   "HttpConfiguration": { 
      "BaseUrl": "string"
   },
   "LastModifiedTime": number,
   "SegmentDeliveryConfigurations": [ 
      { 
         "BaseUrl": "string",
         "Name": "string"
      }
   ],
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateSourceLocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessConfiguration](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-AccessConfiguration"></a>
Access configuration parameters. Configures the type of authentication used to access content from your source location.  
Type: [AccessConfiguration](API_AccessConfiguration.md) object

 ** [Arn](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-Arn"></a>
The ARN to assign to the source location.  
Type: String

 ** [CreationTime](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-CreationTime"></a>
The time the source location was created.  
Type: Timestamp

 ** [DefaultSegmentDeliveryConfiguration](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-DefaultSegmentDeliveryConfiguration"></a>
The optional configuration for the server that serves segments.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object

 ** [HttpConfiguration](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-HttpConfiguration"></a>
The source's HTTP package configurations.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object

 ** [LastModifiedTime](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-LastModifiedTime"></a>
The time the source location was last modified.  
Type: Timestamp

 ** [SegmentDeliveryConfigurations](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-SegmentDeliveryConfigurations"></a>
The segment delivery configurations for the source location. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects

 ** [SourceLocationName](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-SourceLocationName"></a>
The name to assign to the source location.  
Type: String

 ** [tags](#API_CreateSourceLocation_ResponseSyntax) **   <a name="mediatailor-CreateSourceLocation-response-tags"></a>
The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_CreateSourceLocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateSourceLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreateSourceLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreateSourceLocation) 

# CreateVodSource
<a name="API_CreateVodSource"></a>

The VOD source configuration parameters.

## Request Syntax
<a name="API_CreateVodSource_RequestSyntax"></a>

```
POST /sourceLocation/SourceLocationName/vodSource/VodSourceName HTTP/1.1
Content-type: application/json

{
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateVodSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_CreateVodSource_RequestSyntax) **   <a name="mediatailor-CreateVodSource-request-uri-SourceLocationName"></a>
The name of the source location for this VOD source.  
Required: Yes

 ** [VodSourceName](#API_CreateVodSource_RequestSyntax) **   <a name="mediatailor-CreateVodSource-request-uri-VodSourceName"></a>
The name associated with the VOD source.>  
Required: Yes

## Request Body
<a name="API_CreateVodSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HttpPackageConfigurations](#API_CreateVodSource_RequestSyntax) **   <a name="mediatailor-CreateVodSource-request-HttpPackageConfigurations"></a>
A list of HTTP package configuration parameters for this VOD source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

 ** [tags](#API_CreateVodSource_RequestSyntax) **   <a name="mediatailor-CreateVodSource-request-tags"></a>
The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateVodSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   },
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_CreateVodSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-Arn"></a>
The ARN to assign to this VOD source.  
Type: String

 ** [CreationTime](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-CreationTime"></a>
The time the VOD source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-HttpPackageConfigurations"></a>
A list of HTTP package configuration parameters for this VOD source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-LastModifiedTime"></a>
The time the VOD source was last modified.  
Type: Timestamp

 ** [SourceLocationName](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-SourceLocationName"></a>
The name to assign to the source location for this VOD source.  
Type: String

 ** [tags](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-tags"></a>
The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [VodSourceName](#API_CreateVodSource_ResponseSyntax) **   <a name="mediatailor-CreateVodSource-response-VodSourceName"></a>
The name to assign to the VOD source.  
Type: String

## Errors
<a name="API_CreateVodSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_CreateVodSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/CreateVodSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CreateVodSource) 

# DeleteChannel
<a name="API_DeleteChannel"></a>

Deletes a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DeleteChannel_RequestSyntax"></a>

```
DELETE /channel/ChannelName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_DeleteChannel_RequestSyntax) **   <a name="mediatailor-DeleteChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_DeleteChannel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteChannel) 

# DeleteChannelPolicy
<a name="API_DeleteChannelPolicy"></a>

The channel policy to delete.

## Request Syntax
<a name="API_DeleteChannelPolicy_RequestSyntax"></a>

```
DELETE /channel/ChannelName/policy HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteChannelPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_DeleteChannelPolicy_RequestSyntax) **   <a name="mediatailor-DeleteChannelPolicy-request-uri-ChannelName"></a>
The name of the channel associated with this channel policy.  
Required: Yes

## Request Body
<a name="API_DeleteChannelPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteChannelPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteChannelPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteChannelPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteChannelPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteChannelPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteChannelPolicy) 

# DeleteLiveSource
<a name="API_DeleteLiveSource"></a>

The live source to delete.

## Request Syntax
<a name="API_DeleteLiveSource_RequestSyntax"></a>

```
DELETE /sourceLocation/SourceLocationName/liveSource/LiveSourceName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteLiveSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [LiveSourceName](#API_DeleteLiveSource_RequestSyntax) **   <a name="mediatailor-DeleteLiveSource-request-uri-LiveSourceName"></a>
The name of the live source.  
Required: Yes

 ** [SourceLocationName](#API_DeleteLiveSource_RequestSyntax) **   <a name="mediatailor-DeleteLiveSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this Live Source.  
Required: Yes

## Request Body
<a name="API_DeleteLiveSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteLiveSource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteLiveSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteLiveSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteLiveSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteLiveSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteLiveSource) 

# DeletePlaybackConfiguration
<a name="API_DeletePlaybackConfiguration"></a>

Deletes a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).

## Request Syntax
<a name="API_DeletePlaybackConfiguration_RequestSyntax"></a>

```
DELETE /playbackConfiguration/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePlaybackConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_DeletePlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-DeletePlaybackConfiguration-request-uri-Name"></a>
The name of the playback configuration.  
Required: Yes

## Request Body
<a name="API_DeletePlaybackConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePlaybackConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeletePlaybackConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeletePlaybackConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeletePlaybackConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeletePlaybackConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeletePlaybackConfiguration) 

# DeletePrefetchSchedule
<a name="API_DeletePrefetchSchedule"></a>

Deletes a prefetch schedule for a specific playback configuration. If you call `DeletePrefetchSchedule` on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see [Using ad prefetching](https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DeletePrefetchSchedule_RequestSyntax"></a>

```
DELETE /prefetchSchedule/PlaybackConfigurationName/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePrefetchSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_DeletePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-DeletePrefetchSchedule-request-uri-Name"></a>
The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.  
Required: Yes

 ** [PlaybackConfigurationName](#API_DeletePrefetchSchedule_RequestSyntax) **   <a name="mediatailor-DeletePrefetchSchedule-request-uri-PlaybackConfigurationName"></a>
The name of the playback configuration for this prefetch schedule.  
Required: Yes

## Request Body
<a name="API_DeletePrefetchSchedule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePrefetchSchedule_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeletePrefetchSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeletePrefetchSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeletePrefetchSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeletePrefetchSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeletePrefetchSchedule) 

# DeleteProgram
<a name="API_DeleteProgram"></a>

Deletes a program within a channel. For information about programs, see [Working with programs](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DeleteProgram_RequestSyntax"></a>

```
DELETE /channel/ChannelName/program/ProgramName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProgram_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_DeleteProgram_RequestSyntax) **   <a name="mediatailor-DeleteProgram-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

 ** [ProgramName](#API_DeleteProgram_RequestSyntax) **   <a name="mediatailor-DeleteProgram-request-uri-ProgramName"></a>
The name of the program.  
Required: Yes

## Request Body
<a name="API_DeleteProgram_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProgram_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteProgram_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProgram_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteProgram_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteProgram) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteProgram) 

# DeleteSourceLocation
<a name="API_DeleteSourceLocation"></a>

Deletes a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DeleteSourceLocation_RequestSyntax"></a>

```
DELETE /sourceLocation/SourceLocationName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSourceLocation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_DeleteSourceLocation_RequestSyntax) **   <a name="mediatailor-DeleteSourceLocation-request-uri-SourceLocationName"></a>
The name of the source location.  
Required: Yes

## Request Body
<a name="API_DeleteSourceLocation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSourceLocation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteSourceLocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteSourceLocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteSourceLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteSourceLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteSourceLocation) 

# DeleteVodSource
<a name="API_DeleteVodSource"></a>

The video on demand (VOD) source to delete.

## Request Syntax
<a name="API_DeleteVodSource_RequestSyntax"></a>

```
DELETE /sourceLocation/SourceLocationName/vodSource/VodSourceName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteVodSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_DeleteVodSource_RequestSyntax) **   <a name="mediatailor-DeleteVodSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this VOD Source.  
Required: Yes

 ** [VodSourceName](#API_DeleteVodSource_RequestSyntax) **   <a name="mediatailor-DeleteVodSource-request-uri-VodSourceName"></a>
The name of the VOD source.  
Required: Yes

## Request Body
<a name="API_DeleteVodSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteVodSource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteVodSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteVodSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DeleteVodSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DeleteVodSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DeleteVodSource) 

# DescribeChannel
<a name="API_DescribeChannel"></a>

Describes a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DescribeChannel_RequestSyntax"></a>

```
GET /channel/ChannelName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_DescribeChannel_RequestSyntax) **   <a name="mediatailor-DescribeChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_DescribeChannel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Audiences": [ "string" ],
   "ChannelName": "string",
   "ChannelState": "string",
   "CreationTime": number,
   "FillerSlate": { 
      "SourceLocationName": "string",
      "VodSourceName": "string"
   },
   "LastModifiedTime": number,
   "LogConfiguration": { 
      "LogTypes": [ "string" ]
   },
   "Outputs": [ 
      { 
         "DashPlaylistSettings": { 
            "ManifestWindowSeconds": number,
            "MinBufferTimeSeconds": number,
            "MinUpdatePeriodSeconds": number,
            "SuggestedPresentationDelaySeconds": number
         },
         "HlsPlaylistSettings": { 
            "AdMarkupType": [ "string" ],
            "ManifestWindowSeconds": number
         },
         "ManifestName": "string",
         "PlaybackUrl": "string",
         "SourceGroup": "string"
      }
   ],
   "PlaybackMode": "string",
   "tags": { 
      "string" : "string" 
   },
   "Tier": "string",
   "TimeShiftConfiguration": { 
      "MaxTimeDelaySeconds": number
   }
}
```

## Response Elements
<a name="API_DescribeChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-Arn"></a>
The ARN of the channel.  
Type: String

 ** [Audiences](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings

 ** [ChannelName](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-ChannelName"></a>
The name of the channel.  
Type: String

 ** [ChannelState](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-ChannelState"></a>
Indicates whether the channel is in a running state or not.  
Type: String  
Valid Values: `RUNNING | STOPPED` 

 ** [CreationTime](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-CreationTime"></a>
The timestamp of when the channel was created.  
Type: Timestamp

 ** [FillerSlate](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-FillerSlate"></a>
Contains information about the slate used to fill gaps between programs in the schedule.  
Type: [SlateSource](API_SlateSource.md) object

 ** [LastModifiedTime](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-LastModifiedTime"></a>
The timestamp of when the channel was last modified.  
Type: Timestamp

 ** [LogConfiguration](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-LogConfiguration"></a>
The log configuration for the channel.  
Type: [LogConfigurationForChannel](API_LogConfigurationForChannel.md) object

 ** [Outputs](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-Outputs"></a>
The channel's output properties.  
Type: Array of [ResponseOutputItem](API_ResponseOutputItem.md) objects

 ** [PlaybackMode](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-PlaybackMode"></a>
The channel's playback mode.  
Type: String

 ** [tags](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-tags"></a>
The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [Tier](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-Tier"></a>
The channel's tier.  
Type: String

 ** [TimeShiftConfiguration](#API_DescribeChannel_ResponseSyntax) **   <a name="mediatailor-DescribeChannel-response-TimeShiftConfiguration"></a>
 The time-shifted viewing configuration for the channel.   
Type: [TimeShiftConfiguration](API_TimeShiftConfiguration.md) object

## Errors
<a name="API_DescribeChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DescribeChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DescribeChannel) 

# DescribeLiveSource
<a name="API_DescribeLiveSource"></a>

The live source to describe.

## Request Syntax
<a name="API_DescribeLiveSource_RequestSyntax"></a>

```
GET /sourceLocation/SourceLocationName/liveSource/LiveSourceName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeLiveSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [LiveSourceName](#API_DescribeLiveSource_RequestSyntax) **   <a name="mediatailor-DescribeLiveSource-request-uri-LiveSourceName"></a>
The name of the live source.  
Required: Yes

 ** [SourceLocationName](#API_DescribeLiveSource_RequestSyntax) **   <a name="mediatailor-DescribeLiveSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this Live Source.  
Required: Yes

## Request Body
<a name="API_DescribeLiveSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeLiveSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "LiveSourceName": "string",
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_DescribeLiveSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-Arn"></a>
The ARN of the live source.  
Type: String

 ** [CreationTime](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-CreationTime"></a>
The timestamp that indicates when the live source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-HttpPackageConfigurations"></a>
The HTTP package configurations.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-LastModifiedTime"></a>
The timestamp that indicates when the live source was modified.  
Type: Timestamp

 ** [LiveSourceName](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-LiveSourceName"></a>
The name of the live source.  
Type: String

 ** [SourceLocationName](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-SourceLocationName"></a>
The name of the source location associated with the live source.  
Type: String

 ** [tags](#API_DescribeLiveSource_ResponseSyntax) **   <a name="mediatailor-DescribeLiveSource-response-tags"></a>
The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_DescribeLiveSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeLiveSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DescribeLiveSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DescribeLiveSource) 

# DescribeProgram
<a name="API_DescribeProgram"></a>

Describes a program within a channel. For information about programs, see [Working with programs](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DescribeProgram_RequestSyntax"></a>

```
GET /channel/ChannelName/program/ProgramName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeProgram_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_DescribeProgram_RequestSyntax) **   <a name="mediatailor-DescribeProgram-request-uri-ChannelName"></a>
The name of the channel associated with this Program.  
Required: Yes

 ** [ProgramName](#API_DescribeProgram_RequestSyntax) **   <a name="mediatailor-DescribeProgram-request-uri-ProgramName"></a>
The name of the program.  
Required: Yes

## Request Body
<a name="API_DescribeProgram_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeProgram_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdBreaks": [ 
      { 
         "AdBreakMetadata": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "MessageType": "string",
         "OffsetMillis": number,
         "Slate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "SpliceInsertMessage": { 
            "AvailNum": number,
            "AvailsExpected": number,
            "SpliceEventId": number,
            "UniqueProgramId": number
         },
         "TimeSignalMessage": { 
            "SegmentationDescriptors": [ 
               { 
                  "SegmentationEventId": number,
                  "SegmentationTypeId": number,
                  "SegmentationUpid": "string",
                  "SegmentationUpidType": number,
                  "SegmentNum": number,
                  "SegmentsExpected": number,
                  "SubSegmentNum": number,
                  "SubSegmentsExpected": number
               }
            ]
         }
      }
   ],
   "Arn": "string",
   "AudienceMedia": [ 
      { 
         "AlternateMedia": [ 
            { 
               "AdBreaks": [ 
                  { 
                     "AdBreakMetadata": [ 
                        { 
                           "Key": "string",
                           "Value": "string"
                        }
                     ],
                     "MessageType": "string",
                     "OffsetMillis": number,
                     "Slate": { 
                        "SourceLocationName": "string",
                        "VodSourceName": "string"
                     },
                     "SpliceInsertMessage": { 
                        "AvailNum": number,
                        "AvailsExpected": number,
                        "SpliceEventId": number,
                        "UniqueProgramId": number
                     },
                     "TimeSignalMessage": { 
                        "SegmentationDescriptors": [ 
                           { 
                              "SegmentationEventId": number,
                              "SegmentationTypeId": number,
                              "SegmentationUpid": "string",
                              "SegmentationUpidType": number,
                              "SegmentNum": number,
                              "SegmentsExpected": number,
                              "SubSegmentNum": number,
                              "SubSegmentsExpected": number
                           }
                        ]
                     }
                  }
               ],
               "ClipRange": { 
                  "EndOffsetMillis": number,
                  "StartOffsetMillis": number
               },
               "DurationMillis": number,
               "LiveSourceName": "string",
               "ScheduledStartTimeMillis": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "Audience": "string"
      }
   ],
   "ChannelName": "string",
   "ClipRange": { 
      "EndOffsetMillis": number,
      "StartOffsetMillis": number
   },
   "CreationTime": number,
   "DurationMillis": number,
   "LiveSourceName": "string",
   "ProgramName": "string",
   "ScheduledStartTime": number,
   "SourceLocationName": "string",
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_DescribeProgram_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdBreaks](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-AdBreaks"></a>
The ad break configuration settings.  
Type: Array of [AdBreak](API_AdBreak.md) objects

 ** [Arn](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-Arn"></a>
The ARN of the program.  
Type: String

 ** [AudienceMedia](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-AudienceMedia"></a>
The list of AudienceMedia defined in program.  
Type: Array of [AudienceMedia](API_AudienceMedia.md) objects

 ** [ChannelName](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-ChannelName"></a>
The name of the channel that the program belongs to.  
Type: String

 ** [ClipRange](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-ClipRange"></a>
The clip range configuration settings.  
Type: [ClipRange](API_ClipRange.md) object

 ** [CreationTime](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-CreationTime"></a>
The timestamp of when the program was created.  
Type: Timestamp

 ** [DurationMillis](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-DurationMillis"></a>
The duration of the live program in milliseconds.  
Type: Long

 ** [LiveSourceName](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-LiveSourceName"></a>
The name of the LiveSource for this Program.  
Type: String

 ** [ProgramName](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-ProgramName"></a>
The name of the program.  
Type: String

 ** [ScheduledStartTime](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-ScheduledStartTime"></a>
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.  
Type: Timestamp

 ** [SourceLocationName](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-SourceLocationName"></a>
The source location name.  
Type: String

 ** [VodSourceName](#API_DescribeProgram_ResponseSyntax) **   <a name="mediatailor-DescribeProgram-response-VodSourceName"></a>
The name that's used to refer to a VOD source.  
Type: String

## Errors
<a name="API_DescribeProgram_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeProgram_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DescribeProgram) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DescribeProgram) 

# DescribeSourceLocation
<a name="API_DescribeSourceLocation"></a>

Describes a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_DescribeSourceLocation_RequestSyntax"></a>

```
GET /sourceLocation/SourceLocationName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeSourceLocation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_DescribeSourceLocation_RequestSyntax) **   <a name="mediatailor-DescribeSourceLocation-request-uri-SourceLocationName"></a>
The name of the source location.  
Required: Yes

## Request Body
<a name="API_DescribeSourceLocation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeSourceLocation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AccessConfiguration": { 
      "AccessType": "string",
      "SecretsManagerAccessTokenConfiguration": { 
         "HeaderName": "string",
         "SecretArn": "string",
         "SecretStringKey": "string"
      }
   },
   "Arn": "string",
   "CreationTime": number,
   "DefaultSegmentDeliveryConfiguration": { 
      "BaseUrl": "string"
   },
   "HttpConfiguration": { 
      "BaseUrl": "string"
   },
   "LastModifiedTime": number,
   "SegmentDeliveryConfigurations": [ 
      { 
         "BaseUrl": "string",
         "Name": "string"
      }
   ],
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_DescribeSourceLocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessConfiguration](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-AccessConfiguration"></a>
The access configuration for the source location.  
Type: [AccessConfiguration](API_AccessConfiguration.md) object

 ** [Arn](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-Arn"></a>
The ARN of the source location.  
Type: String

 ** [CreationTime](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-CreationTime"></a>
The timestamp that indicates when the source location was created.  
Type: Timestamp

 ** [DefaultSegmentDeliveryConfiguration](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-DefaultSegmentDeliveryConfiguration"></a>
The default segment delivery configuration settings.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object

 ** [HttpConfiguration](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-HttpConfiguration"></a>
The HTTP package configuration settings for the source location.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object

 ** [LastModifiedTime](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-LastModifiedTime"></a>
The timestamp that indicates when the source location was last modified.  
Type: Timestamp

 ** [SegmentDeliveryConfigurations](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-SegmentDeliveryConfigurations"></a>
A list of the segment delivery configurations associated with this resource.  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects

 ** [SourceLocationName](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-SourceLocationName"></a>
The name of the source location.  
Type: String

 ** [tags](#API_DescribeSourceLocation_ResponseSyntax) **   <a name="mediatailor-DescribeSourceLocation-response-tags"></a>
The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_DescribeSourceLocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeSourceLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DescribeSourceLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DescribeSourceLocation) 

# DescribeVodSource
<a name="API_DescribeVodSource"></a>

Provides details about a specific video on demand (VOD) source in a specific source location.

## Request Syntax
<a name="API_DescribeVodSource_RequestSyntax"></a>

```
GET /sourceLocation/SourceLocationName/vodSource/VodSourceName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeVodSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_DescribeVodSource_RequestSyntax) **   <a name="mediatailor-DescribeVodSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this VOD Source.  
Required: Yes

 ** [VodSourceName](#API_DescribeVodSource_RequestSyntax) **   <a name="mediatailor-DescribeVodSource-request-uri-VodSourceName"></a>
The name of the VOD Source.  
Required: Yes

## Request Body
<a name="API_DescribeVodSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeVodSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdBreakOpportunities": [ 
      { 
         "OffsetMillis": number
      }
   ],
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   },
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_DescribeVodSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdBreakOpportunities](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-AdBreakOpportunities"></a>
The ad break opportunities within the VOD source.  
Type: Array of [AdBreakOpportunity](API_AdBreakOpportunity.md) objects

 ** [Arn](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-Arn"></a>
The ARN of the VOD source.  
Type: String

 ** [CreationTime](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-CreationTime"></a>
The timestamp that indicates when the VOD source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-HttpPackageConfigurations"></a>
The HTTP package configurations.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-LastModifiedTime"></a>
The last modified time of the VOD source.  
Type: Timestamp

 ** [SourceLocationName](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-SourceLocationName"></a>
The name of the source location associated with the VOD source.  
Type: String

 ** [tags](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-tags"></a>
The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [VodSourceName](#API_DescribeVodSource_ResponseSyntax) **   <a name="mediatailor-DescribeVodSource-response-VodSourceName"></a>
The name of the VOD source.  
Type: String

## Errors
<a name="API_DescribeVodSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_DescribeVodSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/DescribeVodSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DescribeVodSource) 

# GetChannelPolicy
<a name="API_GetChannelPolicy"></a>

Returns the channel's IAM policy. IAM policies are used to control access to your channel.

## Request Syntax
<a name="API_GetChannelPolicy_RequestSyntax"></a>

```
GET /channel/ChannelName/policy HTTP/1.1
```

## URI Request Parameters
<a name="API_GetChannelPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_GetChannelPolicy_RequestSyntax) **   <a name="mediatailor-GetChannelPolicy-request-uri-ChannelName"></a>
The name of the channel associated with this Channel Policy.  
Required: Yes

## Request Body
<a name="API_GetChannelPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetChannelPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Policy": "string"
}
```

## Response Elements
<a name="API_GetChannelPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Policy](#API_GetChannelPolicy_ResponseSyntax) **   <a name="mediatailor-GetChannelPolicy-response-Policy"></a>
The IAM policy for the channel. IAM policies are used to control access to your channel.  
Type: String

## Errors
<a name="API_GetChannelPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_GetChannelPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/GetChannelPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/GetChannelPolicy) 

# GetChannelSchedule
<a name="API_GetChannelSchedule"></a>

Retrieves information about your channel's schedule.

## Request Syntax
<a name="API_GetChannelSchedule_RequestSyntax"></a>

```
GET /channel/ChannelName/schedule?audience=Audience&durationMinutes=DurationMinutes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_GetChannelSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Audience](#API_GetChannelSchedule_RequestSyntax) **   <a name="mediatailor-GetChannelSchedule-request-uri-Audience"></a>
The single audience for GetChannelScheduleRequest.

 ** [ChannelName](#API_GetChannelSchedule_RequestSyntax) **   <a name="mediatailor-GetChannelSchedule-request-uri-ChannelName"></a>
The name of the channel associated with this Channel Schedule.  
Required: Yes

 ** [DurationMinutes](#API_GetChannelSchedule_RequestSyntax) **   <a name="mediatailor-GetChannelSchedule-request-uri-DurationMinutes"></a>
The duration in minutes of the channel schedule.

 ** [MaxResults](#API_GetChannelSchedule_RequestSyntax) **   <a name="mediatailor-GetChannelSchedule-request-uri-MaxResults"></a>
The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` channel schedules, use the value of `NextToken` in the response to get the next page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_GetChannelSchedule_RequestSyntax) **   <a name="mediatailor-GetChannelSchedule-request-uri-NextToken"></a>
(Optional) If the playback configuration has more than `MaxResults` channel schedules, use `NextToken` to get the second and subsequent pages of results.  
For the first `GetChannelScheduleRequest` request, omit this value.  
For the second and subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request.  
If the previous response didn't include a `NextToken` element, there are no more channel schedules to get.

## Request Body
<a name="API_GetChannelSchedule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetChannelSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ApproximateDurationSeconds": number,
         "ApproximateStartTime": number,
         "Arn": "string",
         "Audiences": [ "string" ],
         "ChannelName": "string",
         "LiveSourceName": "string",
         "ProgramName": "string",
         "ScheduleAdBreaks": [ 
            { 
               "ApproximateDurationSeconds": number,
               "ApproximateStartTime": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "ScheduleEntryType": "string",
         "SourceLocationName": "string",
         "VodSourceName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetChannelSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_GetChannelSchedule_ResponseSyntax) **   <a name="mediatailor-GetChannelSchedule-response-Items"></a>
A list of schedule entries for the channel.  
Type: Array of [ScheduleEntry](API_ScheduleEntry.md) objects

 ** [NextToken](#API_GetChannelSchedule_ResponseSyntax) **   <a name="mediatailor-GetChannelSchedule-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_GetChannelSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_GetChannelSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/GetChannelSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/GetChannelSchedule) 

# GetPlaybackConfiguration
<a name="API_GetPlaybackConfiguration"></a>

Retrieves a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).

## Request Syntax
<a name="API_GetPlaybackConfiguration_RequestSyntax"></a>

```
GET /playbackConfiguration/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPlaybackConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_GetPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-request-uri-Name"></a>
The identifier for the playback configuration.  
Required: Yes

## Request Body
<a name="API_GetPlaybackConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPlaybackConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdConditioningConfiguration": { 
      "StreamingMediaFileConditioning": "string"
   },
   "AdDecisionServerUrl": "string",
   "AvailSuppression": { 
      "FillPolicy": "string",
      "Mode": "string",
      "Value": "string"
   },
   "Bumper": { 
      "EndUrl": "string",
      "StartUrl": "string"
   },
   "CdnConfiguration": { 
      "AdSegmentUrlPrefix": "string",
      "ContentSegmentUrlPrefix": "string"
   },
   "ConfigurationAliases": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "DashConfiguration": { 
      "ManifestEndpointPrefix": "string",
      "MpdLocation": "string",
      "OriginManifestType": "string"
   },
   "HlsConfiguration": { 
      "ManifestEndpointPrefix": "string"
   },
   "InsertionMode": "string",
   "LivePreRollConfiguration": { 
      "AdDecisionServerUrl": "string",
      "MaxDurationSeconds": number
   },
   "LogConfiguration": { 
      "AdsInteractionLog": { 
         "ExcludeEventTypes": [ "string" ],
         "PublishOptInEventTypes": [ "string" ]
      },
      "EnabledLoggingStrategies": [ "string" ],
      "ManifestServiceInteractionLog": { 
         "ExcludeEventTypes": [ "string" ]
      },
      "PercentEnabled": number
   },
   "ManifestProcessingRules": { 
      "AdMarkerPassthrough": { 
         "Enabled": boolean
      }
   },
   "Name": "string",
   "PersonalizationThresholdSeconds": number,
   "PlaybackConfigurationArn": "string",
   "PlaybackEndpointPrefix": "string",
   "SessionInitializationEndpointPrefix": "string",
   "SlateAdUrl": "string",
   "tags": { 
      "string" : "string" 
   },
   "TranscodeProfileName": "string",
   "VideoContentSourceUrl": "string"
}
```

## Response Elements
<a name="API_GetPlaybackConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdConditioningConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-AdConditioningConfiguration"></a>
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.   
Type: [AdConditioningConfiguration](API_AdConditioningConfiguration.md) object

 ** [AdDecisionServerUrl](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-AdDecisionServerUrl"></a>
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.  
Type: String

 ** [AvailSuppression](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-AvailSuppression"></a>
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: [AvailSuppression](API_AvailSuppression.md) object

 ** [Bumper](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-Bumper"></a>
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).  
Type: [Bumper](API_Bumper.md) object

 ** [CdnConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-CdnConfiguration"></a>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.  
Type: [CdnConfiguration](API_CdnConfiguration.md) object

 ** [ConfigurationAliases](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-ConfigurationAliases"></a>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html).  
Type: String to string to string map map

 ** [DashConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-DashConfiguration"></a>
The configuration for DASH content.  
Type: [DashConfiguration](API_DashConfiguration.md) object

 ** [HlsConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-HlsConfiguration"></a>
The configuration for HLS content.  
Type: [HlsConfiguration](API_HlsConfiguration.md) object

 ** [InsertionMode](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-InsertionMode"></a>
The setting that controls whether players can use stitched or guided ad insertion. The default, `STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.  
Type: String  
Valid Values: `STITCHED_ONLY | PLAYER_SELECT` 

 ** [LivePreRollConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-LivePreRollConfiguration"></a>
The configuration for pre-roll ad insertion.  
Type: [LivePreRollConfiguration](API_LivePreRollConfiguration.md) object

 ** [LogConfiguration](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-LogConfiguration"></a>
The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.  
Type: [LogConfiguration](API_LogConfiguration.md) object

 ** [ManifestProcessingRules](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-ManifestProcessingRules"></a>
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.  
Type: [ManifestProcessingRules](API_ManifestProcessingRules.md) object

 ** [Name](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-Name"></a>
The identifier for the playback configuration.  
Type: String

 ** [PersonalizationThresholdSeconds](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-PersonalizationThresholdSeconds"></a>
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [PlaybackConfigurationArn](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-PlaybackConfigurationArn"></a>
The Amazon Resource Name (ARN) for the playback configuration.  
Type: String

 ** [PlaybackEndpointPrefix](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-PlaybackEndpointPrefix"></a>
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.  
Type: String

 ** [SessionInitializationEndpointPrefix](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-SessionInitializationEndpointPrefix"></a>
The URL that the player uses to initialize a session that uses client-side reporting.  
Type: String

 ** [SlateAdUrl](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-SlateAdUrl"></a>
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.  
Type: String

 ** [tags](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-tags"></a>
The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [TranscodeProfileName](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-TranscodeProfileName"></a>
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.  
Type: String

 ** [VideoContentSourceUrl](#API_GetPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-GetPlaybackConfiguration-response-VideoContentSourceUrl"></a>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.  
Type: String

## Errors
<a name="API_GetPlaybackConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_GetPlaybackConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/GetPlaybackConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/GetPlaybackConfiguration) 

# GetPrefetchSchedule
<a name="API_GetPrefetchSchedule"></a>

Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see [Using ad prefetching](https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_GetPrefetchSchedule_RequestSyntax"></a>

```
GET /prefetchSchedule/PlaybackConfigurationName/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPrefetchSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_GetPrefetchSchedule_RequestSyntax) **   <a name="mediatailor-GetPrefetchSchedule-request-uri-Name"></a>
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.  
Required: Yes

 ** [PlaybackConfigurationName](#API_GetPrefetchSchedule_RequestSyntax) **   <a name="mediatailor-GetPrefetchSchedule-request-uri-PlaybackConfigurationName"></a>
Returns information about the prefetch schedule for a specific playback configuration. If you call `GetPrefetchSchedule` on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.  
Required: Yes

## Request Body
<a name="API_GetPrefetchSchedule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPrefetchSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Consumption": { 
      "AvailMatchingCriteria": [ 
         { 
            "DynamicVariable": "string",
            "Operator": "string"
         }
      ],
      "EndTime": number,
      "StartTime": number
   },
   "Name": "string",
   "PlaybackConfigurationName": "string",
   "RecurringPrefetchConfiguration": { 
      "EndTime": number,
      "RecurringConsumption": { 
         "AvailMatchingCriteria": [ 
            { 
               "DynamicVariable": "string",
               "Operator": "string"
            }
         ],
         "RetrievedAdExpirationSeconds": number
      },
      "RecurringRetrieval": { 
         "DelayAfterAvailEndSeconds": number,
         "DynamicVariables": { 
            "string" : "string" 
         },
         "TrafficShapingRetrievalWindow": { 
            "RetrievalWindowDurationSeconds": number
         },
         "TrafficShapingType": "string"
      },
      "StartTime": number
   },
   "Retrieval": { 
      "DynamicVariables": { 
         "string" : "string" 
      },
      "EndTime": number,
      "StartTime": number,
      "TrafficShapingRetrievalWindow": { 
         "RetrievalWindowDurationSeconds": number
      },
      "TrafficShapingType": "string"
   },
   "ScheduleType": "string",
   "StreamId": "string"
}
```

## Response Elements
<a name="API_GetPrefetchSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-Arn"></a>
The Amazon Resource Name (ARN) of the prefetch schedule.  
Type: String

 ** [Consumption](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-Consumption"></a>
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the *consumption window*. Prefetch schedules automatically expire no earlier than seven days after the end time.  
Type: [PrefetchConsumption](API_PrefetchConsumption.md) object

 ** [Name](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-Name"></a>
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.  
Type: String

 ** [PlaybackConfigurationName](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-PlaybackConfigurationName"></a>
The name of the playback configuration to create the prefetch schedule for.  
Type: String

 ** [RecurringPrefetchConfiguration](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-RecurringPrefetchConfiguration"></a>
The configuration that defines how and when MediaTailor performs ad prefetching in a live event.  
Type: [RecurringPrefetchConfiguration](API_RecurringPrefetchConfiguration.md) object

 ** [Retrieval](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-Retrieval"></a>
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).  
Type: [PrefetchRetrieval](API_PrefetchRetrieval.md) object

 ** [ScheduleType](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-ScheduleType"></a>
The frequency that MediaTailor creates prefetch schedules. `SINGLE` indicates that this schedule applies to one ad break. `RECURRING` indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.  
Type: String  
Valid Values: `SINGLE | RECURRING` 

 ** [StreamId](#API_GetPrefetchSchedule_ResponseSyntax) **   <a name="mediatailor-GetPrefetchSchedule-response-StreamId"></a>
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.  
Type: String

## Errors
<a name="API_GetPrefetchSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_GetPrefetchSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/GetPrefetchSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/GetPrefetchSchedule) 

# ListAlerts
<a name="API_ListAlerts"></a>

Lists the alerts that are associated with a MediaTailor channel assembly resource.

## Request Syntax
<a name="API_ListAlerts_RequestSyntax"></a>

```
GET /alerts?maxResults=MaxResults&nextToken=NextToken&resourceArn=ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAlerts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListAlerts_RequestSyntax) **   <a name="mediatailor-ListAlerts-request-uri-MaxResults"></a>
The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` alerts, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListAlerts_RequestSyntax) **   <a name="mediatailor-ListAlerts-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListAlerts` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

 ** [ResourceArn](#API_ListAlerts_RequestSyntax) **   <a name="mediatailor-ListAlerts-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Required: Yes

## Request Body
<a name="API_ListAlerts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAlerts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AlertCode": "string",
         "AlertMessage": "string",
         "Category": "string",
         "LastModifiedTime": number,
         "RelatedResourceArns": [ "string" ],
         "ResourceArn": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAlerts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListAlerts_ResponseSyntax) **   <a name="mediatailor-ListAlerts-response-Items"></a>
A list of alerts that are associated with this resource.  
Type: Array of [Alert](API_Alert.md) objects

 ** [NextToken](#API_ListAlerts_ResponseSyntax) **   <a name="mediatailor-ListAlerts-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListAlerts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListAlerts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListAlerts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListAlerts) 

# ListChannels
<a name="API_ListChannels"></a>

Retrieves information about the channels that are associated with the current AWS account.

## Request Syntax
<a name="API_ListChannels_RequestSyntax"></a>

```
GET /channels?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListChannels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListChannels_RequestSyntax) **   <a name="mediatailor-ListChannels-request-uri-MaxResults"></a>
The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` channels, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListChannels_RequestSyntax) **   <a name="mediatailor-ListChannels-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListChannels` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

## Request Body
<a name="API_ListChannels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListChannels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "Audiences": [ "string" ],
         "ChannelName": "string",
         "ChannelState": "string",
         "CreationTime": number,
         "FillerSlate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "LastModifiedTime": number,
         "LogConfiguration": { 
            "LogTypes": [ "string" ]
         },
         "Outputs": [ 
            { 
               "DashPlaylistSettings": { 
                  "ManifestWindowSeconds": number,
                  "MinBufferTimeSeconds": number,
                  "MinUpdatePeriodSeconds": number,
                  "SuggestedPresentationDelaySeconds": number
               },
               "HlsPlaylistSettings": { 
                  "AdMarkupType": [ "string" ],
                  "ManifestWindowSeconds": number
               },
               "ManifestName": "string",
               "PlaybackUrl": "string",
               "SourceGroup": "string"
            }
         ],
         "PlaybackMode": "string",
         "tags": { 
            "string" : "string" 
         },
         "Tier": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListChannels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListChannels_ResponseSyntax) **   <a name="mediatailor-ListChannels-response-Items"></a>
A list of channels that are associated with this account.  
Type: Array of [Channel](API_Channel.md) objects

 ** [NextToken](#API_ListChannels_ResponseSyntax) **   <a name="mediatailor-ListChannels-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListChannels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListChannels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListChannels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListChannels) 

# ListLiveSources
<a name="API_ListLiveSources"></a>

Lists the live sources contained in a source location. A source represents a piece of content.

## Request Syntax
<a name="API_ListLiveSources_RequestSyntax"></a>

```
GET /sourceLocation/SourceLocationName/liveSources?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListLiveSources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListLiveSources_RequestSyntax) **   <a name="mediatailor-ListLiveSources-request-uri-MaxResults"></a>
The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` live sources, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListLiveSources_RequestSyntax) **   <a name="mediatailor-ListLiveSources-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListLiveSources` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

 ** [SourceLocationName](#API_ListLiveSources_RequestSyntax) **   <a name="mediatailor-ListLiveSources-request-uri-SourceLocationName"></a>
The name of the source location associated with this Live Sources list.  
Required: Yes

## Request Body
<a name="API_ListLiveSources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListLiveSources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "HttpPackageConfigurations": [ 
            { 
               "Path": "string",
               "SourceGroup": "string",
               "Type": "string"
            }
         ],
         "LastModifiedTime": number,
         "LiveSourceName": "string",
         "SourceLocationName": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLiveSources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListLiveSources_ResponseSyntax) **   <a name="mediatailor-ListLiveSources-response-Items"></a>
Lists the live sources.  
Type: Array of [LiveSource](API_LiveSource.md) objects

 ** [NextToken](#API_ListLiveSources_ResponseSyntax) **   <a name="mediatailor-ListLiveSources-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListLiveSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListLiveSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListLiveSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListLiveSources) 

# ListPlaybackConfigurations
<a name="API_ListPlaybackConfigurations"></a>

Retrieves existing playback configurations. For information about MediaTailor configurations, see [Working with Configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).

## Request Syntax
<a name="API_ListPlaybackConfigurations_RequestSyntax"></a>

```
GET /playbackConfigurations?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPlaybackConfigurations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListPlaybackConfigurations_RequestSyntax) **   <a name="mediatailor-ListPlaybackConfigurations-request-uri-MaxResults"></a>
The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` playback configurations, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListPlaybackConfigurations_RequestSyntax) **   <a name="mediatailor-ListPlaybackConfigurations-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListPlaybackConfigurations` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

## Request Body
<a name="API_ListPlaybackConfigurations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPlaybackConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AdConditioningConfiguration": { 
            "StreamingMediaFileConditioning": "string"
         },
         "AdDecisionServerUrl": "string",
         "AvailSuppression": { 
            "FillPolicy": "string",
            "Mode": "string",
            "Value": "string"
         },
         "Bumper": { 
            "EndUrl": "string",
            "StartUrl": "string"
         },
         "CdnConfiguration": { 
            "AdSegmentUrlPrefix": "string",
            "ContentSegmentUrlPrefix": "string"
         },
         "ConfigurationAliases": { 
            "string" : { 
               "string" : "string" 
            }
         },
         "DashConfiguration": { 
            "ManifestEndpointPrefix": "string",
            "MpdLocation": "string",
            "OriginManifestType": "string"
         },
         "HlsConfiguration": { 
            "ManifestEndpointPrefix": "string"
         },
         "InsertionMode": "string",
         "LivePreRollConfiguration": { 
            "AdDecisionServerUrl": "string",
            "MaxDurationSeconds": number
         },
         "LogConfiguration": { 
            "AdsInteractionLog": { 
               "ExcludeEventTypes": [ "string" ],
               "PublishOptInEventTypes": [ "string" ]
            },
            "EnabledLoggingStrategies": [ "string" ],
            "ManifestServiceInteractionLog": { 
               "ExcludeEventTypes": [ "string" ]
            },
            "PercentEnabled": number
         },
         "ManifestProcessingRules": { 
            "AdMarkerPassthrough": { 
               "Enabled": boolean
            }
         },
         "Name": "string",
         "PersonalizationThresholdSeconds": number,
         "PlaybackConfigurationArn": "string",
         "PlaybackEndpointPrefix": "string",
         "SessionInitializationEndpointPrefix": "string",
         "SlateAdUrl": "string",
         "tags": { 
            "string" : "string" 
         },
         "TranscodeProfileName": "string",
         "VideoContentSourceUrl": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListPlaybackConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListPlaybackConfigurations_ResponseSyntax) **   <a name="mediatailor-ListPlaybackConfigurations-response-Items"></a>
Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.  
Type: Array of [PlaybackConfiguration](API_PlaybackConfiguration.md) objects

 ** [NextToken](#API_ListPlaybackConfigurations_ResponseSyntax) **   <a name="mediatailor-ListPlaybackConfigurations-response-NextToken"></a>
Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListPlaybackConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListPlaybackConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListPlaybackConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListPlaybackConfigurations) 

# ListPrefetchSchedules
<a name="API_ListPrefetchSchedules"></a>

Lists the prefetch schedules for a playback configuration.

## Request Syntax
<a name="API_ListPrefetchSchedules_RequestSyntax"></a>

```
POST /prefetchSchedule/PlaybackConfigurationName HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "ScheduleType": "string",
   "StreamId": "string"
}
```

## URI Request Parameters
<a name="API_ListPrefetchSchedules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PlaybackConfigurationName](#API_ListPrefetchSchedules_RequestSyntax) **   <a name="mediatailor-ListPrefetchSchedules-request-uri-PlaybackConfigurationName"></a>
Retrieves the prefetch schedule(s) for a specific playback configuration.  
Required: Yes

## Request Body
<a name="API_ListPrefetchSchedules_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListPrefetchSchedules_RequestSyntax) **   <a name="mediatailor-ListPrefetchSchedules-request-MaxResults"></a>
The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` prefetch schedules, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListPrefetchSchedules_RequestSyntax) **   <a name="mediatailor-ListPrefetchSchedules-request-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListPrefetchSchedules` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.  
Type: String  
Required: No

 ** [ScheduleType](#API_ListPrefetchSchedules_RequestSyntax) **   <a name="mediatailor-ListPrefetchSchedules-request-ScheduleType"></a>
The type of prefetch schedules that you want to list. `SINGLE` indicates that you want to list the configured single prefetch schedules. `RECURRING` indicates that you want to list the configured recurring prefetch schedules. `ALL` indicates that you want to list all configured prefetch schedules.  
Type: String  
Valid Values: `SINGLE | RECURRING | ALL`   
Required: No

 ** [StreamId](#API_ListPrefetchSchedules_RequestSyntax) **   <a name="mediatailor-ListPrefetchSchedules-request-StreamId"></a>
An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListPrefetchSchedules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "Consumption": { 
            "AvailMatchingCriteria": [ 
               { 
                  "DynamicVariable": "string",
                  "Operator": "string"
               }
            ],
            "EndTime": number,
            "StartTime": number
         },
         "Name": "string",
         "PlaybackConfigurationName": "string",
         "RecurringPrefetchConfiguration": { 
            "EndTime": number,
            "RecurringConsumption": { 
               "AvailMatchingCriteria": [ 
                  { 
                     "DynamicVariable": "string",
                     "Operator": "string"
                  }
               ],
               "RetrievedAdExpirationSeconds": number
            },
            "RecurringRetrieval": { 
               "DelayAfterAvailEndSeconds": number,
               "DynamicVariables": { 
                  "string" : "string" 
               },
               "TrafficShapingRetrievalWindow": { 
                  "RetrievalWindowDurationSeconds": number
               },
               "TrafficShapingType": "string"
            },
            "StartTime": number
         },
         "Retrieval": { 
            "DynamicVariables": { 
               "string" : "string" 
            },
            "EndTime": number,
            "StartTime": number,
            "TrafficShapingRetrievalWindow": { 
               "RetrievalWindowDurationSeconds": number
            },
            "TrafficShapingType": "string"
         },
         "ScheduleType": "string",
         "StreamId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListPrefetchSchedules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListPrefetchSchedules_ResponseSyntax) **   <a name="mediatailor-ListPrefetchSchedules-response-Items"></a>
Lists the prefetch schedules. An empty `Items` list doesn't mean there aren't more items to fetch, just that that page was empty.  
Type: Array of [PrefetchSchedule](API_PrefetchSchedule.md) objects

 ** [NextToken](#API_ListPrefetchSchedules_ResponseSyntax) **   <a name="mediatailor-ListPrefetchSchedules-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListPrefetchSchedules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListPrefetchSchedules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListPrefetchSchedules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListPrefetchSchedules) 

# ListSourceLocations
<a name="API_ListSourceLocations"></a>

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

## Request Syntax
<a name="API_ListSourceLocations_RequestSyntax"></a>

```
GET /sourceLocations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSourceLocations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListSourceLocations_RequestSyntax) **   <a name="mediatailor-ListSourceLocations-request-uri-MaxResults"></a>
 The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` source locations, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListSourceLocations_RequestSyntax) **   <a name="mediatailor-ListSourceLocations-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListSourceLocations` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

## Request Body
<a name="API_ListSourceLocations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSourceLocations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AccessConfiguration": { 
            "AccessType": "string",
            "SecretsManagerAccessTokenConfiguration": { 
               "HeaderName": "string",
               "SecretArn": "string",
               "SecretStringKey": "string"
            }
         },
         "Arn": "string",
         "CreationTime": number,
         "DefaultSegmentDeliveryConfiguration": { 
            "BaseUrl": "string"
         },
         "HttpConfiguration": { 
            "BaseUrl": "string"
         },
         "LastModifiedTime": number,
         "SegmentDeliveryConfigurations": [ 
            { 
               "BaseUrl": "string",
               "Name": "string"
            }
         ],
         "SourceLocationName": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListSourceLocations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListSourceLocations_ResponseSyntax) **   <a name="mediatailor-ListSourceLocations-response-Items"></a>
A list of source locations.  
Type: Array of [SourceLocation](API_SourceLocation.md) objects

 ** [NextToken](#API_ListSourceLocations_ResponseSyntax) **   <a name="mediatailor-ListSourceLocations-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListSourceLocations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListSourceLocations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListSourceLocations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListSourceLocations) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/ResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="mediatailor-ListTagsForResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) associated with this resource.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="mediatailor-ListTagsForResource-response-tags"></a>
The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
A request contains unexpected data.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListTagsForResource) 

# ListVodSources
<a name="API_ListVodSources"></a>

Lists the VOD sources contained in a source location. A source represents a piece of content.

## Request Syntax
<a name="API_ListVodSources_RequestSyntax"></a>

```
GET /sourceLocation/SourceLocationName/vodSources?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListVodSources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListVodSources_RequestSyntax) **   <a name="mediatailor-ListVodSources-request-uri-MaxResults"></a>
 The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than `MaxResults` VOD sources, use the value of `NextToken` in the response to get the next page of results.  
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than `MaxResults` items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the `NextToken` value from each response until the response no longer includes a `NextToken` value.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListVodSources_RequestSyntax) **   <a name="mediatailor-ListVodSources-request-uri-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
For the first `ListVodSources` request, omit this value. For subsequent requests, get the value of `NextToken` from the previous response and specify that value for `NextToken` in the request. Continue making requests until the response no longer includes a `NextToken` value, which indicates that all results have been retrieved.

 ** [SourceLocationName](#API_ListVodSources_RequestSyntax) **   <a name="mediatailor-ListVodSources-request-uri-SourceLocationName"></a>
The name of the source location associated with this VOD Source list.  
Required: Yes

## Request Body
<a name="API_ListVodSources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListVodSources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "HttpPackageConfigurations": [ 
            { 
               "Path": "string",
               "SourceGroup": "string",
               "Type": "string"
            }
         ],
         "LastModifiedTime": number,
         "SourceLocationName": "string",
         "tags": { 
            "string" : "string" 
         },
         "VodSourceName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListVodSources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_ListVodSources_ResponseSyntax) **   <a name="mediatailor-ListVodSources-response-Items"></a>
Lists the VOD sources.  
Type: Array of [VodSource](API_VodSource.md) objects

 ** [NextToken](#API_ListVodSources_ResponseSyntax) **   <a name="mediatailor-ListVodSources-response-NextToken"></a>
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.  
Type: String

## Errors
<a name="API_ListVodSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_ListVodSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/ListVodSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ListVodSources) 

# PutChannelPolicy
<a name="API_PutChannelPolicy"></a>

Creates an IAM policy for the channel. IAM policies are used to control access to your channel.

## Request Syntax
<a name="API_PutChannelPolicy_RequestSyntax"></a>

```
PUT /channel/ChannelName/policy HTTP/1.1
Content-type: application/json

{
   "Policy": "string"
}
```

## URI Request Parameters
<a name="API_PutChannelPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_PutChannelPolicy_RequestSyntax) **   <a name="mediatailor-PutChannelPolicy-request-uri-ChannelName"></a>
The channel name associated with this Channel Policy.  
Required: Yes

## Request Body
<a name="API_PutChannelPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Policy](#API_PutChannelPolicy_RequestSyntax) **   <a name="mediatailor-PutChannelPolicy-request-Policy"></a>
Adds an IAM role that determines the permissions of your channel.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_PutChannelPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutChannelPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutChannelPolicy_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_PutChannelPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/PutChannelPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PutChannelPolicy) 

# PutPlaybackConfiguration
<a name="API_PutPlaybackConfiguration"></a>

Creates a playback configuration. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).

## Request Syntax
<a name="API_PutPlaybackConfiguration_RequestSyntax"></a>

```
PUT /playbackConfiguration HTTP/1.1
Content-type: application/json

{
   "AdConditioningConfiguration": { 
      "StreamingMediaFileConditioning": "string"
   },
   "AdDecisionServerUrl": "string",
   "AvailSuppression": { 
      "FillPolicy": "string",
      "Mode": "string",
      "Value": "string"
   },
   "Bumper": { 
      "EndUrl": "string",
      "StartUrl": "string"
   },
   "CdnConfiguration": { 
      "AdSegmentUrlPrefix": "string",
      "ContentSegmentUrlPrefix": "string"
   },
   "ConfigurationAliases": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "DashConfiguration": { 
      "MpdLocation": "string",
      "OriginManifestType": "string"
   },
   "InsertionMode": "string",
   "LivePreRollConfiguration": { 
      "AdDecisionServerUrl": "string",
      "MaxDurationSeconds": number
   },
   "ManifestProcessingRules": { 
      "AdMarkerPassthrough": { 
         "Enabled": boolean
      }
   },
   "Name": "string",
   "PersonalizationThresholdSeconds": number,
   "SlateAdUrl": "string",
   "tags": { 
      "string" : "string" 
   },
   "TranscodeProfileName": "string",
   "VideoContentSourceUrl": "string"
}
```

## URI Request Parameters
<a name="API_PutPlaybackConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutPlaybackConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdConditioningConfiguration](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-AdConditioningConfiguration"></a>
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.   
Type: [AdConditioningConfiguration](API_AdConditioningConfiguration.md) object  
Required: No

 ** [AdDecisionServerUrl](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-AdDecisionServerUrl"></a>
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.  
Type: String  
Required: No

 ** [AvailSuppression](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-AvailSuppression"></a>
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: [AvailSuppression](API_AvailSuppression.md) object  
Required: No

 ** [Bumper](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-Bumper"></a>
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).  
Type: [Bumper](API_Bumper.md) object  
Required: No

 ** [CdnConfiguration](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-CdnConfiguration"></a>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.  
Type: [CdnConfiguration](API_CdnConfiguration.md) object  
Required: No

 ** [ConfigurationAliases](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-ConfigurationAliases"></a>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html).  
Type: String to string to string map map  
Required: No

 ** [DashConfiguration](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-DashConfiguration"></a>
The configuration for DASH content.  
Type: [DashConfigurationForPut](API_DashConfigurationForPut.md) object  
Required: No

 ** [InsertionMode](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-InsertionMode"></a>
The setting that controls whether players can use stitched or guided ad insertion. The default, `STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.  
Type: String  
Valid Values: `STITCHED_ONLY | PLAYER_SELECT`   
Required: No

 ** [LivePreRollConfiguration](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-LivePreRollConfiguration"></a>
The configuration for pre-roll ad insertion.  
Type: [LivePreRollConfiguration](API_LivePreRollConfiguration.md) object  
Required: No

 ** [ManifestProcessingRules](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-ManifestProcessingRules"></a>
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.  
Type: [ManifestProcessingRules](API_ManifestProcessingRules.md) object  
Required: No

 ** [Name](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-Name"></a>
The identifier for the playback configuration.  
Type: String  
Required: Yes

 ** [PersonalizationThresholdSeconds](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-PersonalizationThresholdSeconds"></a>
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [SlateAdUrl](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-SlateAdUrl"></a>
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.  
Type: String  
Required: No

 ** [tags](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-tags"></a>
The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: No

 ** [TranscodeProfileName](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-TranscodeProfileName"></a>
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.  
Type: String  
Required: No

 ** [VideoContentSourceUrl](#API_PutPlaybackConfiguration_RequestSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-request-VideoContentSourceUrl"></a>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.  
Type: String  
Required: No

## Response Syntax
<a name="API_PutPlaybackConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdConditioningConfiguration": { 
      "StreamingMediaFileConditioning": "string"
   },
   "AdDecisionServerUrl": "string",
   "AvailSuppression": { 
      "FillPolicy": "string",
      "Mode": "string",
      "Value": "string"
   },
   "Bumper": { 
      "EndUrl": "string",
      "StartUrl": "string"
   },
   "CdnConfiguration": { 
      "AdSegmentUrlPrefix": "string",
      "ContentSegmentUrlPrefix": "string"
   },
   "ConfigurationAliases": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "DashConfiguration": { 
      "ManifestEndpointPrefix": "string",
      "MpdLocation": "string",
      "OriginManifestType": "string"
   },
   "HlsConfiguration": { 
      "ManifestEndpointPrefix": "string"
   },
   "InsertionMode": "string",
   "LivePreRollConfiguration": { 
      "AdDecisionServerUrl": "string",
      "MaxDurationSeconds": number
   },
   "LogConfiguration": { 
      "AdsInteractionLog": { 
         "ExcludeEventTypes": [ "string" ],
         "PublishOptInEventTypes": [ "string" ]
      },
      "EnabledLoggingStrategies": [ "string" ],
      "ManifestServiceInteractionLog": { 
         "ExcludeEventTypes": [ "string" ]
      },
      "PercentEnabled": number
   },
   "ManifestProcessingRules": { 
      "AdMarkerPassthrough": { 
         "Enabled": boolean
      }
   },
   "Name": "string",
   "PersonalizationThresholdSeconds": number,
   "PlaybackConfigurationArn": "string",
   "PlaybackEndpointPrefix": "string",
   "SessionInitializationEndpointPrefix": "string",
   "SlateAdUrl": "string",
   "tags": { 
      "string" : "string" 
   },
   "TranscodeProfileName": "string",
   "VideoContentSourceUrl": "string"
}
```

## Response Elements
<a name="API_PutPlaybackConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdConditioningConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-AdConditioningConfiguration"></a>
The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.   
Type: [AdConditioningConfiguration](API_AdConditioningConfiguration.md) object

 ** [AdDecisionServerUrl](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-AdDecisionServerUrl"></a>
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.  
Type: String

 ** [AvailSuppression](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-AvailSuppression"></a>
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see [Ad Suppression](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: [AvailSuppression](API_AvailSuppression.md) object

 ** [Bumper](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-Bumper"></a>
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see [Bumpers](https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html).  
Type: [Bumper](API_Bumper.md) object

 ** [CdnConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-CdnConfiguration"></a>
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.  
Type: [CdnConfiguration](API_CdnConfiguration.md) object

 ** [ConfigurationAliases](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-ConfigurationAliases"></a>
The player parameters and aliases used as dynamic variables during session initialization. For more information, see [Domain Variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html).  
Type: String to string to string map map

 ** [DashConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-DashConfiguration"></a>
The configuration for DASH content.  
Type: [DashConfiguration](API_DashConfiguration.md) object

 ** [HlsConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-HlsConfiguration"></a>
The configuration for HLS content.  
Type: [HlsConfiguration](API_HlsConfiguration.md) object

 ** [InsertionMode](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-InsertionMode"></a>
The setting that controls whether players can use stitched or guided ad insertion. The default, `STITCHED_ONLY`, forces all player sessions to use stitched (server-side) ad insertion. Choosing `PLAYER_SELECT` allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.  
Type: String  
Valid Values: `STITCHED_ONLY | PLAYER_SELECT` 

 ** [LivePreRollConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-LivePreRollConfiguration"></a>
The configuration for pre-roll ad insertion.  
Type: [LivePreRollConfiguration](API_LivePreRollConfiguration.md) object

 ** [LogConfiguration](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-LogConfiguration"></a>
The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.  
Type: [LogConfiguration](API_LogConfiguration.md) object

 ** [ManifestProcessingRules](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-ManifestProcessingRules"></a>
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.  
Type: [ManifestProcessingRules](API_ManifestProcessingRules.md) object

 ** [Name](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-Name"></a>
The identifier for the playback configuration.  
Type: String

 ** [PersonalizationThresholdSeconds](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-PersonalizationThresholdSeconds"></a>
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to *ad replacement* in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see [Ad Behavior in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html).  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [PlaybackConfigurationArn](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-PlaybackConfigurationArn"></a>
The Amazon Resource Name (ARN) associated with the playback configuration.  
Type: String

 ** [PlaybackEndpointPrefix](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-PlaybackEndpointPrefix"></a>
The playback endpoint prefix associated with the playback configuration.  
Type: String

 ** [SessionInitializationEndpointPrefix](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-SessionInitializationEndpointPrefix"></a>
The session initialization endpoint prefix associated with the playback configuration.  
Type: String

 ** [SlateAdUrl](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-SlateAdUrl"></a>
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.  
Type: String

 ** [tags](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-tags"></a>
The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [TranscodeProfileName](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-TranscodeProfileName"></a>
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.  
Type: String

 ** [VideoContentSourceUrl](#API_PutPlaybackConfiguration_ResponseSyntax) **   <a name="mediatailor-PutPlaybackConfiguration-response-VideoContentSourceUrl"></a>
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.  
Type: String

## Errors
<a name="API_PutPlaybackConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_PutPlaybackConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/PutPlaybackConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PutPlaybackConfiguration) 

# StartChannel
<a name="API_StartChannel"></a>

Starts a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_StartChannel_RequestSyntax"></a>

```
PUT /channel/ChannelName/start HTTP/1.1
```

## URI Request Parameters
<a name="API_StartChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_StartChannel_RequestSyntax) **   <a name="mediatailor-StartChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_StartChannel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StartChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StartChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_StartChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/StartChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/StartChannel) 

# StopChannel
<a name="API_StopChannel"></a>

Stops a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_StopChannel_RequestSyntax"></a>

```
PUT /channel/ChannelName/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_StopChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_StopChannel_RequestSyntax) **   <a name="mediatailor-StopChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_StopChannel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_StopChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/StopChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/StopChannel) 

# TagResource
<a name="API_TagResource"></a>

The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="mediatailor-TagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) associated with the resource.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="mediatailor-TagResource-request-tags"></a>
The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
A request contains unexpected data.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

The resource to untag.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="mediatailor-UntagResource-request-uri-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to untag.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="mediatailor-UntagResource-request-uri-TagKeys"></a>
The tag keys associated with the resource.  
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BadRequestException **   
A request contains unexpected data.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UntagResource) 

# UpdateChannel
<a name="API_UpdateChannel"></a>

Updates a channel. For information about MediaTailor channels, see [Working with channels](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_UpdateChannel_RequestSyntax"></a>

```
PUT /channel/ChannelName HTTP/1.1
Content-type: application/json

{
   "Audiences": [ "string" ],
   "FillerSlate": { 
      "SourceLocationName": "string",
      "VodSourceName": "string"
   },
   "Outputs": [ 
      { 
         "DashPlaylistSettings": { 
            "ManifestWindowSeconds": number,
            "MinBufferTimeSeconds": number,
            "MinUpdatePeriodSeconds": number,
            "SuggestedPresentationDelaySeconds": number
         },
         "HlsPlaylistSettings": { 
            "AdMarkupType": [ "string" ],
            "ManifestWindowSeconds": number
         },
         "ManifestName": "string",
         "SourceGroup": "string"
      }
   ],
   "TimeShiftConfiguration": { 
      "MaxTimeDelaySeconds": number
   }
}
```

## URI Request Parameters
<a name="API_UpdateChannel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_UpdateChannel_RequestSyntax) **   <a name="mediatailor-UpdateChannel-request-uri-ChannelName"></a>
The name of the channel.  
Required: Yes

## Request Body
<a name="API_UpdateChannel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Audiences](#API_UpdateChannel_RequestSyntax) **   <a name="mediatailor-UpdateChannel-request-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings  
Required: No

 ** [FillerSlate](#API_UpdateChannel_RequestSyntax) **   <a name="mediatailor-UpdateChannel-request-FillerSlate"></a>
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the `LINEAR` `PlaybackMode`. MediaTailor doesn't support filler slate for channels using the `LOOP` `PlaybackMode`.  
Type: [SlateSource](API_SlateSource.md) object  
Required: No

 ** [Outputs](#API_UpdateChannel_RequestSyntax) **   <a name="mediatailor-UpdateChannel-request-Outputs"></a>
The channel's output properties.  
Type: Array of [RequestOutputItem](API_RequestOutputItem.md) objects  
Required: Yes

 ** [TimeShiftConfiguration](#API_UpdateChannel_RequestSyntax) **   <a name="mediatailor-UpdateChannel-request-TimeShiftConfiguration"></a>
 The time-shifted viewing configuration you want to associate to the channel.   
Type: [TimeShiftConfiguration](API_TimeShiftConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_UpdateChannel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Audiences": [ "string" ],
   "ChannelName": "string",
   "ChannelState": "string",
   "CreationTime": number,
   "FillerSlate": { 
      "SourceLocationName": "string",
      "VodSourceName": "string"
   },
   "LastModifiedTime": number,
   "Outputs": [ 
      { 
         "DashPlaylistSettings": { 
            "ManifestWindowSeconds": number,
            "MinBufferTimeSeconds": number,
            "MinUpdatePeriodSeconds": number,
            "SuggestedPresentationDelaySeconds": number
         },
         "HlsPlaylistSettings": { 
            "AdMarkupType": [ "string" ],
            "ManifestWindowSeconds": number
         },
         "ManifestName": "string",
         "PlaybackUrl": "string",
         "SourceGroup": "string"
      }
   ],
   "PlaybackMode": "string",
   "tags": { 
      "string" : "string" 
   },
   "Tier": "string",
   "TimeShiftConfiguration": { 
      "MaxTimeDelaySeconds": number
   }
}
```

## Response Elements
<a name="API_UpdateChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-Arn"></a>
The Amazon Resource Name (ARN) associated with the channel.  
Type: String

 ** [Audiences](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings

 ** [ChannelName](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-ChannelName"></a>
The name of the channel.  
Type: String

 ** [ChannelState](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-ChannelState"></a>
Returns the state whether the channel is running or not.  
Type: String  
Valid Values: `RUNNING | STOPPED` 

 ** [CreationTime](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-CreationTime"></a>
The timestamp of when the channel was created.  
Type: Timestamp

 ** [FillerSlate](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-FillerSlate"></a>
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the `LINEAR` `PlaybackMode`. MediaTailor doesn't support filler slate for channels using the `LOOP` `PlaybackMode`.  
Type: [SlateSource](API_SlateSource.md) object

 ** [LastModifiedTime](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-LastModifiedTime"></a>
The timestamp that indicates when the channel was last modified.  
Type: Timestamp

 ** [Outputs](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-Outputs"></a>
The channel's output properties.  
Type: Array of [ResponseOutputItem](API_ResponseOutputItem.md) objects

 ** [PlaybackMode](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-PlaybackMode"></a>
The type of playback mode for this channel.  
 `LINEAR` - Programs play back-to-back only once.  
 `LOOP` - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.  
Type: String

 ** [tags](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-tags"></a>
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [Tier](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-Tier"></a>
The tier associated with this Channel.  
Type: String

 ** [TimeShiftConfiguration](#API_UpdateChannel_ResponseSyntax) **   <a name="mediatailor-UpdateChannel-response-TimeShiftConfiguration"></a>
 The time-shifted viewing configuration for the channel.   
Type: [TimeShiftConfiguration](API_TimeShiftConfiguration.md) object

## Errors
<a name="API_UpdateChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UpdateChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateChannel) 

# UpdateLiveSource
<a name="API_UpdateLiveSource"></a>

Updates a live source's configuration.

## Request Syntax
<a name="API_UpdateLiveSource_RequestSyntax"></a>

```
PUT /sourceLocation/SourceLocationName/liveSource/LiveSourceName HTTP/1.1
Content-type: application/json

{
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateLiveSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [LiveSourceName](#API_UpdateLiveSource_RequestSyntax) **   <a name="mediatailor-UpdateLiveSource-request-uri-LiveSourceName"></a>
The name of the live source.  
Required: Yes

 ** [SourceLocationName](#API_UpdateLiveSource_RequestSyntax) **   <a name="mediatailor-UpdateLiveSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this Live Source.  
Required: Yes

## Request Body
<a name="API_UpdateLiveSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HttpPackageConfigurations](#API_UpdateLiveSource_RequestSyntax) **   <a name="mediatailor-UpdateLiveSource-request-HttpPackageConfigurations"></a>
A list of HTTP package configurations for the live source on this account.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateLiveSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "LiveSourceName": "string",
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_UpdateLiveSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-Arn"></a>
The Amazon Resource Name (ARN) associated with this live source.  
Type: String

 ** [CreationTime](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-CreationTime"></a>
The timestamp that indicates when the live source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-HttpPackageConfigurations"></a>
A list of HTTP package configurations for the live source on this account.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-LastModifiedTime"></a>
The timestamp that indicates when the live source was last modified.  
Type: Timestamp

 ** [LiveSourceName](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-LiveSourceName"></a>
The name of the live source.  
Type: String

 ** [SourceLocationName](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-SourceLocationName"></a>
The name of the source location associated with the live source.  
Type: String

 ** [tags](#API_UpdateLiveSource_ResponseSyntax) **   <a name="mediatailor-UpdateLiveSource-response-tags"></a>
The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_UpdateLiveSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateLiveSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UpdateLiveSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateLiveSource) 

# UpdateProgram
<a name="API_UpdateProgram"></a>

Updates a program within a channel.

## Request Syntax
<a name="API_UpdateProgram_RequestSyntax"></a>

```
PUT /channel/ChannelName/program/ProgramName HTTP/1.1
Content-type: application/json

{
   "AdBreaks": [ 
      { 
         "AdBreakMetadata": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "MessageType": "string",
         "OffsetMillis": number,
         "Slate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "SpliceInsertMessage": { 
            "AvailNum": number,
            "AvailsExpected": number,
            "SpliceEventId": number,
            "UniqueProgramId": number
         },
         "TimeSignalMessage": { 
            "SegmentationDescriptors": [ 
               { 
                  "SegmentationEventId": number,
                  "SegmentationTypeId": number,
                  "SegmentationUpid": "string",
                  "SegmentationUpidType": number,
                  "SegmentNum": number,
                  "SegmentsExpected": number,
                  "SubSegmentNum": number,
                  "SubSegmentsExpected": number
               }
            ]
         }
      }
   ],
   "AudienceMedia": [ 
      { 
         "AlternateMedia": [ 
            { 
               "AdBreaks": [ 
                  { 
                     "AdBreakMetadata": [ 
                        { 
                           "Key": "string",
                           "Value": "string"
                        }
                     ],
                     "MessageType": "string",
                     "OffsetMillis": number,
                     "Slate": { 
                        "SourceLocationName": "string",
                        "VodSourceName": "string"
                     },
                     "SpliceInsertMessage": { 
                        "AvailNum": number,
                        "AvailsExpected": number,
                        "SpliceEventId": number,
                        "UniqueProgramId": number
                     },
                     "TimeSignalMessage": { 
                        "SegmentationDescriptors": [ 
                           { 
                              "SegmentationEventId": number,
                              "SegmentationTypeId": number,
                              "SegmentationUpid": "string",
                              "SegmentationUpidType": number,
                              "SegmentNum": number,
                              "SegmentsExpected": number,
                              "SubSegmentNum": number,
                              "SubSegmentsExpected": number
                           }
                        ]
                     }
                  }
               ],
               "ClipRange": { 
                  "EndOffsetMillis": number,
                  "StartOffsetMillis": number
               },
               "DurationMillis": number,
               "LiveSourceName": "string",
               "ScheduledStartTimeMillis": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "Audience": "string"
      }
   ],
   "ScheduleConfiguration": { 
      "ClipRange": { 
         "EndOffsetMillis": number,
         "StartOffsetMillis": number
      },
      "Transition": { 
         "DurationMillis": number,
         "ScheduledStartTimeMillis": number
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateProgram_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ChannelName](#API_UpdateProgram_RequestSyntax) **   <a name="mediatailor-UpdateProgram-request-uri-ChannelName"></a>
The name of the channel for this Program.  
Required: Yes

 ** [ProgramName](#API_UpdateProgram_RequestSyntax) **   <a name="mediatailor-UpdateProgram-request-uri-ProgramName"></a>
The name of the Program.  
Required: Yes

## Request Body
<a name="API_UpdateProgram_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdBreaks](#API_UpdateProgram_RequestSyntax) **   <a name="mediatailor-UpdateProgram-request-AdBreaks"></a>
The ad break configuration settings.  
Type: Array of [AdBreak](API_AdBreak.md) objects  
Required: No

 ** [AudienceMedia](#API_UpdateProgram_RequestSyntax) **   <a name="mediatailor-UpdateProgram-request-AudienceMedia"></a>
The list of AudienceMedia defined in program.  
Type: Array of [AudienceMedia](API_AudienceMedia.md) objects  
Required: No

 ** [ScheduleConfiguration](#API_UpdateProgram_RequestSyntax) **   <a name="mediatailor-UpdateProgram-request-ScheduleConfiguration"></a>
The schedule configuration settings.  
Type: [UpdateProgramScheduleConfiguration](API_UpdateProgramScheduleConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateProgram_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AdBreaks": [ 
      { 
         "AdBreakMetadata": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "MessageType": "string",
         "OffsetMillis": number,
         "Slate": { 
            "SourceLocationName": "string",
            "VodSourceName": "string"
         },
         "SpliceInsertMessage": { 
            "AvailNum": number,
            "AvailsExpected": number,
            "SpliceEventId": number,
            "UniqueProgramId": number
         },
         "TimeSignalMessage": { 
            "SegmentationDescriptors": [ 
               { 
                  "SegmentationEventId": number,
                  "SegmentationTypeId": number,
                  "SegmentationUpid": "string",
                  "SegmentationUpidType": number,
                  "SegmentNum": number,
                  "SegmentsExpected": number,
                  "SubSegmentNum": number,
                  "SubSegmentsExpected": number
               }
            ]
         }
      }
   ],
   "Arn": "string",
   "AudienceMedia": [ 
      { 
         "AlternateMedia": [ 
            { 
               "AdBreaks": [ 
                  { 
                     "AdBreakMetadata": [ 
                        { 
                           "Key": "string",
                           "Value": "string"
                        }
                     ],
                     "MessageType": "string",
                     "OffsetMillis": number,
                     "Slate": { 
                        "SourceLocationName": "string",
                        "VodSourceName": "string"
                     },
                     "SpliceInsertMessage": { 
                        "AvailNum": number,
                        "AvailsExpected": number,
                        "SpliceEventId": number,
                        "UniqueProgramId": number
                     },
                     "TimeSignalMessage": { 
                        "SegmentationDescriptors": [ 
                           { 
                              "SegmentationEventId": number,
                              "SegmentationTypeId": number,
                              "SegmentationUpid": "string",
                              "SegmentationUpidType": number,
                              "SegmentNum": number,
                              "SegmentsExpected": number,
                              "SubSegmentNum": number,
                              "SubSegmentsExpected": number
                           }
                        ]
                     }
                  }
               ],
               "ClipRange": { 
                  "EndOffsetMillis": number,
                  "StartOffsetMillis": number
               },
               "DurationMillis": number,
               "LiveSourceName": "string",
               "ScheduledStartTimeMillis": number,
               "SourceLocationName": "string",
               "VodSourceName": "string"
            }
         ],
         "Audience": "string"
      }
   ],
   "ChannelName": "string",
   "ClipRange": { 
      "EndOffsetMillis": number,
      "StartOffsetMillis": number
   },
   "CreationTime": number,
   "DurationMillis": number,
   "LiveSourceName": "string",
   "ProgramName": "string",
   "ScheduledStartTime": number,
   "SourceLocationName": "string",
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_UpdateProgram_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AdBreaks](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-AdBreaks"></a>
The ad break configuration settings.  
Type: Array of [AdBreak](API_AdBreak.md) objects

 ** [Arn](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-Arn"></a>
The ARN to assign to the program.  
Type: String

 ** [AudienceMedia](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-AudienceMedia"></a>
The list of AudienceMedia defined in program.  
Type: Array of [AudienceMedia](API_AudienceMedia.md) objects

 ** [ChannelName](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-ChannelName"></a>
The name to assign to the channel for this program.  
Type: String

 ** [ClipRange](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-ClipRange"></a>
The clip range configuration settings.  
Type: [ClipRange](API_ClipRange.md) object

 ** [CreationTime](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-CreationTime"></a>
The time the program was created.  
Type: Timestamp

 ** [DurationMillis](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-DurationMillis"></a>
The duration of the live program in milliseconds.  
Type: Long

 ** [LiveSourceName](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-LiveSourceName"></a>
The name of the LiveSource for this Program.  
Type: String

 ** [ProgramName](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-ProgramName"></a>
The name to assign to this program.  
Type: String

 ** [ScheduledStartTime](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-ScheduledStartTime"></a>
The scheduled start time for this Program.  
Type: Timestamp

 ** [SourceLocationName](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-SourceLocationName"></a>
The name to assign to the source location for this program.  
Type: String

 ** [VodSourceName](#API_UpdateProgram_ResponseSyntax) **   <a name="mediatailor-UpdateProgram-response-VodSourceName"></a>
The name that's used to refer to a VOD source.  
Type: String

## Errors
<a name="API_UpdateProgram_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateProgram_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UpdateProgram) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateProgram) 

# UpdateSourceLocation
<a name="API_UpdateSourceLocation"></a>

Updates a source location. A source location is a container for sources. For more information about source locations, see [Working with source locations](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html) in the *MediaTailor User Guide*.

## Request Syntax
<a name="API_UpdateSourceLocation_RequestSyntax"></a>

```
PUT /sourceLocation/SourceLocationName HTTP/1.1
Content-type: application/json

{
   "AccessConfiguration": { 
      "AccessType": "string",
      "SecretsManagerAccessTokenConfiguration": { 
         "HeaderName": "string",
         "SecretArn": "string",
         "SecretStringKey": "string"
      }
   },
   "DefaultSegmentDeliveryConfiguration": { 
      "BaseUrl": "string"
   },
   "HttpConfiguration": { 
      "BaseUrl": "string"
   },
   "SegmentDeliveryConfigurations": [ 
      { 
         "BaseUrl": "string",
         "Name": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateSourceLocation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_UpdateSourceLocation_RequestSyntax) **   <a name="mediatailor-UpdateSourceLocation-request-uri-SourceLocationName"></a>
The name of the source location.  
Required: Yes

## Request Body
<a name="API_UpdateSourceLocation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AccessConfiguration](#API_UpdateSourceLocation_RequestSyntax) **   <a name="mediatailor-UpdateSourceLocation-request-AccessConfiguration"></a>
Access configuration parameters. Configures the type of authentication used to access content from your source location.  
Type: [AccessConfiguration](API_AccessConfiguration.md) object  
Required: No

 ** [DefaultSegmentDeliveryConfiguration](#API_UpdateSourceLocation_RequestSyntax) **   <a name="mediatailor-UpdateSourceLocation-request-DefaultSegmentDeliveryConfiguration"></a>
The optional configuration for the host server that serves segments.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object  
Required: No

 ** [HttpConfiguration](#API_UpdateSourceLocation_RequestSyntax) **   <a name="mediatailor-UpdateSourceLocation-request-HttpConfiguration"></a>
The HTTP configuration for the source location.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object  
Required: Yes

 ** [SegmentDeliveryConfigurations](#API_UpdateSourceLocation_RequestSyntax) **   <a name="mediatailor-UpdateSourceLocation-request-SegmentDeliveryConfigurations"></a>
A list of the segment delivery configurations associated with this resource.  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateSourceLocation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AccessConfiguration": { 
      "AccessType": "string",
      "SecretsManagerAccessTokenConfiguration": { 
         "HeaderName": "string",
         "SecretArn": "string",
         "SecretStringKey": "string"
      }
   },
   "Arn": "string",
   "CreationTime": number,
   "DefaultSegmentDeliveryConfiguration": { 
      "BaseUrl": "string"
   },
   "HttpConfiguration": { 
      "BaseUrl": "string"
   },
   "LastModifiedTime": number,
   "SegmentDeliveryConfigurations": [ 
      { 
         "BaseUrl": "string",
         "Name": "string"
      }
   ],
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_UpdateSourceLocation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessConfiguration](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-AccessConfiguration"></a>
Access configuration parameters. Configures the type of authentication used to access content from your source location.  
Type: [AccessConfiguration](API_AccessConfiguration.md) object

 ** [Arn](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-Arn"></a>
The Amazon Resource Name (ARN) associated with the source location.  
Type: String

 ** [CreationTime](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-CreationTime"></a>
The timestamp that indicates when the source location was created.  
Type: Timestamp

 ** [DefaultSegmentDeliveryConfiguration](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-DefaultSegmentDeliveryConfiguration"></a>
The optional configuration for the host server that serves segments.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object

 ** [HttpConfiguration](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-HttpConfiguration"></a>
The HTTP configuration for the source location.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object

 ** [LastModifiedTime](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-LastModifiedTime"></a>
The timestamp that indicates when the source location was last modified.  
Type: Timestamp

 ** [SegmentDeliveryConfigurations](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-SegmentDeliveryConfigurations"></a>
The segment delivery configurations for the source location. For information about MediaTailor configurations, see [Working with configurations in AWS Elemental MediaTailor](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html).  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects

 ** [SourceLocationName](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-SourceLocationName"></a>
The name of the source location.  
Type: String

 ** [tags](#API_UpdateSourceLocation_ResponseSyntax) **   <a name="mediatailor-UpdateSourceLocation-response-tags"></a>
The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

## Errors
<a name="API_UpdateSourceLocation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateSourceLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UpdateSourceLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateSourceLocation) 

# UpdateVodSource
<a name="API_UpdateVodSource"></a>

Updates a VOD source's configuration.

## Request Syntax
<a name="API_UpdateVodSource_RequestSyntax"></a>

```
PUT /sourceLocation/SourceLocationName/vodSource/VodSourceName HTTP/1.1
Content-type: application/json

{
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateVodSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [SourceLocationName](#API_UpdateVodSource_RequestSyntax) **   <a name="mediatailor-UpdateVodSource-request-uri-SourceLocationName"></a>
The name of the source location associated with this VOD Source.  
Required: Yes

 ** [VodSourceName](#API_UpdateVodSource_RequestSyntax) **   <a name="mediatailor-UpdateVodSource-request-uri-VodSourceName"></a>
The name of the VOD source.  
Required: Yes

## Request Body
<a name="API_UpdateVodSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HttpPackageConfigurations](#API_UpdateVodSource_RequestSyntax) **   <a name="mediatailor-UpdateVodSource-request-HttpPackageConfigurations"></a>
A list of HTTP package configurations for the VOD source on this account.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateVodSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": number,
   "HttpPackageConfigurations": [ 
      { 
         "Path": "string",
         "SourceGroup": "string",
         "Type": "string"
      }
   ],
   "LastModifiedTime": number,
   "SourceLocationName": "string",
   "tags": { 
      "string" : "string" 
   },
   "VodSourceName": "string"
}
```

## Response Elements
<a name="API_UpdateVodSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-Arn"></a>
The Amazon Resource Name (ARN) associated with the VOD source.  
Type: String

 ** [CreationTime](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-CreationTime"></a>
The timestamp that indicates when the VOD source was created.  
Type: Timestamp

 ** [HttpPackageConfigurations](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-HttpPackageConfigurations"></a>
A list of HTTP package configurations for the VOD source on this account.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects

 ** [LastModifiedTime](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-LastModifiedTime"></a>
The timestamp that indicates when the VOD source was last modified.  
Type: Timestamp

 ** [SourceLocationName](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-SourceLocationName"></a>
The name of the source location associated with the VOD source.  
Type: String

 ** [tags](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-tags"></a>
The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see [Tagging AWS Elemental MediaTailor Resources](https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html).  
Type: String to string map

 ** [VodSourceName](#API_UpdateVodSource_ResponseSyntax) **   <a name="mediatailor-UpdateVodSource-response-VodSourceName"></a>
The name of the VOD source.  
Type: String

## Errors
<a name="API_UpdateVodSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

## See Also
<a name="API_UpdateVodSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/mediatailor-2018-04-23/UpdateVodSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateVodSource) 