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

Description

Documentation

data PrefetchRetrieval Source #

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

See: newPrefetchRetrieval smart constructor.

Constructors

PrefetchRetrieval'

Fields

startTime :: Maybe POSIX
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
dynamicVariables :: Maybe (HashMap Text Text)
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
endTime :: POSIX
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Instances

Instances details

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

newPrefetchRetrieval Source #

Arguments

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

Create a value of PrefetchRetrieval 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:startTime:PrefetchRetrieval', prefetchRetrieval_startTime - The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

$sel:dynamicVariables:PrefetchRetrieval', prefetchRetrieval_dynamicVariables - The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

$sel:endTime:PrefetchRetrieval', prefetchRetrieval_endTime - The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

prefetchRetrieval_startTime :: Lens' PrefetchRetrieval (Maybe UTCTime) Source #

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

prefetchRetrieval_dynamicVariables :: Lens' PrefetchRetrieval (Maybe (HashMap Text Text)) Source #

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

prefetchRetrieval_endTime :: Lens' PrefetchRetrieval UTCTime Source #

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.