v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444174189.1 KB

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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.

post/prefetchSchedule/{PlaybackConfigurationName}/{Name}

Path parameters

Namestring required

The name to assign to the schedule request.

PlaybackConfigurationNamestring required

The name to assign to the playback configuration.

Request body

StreamIdstring

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.

Response

Success

Arnstring

The ARN to assign to the prefetch schedule.

Namestring

The name to assign to the prefetch schedule.

PlaybackConfigurationNamestring

The name to assign to the playback configuration.

StreamIdstring

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.