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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a prefetch schedule for a playback configuration. 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.

Synopsis

Creating a Request

data CreatePrefetchSchedule Source #

See: newCreatePrefetchSchedule smart constructor.

Constructors

CreatePrefetchSchedule'

Fields

streamId :: Maybe Text
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
consumption :: PrefetchConsumption
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
name :: Text
The name to assign to the schedule request.
playbackConfigurationName :: Text
The name to assign to the playback configuration.
retrieval :: PrefetchRetrieval
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

Instances

Instances details

ToJSON CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods toJSON :: CreatePrefetchSchedule -> Value # toEncoding :: CreatePrefetchSchedule -> Encoding # toJSONList :: [CreatePrefetchSchedule] -> Value # toEncodingList :: [CreatePrefetchSchedule] -> Encoding #
ToHeaders CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods toHeaders :: CreatePrefetchSchedule -> [Header] #
ToPath CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods toPath :: CreatePrefetchSchedule -> ByteString #
ToQuery CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods toQuery :: CreatePrefetchSchedule -> QueryString #
AWSRequest CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Associated Types type AWSResponse CreatePrefetchSchedule # Methods request :: (Service -> Service) -> CreatePrefetchSchedule -> Request CreatePrefetchSchedule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePrefetchSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePrefetchSchedule))) #
Generic CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Associated Types type Rep CreatePrefetchSchedule :: Type -> Type # Methods from :: CreatePrefetchSchedule -> Rep CreatePrefetchSchedule x # to :: Rep CreatePrefetchSchedule x -> CreatePrefetchSchedule #
Read CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods readsPrec :: Int -> ReadS CreatePrefetchSchedule # readList :: ReadS [CreatePrefetchSchedule] # readPrec :: ReadPrec CreatePrefetchSchedule # readListPrec :: ReadPrec [CreatePrefetchSchedule] #
Show CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods showsPrec :: Int -> CreatePrefetchSchedule -> ShowS # show :: CreatePrefetchSchedule -> String # showList :: [CreatePrefetchSchedule] -> ShowS #
NFData CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods rnf :: CreatePrefetchSchedule -> () #
Eq CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods (==) :: CreatePrefetchSchedule -> CreatePrefetchSchedule -> Bool # (/=) :: CreatePrefetchSchedule -> CreatePrefetchSchedule -> Bool #
Hashable CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods hashWithSalt :: Int -> CreatePrefetchSchedule -> Int # hash :: CreatePrefetchSchedule -> Int #
type AWSResponse CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule type AWSResponse CreatePrefetchSchedule = CreatePrefetchScheduleResponse
type Rep CreatePrefetchSchedule Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule type Rep CreatePrefetchSchedule = D1 ('MetaData "CreatePrefetchSchedule" "Amazonka.MediaTailor.CreatePrefetchSchedule" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "CreatePrefetchSchedule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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)))))

newCreatePrefetchSchedule Source #

Arguments

:: PrefetchConsumption	`CreatePrefetchSchedule`
-> Text	`CreatePrefetchSchedule`
-> Text	`CreatePrefetchSchedule`
-> PrefetchRetrieval	`CreatePrefetchSchedule`
-> CreatePrefetchSchedule

Create a value of CreatePrefetchSchedule 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:

CreatePrefetchSchedule, createPrefetchSchedule_streamId - An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

CreatePrefetchSchedule, createPrefetchSchedule_consumption - The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

CreatePrefetchSchedule, createPrefetchSchedule_name - The name to assign to the schedule request.

CreatePrefetchSchedule, createPrefetchSchedule_playbackConfigurationName - The name to assign to the playback configuration.

CreatePrefetchSchedule, createPrefetchSchedule_retrieval - The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

Request Lenses

createPrefetchSchedule_streamId :: Lens' CreatePrefetchSchedule (Maybe Text) Source #

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

createPrefetchSchedule_consumption :: Lens' CreatePrefetchSchedule PrefetchConsumption Source #

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

createPrefetchSchedule_name :: Lens' CreatePrefetchSchedule Text Source #

The name to assign to the schedule request.

createPrefetchSchedule_playbackConfigurationName :: Lens' CreatePrefetchSchedule Text Source #

The name to assign to the playback configuration.

createPrefetchSchedule_retrieval :: Lens' CreatePrefetchSchedule PrefetchRetrieval Source #

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

Destructuring the Response

data CreatePrefetchScheduleResponse Source #

See: newCreatePrefetchScheduleResponse smart constructor.

Constructors

CreatePrefetchScheduleResponse'

Fields

arn :: Maybe Text
The ARN to assign to the prefetch schedule.
consumption :: Maybe PrefetchConsumption
The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
name :: Maybe Text
The name to assign to the prefetch schedule.
playbackConfigurationName :: Maybe Text
The name to assign to the playback configuration.
retrieval :: Maybe PrefetchRetrieval
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
streamId :: Maybe Text
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Associated Types type Rep CreatePrefetchScheduleResponse :: Type -> Type # Methods from :: CreatePrefetchScheduleResponse -> Rep CreatePrefetchScheduleResponse x # to :: Rep CreatePrefetchScheduleResponse x -> CreatePrefetchScheduleResponse #
Read CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods readsPrec :: Int -> ReadS CreatePrefetchScheduleResponse # readList :: ReadS [CreatePrefetchScheduleResponse] # readPrec :: ReadPrec CreatePrefetchScheduleResponse # readListPrec :: ReadPrec [CreatePrefetchScheduleResponse] #
Show CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods showsPrec :: Int -> CreatePrefetchScheduleResponse -> ShowS # show :: CreatePrefetchScheduleResponse -> String # showList :: [CreatePrefetchScheduleResponse] -> ShowS #
NFData CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods rnf :: CreatePrefetchScheduleResponse -> () #
Eq CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule Methods (==) :: CreatePrefetchScheduleResponse -> CreatePrefetchScheduleResponse -> Bool # (/=) :: CreatePrefetchScheduleResponse -> CreatePrefetchScheduleResponse -> Bool #
type Rep CreatePrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.CreatePrefetchSchedule type Rep CreatePrefetchScheduleResponse = D1 ('MetaData "CreatePrefetchScheduleResponse" "Amazonka.MediaTailor.CreatePrefetchSchedule" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "CreatePrefetchScheduleResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "consumption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrefetchConsumption)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "playbackConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "retrieval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrefetchRetrieval))) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreatePrefetchScheduleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePrefetchScheduleResponse'`
-> CreatePrefetchScheduleResponse

Create a value of CreatePrefetchScheduleResponse 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:

CreatePrefetchScheduleResponse, createPrefetchScheduleResponse_arn - The ARN to assign to the prefetch schedule.

CreatePrefetchSchedule, createPrefetchScheduleResponse_consumption - The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

CreatePrefetchSchedule, createPrefetchScheduleResponse_name - The name to assign to the prefetch schedule.

CreatePrefetchSchedule, createPrefetchScheduleResponse_playbackConfigurationName - The name to assign to the playback configuration.

CreatePrefetchSchedule, createPrefetchScheduleResponse_retrieval - The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

CreatePrefetchSchedule, createPrefetchScheduleResponse_streamId - An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

$sel:httpStatus:CreatePrefetchScheduleResponse', createPrefetchScheduleResponse_httpStatus - The response's http status code.

Response Lenses

createPrefetchScheduleResponse_arn :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The ARN to assign to the prefetch schedule.

createPrefetchScheduleResponse_consumption :: Lens' CreatePrefetchScheduleResponse (Maybe PrefetchConsumption) Source #

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

createPrefetchScheduleResponse_name :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The name to assign to the prefetch schedule.

createPrefetchScheduleResponse_playbackConfigurationName :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The name to assign to the playback configuration.

createPrefetchScheduleResponse_retrieval :: Lens' CreatePrefetchScheduleResponse (Maybe PrefetchRetrieval) Source #

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

createPrefetchScheduleResponse_streamId :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

createPrefetchScheduleResponse_httpStatus :: Lens' CreatePrefetchScheduleResponse Int Source #

The response's http status code.