Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PrefetchSchedule

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.

Hierarchy

  • PrefetchSchedule

Index

Properties

Arn

Arn: string | undefined

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

Consumption

Consumption: PrefetchConsumption | undefined

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

Name: string | undefined

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

PlaybackConfigurationName

PlaybackConfigurationName: string | undefined

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

Retrieval

Retrieval: PrefetchRetrieval | undefined

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

Optional StreamId

StreamId: undefined | string

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