GetPrefetchSchedule
Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
Request Syntax
GET /prefetchSchedule/PlaybackConfigurationName/Name HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Name
-
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
Required: Yes
- PlaybackConfigurationName
-
Returns information about the prefetch schedule for a specific playback configuration. If you call
GetPrefetchScheduleon an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.Required: Yes
Request Body
The request does not have a request body.
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 Amazon Resource Name (ARN) of the prefetch schedule.
Type: String
- Consumption
-
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 consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
Type: PrefetchConsumption object
- Name
-
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
Type: String
- PlaybackConfigurationName
-
The name of the playback configuration to create the prefetch schedule for.
Type: String
- Retrieval
-
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
Type: PrefetchRetrieval object
- StreamId
-
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
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:
