ListPrefetchSchedules - AWS Elemental MediaTailor

ListPrefetchSchedules

Lists the prefetch schedules for a playback configuration.

URI

/v1/prefetchSchedule/PlaybackConfigurationName

HTTP methods

POST

Operation ID: ListPrefetchSchedules

Creates a new prefetch schedule.

Path parameters
NameTypeRequiredDescription
PlaybackConfigurationNameStringTrue

The name of the playback configuration.

Responses
Status codeResponse modelDescription
200ListPrefetchSchedulesResponse

Success.

OPTIONS

Path parameters
NameTypeRequiredDescription
PlaybackConfigurationNameStringTrue

The name of the playback configuration.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

{ "StreamId": "string", "NextToken": "string", "MaxResults": integer }

Response bodies

{ "NextToken": "string", "Items": [ { "Consumption": { "AvailMatchingCriteria": [ { "Operator": enum, "DynamicVariable": "string" } ], "EndTime": integer, "StartTime": integer }, "Retrieval": { "EndTime": integer, "StartTime": integer, "DynamicVariables": { } }, "StreamId": "string", "Arn": "string", "PlaybackConfigurationName": "string", "Name": "string" } ] }

Properties

AvailMatchingCriteria

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.

PropertyTypeRequiredDescription
DynamicVariable

string

True

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 in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Operator

string

Values: EQUALS

True

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

ListPrefetchSchedulesRequest

Retrieves the prefetch schedule(s) for a specific playback configuration.

PropertyTypeRequiredDescription
MaxResults

integer

Minimum: 1

Maximum: 100

False

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

NextToken

string

False

(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.

For the first ListPrefetchSchedulesRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.

StreamId

string

False

An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

ListPrefetchSchedulesResponse

The list of prefetch schedules.

PropertyTypeRequiredDescription
Items

Array of type PrefetchSchedule

True

Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.

NextToken

string

False

The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.

PrefetchConsumption

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

PropertyTypeRequiredDescription
AvailMatchingCriteria

Array of type AvailMatchingCriteria

False

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.

EndTime

integer

Format: date-time

True

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.

StartTime

integer

Format: date-time

False

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 retrives them from the ad decision server.

PrefetchRetrieval

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.

PropertyTypeRequiredDescription
DynamicVariables

object

False

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You intially configure dynamic variables 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.

EndTime

integer

Format: date-time

True

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

StartTime

integer

Format: date-time

False

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.

PrefetchSchedule

A complex type that contains prefetch schedule information.

PropertyTypeRequiredDescription
Arn

string

True

The Amazon Resource Name (ARN) of the prefetch schedule.

Consumption

PrefetchConsumption

True

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.

Name

string

True

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

PlaybackConfigurationName

string

True

The name of the playback configuration to create the prefetch schedule for.

Retrieval

PrefetchRetrieval

True

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

StreamId

string

False

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListPrefetchSchedules