# Data Types
<a name="API_Types"></a>

The AWS MediaTailor API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AccessConfiguration](API_AccessConfiguration.md) 
+  [AdBreak](API_AdBreak.md) 
+  [AdBreakOpportunity](API_AdBreakOpportunity.md) 
+  [AdConditioningConfiguration](API_AdConditioningConfiguration.md) 
+  [AdMarkerPassthrough](API_AdMarkerPassthrough.md) 
+  [AdsInteractionLog](API_AdsInteractionLog.md) 
+  [Alert](API_Alert.md) 
+  [AlternateMedia](API_AlternateMedia.md) 
+  [AudienceMedia](API_AudienceMedia.md) 
+  [AvailMatchingCriteria](API_AvailMatchingCriteria.md) 
+  [AvailSuppression](API_AvailSuppression.md) 
+  [Bumper](API_Bumper.md) 
+  [CdnConfiguration](API_CdnConfiguration.md) 
+  [Channel](API_Channel.md) 
+  [ClipRange](API_ClipRange.md) 
+  [DashConfiguration](API_DashConfiguration.md) 
+  [DashConfigurationForPut](API_DashConfigurationForPut.md) 
+  [DashPlaylistSettings](API_DashPlaylistSettings.md) 
+  [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) 
+  [HlsConfiguration](API_HlsConfiguration.md) 
+  [HlsPlaylistSettings](API_HlsPlaylistSettings.md) 
+  [HttpConfiguration](API_HttpConfiguration.md) 
+  [HttpPackageConfiguration](API_HttpPackageConfiguration.md) 
+  [KeyValuePair](API_KeyValuePair.md) 
+  [LivePreRollConfiguration](API_LivePreRollConfiguration.md) 
+  [LiveSource](API_LiveSource.md) 
+  [LogConfiguration](API_LogConfiguration.md) 
+  [LogConfigurationForChannel](API_LogConfigurationForChannel.md) 
+  [ManifestProcessingRules](API_ManifestProcessingRules.md) 
+  [ManifestServiceInteractionLog](API_ManifestServiceInteractionLog.md) 
+  [PlaybackConfiguration](API_PlaybackConfiguration.md) 
+  [PrefetchConsumption](API_PrefetchConsumption.md) 
+  [PrefetchRetrieval](API_PrefetchRetrieval.md) 
+  [PrefetchSchedule](API_PrefetchSchedule.md) 
+  [RecurringConsumption](API_RecurringConsumption.md) 
+  [RecurringPrefetchConfiguration](API_RecurringPrefetchConfiguration.md) 
+  [RecurringRetrieval](API_RecurringRetrieval.md) 
+  [RequestOutputItem](API_RequestOutputItem.md) 
+  [ResponseOutputItem](API_ResponseOutputItem.md) 
+  [ScheduleAdBreak](API_ScheduleAdBreak.md) 
+  [ScheduleConfiguration](API_ScheduleConfiguration.md) 
+  [ScheduleEntry](API_ScheduleEntry.md) 
+  [SecretsManagerAccessTokenConfiguration](API_SecretsManagerAccessTokenConfiguration.md) 
+  [SegmentationDescriptor](API_SegmentationDescriptor.md) 
+  [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) 
+  [SlateSource](API_SlateSource.md) 
+  [SourceLocation](API_SourceLocation.md) 
+  [SpliceInsertMessage](API_SpliceInsertMessage.md) 
+  [TimeShiftConfiguration](API_TimeShiftConfiguration.md) 
+  [TimeSignalMessage](API_TimeSignalMessage.md) 
+  [TrafficShapingRetrievalWindow](API_TrafficShapingRetrievalWindow.md) 
+  [Transition](API_Transition.md) 
+  [UpdateProgramScheduleConfiguration](API_UpdateProgramScheduleConfiguration.md) 
+  [UpdateProgramTransition](API_UpdateProgramTransition.md) 
+  [VodSource](API_VodSource.md) 

# AccessConfiguration
<a name="API_AccessConfiguration"></a>

Access configuration parameters.

## Contents
<a name="API_AccessConfiguration_Contents"></a>

 ** AccessType **   <a name="mediatailor-Type-AccessConfiguration-AccessType"></a>
The type of authentication used to access content from `HttpConfiguration::BaseUrl` on your source location.  
 `S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.  
Before you can use `S3_SIGV4`, you must meet these requirements:  
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.  
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.  
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.  
 `AUTODETECT_SIGV4` - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.  
Before you can use `AUTODETECT_SIGV4` with a MediaPackage Version 2 endpoint, you must meet these requirements:  
• You must grant MediaTailor access to your MediaPackage endpoint by granting `mediatailor.amazonaws.com` principal access in an Origin Access policy on the endpoint.  
• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.  
• The caller of the API must have `mediapackagev2:GetObject` IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.  
Before you can use `AUTODETECT_SIGV4` with an Amazon S3 bucket, you must meet these requirements:  
• You must grant MediaTailor access to your S3 bucket by granting `mediatailor.amazonaws.com` principal access in IAM. For more information about configuring access in IAM, see [Access management](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the *IAM User Guide.*.  
• The `mediatailor.amazonaws.com` service principal must have permissions to read all top-level manifests referenced by the `VodSource` packaging configurations.  
• The caller of the API must have `s3:GetObject` IAM permissions to read all top level manifests referenced by your MediaTailor `VodSource` packaging configurations.  
Type: String  
Valid Values: `S3_SIGV4 | SECRETS_MANAGER_ACCESS_TOKEN | AUTODETECT_SIGV4`   
Required: No

 ** SecretsManagerAccessTokenConfiguration **   <a name="mediatailor-Type-AccessConfiguration-SecretsManagerAccessTokenConfiguration"></a>
AWS Secrets Manager access token configuration parameters.  
Type: [SecretsManagerAccessTokenConfiguration](API_SecretsManagerAccessTokenConfiguration.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AccessConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AccessConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AccessConfiguration) 

# AdBreak
<a name="API_AdBreak"></a>

Ad break configuration parameters.

## Contents
<a name="API_AdBreak_Contents"></a>

 ** OffsetMillis **   <a name="mediatailor-Type-AdBreak-OffsetMillis"></a>
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.  
Type: Long  
Required: Yes

 ** AdBreakMetadata **   <a name="mediatailor-Type-AdBreak-AdBreakMetadata"></a>
Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.  
Type: Array of [KeyValuePair](API_KeyValuePair.md) objects  
Required: No

 ** MessageType **   <a name="mediatailor-Type-AdBreak-MessageType"></a>
The SCTE-35 ad insertion type. Accepted value: `SPLICE_INSERT`, `TIME_SIGNAL`.  
Type: String  
Valid Values: `SPLICE_INSERT | TIME_SIGNAL`   
Required: No

 ** Slate **   <a name="mediatailor-Type-AdBreak-Slate"></a>
Ad break slate configuration.  
Type: [SlateSource](API_SlateSource.md) object  
Required: No

 ** SpliceInsertMessage **   <a name="mediatailor-Type-AdBreak-SpliceInsertMessage"></a>
This defines the SCTE-35 `splice_insert()` message inserted around the ad. For information about using `splice_insert()`, see the SCTE-35 specficiaiton, section 9.7.3.1.  
Type: [SpliceInsertMessage](API_SpliceInsertMessage.md) object  
Required: No

 ** TimeSignalMessage **   <a name="mediatailor-Type-AdBreak-TimeSignalMessage"></a>
Defines the SCTE-35 `time_signal` message inserted around the ad.  
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a `splice_insert` SCTE-35 message to the ad break. This message provides basic metadata about the ad break.  
See section 9.7.4 of the 2022 SCTE-35 specification for more information.  
Type: [TimeSignalMessage](API_TimeSignalMessage.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AdBreak) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AdBreak) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AdBreak) 

# AdBreakOpportunity
<a name="API_AdBreakOpportunity"></a>

A location at which a zero-duration ad marker was detected in a VOD source manifest.

## Contents
<a name="API_AdBreakOpportunity_Contents"></a>

 ** OffsetMillis **   <a name="mediatailor-Type-AdBreakOpportunity-OffsetMillis"></a>
The offset in milliseconds from the start of the VOD source at which an ad marker was detected.  
Type: Long  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AdBreakOpportunity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AdBreakOpportunity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AdBreakOpportunity) 

# AdConditioningConfiguration
<a name="API_AdConditioningConfiguration"></a>

The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.

## Contents
<a name="API_AdConditioningConfiguration_Contents"></a>

 ** StreamingMediaFileConditioning **   <a name="mediatailor-Type-AdConditioningConfiguration-StreamingMediaFileConditioning"></a>
For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. `TRANSCODE` indicates that MediaTailor must transcode the ads. `NONE` indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see [Using preconditioned ads](https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html) in the AWS Elemental MediaTailor user guide.  
Type: String  
Valid Values: `TRANSCODE | NONE`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AdConditioningConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AdConditioningConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AdConditioningConfiguration) 

# AdMarkerPassthrough
<a name="API_AdMarkerPassthrough"></a>

For HLS, when set to `true`, MediaTailor passes through `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.

No logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad break, MediaTailor will not set the value to `0`.

## Contents
<a name="API_AdMarkerPassthrough_Contents"></a>

 ** Enabled **   <a name="mediatailor-Type-AdMarkerPassthrough-Enabled"></a>
Enables ad marker passthrough for your configuration.  
Type: Boolean  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AdMarkerPassthrough) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AdMarkerPassthrough) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AdMarkerPassthrough) 

# AdsInteractionLog
<a name="API_AdsInteractionLog"></a>

Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).

For more information about ADS logs, inlcuding descriptions of the event types, see [MediaTailor ADS logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html) in AWS Elemental MediaTailor User Guide.

## Contents
<a name="API_AdsInteractionLog_Contents"></a>

 ** ExcludeEventTypes **   <a name="mediatailor-Type-AdsInteractionLog-ExcludeEventTypes"></a>
Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.  
Type: Array of strings  
Valid Values: `AD_MARKER_FOUND | NON_AD_MARKER_FOUND | MAKING_ADS_REQUEST | MODIFIED_TARGET_URL | VAST_REDIRECT | EMPTY_VAST_RESPONSE | EMPTY_VMAP_RESPONSE | VAST_RESPONSE | REDIRECTED_VAST_RESPONSE | FILLED_AVAIL | FILLED_OVERLAY_AVAIL | BEACON_FIRED | WARNING_NO_ADVERTISEMENTS | WARNING_VPAID_AD_DROPPED | WARNING_URL_VARIABLE_SUBSTITUTION_FAILED | ERROR_UNKNOWN | ERROR_UNKNOWN_HOST | ERROR_DISALLOWED_HOST | ERROR_ADS_IO | ERROR_ADS_TIMEOUT | ERROR_ADS_RESPONSE_PARSE | ERROR_ADS_RESPONSE_UNKNOWN_ROOT_ELEMENT | ERROR_ADS_INVALID_RESPONSE | ERROR_VAST_REDIRECT_EMPTY_RESPONSE | ERROR_VAST_REDIRECT_MULTIPLE_VAST | ERROR_VAST_REDIRECT_FAILED | ERROR_VAST_MISSING_MEDIAFILES | ERROR_VAST_MISSING_CREATIVES | ERROR_VAST_MISSING_OVERLAYS | ERROR_VAST_MISSING_IMPRESSION | ERROR_VAST_INVALID_VAST_AD_TAG_URI | ERROR_VAST_MULTIPLE_TRACKING_EVENTS | ERROR_VAST_MULTIPLE_LINEAR | ERROR_VAST_INVALID_MEDIA_FILE | ERROR_FIRING_BEACON_FAILED | ERROR_PERSONALIZATION_DISABLED | VOD_TIME_BASED_AVAIL_PLAN_VAST_RESPONSE_FOR_OFFSET | VOD_TIME_BASED_AVAIL_PLAN_SUCCESS | VOD_TIME_BASED_AVAIL_PLAN_WARNING_NO_ADVERTISEMENTS | INTERSTITIAL_VOD_SUCCESS | INTERSTITIAL_VOD_FAILURE`   
Required: No

 ** PublishOptInEventTypes **   <a name="mediatailor-Type-AdsInteractionLog-PublishOptInEventTypes"></a>
Indicates that MediaTailor emits `RAW_ADS_RESPONSE` logs for playback sessions that are initialized with this configuration.  
Type: Array of strings  
Valid Values: `RAW_ADS_RESPONSE`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AdsInteractionLog) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AdsInteractionLog) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AdsInteractionLog) 

# Alert
<a name="API_Alert"></a>

Alert configuration parameters.

## Contents
<a name="API_Alert_Contents"></a>

 ** AlertCode **   <a name="mediatailor-Type-Alert-AlertCode"></a>
The code for the alert. For example, `NOT_PROCESSED`.  
Type: String  
Required: Yes

 ** AlertMessage **   <a name="mediatailor-Type-Alert-AlertMessage"></a>
If an alert is generated for a resource, an explanation of the reason for the alert.  
Type: String  
Required: Yes

 ** LastModifiedTime **   <a name="mediatailor-Type-Alert-LastModifiedTime"></a>
The timestamp when the alert was last modified.  
Type: Timestamp  
Required: Yes

 ** RelatedResourceArns **   <a name="mediatailor-Type-Alert-RelatedResourceArns"></a>
The Amazon Resource Names (ARNs) related to this alert.  
Type: Array of strings  
Required: Yes

 ** ResourceArn **   <a name="mediatailor-Type-Alert-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Required: Yes

 ** Category **   <a name="mediatailor-Type-Alert-Category"></a>
The category that MediaTailor assigns to the alert.  
Type: String  
Valid Values: `SCHEDULING_ERROR | PLAYBACK_WARNING | INFO`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/Alert) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/Alert) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/Alert) 

# AlternateMedia
<a name="API_AlternateMedia"></a>

A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.

## Contents
<a name="API_AlternateMedia_Contents"></a>

 ** AdBreaks **   <a name="mediatailor-Type-AlternateMedia-AdBreaks"></a>
Ad break configuration parameters defined in AlternateMedia.  
Type: Array of [AdBreak](API_AdBreak.md) objects  
Required: No

 ** ClipRange **   <a name="mediatailor-Type-AlternateMedia-ClipRange"></a>
Clip range configuration for the VOD source associated with the program.  
Type: [ClipRange](API_ClipRange.md) object  
Required: No

 ** DurationMillis **   <a name="mediatailor-Type-AlternateMedia-DurationMillis"></a>
The duration of the alternateMedia in milliseconds.  
Type: Long  
Required: No

 ** LiveSourceName **   <a name="mediatailor-Type-AlternateMedia-LiveSourceName"></a>
The name of the live source for alternateMedia.  
Type: String  
Required: No

 ** ScheduledStartTimeMillis **   <a name="mediatailor-Type-AlternateMedia-ScheduledStartTimeMillis"></a>
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.  
Type: Long  
Required: No

 ** SourceLocationName **   <a name="mediatailor-Type-AlternateMedia-SourceLocationName"></a>
The name of the source location for alternateMedia.  
Type: String  
Required: No

 ** VodSourceName **   <a name="mediatailor-Type-AlternateMedia-VodSourceName"></a>
The name of the VOD source for alternateMedia.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AlternateMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AlternateMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AlternateMedia) 

# AudienceMedia
<a name="API_AudienceMedia"></a>

An AudienceMedia object contains an Audience and a list of AlternateMedia.

## Contents
<a name="API_AudienceMedia_Contents"></a>

 ** AlternateMedia **   <a name="mediatailor-Type-AudienceMedia-AlternateMedia"></a>
The list of AlternateMedia defined in AudienceMedia.  
Type: Array of [AlternateMedia](API_AlternateMedia.md) objects  
Required: No

 ** Audience **   <a name="mediatailor-Type-AudienceMedia-Audience"></a>
The Audience defined in AudienceMedia.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AudienceMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AudienceMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AudienceMedia) 

# AvailMatchingCriteria
<a name="API_AvailMatchingCriteria"></a>

MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.

As an example, let's say that you set `DynamicVariable` to `scte.event_id` and `Operator` to `EQUALS`, and your playback configuration has an ADS URL of `https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]`. And the prefetch request to the ADS contains these values `https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30`. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of `my-awesome-event`, since it must match the event id that MediaTailor uses to query the ADS.

You can specify up to five `AvailMatchingCriteria`. If you specify multiple `AvailMatchingCriteria`, MediaTailor combines them to match using a logical `AND`. You can model logical `OR` combinations by creating multiple prefetch schedules.

## Contents
<a name="API_AvailMatchingCriteria_Contents"></a>

 ** DynamicVariable **   <a name="mediatailor-Type-AvailMatchingCriteria-DynamicVariable"></a>
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see [Using dynamic ad variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) in the *MediaTailor User Guide*.  
You can include up to 100 dynamic variables.  
Type: String  
Required: Yes

 ** Operator **   <a name="mediatailor-Type-AvailMatchingCriteria-Operator"></a>
For the `DynamicVariable` specified in `AvailMatchingCriteria`, the Operator that is used for the comparison.  
Type: String  
Valid Values: `EQUALS`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AvailMatchingCriteria) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AvailMatchingCriteria) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AvailMatchingCriteria) 

# AvailSuppression
<a name="API_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).

## Contents
<a name="API_AvailSuppression_Contents"></a>

 ** FillPolicy **   <a name="mediatailor-Type-AvailSuppression-FillPolicy"></a>
Defines the policy to apply to the avail suppression mode. `BEHIND_LIVE_EDGE` will always use the full avail suppression policy. `AFTER_LIVE_EDGE` mode can be used to invoke partial ad break fills when a session starts mid-break.  
Type: String  
Valid Values: `FULL_AVAIL_ONLY | PARTIAL_AVAIL`   
Required: No

 ** Mode **   <a name="mediatailor-Type-AvailSuppression-Mode"></a>
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to `BEHIND_LIVE_EDGE`, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to `AFTER_LIVE_EDGE`, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.  
Type: String  
Valid Values: `OFF | BEHIND_LIVE_EDGE | AFTER_LIVE_EDGE`   
Required: No

 ** Value **   <a name="mediatailor-Type-AvailSuppression-Value"></a>
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/AvailSuppression) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/AvailSuppression) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/AvailSuppression) 

# Bumper
<a name="API_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).

## Contents
<a name="API_Bumper_Contents"></a>

 ** EndUrl **   <a name="mediatailor-Type-Bumper-EndUrl"></a>
The URL for the end bumper asset.  
Type: String  
Required: No

 ** StartUrl **   <a name="mediatailor-Type-Bumper-StartUrl"></a>
The URL for the start bumper asset.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/Bumper) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/Bumper) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/Bumper) 

# CdnConfiguration
<a name="API_CdnConfiguration"></a>

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

## Contents
<a name="API_CdnConfiguration_Contents"></a>

 ** AdSegmentUrlPrefix **   <a name="mediatailor-Type-CdnConfiguration-AdSegmentUrlPrefix"></a>
A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.*<region>*.amazonaws.com. Then specify the rule's name in this `AdSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.  
Type: String  
Required: No

 ** ContentSegmentUrlPrefix **   <a name="mediatailor-Type-CdnConfiguration-ContentSegmentUrlPrefix"></a>
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this `ContentSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/CdnConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/CdnConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/CdnConfiguration) 

# Channel
<a name="API_Channel"></a>

The configuration parameters for 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*.

## Contents
<a name="API_Channel_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-Channel-Arn"></a>
The ARN of the channel.  
Type: String  
Required: Yes

 ** ChannelName **   <a name="mediatailor-Type-Channel-ChannelName"></a>
The name of the channel.  
Type: String  
Required: Yes

 ** ChannelState **   <a name="mediatailor-Type-Channel-ChannelState"></a>
Returns the state whether the channel is running or not.  
Type: String  
Required: Yes

 ** LogConfiguration **   <a name="mediatailor-Type-Channel-LogConfiguration"></a>
The log configuration.  
Type: [LogConfigurationForChannel](API_LogConfigurationForChannel.md) object  
Required: Yes

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

 ** PlaybackMode **   <a name="mediatailor-Type-Channel-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  
Required: Yes

 ** Tier **   <a name="mediatailor-Type-Channel-Tier"></a>
The tier for this channel. STANDARD tier channels can contain live programs.  
Type: String  
Required: Yes

 ** Audiences **   <a name="mediatailor-Type-Channel-Audiences"></a>
The list of audiences defined in channel.  
Type: Array of strings  
Required: No

 ** CreationTime **   <a name="mediatailor-Type-Channel-CreationTime"></a>
The timestamp of when the channel was created.  
Type: Timestamp  
Required: No

 ** FillerSlate **   <a name="mediatailor-Type-Channel-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

 ** LastModifiedTime **   <a name="mediatailor-Type-Channel-LastModifiedTime"></a>
The timestamp of when the channel was last modified.  
Type: Timestamp  
Required: No

 ** tags **   <a name="mediatailor-Type-Channel-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

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/Channel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/Channel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/Channel) 

# ClipRange
<a name="API_ClipRange"></a>

Clip range configuration for the VOD source associated with the program.

## Contents
<a name="API_ClipRange_Contents"></a>

 ** EndOffsetMillis **   <a name="mediatailor-Type-ClipRange-EndOffsetMillis"></a>
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.  
Type: Long  
Required: No

 ** StartOffsetMillis **   <a name="mediatailor-Type-ClipRange-StartOffsetMillis"></a>
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.  
Type: Long  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ClipRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ClipRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ClipRange) 

# DashConfiguration
<a name="API_DashConfiguration"></a>

The configuration for DASH content.

## Contents
<a name="API_DashConfiguration_Contents"></a>

 ** ManifestEndpointPrefix **   <a name="mediatailor-Type-DashConfiguration-ManifestEndpointPrefix"></a>
The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.  
Type: String  
Required: No

 ** MpdLocation **   <a name="mediatailor-Type-DashConfiguration-MpdLocation"></a>
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are `DISABLED` and `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value.  
Type: String  
Required: No

 ** OriginManifestType **   <a name="mediatailor-Type-DashConfiguration-OriginManifestType"></a>
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`. For multi-period manifests, omit this setting or set it to `MULTI_PERIOD`.  
Type: String  
Valid Values: `SINGLE_PERIOD | MULTI_PERIOD`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DashConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DashConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DashConfiguration) 

# DashConfigurationForPut
<a name="API_DashConfigurationForPut"></a>

The configuration for DASH PUT operations.

## Contents
<a name="API_DashConfigurationForPut_Contents"></a>

 ** MpdLocation **   <a name="mediatailor-Type-DashConfigurationForPut-MpdLocation"></a>
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are `DISABLED` and `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of the tag and is the default value.  
Type: String  
Required: No

 ** OriginManifestType **   <a name="mediatailor-Type-DashConfigurationForPut-OriginManifestType"></a>
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`. For multi-period manifests, omit this setting or set it to `MULTI_PERIOD`.  
Type: String  
Valid Values: `SINGLE_PERIOD | MULTI_PERIOD`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DashConfigurationForPut) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DashConfigurationForPut) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DashConfigurationForPut) 

# DashPlaylistSettings
<a name="API_DashPlaylistSettings"></a>

Dash manifest configuration parameters.

## Contents
<a name="API_DashPlaylistSettings_Contents"></a>

 ** ManifestWindowSeconds **   <a name="mediatailor-Type-DashPlaylistSettings-ManifestWindowSeconds"></a>
The total duration (in seconds) of each manifest. Minimum value: `30` seconds. Maximum value: `3600` seconds.  
Type: Integer  
Required: No

 ** MinBufferTimeSeconds **   <a name="mediatailor-Type-DashPlaylistSettings-MinBufferTimeSeconds"></a>
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: `2` seconds. Maximum value: `60` seconds.  
Type: Integer  
Required: No

 ** MinUpdatePeriodSeconds **   <a name="mediatailor-Type-DashPlaylistSettings-MinUpdatePeriodSeconds"></a>
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: `2` seconds. Maximum value: `60` seconds.  
Type: Integer  
Required: No

 ** SuggestedPresentationDelaySeconds **   <a name="mediatailor-Type-DashPlaylistSettings-SuggestedPresentationDelaySeconds"></a>
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: `2` seconds. Maximum value: `60` seconds.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DashPlaylistSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DashPlaylistSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DashPlaylistSettings) 

# DefaultSegmentDeliveryConfiguration
<a name="API_DefaultSegmentDeliveryConfiguration"></a>

The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.

## Contents
<a name="API_DefaultSegmentDeliveryConfiguration_Contents"></a>

 ** BaseUrl **   <a name="mediatailor-Type-DefaultSegmentDeliveryConfiguration-BaseUrl"></a>
The hostname of the server that will be used to serve segments. This string must include the protocol, such as **https://**.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/DefaultSegmentDeliveryConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/DefaultSegmentDeliveryConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/DefaultSegmentDeliveryConfiguration) 

# HlsConfiguration
<a name="API_HlsConfiguration"></a>

The configuration for HLS content.

## Contents
<a name="API_HlsConfiguration_Contents"></a>

 ** ManifestEndpointPrefix **   <a name="mediatailor-Type-HlsConfiguration-ManifestEndpointPrefix"></a>
The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/HlsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/HlsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/HlsConfiguration) 

# HlsPlaylistSettings
<a name="API_HlsPlaylistSettings"></a>

HLS playlist configuration parameters.

## Contents
<a name="API_HlsPlaylistSettings_Contents"></a>

 ** AdMarkupType **   <a name="mediatailor-Type-HlsPlaylistSettings-AdMarkupType"></a>
Determines the type of SCTE 35 tags to use in ad markup. Specify `DATERANGE` to use `DATERANGE` tags (for live or VOD content). Specify `SCTE35_ENHANCED` to use `EXT-X-CUE-OUT` and `EXT-X-CUE-IN` tags (for VOD content only).  
Type: Array of strings  
Valid Values: `DATERANGE | SCTE35_ENHANCED`   
Required: No

 ** ManifestWindowSeconds **   <a name="mediatailor-Type-HlsPlaylistSettings-ManifestWindowSeconds"></a>
The total duration (in seconds) of each manifest. Minimum value: `30` seconds. Maximum value: `3600` seconds.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/HlsPlaylistSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/HlsPlaylistSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/HlsPlaylistSettings) 

# HttpConfiguration
<a name="API_HttpConfiguration"></a>

The HTTP configuration for the source location.

## Contents
<a name="API_HttpConfiguration_Contents"></a>

 ** BaseUrl **   <a name="mediatailor-Type-HttpConfiguration-BaseUrl"></a>
The base URL for the source location host server. This string must include the protocol, such as **https://**.  
Type: String  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/HttpConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/HttpConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/HttpConfiguration) 

# HttpPackageConfiguration
<a name="API_HttpPackageConfiguration"></a>

The HTTP package configuration properties for the requested VOD source.

## Contents
<a name="API_HttpPackageConfiguration_Contents"></a>

 ** Path **   <a name="mediatailor-Type-HttpPackageConfiguration-Path"></a>
The relative path to the URL for this VOD source. This is combined with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid URL.  
Type: String  
Required: Yes

 ** SourceGroup **   <a name="mediatailor-Type-HttpPackageConfiguration-SourceGroup"></a>
The name of the source group. This has to match one of the `Channel::Outputs::SourceGroup`.  
Type: String  
Required: Yes

 ** Type **   <a name="mediatailor-Type-HttpPackageConfiguration-Type"></a>
The streaming protocol for this package configuration. Supported values are `HLS` and `DASH`.  
Type: String  
Valid Values: `DASH | HLS`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/HttpPackageConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/HttpPackageConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/HttpPackageConfiguration) 

# KeyValuePair
<a name="API_KeyValuePair"></a>

For `SCTE35_ENHANCED` output, defines a key and corresponding value. MediaTailor generates these pairs within the `EXT-X-ASSET`tag.

## Contents
<a name="API_KeyValuePair_Contents"></a>

 ** Key **   <a name="mediatailor-Type-KeyValuePair-Key"></a>
For `SCTE35_ENHANCED` output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the `EXT-X-ASSET`tag. If you specify a key, you must also specify a corresponding value.  
Type: String  
Required: Yes

 ** Value **   <a name="mediatailor-Type-KeyValuePair-Value"></a>
For `SCTE35_ENHANCED` output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the `EXT-X-ASSET`tag. If you specify a value, you must also specify a corresponding key.  
Type: String  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/KeyValuePair) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/KeyValuePair) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/KeyValuePair) 

# LivePreRollConfiguration
<a name="API_LivePreRollConfiguration"></a>

The configuration for pre-roll ad insertion.

## Contents
<a name="API_LivePreRollConfiguration_Contents"></a>

 ** AdDecisionServerUrl **   <a name="mediatailor-Type-LivePreRollConfiguration-AdDecisionServerUrl"></a>
The URL for the ad decision server (ADS) for pre-roll 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

 ** MaxDurationSeconds **   <a name="mediatailor-Type-LivePreRollConfiguration-MaxDurationSeconds"></a>
The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/LivePreRollConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/LivePreRollConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/LivePreRollConfiguration) 

# LiveSource
<a name="API_LiveSource"></a>

Live source configuration parameters.

## Contents
<a name="API_LiveSource_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-LiveSource-Arn"></a>
The ARN for the live source.  
Type: String  
Required: Yes

 ** HttpPackageConfigurations **   <a name="mediatailor-Type-LiveSource-HttpPackageConfigurations"></a>
The HTTP package configurations for the live source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

 ** LiveSourceName **   <a name="mediatailor-Type-LiveSource-LiveSourceName"></a>
The name that's used to refer to a live source.  
Type: String  
Required: Yes

 ** SourceLocationName **   <a name="mediatailor-Type-LiveSource-SourceLocationName"></a>
The name of the source location.  
Type: String  
Required: Yes

 ** CreationTime **   <a name="mediatailor-Type-LiveSource-CreationTime"></a>
The timestamp that indicates when the live source was created.  
Type: Timestamp  
Required: No

 ** LastModifiedTime **   <a name="mediatailor-Type-LiveSource-LastModifiedTime"></a>
The timestamp that indicates when the live source was last modified.  
Type: Timestamp  
Required: No

 ** tags **   <a name="mediatailor-Type-LiveSource-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  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/LiveSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/LiveSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/LiveSource) 

# LogConfiguration
<a name="API_LogConfiguration"></a>

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

## Contents
<a name="API_LogConfiguration_Contents"></a>

 ** EnabledLoggingStrategies **   <a name="mediatailor-Type-LogConfiguration-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`   
Required: Yes

 ** PercentEnabled **   <a name="mediatailor-Type-LogConfiguration-PercentEnabled"></a>
The percentage of session logs that MediaTailor sends to your configured log destination. 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

 ** AdsInteractionLog **   <a name="mediatailor-Type-LogConfiguration-AdsInteractionLog"></a>
Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).  
Type: [AdsInteractionLog](API_AdsInteractionLog.md) object  
Required: No

 ** ManifestServiceInteractionLog **   <a name="mediatailor-Type-LogConfiguration-ManifestServiceInteractionLog"></a>
Settings for customizing what events are included in logs for interactions with the origin server.  
Type: [ManifestServiceInteractionLog](API_ManifestServiceInteractionLog.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/LogConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/LogConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/LogConfiguration) 

# LogConfigurationForChannel
<a name="API_LogConfigurationForChannel"></a>

The log configuration for the channel.

## Contents
<a name="API_LogConfigurationForChannel_Contents"></a>

 ** LogTypes **   <a name="mediatailor-Type-LogConfigurationForChannel-LogTypes"></a>
The log types.  
Type: Array of strings  
Valid Values: `AS_RUN`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/LogConfigurationForChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/LogConfigurationForChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/LogConfigurationForChannel) 

# ManifestProcessingRules
<a name="API_ManifestProcessingRules"></a>

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

## Contents
<a name="API_ManifestProcessingRules_Contents"></a>

 ** AdMarkerPassthrough **   <a name="mediatailor-Type-ManifestProcessingRules-AdMarkerPassthrough"></a>
For HLS, when set to `true`, MediaTailor passes through `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad markers from the origin manifest to the MediaTailor personalized manifest.  
No logic is applied to these ad markers. For example, if `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad break, MediaTailor will not set the value to `0`.  
Type: [AdMarkerPassthrough](API_AdMarkerPassthrough.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ManifestProcessingRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ManifestProcessingRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ManifestProcessingRules) 

# ManifestServiceInteractionLog
<a name="API_ManifestServiceInteractionLog"></a>

Settings for customizing what events are included in logs for interactions with the origin server.

For more information about manifest service logs, including descriptions of the event types, see [MediaTailor manifest logs description and event types](https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html) in AWS Elemental MediaTailor User Guide.

## Contents
<a name="API_ManifestServiceInteractionLog_Contents"></a>

 ** ExcludeEventTypes **   <a name="mediatailor-Type-ManifestServiceInteractionLog-ExcludeEventTypes"></a>
Indicates that MediaTailor won't emit the selected events in the logs for playback sessions that are initialized with this configuration.  
Type: Array of strings  
Valid Values: `GENERATED_MANIFEST | ORIGIN_MANIFEST | SESSION_INITIALIZED | TRACKING_RESPONSE | CONFIG_SYNTAX_ERROR | CONFIG_SECURITY_ERROR | UNKNOWN_HOST | TIMEOUT_ERROR | CONNECTION_ERROR | IO_ERROR | UNKNOWN_ERROR | HOST_DISALLOWED | PARSING_ERROR | MANIFEST_ERROR | NO_MASTER_OR_MEDIA_PLAYLIST | NO_MASTER_PLAYLIST | NO_MEDIA_PLAYLIST | INCOMPATIBLE_HLS_VERSION | SCTE35_PARSING_ERROR | INVALID_SINGLE_PERIOD_DASH_MANIFEST | UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST | LAST_PERIOD_MISSING_AUDIO | LAST_PERIOD_MISSING_AUDIO_WARNING | ERROR_ORIGIN_PREFIX_INTERPOLATION | ERROR_ADS_INTERPOLATION | ERROR_LIVE_PRE_ROLL_ADS_INTERPOLATION | ERROR_CDN_AD_SEGMENT_INTERPOLATION | ERROR_CDN_CONTENT_SEGMENT_INTERPOLATION | ERROR_SLATE_AD_URL_INTERPOLATION | ERROR_PROFILE_NAME_INTERPOLATION | ERROR_BUMPER_START_INTERPOLATION | ERROR_BUMPER_END_INTERPOLATION`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ManifestServiceInteractionLog) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ManifestServiceInteractionLog) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ManifestServiceInteractionLog) 

# PlaybackConfiguration
<a name="API_PlaybackConfiguration"></a>

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

## Contents
<a name="API_PlaybackConfiguration_Contents"></a>

 ** AdConditioningConfiguration **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-DashConfiguration"></a>
The configuration for a DASH source.  
Type: [DashConfiguration](API_DashConfiguration.md) object  
Required: No

 ** HlsConfiguration **   <a name="mediatailor-Type-PlaybackConfiguration-HlsConfiguration"></a>
The configuration for HLS content.  
Type: [HlsConfiguration](API_HlsConfiguration.md) object  
Required: No

 ** InsertionMode **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-LivePreRollConfiguration"></a>
The configuration for pre-roll ad insertion.  
Type: [LivePreRollConfiguration](API_LivePreRollConfiguration.md) object  
Required: No

 ** LogConfiguration **   <a name="mediatailor-Type-PlaybackConfiguration-LogConfiguration"></a>
Defines where AWS Elemental MediaTailor sends logs for the playback configuration.  
Type: [LogConfiguration](API_LogConfiguration.md) object  
Required: No

 ** ManifestProcessingRules **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-Name"></a>
The identifier for the playback configuration.  
Type: String  
Required: No

 ** PersonalizationThresholdSeconds **   <a name="mediatailor-Type-PlaybackConfiguration-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

 ** PlaybackConfigurationArn **   <a name="mediatailor-Type-PlaybackConfiguration-PlaybackConfigurationArn"></a>
The Amazon Resource Name (ARN) for the playback configuration.  
Type: String  
Required: No

 ** PlaybackEndpointPrefix **   <a name="mediatailor-Type-PlaybackConfiguration-PlaybackEndpointPrefix"></a>
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.  
Type: String  
Required: No

 ** SessionInitializationEndpointPrefix **   <a name="mediatailor-Type-PlaybackConfiguration-SessionInitializationEndpointPrefix"></a>
The URL that the player uses to initialize a session that uses client-side reporting.  
Type: String  
Required: No

 ** SlateAdUrl **   <a name="mediatailor-Type-PlaybackConfiguration-SlateAdUrl"></a>
The URL for a 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  
Required: No

 ** tags **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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 **   <a name="mediatailor-Type-PlaybackConfiguration-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

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PlaybackConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PlaybackConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PlaybackConfiguration) 

# PrefetchConsumption
<a name="API_PrefetchConsumption"></a>

For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.

## Contents
<a name="API_PrefetchConsumption_Contents"></a>

 ** EndTime **   <a name="mediatailor-Type-PrefetchConsumption-EndTime"></a>
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call `DeletePrefetchSchedule`.  
Type: Timestamp  
Required: Yes

 ** AvailMatchingCriteria **   <a name="mediatailor-Type-PrefetchConsumption-AvailMatchingCriteria"></a>
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as `scte.event_id`, set the avail matching criteria.  
Type: Array of [AvailMatchingCriteria](API_AvailMatchingCriteria.md) objects  
Required: No

 ** StartTime **   <a name="mediatailor-Type-PrefetchConsumption-StartTime"></a>
The time when prefetched ads are considered for use in an ad break. If you don't specify `StartTime`, the prefetched ads are available after MediaTailor retrieves them from the ad decision server.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PrefetchConsumption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PrefetchConsumption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PrefetchConsumption) 

# PrefetchRetrieval
<a name="API_PrefetchRetrieval"></a>

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

## Contents
<a name="API_PrefetchRetrieval_Contents"></a>

 ** EndTime **   <a name="mediatailor-Type-PrefetchRetrieval-EndTime"></a>
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.  
Type: Timestamp  
Required: Yes

 ** DynamicVariables **   <a name="mediatailor-Type-PrefetchRetrieval-DynamicVariables"></a>
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).  
You initially configure [dynamic variables](https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html) for the ADS URL when you set up your playback configuration. When you specify `DynamicVariables` for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.  
Type: String to string map  
Required: No

 ** StartTime **   <a name="mediatailor-Type-PrefetchRetrieval-StartTime"></a>
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.  
Type: Timestamp  
Required: No

 ** TrafficShapingRetrievalWindow **   <a name="mediatailor-Type-PrefetchRetrieval-TrafficShapingRetrievalWindow"></a>
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.  
Type: [TrafficShapingRetrievalWindow](API_TrafficShapingRetrievalWindow.md) object  
Required: No

 ** TrafficShapingType **   <a name="mediatailor-Type-PrefetchRetrieval-TrafficShapingType"></a>
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.  
Type: String  
Valid Values: `RETRIEVAL_WINDOW`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PrefetchRetrieval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PrefetchRetrieval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PrefetchRetrieval) 

# PrefetchSchedule
<a name="API_PrefetchSchedule"></a>

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

## Contents
<a name="API_PrefetchSchedule_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-PrefetchSchedule-Arn"></a>
The Amazon Resource Name (ARN) of the prefetch schedule.  
Type: String  
Required: Yes

 ** Name **   <a name="mediatailor-Type-PrefetchSchedule-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  
Required: Yes

 ** PlaybackConfigurationName **   <a name="mediatailor-Type-PrefetchSchedule-PlaybackConfigurationName"></a>
The name of the playback configuration to create the prefetch schedule for.  
Type: String  
Required: Yes

 ** Consumption **   <a name="mediatailor-Type-PrefetchSchedule-Consumption"></a>
Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a *consumption window*. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.  
Type: [PrefetchConsumption](API_PrefetchConsumption.md) object  
Required: No

 ** RecurringPrefetchConfiguration **   <a name="mediatailor-Type-PrefetchSchedule-RecurringPrefetchConfiguration"></a>
The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.  
Type: [RecurringPrefetchConfiguration](API_RecurringPrefetchConfiguration.md) object  
Required: No

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

 ** ScheduleType **   <a name="mediatailor-Type-PrefetchSchedule-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 **   <a name="mediatailor-Type-PrefetchSchedule-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  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/PrefetchSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/PrefetchSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/PrefetchSchedule) 

# RecurringConsumption
<a name="API_RecurringConsumption"></a>

The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.

## Contents
<a name="API_RecurringConsumption_Contents"></a>

 ** AvailMatchingCriteria **   <a name="mediatailor-Type-RecurringConsumption-AvailMatchingCriteria"></a>
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.  
Type: Array of [AvailMatchingCriteria](API_AvailMatchingCriteria.md) objects  
Required: No

 ** RetrievedAdExpirationSeconds **   <a name="mediatailor-Type-RecurringConsumption-RetrievedAdExpirationSeconds"></a>
The number of seconds that an ad is available for insertion after it was prefetched.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/RecurringConsumption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/RecurringConsumption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/RecurringConsumption) 

# RecurringPrefetchConfiguration
<a name="API_RecurringPrefetchConfiguration"></a>

The configuration that defines how MediaTailor performs recurring prefetch. 

## Contents
<a name="API_RecurringPrefetchConfiguration_Contents"></a>

 ** EndTime **   <a name="mediatailor-Type-RecurringPrefetchConfiguration-EndTime"></a>
The end time for the window that MediaTailor prefetches and inserts ads in a live event.   
Type: Timestamp  
Required: Yes

 ** RecurringConsumption **   <a name="mediatailor-Type-RecurringPrefetchConfiguration-RecurringConsumption"></a>
The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.  
Type: [RecurringConsumption](API_RecurringConsumption.md) object  
Required: Yes

 ** RecurringRetrieval **   <a name="mediatailor-Type-RecurringPrefetchConfiguration-RecurringRetrieval"></a>
The configuration for prefetch ad retrieval from the ADS.  
Type: [RecurringRetrieval](API_RecurringRetrieval.md) object  
Required: Yes

 ** StartTime **   <a name="mediatailor-Type-RecurringPrefetchConfiguration-StartTime"></a>
The start time for the window that MediaTailor prefetches and inserts ads in a live event.   
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/RecurringPrefetchConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/RecurringPrefetchConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/RecurringPrefetchConfiguration) 

# RecurringRetrieval
<a name="API_RecurringRetrieval"></a>

With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following configurations describe the MediaTailor behavior when prefetching ads for a live event.

## Contents
<a name="API_RecurringRetrieval_Contents"></a>

 ** DelayAfterAvailEndSeconds **   <a name="mediatailor-Type-RecurringRetrieval-DelayAfterAvailEndSeconds"></a>
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).  
Type: Integer  
Required: No

 ** DynamicVariables **   <a name="mediatailor-Type-RecurringRetrieval-DynamicVariables"></a>
The dynamic variables to use for substitution during prefetch requests to the ADS.  
Type: String to string map  
Required: No

 ** TrafficShapingRetrievalWindow **   <a name="mediatailor-Type-RecurringRetrieval-TrafficShapingRetrievalWindow"></a>
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.  
Type: [TrafficShapingRetrievalWindow](API_TrafficShapingRetrievalWindow.md) object  
Required: No

 ** TrafficShapingType **   <a name="mediatailor-Type-RecurringRetrieval-TrafficShapingType"></a>
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.  
Type: String  
Valid Values: `RETRIEVAL_WINDOW`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/RecurringRetrieval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/RecurringRetrieval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/RecurringRetrieval) 

# RequestOutputItem
<a name="API_RequestOutputItem"></a>

The output configuration for this channel.

## Contents
<a name="API_RequestOutputItem_Contents"></a>

 ** ManifestName **   <a name="mediatailor-Type-RequestOutputItem-ManifestName"></a>
The name of the manifest for the channel. The name appears in the `PlaybackUrl`.  
Type: String  
Required: Yes

 ** SourceGroup **   <a name="mediatailor-Type-RequestOutputItem-SourceGroup"></a>
A string used to match which `HttpPackageConfiguration` is used for each `VodSource`.  
Type: String  
Required: Yes

 ** DashPlaylistSettings **   <a name="mediatailor-Type-RequestOutputItem-DashPlaylistSettings"></a>
DASH manifest configuration parameters.  
Type: [DashPlaylistSettings](API_DashPlaylistSettings.md) object  
Required: No

 ** HlsPlaylistSettings **   <a name="mediatailor-Type-RequestOutputItem-HlsPlaylistSettings"></a>
HLS playlist configuration parameters.  
Type: [HlsPlaylistSettings](API_HlsPlaylistSettings.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/RequestOutputItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/RequestOutputItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/RequestOutputItem) 

# ResponseOutputItem
<a name="API_ResponseOutputItem"></a>

The output item response.

## Contents
<a name="API_ResponseOutputItem_Contents"></a>

 ** ManifestName **   <a name="mediatailor-Type-ResponseOutputItem-ManifestName"></a>
The name of the manifest for the channel that will appear in the channel output's playback URL.  
Type: String  
Required: Yes

 ** PlaybackUrl **   <a name="mediatailor-Type-ResponseOutputItem-PlaybackUrl"></a>
The URL used for playback by content players.  
Type: String  
Required: Yes

 ** SourceGroup **   <a name="mediatailor-Type-ResponseOutputItem-SourceGroup"></a>
A string used to associate a package configuration source group with a channel output.  
Type: String  
Required: Yes

 ** DashPlaylistSettings **   <a name="mediatailor-Type-ResponseOutputItem-DashPlaylistSettings"></a>
DASH manifest configuration settings.  
Type: [DashPlaylistSettings](API_DashPlaylistSettings.md) object  
Required: No

 ** HlsPlaylistSettings **   <a name="mediatailor-Type-ResponseOutputItem-HlsPlaylistSettings"></a>
HLS manifest configuration settings.  
Type: [HlsPlaylistSettings](API_HlsPlaylistSettings.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ResponseOutputItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ResponseOutputItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ResponseOutputItem) 

# ScheduleAdBreak
<a name="API_ScheduleAdBreak"></a>

The schedule's ad break properties.

## Contents
<a name="API_ScheduleAdBreak_Contents"></a>

 ** ApproximateDurationSeconds **   <a name="mediatailor-Type-ScheduleAdBreak-ApproximateDurationSeconds"></a>
The approximate duration of the ad break, in seconds.  
Type: Long  
Required: No

 ** ApproximateStartTime **   <a name="mediatailor-Type-ScheduleAdBreak-ApproximateStartTime"></a>
The approximate time that the ad will start playing.  
Type: Timestamp  
Required: No

 ** SourceLocationName **   <a name="mediatailor-Type-ScheduleAdBreak-SourceLocationName"></a>
The name of the source location containing the VOD source used for the ad break.  
Type: String  
Required: No

 ** VodSourceName **   <a name="mediatailor-Type-ScheduleAdBreak-VodSourceName"></a>
The name of the VOD source used for the ad break.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ScheduleAdBreak) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ScheduleAdBreak) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ScheduleAdBreak) 

# ScheduleConfiguration
<a name="API_ScheduleConfiguration"></a>

Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.

## Contents
<a name="API_ScheduleConfiguration_Contents"></a>

 ** Transition **   <a name="mediatailor-Type-ScheduleConfiguration-Transition"></a>
Program transition configurations.  
Type: [Transition](API_Transition.md) object  
Required: Yes

 ** ClipRange **   <a name="mediatailor-Type-ScheduleConfiguration-ClipRange"></a>
Program clip range configuration.  
Type: [ClipRange](API_ClipRange.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ScheduleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ScheduleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ScheduleConfiguration) 

# ScheduleEntry
<a name="API_ScheduleEntry"></a>

The properties for a schedule.

## Contents
<a name="API_ScheduleEntry_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-ScheduleEntry-Arn"></a>
The ARN of the program.  
Type: String  
Required: Yes

 ** ChannelName **   <a name="mediatailor-Type-ScheduleEntry-ChannelName"></a>
The name of the channel that uses this schedule.  
Type: String  
Required: Yes

 ** ProgramName **   <a name="mediatailor-Type-ScheduleEntry-ProgramName"></a>
The name of the program.  
Type: String  
Required: Yes

 ** SourceLocationName **   <a name="mediatailor-Type-ScheduleEntry-SourceLocationName"></a>
The name of the source location.  
Type: String  
Required: Yes

 ** ApproximateDurationSeconds **   <a name="mediatailor-Type-ScheduleEntry-ApproximateDurationSeconds"></a>
The approximate duration of this program, in seconds.  
Type: Long  
Required: No

 ** ApproximateStartTime **   <a name="mediatailor-Type-ScheduleEntry-ApproximateStartTime"></a>
The approximate time that the program will start playing.  
Type: Timestamp  
Required: No

 ** Audiences **   <a name="mediatailor-Type-ScheduleEntry-Audiences"></a>
The list of audiences defined in ScheduleEntry.  
Type: Array of strings  
Required: No

 ** LiveSourceName **   <a name="mediatailor-Type-ScheduleEntry-LiveSourceName"></a>
The name of the live source used for the program.  
Type: String  
Required: No

 ** ScheduleAdBreaks **   <a name="mediatailor-Type-ScheduleEntry-ScheduleAdBreaks"></a>
The schedule's ad break properties.  
Type: Array of [ScheduleAdBreak](API_ScheduleAdBreak.md) objects  
Required: No

 ** ScheduleEntryType **   <a name="mediatailor-Type-ScheduleEntry-ScheduleEntryType"></a>
The type of schedule entry.  
Type: String  
Valid Values: `PROGRAM | FILLER_SLATE | ALTERNATE_MEDIA`   
Required: No

 ** VodSourceName **   <a name="mediatailor-Type-ScheduleEntry-VodSourceName"></a>
The name of the VOD source.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/ScheduleEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/ScheduleEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/ScheduleEntry) 

# SecretsManagerAccessTokenConfiguration
<a name="API_SecretsManagerAccessTokenConfiguration"></a>

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see [Working with AWS Secrets Manager access token authentication](https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html).

## Contents
<a name="API_SecretsManagerAccessTokenConfiguration_Contents"></a>

 ** HeaderName **   <a name="mediatailor-Type-SecretsManagerAccessTokenConfiguration-HeaderName"></a>
The name of the HTTP header used to supply the access token in requests to the source location.  
Type: String  
Required: No

 ** SecretArn **   <a name="mediatailor-Type-SecretsManagerAccessTokenConfiguration-SecretArn"></a>
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.  
Type: String  
Required: No

 ** SecretStringKey **   <a name="mediatailor-Type-SecretsManagerAccessTokenConfiguration-SecretStringKey"></a>
The AWS Secrets Manager [SecretString](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html) key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SecretsManagerAccessTokenConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SecretsManagerAccessTokenConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SecretsManagerAccessTokenConfiguration) 

# SegmentationDescriptor
<a name="API_SegmentationDescriptor"></a>

The `segmentation_descriptor` message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the `EXT-X-DATERANGE` or `EventStream` ad marker's SCTE-35 data.

 `segmentation_descriptor` messages must be sent with the `time_signal` message type.

See the `segmentation_descriptor()` table of the 2022 SCTE-35 specification for more information.

## Contents
<a name="API_SegmentationDescriptor_Contents"></a>

 ** SegmentationEventId **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentationEventId"></a>
The Event Identifier to assign to the `segmentation_descriptor.segmentation_event_id` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.  
Type: Integer  
Required: No

 ** SegmentationTypeId **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentationTypeId"></a>
The Type Identifier to assign to the `segmentation_descriptor.segmentation_type_id` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.  
Type: Integer  
Required: No

 ** SegmentationUpid **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentationUpid"></a>
The Upid to assign to the `segmentation_descriptor.segmentation_upid` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).  
Type: String  
Required: No

 ** SegmentationUpidType **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentationUpidType"></a>
The Upid Type to assign to the `segmentation_descriptor.segmentation_upid_type` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.  
Type: Integer  
Required: No

 ** SegmentNum **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentNum"></a>
The segment number to assign to the `segmentation_descriptor.segment_num` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.  
Type: Integer  
Required: No

 ** SegmentsExpected **   <a name="mediatailor-Type-SegmentationDescriptor-SegmentsExpected"></a>
The number of segments expected, which is assigned to the `segmentation_descriptor.segments_expectedS` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.  
Type: Integer  
Required: No

 ** SubSegmentNum **   <a name="mediatailor-Type-SegmentationDescriptor-SubSegmentNum"></a>
The sub-segment number to assign to the `segmentation_descriptor.sub_segment_num` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.  
Type: Integer  
Required: No

 ** SubSegmentsExpected **   <a name="mediatailor-Type-SegmentationDescriptor-SubSegmentsExpected"></a>
The number of sub-segments expected, which is assigned to the `segmentation_descriptor.sub_segments_expected` message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SegmentationDescriptor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SegmentationDescriptor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SegmentationDescriptor) 

# SegmentDeliveryConfiguration
<a name="API_SegmentDeliveryConfiguration"></a>

The segment delivery configuration settings.

## Contents
<a name="API_SegmentDeliveryConfiguration_Contents"></a>

 ** BaseUrl **   <a name="mediatailor-Type-SegmentDeliveryConfiguration-BaseUrl"></a>
The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as `https://example.com/some/path`. To use a relative URL specify the relative path, such as `/some/path*`.  
Type: String  
Required: No

 ** Name **   <a name="mediatailor-Type-SegmentDeliveryConfiguration-Name"></a>
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SegmentDeliveryConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SegmentDeliveryConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SegmentDeliveryConfiguration) 

# SlateSource
<a name="API_SlateSource"></a>

Slate VOD source configuration.

## Contents
<a name="API_SlateSource_Contents"></a>

 ** SourceLocationName **   <a name="mediatailor-Type-SlateSource-SourceLocationName"></a>
The name of the source location where the slate VOD source is stored.  
Type: String  
Required: No

 ** VodSourceName **   <a name="mediatailor-Type-SlateSource-VodSourceName"></a>
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.  
Type: String  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SlateSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SlateSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SlateSource) 

# SourceLocation
<a name="API_SourceLocation"></a>

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

## Contents
<a name="API_SourceLocation_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-SourceLocation-Arn"></a>
The ARN of the SourceLocation.  
Type: String  
Required: Yes

 ** HttpConfiguration **   <a name="mediatailor-Type-SourceLocation-HttpConfiguration"></a>
The HTTP configuration for the source location.  
Type: [HttpConfiguration](API_HttpConfiguration.md) object  
Required: Yes

 ** SourceLocationName **   <a name="mediatailor-Type-SourceLocation-SourceLocationName"></a>
The name of the source location.  
Type: String  
Required: Yes

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

 ** CreationTime **   <a name="mediatailor-Type-SourceLocation-CreationTime"></a>
The timestamp that indicates when the source location was created.  
Type: Timestamp  
Required: No

 ** DefaultSegmentDeliveryConfiguration **   <a name="mediatailor-Type-SourceLocation-DefaultSegmentDeliveryConfiguration"></a>
The default segment delivery configuration.  
Type: [DefaultSegmentDeliveryConfiguration](API_DefaultSegmentDeliveryConfiguration.md) object  
Required: No

 ** LastModifiedTime **   <a name="mediatailor-Type-SourceLocation-LastModifiedTime"></a>
The timestamp that indicates when the source location was last modified.  
Type: Timestamp  
Required: No

 ** SegmentDeliveryConfigurations **   <a name="mediatailor-Type-SourceLocation-SegmentDeliveryConfigurations"></a>
The segment delivery configurations for the source location.  
Type: Array of [SegmentDeliveryConfiguration](API_SegmentDeliveryConfiguration.md) objects  
Required: No

 ** tags **   <a name="mediatailor-Type-SourceLocation-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  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SourceLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SourceLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SourceLocation) 

# SpliceInsertMessage
<a name="API_SpliceInsertMessage"></a>

Splice insert message configuration.

## Contents
<a name="API_SpliceInsertMessage_Contents"></a>

 ** AvailNum **   <a name="mediatailor-Type-SpliceInsertMessage-AvailNum"></a>
This is written to `splice_insert.avail_num`, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is `0`. Values must be between `0` and `256`, inclusive.  
Type: Integer  
Required: No

 ** AvailsExpected **   <a name="mediatailor-Type-SpliceInsertMessage-AvailsExpected"></a>
This is written to `splice_insert.avails_expected`, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is `0`. Values must be between `0` and `256`, inclusive.  
Type: Integer  
Required: No

 ** SpliceEventId **   <a name="mediatailor-Type-SpliceInsertMessage-SpliceEventId"></a>
This is written to `splice_insert.splice_event_id`, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is `1`.  
Type: Integer  
Required: No

 ** UniqueProgramId **   <a name="mediatailor-Type-SpliceInsertMessage-UniqueProgramId"></a>
This is written to `splice_insert.unique_program_id`, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is `0`. Values must be between `0` and `256`, inclusive.  
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/SpliceInsertMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/SpliceInsertMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/SpliceInsertMessage) 

# TimeShiftConfiguration
<a name="API_TimeShiftConfiguration"></a>

 The configuration for time-shifted viewing. 

## Contents
<a name="API_TimeShiftConfiguration_Contents"></a>

 ** MaxTimeDelaySeconds **   <a name="mediatailor-Type-TimeShiftConfiguration-MaxTimeDelaySeconds"></a>
 The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).   
Type: Integer  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/TimeShiftConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/TimeShiftConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/TimeShiftConfiguration) 

# TimeSignalMessage
<a name="API_TimeSignalMessage"></a>

The SCTE-35 `time_signal` message can be sent with one or more `segmentation_descriptor` messages. A `time_signal` message can be sent only if a single `segmentation_descriptor` message is sent.

The `time_signal` message contains only the `splice_time` field which is constructed using a given presentation timestamp. When sending a `time_signal` message, the `splice_command_type` field in the `splice_info_section` message is set to 6 (0x06).

See the `time_signal()` table of the 2022 SCTE-35 specification for more information.

## Contents
<a name="API_TimeSignalMessage_Contents"></a>

 ** SegmentationDescriptors **   <a name="mediatailor-Type-TimeSignalMessage-SegmentationDescriptors"></a>
The configurations for the SCTE-35 `segmentation_descriptor` message(s) sent with the `time_signal` message.  
Type: Array of [SegmentationDescriptor](API_SegmentationDescriptor.md) objects  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/TimeSignalMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/TimeSignalMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/TimeSignalMessage) 

# TrafficShapingRetrievalWindow
<a name="API_TrafficShapingRetrievalWindow"></a>

The configuration that tells AWS Elemental MediaTailor how to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

## Contents
<a name="API_TrafficShapingRetrievalWindow_Contents"></a>

 ** RetrievalWindowDurationSeconds **   <a name="mediatailor-Type-TrafficShapingRetrievalWindow-RetrievalWindowDurationSeconds"></a>
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.   
Type: Integer  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/TrafficShapingRetrievalWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/TrafficShapingRetrievalWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/TrafficShapingRetrievalWindow) 

# Transition
<a name="API_Transition"></a>

Program transition configuration.

## Contents
<a name="API_Transition_Contents"></a>

 ** RelativePosition **   <a name="mediatailor-Type-Transition-RelativePosition"></a>
The position where this program will be inserted relative to the `RelativePosition`.  
Type: String  
Valid Values: `BEFORE_PROGRAM | AFTER_PROGRAM`   
Required: Yes

 ** Type **   <a name="mediatailor-Type-Transition-Type"></a>
Defines when the program plays in the schedule. You can set the value to `ABSOLUTE` or `RELATIVE`.  
 `ABSOLUTE` - The program plays at a specific wall clock time. This setting can only be used for channels using the `LINEAR` `PlaybackMode`.  
Note the following considerations when using `ABSOLUTE` transitions:  
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.  
If there are gaps in playback, MediaTailor plays the `FillerSlate` you configured for your linear channel.  
 `RELATIVE` - The program is inserted into the schedule either before or after a program that you specify via `RelativePosition`.  
Type: String  
Required: Yes

 ** DurationMillis **   <a name="mediatailor-Type-Transition-DurationMillis"></a>
The duration of the live program in seconds.  
Type: Long  
Required: No

 ** RelativeProgram **   <a name="mediatailor-Type-Transition-RelativeProgram"></a>
The name of the program that this program will be inserted next to, as defined by `RelativePosition`.  
Type: String  
Required: No

 ** ScheduledStartTimeMillis **   <a name="mediatailor-Type-Transition-ScheduledStartTimeMillis"></a>
The date and time that the program is scheduled to start, in epoch milliseconds.  
Type: Long  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/Transition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/Transition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/Transition) 

# UpdateProgramScheduleConfiguration
<a name="API_UpdateProgramScheduleConfiguration"></a>

Schedule configuration parameters.

## Contents
<a name="API_UpdateProgramScheduleConfiguration_Contents"></a>

 ** ClipRange **   <a name="mediatailor-Type-UpdateProgramScheduleConfiguration-ClipRange"></a>
Program clip range configuration.  
Type: [ClipRange](API_ClipRange.md) object  
Required: No

 ** Transition **   <a name="mediatailor-Type-UpdateProgramScheduleConfiguration-Transition"></a>
Program transition configuration.  
Type: [UpdateProgramTransition](API_UpdateProgramTransition.md) object  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateProgramScheduleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateProgramScheduleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateProgramScheduleConfiguration) 

# UpdateProgramTransition
<a name="API_UpdateProgramTransition"></a>

Program transition configuration.

## Contents
<a name="API_UpdateProgramTransition_Contents"></a>

 ** DurationMillis **   <a name="mediatailor-Type-UpdateProgramTransition-DurationMillis"></a>
The duration of the live program in seconds.  
Type: Long  
Required: No

 ** ScheduledStartTimeMillis **   <a name="mediatailor-Type-UpdateProgramTransition-ScheduledStartTimeMillis"></a>
The date and time that the program is scheduled to start, in epoch milliseconds.  
Type: Long  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/UpdateProgramTransition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/UpdateProgramTransition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/UpdateProgramTransition) 

# VodSource
<a name="API_VodSource"></a>

VOD source configuration parameters.

## Contents
<a name="API_VodSource_Contents"></a>

 ** Arn **   <a name="mediatailor-Type-VodSource-Arn"></a>
The ARN for the VOD source.  
Type: String  
Required: Yes

 ** HttpPackageConfigurations **   <a name="mediatailor-Type-VodSource-HttpPackageConfigurations"></a>
The HTTP package configurations for the VOD source.  
Type: Array of [HttpPackageConfiguration](API_HttpPackageConfiguration.md) objects  
Required: Yes

 ** SourceLocationName **   <a name="mediatailor-Type-VodSource-SourceLocationName"></a>
The name of the source location that the VOD source is associated with.  
Type: String  
Required: Yes

 ** VodSourceName **   <a name="mediatailor-Type-VodSource-VodSourceName"></a>
The name of the VOD source.  
Type: String  
Required: Yes

 ** CreationTime **   <a name="mediatailor-Type-VodSource-CreationTime"></a>
The timestamp that indicates when the VOD source was created.  
Type: Timestamp  
Required: No

 ** LastModifiedTime **   <a name="mediatailor-Type-VodSource-LastModifiedTime"></a>
The timestamp that indicates when the VOD source was last modified.  
Type: Timestamp  
Required: No

 ** tags **   <a name="mediatailor-Type-VodSource-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  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/mediatailor-2018-04-23/VodSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/mediatailor-2018-04-23/VodSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/mediatailor-2018-04-23/VodSource)