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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves 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

data GetPrefetchSchedule = GetPrefetchSchedule' {
- name :: Text
- playbackConfigurationName :: Text
}
newGetPrefetchSchedule :: Text -> Text -> GetPrefetchSchedule
getPrefetchSchedule_name :: Lens' GetPrefetchSchedule Text
getPrefetchSchedule_playbackConfigurationName :: Lens' GetPrefetchSchedule Text
data GetPrefetchScheduleResponse = GetPrefetchScheduleResponse' {
- arn :: Maybe Text
- consumption :: Maybe PrefetchConsumption
- name :: Maybe Text
- playbackConfigurationName :: Maybe Text
- retrieval :: Maybe PrefetchRetrieval
- streamId :: Maybe Text
- httpStatus :: Int
}
newGetPrefetchScheduleResponse :: Int -> GetPrefetchScheduleResponse
getPrefetchScheduleResponse_arn :: Lens' GetPrefetchScheduleResponse (Maybe Text)
getPrefetchScheduleResponse_consumption :: Lens' GetPrefetchScheduleResponse (Maybe PrefetchConsumption)
getPrefetchScheduleResponse_name :: Lens' GetPrefetchScheduleResponse (Maybe Text)
getPrefetchScheduleResponse_playbackConfigurationName :: Lens' GetPrefetchScheduleResponse (Maybe Text)
getPrefetchScheduleResponse_retrieval :: Lens' GetPrefetchScheduleResponse (Maybe PrefetchRetrieval)
getPrefetchScheduleResponse_streamId :: Lens' GetPrefetchScheduleResponse (Maybe Text)
getPrefetchScheduleResponse_httpStatus :: Lens' GetPrefetchScheduleResponse Int

Creating a Request

data GetPrefetchSchedule Source #

See: newGetPrefetchSchedule smart constructor.

Constructors

GetPrefetchSchedule'

Fields

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
Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Instances

Instances details

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

newGetPrefetchSchedule Source #

Arguments

:: Text	`GetPrefetchSchedule`
-> Text	`GetPrefetchSchedule`
-> GetPrefetchSchedule

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

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

GetPrefetchSchedule, getPrefetchSchedule_playbackConfigurationName - Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Request Lenses

getPrefetchSchedule_name :: Lens' GetPrefetchSchedule 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.

getPrefetchSchedule_playbackConfigurationName :: Lens' GetPrefetchSchedule Text Source #

Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Destructuring the Response

data GetPrefetchScheduleResponse Source #

See: newGetPrefetchScheduleResponse smart constructor.

Constructors

GetPrefetchScheduleResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the prefetch schedule.
consumption :: Maybe 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 :: Maybe 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 :: Maybe Text
The name of the playback configuration to create the prefetch schedule for.
retrieval :: Maybe PrefetchRetrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
streamId :: Maybe Text
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule Associated Types type Rep GetPrefetchScheduleResponse :: Type -> Type # Methods from :: GetPrefetchScheduleResponse -> Rep GetPrefetchScheduleResponse x # to :: Rep GetPrefetchScheduleResponse x -> GetPrefetchScheduleResponse #
Read GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule Methods readsPrec :: Int -> ReadS GetPrefetchScheduleResponse # readList :: ReadS [GetPrefetchScheduleResponse] # readPrec :: ReadPrec GetPrefetchScheduleResponse # readListPrec :: ReadPrec [GetPrefetchScheduleResponse] #
Show GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule Methods showsPrec :: Int -> GetPrefetchScheduleResponse -> ShowS # show :: GetPrefetchScheduleResponse -> String # showList :: [GetPrefetchScheduleResponse] -> ShowS #
NFData GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule Methods rnf :: GetPrefetchScheduleResponse -> () #
Eq GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule Methods (==) :: GetPrefetchScheduleResponse -> GetPrefetchScheduleResponse -> Bool # (/=) :: GetPrefetchScheduleResponse -> GetPrefetchScheduleResponse -> Bool #
type Rep GetPrefetchScheduleResponse Source #
Instance details Defined in Amazonka.MediaTailor.GetPrefetchSchedule type Rep GetPrefetchScheduleResponse = D1 ('MetaData "GetPrefetchScheduleResponse" "Amazonka.MediaTailor.GetPrefetchSchedule" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "GetPrefetchScheduleResponse'" '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)))))

newGetPrefetchScheduleResponse Source #

Arguments

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

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

GetPrefetchScheduleResponse, getPrefetchScheduleResponse_arn - The Amazon Resource Name (ARN) of the prefetch schedule.

GetPrefetchScheduleResponse, getPrefetchScheduleResponse_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.

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

GetPrefetchSchedule, getPrefetchScheduleResponse_playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.

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

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

$sel:httpStatus:GetPrefetchScheduleResponse', getPrefetchScheduleResponse_httpStatus - The response's http status code.

Response Lenses

getPrefetchScheduleResponse_arn :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

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

getPrefetchScheduleResponse_consumption :: Lens' GetPrefetchScheduleResponse (Maybe 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.

getPrefetchScheduleResponse_name :: Lens' GetPrefetchScheduleResponse (Maybe 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.

getPrefetchScheduleResponse_playbackConfigurationName :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

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

getPrefetchScheduleResponse_retrieval :: Lens' GetPrefetchScheduleResponse (Maybe PrefetchRetrieval) Source #

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

getPrefetchScheduleResponse_streamId :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

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

getPrefetchScheduleResponse_httpStatus :: Lens' GetPrefetchScheduleResponse Int Source #

The response's http status code.