Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaTailor.Types.PrefetchConsumption

Description

Documentation

data PrefetchConsumption Source #

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

See: newPrefetchConsumption smart constructor.

Constructors

PrefetchConsumption'

Fields

availMatchingCriteria :: Maybe [AvailMatchingCriteria]
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.
startTime :: Maybe POSIX
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.
endTime :: POSIX
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.

Instances

Instances details

FromJSON PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods parseJSON :: Value -> Parser PrefetchConsumption # parseJSONList :: Value -> Parser [PrefetchConsumption] #
ToJSON PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods toJSON :: PrefetchConsumption -> Value # toEncoding :: PrefetchConsumption -> Encoding # toJSONList :: [PrefetchConsumption] -> Value # toEncodingList :: [PrefetchConsumption] -> Encoding #
Generic PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Associated Types type Rep PrefetchConsumption :: Type -> Type # Methods from :: PrefetchConsumption -> Rep PrefetchConsumption x # to :: Rep PrefetchConsumption x -> PrefetchConsumption #
Read PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods readsPrec :: Int -> ReadS PrefetchConsumption # readList :: ReadS [PrefetchConsumption] # readPrec :: ReadPrec PrefetchConsumption # readListPrec :: ReadPrec [PrefetchConsumption] #
Show PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods showsPrec :: Int -> PrefetchConsumption -> ShowS # show :: PrefetchConsumption -> String # showList :: [PrefetchConsumption] -> ShowS #
NFData PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods rnf :: PrefetchConsumption -> () #
Eq PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods (==) :: PrefetchConsumption -> PrefetchConsumption -> Bool # (/=) :: PrefetchConsumption -> PrefetchConsumption -> Bool #
Hashable PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption Methods hashWithSalt :: Int -> PrefetchConsumption -> Int # hash :: PrefetchConsumption -> Int #
type Rep PrefetchConsumption Source #
Instance details Defined in Amazonka.MediaTailor.Types.PrefetchConsumption type Rep PrefetchConsumption = D1 ('MetaData "PrefetchConsumption" "Amazonka.MediaTailor.Types.PrefetchConsumption" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "PrefetchConsumption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availMatchingCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailMatchingCriteria])) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newPrefetchConsumption Source #

Arguments

:: UTCTime	`$sel:endTime:PrefetchConsumption'`
-> PrefetchConsumption

Create a value of PrefetchConsumption 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:availMatchingCriteria:PrefetchConsumption', prefetchConsumption_availMatchingCriteria - 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.

$sel:startTime:PrefetchConsumption', prefetchConsumption_startTime - 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.

$sel:endTime:PrefetchConsumption', prefetchConsumption_endTime - 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.

prefetchConsumption_availMatchingCriteria :: Lens' PrefetchConsumption (Maybe [AvailMatchingCriteria]) Source #

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.

prefetchConsumption_startTime :: Lens' PrefetchConsumption (Maybe UTCTime) Source #

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.

prefetchConsumption_endTime :: Lens' PrefetchConsumption UTCTime Source #

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.