CreatePrefetchSchedule
Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
Request Syntax
POST /prefetchSchedule/PlaybackConfigurationName/Name HTTP/1.1
Content-type: application/json
{
"Consumption": {
"AvailMatchingCriteria": [
{
"DynamicVariable": "string",
"Operator": "string"
}
],
"EndTime": number,
"StartTime": number
},
"Retrieval": {
"DynamicVariables": {
"string" : "string"
},
"EndTime": number,
"StartTime": number
},
"StreamId": "string"
}URI Request Parameters
The request uses the following URI parameters.
- Name
-
The name to assign to the schedule request.
Required: Yes
- PlaybackConfigurationName
-
The name to assign to the playback configuration.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Consumption
-
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
Type: PrefetchConsumption object
Required: Yes
- Retrieval
-
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
Type: PrefetchRetrieval object
Required: Yes
- StreamId
-
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If
StreamIdis specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId.Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"Consumption": {
"AvailMatchingCriteria": [
{
"DynamicVariable": "string",
"Operator": "string"
}
],
"EndTime": number,
"StartTime": number
},
"Name": "string",
"PlaybackConfigurationName": "string",
"Retrieval": {
"DynamicVariables": {
"string" : "string"
},
"EndTime": number,
"StartTime": number
},
"StreamId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The ARN to assign to the prefetch schedule.
Type: String
- Consumption
-
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
Type: PrefetchConsumption object
- Name
-
The name to assign to the prefetch schedule.
Type: String
- PlaybackConfigurationName
-
The name to assign to the playback configuration.
Type: String
- Retrieval
-
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
Type: PrefetchRetrieval object
- StreamId
-
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If
StreamIdis specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
