Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MediaTailor.Types.PrefetchSchedule

Description

Documentation

data PrefetchSchedule Source #

A complex type that contains prefetch schedule information.

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.
retrieval :: PrefetchRetrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
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.
arn :: Text
The Amazon Resource Name (ARN) of the prefetch schedule.
playbackConfigurationName :: Text
The name of the playback configuration to create the prefetch schedule for.
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.

Instances

Instances details

Eq PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods (==) :: PrefetchSchedule -> PrefetchSchedule -> Bool # (/=) :: PrefetchSchedule -> PrefetchSchedule -> Bool #
Read PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods readsPrec :: Int -> ReadS PrefetchSchedule # readList :: ReadS [PrefetchSchedule] # readPrec :: ReadPrec PrefetchSchedule # readListPrec :: ReadPrec [PrefetchSchedule] #
Show PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods showsPrec :: Int -> PrefetchSchedule -> ShowS # show :: PrefetchSchedule -> String # showList :: [PrefetchSchedule] -> ShowS #
Generic PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Associated Types type Rep PrefetchSchedule :: Type -> Type # Methods from :: PrefetchSchedule -> Rep PrefetchSchedule x # to :: Rep PrefetchSchedule x -> PrefetchSchedule #
NFData PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods rnf :: PrefetchSchedule -> () #
Hashable PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods hashWithSalt :: Int -> PrefetchSchedule -> Int # hash :: PrefetchSchedule -> Int #
FromJSON PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule Methods parseJSON :: Value -> Parser PrefetchSchedule # parseJSONList :: Value -> Parser [PrefetchSchedule] #
type Rep PrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchSchedule type Rep PrefetchSchedule = D1 ('MetaData "PrefetchSchedule" "Amazonka.MediaTailor.Types.PrefetchSchedule" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "PrefetchSchedule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "retrieval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrefetchRetrieval) :: S1 ('MetaSel ('Just "consumption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PrefetchConsumption))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "playbackConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPrefetchSchedule Source #

Arguments

:: PrefetchRetrieval	`$sel:retrieval:PrefetchSchedule'`
-> PrefetchConsumption	`$sel:consumption:PrefetchSchedule'`
-> Text	`$sel:arn:PrefetchSchedule'`
-> Text	`$sel:playbackConfigurationName:PrefetchSchedule'`
-> Text	`$sel:name: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:retrieval:PrefetchSchedule', prefetchSchedule_retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

$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:arn:PrefetchSchedule', prefetchSchedule_arn - The Amazon Resource Name (ARN) of the prefetch schedule.

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

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

prefetchSchedule_streamId :: Lens' PrefetchSchedule (Maybe Text) Source #

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

prefetchSchedule_retrieval :: Lens' PrefetchSchedule PrefetchRetrieval Source #

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

prefetchSchedule_consumption :: Lens' PrefetchSchedule PrefetchConsumption Source #

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_arn :: Lens' PrefetchSchedule Text Source #

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

prefetchSchedule_playbackConfigurationName :: Lens' PrefetchSchedule Text Source #

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

prefetchSchedule_name :: Lens' PrefetchSchedule Text Source #

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