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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about your channel's schedule.

This operation returns paginated results.

Synopsis

data GetChannelSchedule = GetChannelSchedule' {
- durationMinutes :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- channelName :: Text
}
newGetChannelSchedule :: Text -> GetChannelSchedule
getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text)
getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural)
getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text)
getChannelSchedule_channelName :: Lens' GetChannelSchedule Text
data GetChannelScheduleResponse = GetChannelScheduleResponse' {
- items :: Maybe [ScheduleEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetChannelScheduleResponse :: Int -> GetChannelScheduleResponse
getChannelScheduleResponse_items :: Lens' GetChannelScheduleResponse (Maybe [ScheduleEntry])
getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text)
getChannelScheduleResponse_httpStatus :: Lens' GetChannelScheduleResponse Int

Creating a Request

data GetChannelSchedule Source #

See: newGetChannelSchedule smart constructor.

Constructors

GetChannelSchedule'

Fields

durationMinutes :: Maybe Text
The duration in minutes of the channel schedule.
maxResults :: Maybe Natural
The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
nextToken :: Maybe Text
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
channelName :: Text
The name of the channel associated with this Channel Schedule.

Instances

Instances details

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

newGetChannelSchedule Source #

Arguments

:: Text	`GetChannelSchedule`
-> GetChannelSchedule

Create a value of GetChannelSchedule 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:durationMinutes:GetChannelSchedule', getChannelSchedule_durationMinutes - The duration in minutes of the channel schedule.

$sel:maxResults:GetChannelSchedule', getChannelSchedule_maxResults - The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.

GetChannelSchedule, getChannelSchedule_nextToken - (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

For the first GetChannelScheduleRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more channel schedules to get.

GetChannelSchedule, getChannelSchedule_channelName - The name of the channel associated with this Channel Schedule.

Request Lenses

getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text) Source #

The duration in minutes of the channel schedule.

getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural) Source #

The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.

getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text) Source #

(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

For the first GetChannelScheduleRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn't include a NextToken element, there are no more channel schedules to get.

getChannelSchedule_channelName :: Lens' GetChannelSchedule Text Source #

The name of the channel associated with this Channel Schedule.

Destructuring the Response

data GetChannelScheduleResponse Source #

See: newGetChannelScheduleResponse smart constructor.

Constructors

GetChannelScheduleResponse'
Fields items :: Maybe [ScheduleEntry] A list of schedule entries for the channel. nextToken :: Maybe Text Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetChannelScheduleResponse Source #

Arguments

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

Create a value of GetChannelScheduleResponse 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:items:GetChannelScheduleResponse', getChannelScheduleResponse_items - A list of schedule entries for the channel.

GetChannelSchedule, getChannelScheduleResponse_nextToken - Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

$sel:httpStatus:GetChannelScheduleResponse', getChannelScheduleResponse_httpStatus - The response's http status code.

Response Lenses

getChannelScheduleResponse_items :: Lens' GetChannelScheduleResponse (Maybe [ScheduleEntry]) Source #

A list of schedule entries for the channel.

getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text) Source #

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

getChannelScheduleResponse_httpStatus :: Lens' GetChannelScheduleResponse Int Source #

The response's http status code.