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 in the MediaTailor User Guide.
Type: objectProperties: 6Required: 5
BroadcastingMedia ProcessingMedia
PrefetchSchedule is a JSON Structure definition published by Amazon MediaTailor, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediatailor/refs/heads/main/json-structure/mediatailor-api-prefetch-schedule-structure.json",
"name": "PrefetchSchedule",
"type": "object",
"description": "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 <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html\">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.",
"properties": {
"Arn": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The Amazon Resource Name (ARN) of the prefetch schedule."
}
]
},
"Consumption": {
"allOf": [
{
"$ref": "#/components/schemas/PrefetchConsumption"
},
{
"description": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria."
}
]
},
"Name": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration."
}
]
},
"PlaybackConfigurationName": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The name of the playback configuration to create the prefetch schedule for."
}
]
},
"Retrieval": {
"allOf": [
{
"$ref": "#/components/schemas/PrefetchRetrieval"
},
{
"description": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS)."
}
]
},
"StreamId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration."
}
]
}
},
"required": [
"Arn",
"Consumption",
"Name",
"PlaybackConfigurationName",
"Retrieval"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.