Amazonka.MediaTailor.Types.PrefetchSchedule

Documentation

data 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.

See: newPrefetchSchedule smart constructor.

Constructors

PrefetchSchedule'

Fields

• streamId :: Maybe Text

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

• arn :: Text

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

• consumption :: PrefetchConsumption

  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 :: Text

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

• playbackConfigurationName :: Text

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

• retrieval :: PrefetchRetrieval

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

Instances

FromJSON PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

parseJSON :: Value -> Parser PrefetchSchedule

parseJSONList :: Value -> Parser [PrefetchSchedule]

Generic PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Associated Types

type Rep PrefetchSchedule :: Type -> Type

Methods

from :: PrefetchSchedule -> Rep PrefetchSchedule x

to :: Rep PrefetchSchedule x -> PrefetchSchedule

Read PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

readsPrec :: Int -> ReadS PrefetchSchedule

readList :: ReadS [PrefetchSchedule]

readPrec :: ReadPrec PrefetchSchedule

readListPrec :: ReadPrec [PrefetchSchedule]

Show PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

showsPrec :: Int -> PrefetchSchedule -> ShowS

show :: PrefetchSchedule -> String

showList :: [PrefetchSchedule] -> ShowS

NFData PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

rnf :: PrefetchSchedule -> ()

Eq PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

(==) :: PrefetchSchedule -> PrefetchSchedule -> Bool

(/=) :: PrefetchSchedule -> PrefetchSchedule -> Bool

Hashable PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

Methods

hashWithSalt :: Int -> PrefetchSchedule -> Int

hash :: PrefetchSchedule -> Int

type Rep PrefetchSchedule

Defined in Amazonka.MediaTailor.Types.PrefetchSchedule

type Rep PrefetchSchedule = D1 ('MetaData "PrefetchSchedule" "Amazonka.MediaTailor.Types.PrefetchSchedule" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "PrefetchSchedule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "consumption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrefetchConsumption))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "playbackConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "retrieval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrefetchRetrieval)))))

newPrefetchSchedule

Arguments

:: Text

$sel:arn:PrefetchSchedule'

-> PrefetchConsumption

$sel:consumption:PrefetchSchedule'

-> Text

$sel:name:PrefetchSchedule'

-> Text

$sel:playbackConfigurationName:PrefetchSchedule'

-> PrefetchRetrieval

$sel:retrieval:PrefetchSchedule'

-> PrefetchSchedule

Create a value of PrefetchSchedule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:streamId:PrefetchSchedule', prefetchSchedule_streamId - An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

$sel:arn:PrefetchSchedule', prefetchSchedule_arn - The Amazon Resource Name (ARN) of the prefetch schedule.

$sel:consumption:PrefetchSchedule', prefetchSchedule_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.

$sel:name:PrefetchSchedule', prefetchSchedule_name - The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

$sel:playbackConfigurationName:PrefetchSchedule', prefetchSchedule_playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.

$sel:retrieval:PrefetchSchedule', prefetchSchedule_retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

prefetchSchedule_streamId :: Lens' PrefetchSchedule (Maybe Text)

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

prefetchSchedule_arn :: Lens' PrefetchSchedule Text

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

prefetchSchedule_consumption :: Lens' PrefetchSchedule PrefetchConsumption

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.

prefetchSchedule_name :: Lens' PrefetchSchedule Text

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

prefetchSchedule_playbackConfigurationName :: Lens' PrefetchSchedule Text

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

prefetchSchedule_retrieval :: Lens' PrefetchSchedule PrefetchRetrieval

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