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.MediaLive.ListOfferings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List offerings available for purchase.

This operation returns paginated results.

Synopsis

data ListOfferings = ListOfferings' {
- channelClass :: Maybe Text
- channelConfiguration :: Maybe Text
- codec :: Maybe Text
- duration :: Maybe Text
- maxResults :: Maybe Natural
- maximumBitrate :: Maybe Text
- maximumFramerate :: Maybe Text
- nextToken :: Maybe Text
- resolution :: Maybe Text
- resourceType :: Maybe Text
- specialFeature :: Maybe Text
- videoQuality :: Maybe Text
}
newListOfferings :: ListOfferings
listOfferings_channelClass :: Lens' ListOfferings (Maybe Text)
listOfferings_channelConfiguration :: Lens' ListOfferings (Maybe Text)
listOfferings_codec :: Lens' ListOfferings (Maybe Text)
listOfferings_duration :: Lens' ListOfferings (Maybe Text)
listOfferings_maxResults :: Lens' ListOfferings (Maybe Natural)
listOfferings_maximumBitrate :: Lens' ListOfferings (Maybe Text)
listOfferings_maximumFramerate :: Lens' ListOfferings (Maybe Text)
listOfferings_nextToken :: Lens' ListOfferings (Maybe Text)
listOfferings_resolution :: Lens' ListOfferings (Maybe Text)
listOfferings_resourceType :: Lens' ListOfferings (Maybe Text)
listOfferings_specialFeature :: Lens' ListOfferings (Maybe Text)
listOfferings_videoQuality :: Lens' ListOfferings (Maybe Text)
data ListOfferingsResponse = ListOfferingsResponse' {
- nextToken :: Maybe Text
- offerings :: Maybe [Offering]
- httpStatus :: Int
}
newListOfferingsResponse :: Int -> ListOfferingsResponse
listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text)
listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering])
listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int

Creating a Request

data ListOfferings Source #

Placeholder documentation for ListOfferingsRequest

See: newListOfferings smart constructor.

Constructors

ListOfferings'

Fields

channelClass :: Maybe Text
Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
channelConfiguration :: Maybe Text
Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
codec :: Maybe Text
Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
duration :: Maybe Text
Filter by offering duration, e.g. '12'
maxResults :: Maybe Natural
maximumBitrate :: Maybe Text
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
maximumFramerate :: Maybe Text
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
nextToken :: Maybe Text
resolution :: Maybe Text
Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
resourceType :: Maybe Text
Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
specialFeature :: Maybe Text
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
videoQuality :: Maybe Text
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

Instances

Instances details

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

newListOfferings :: ListOfferings Source #

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

ListOfferings, listOfferings_channelClass - Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

$sel:channelConfiguration:ListOfferings', listOfferings_channelConfiguration - Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)

ListOfferings, listOfferings_codec - Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'

ListOfferings, listOfferings_duration - Filter by offering duration, e.g. '12'

$sel:maxResults:ListOfferings', listOfferings_maxResults - Undocumented member.

ListOfferings, listOfferings_maximumBitrate - Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

ListOfferings, listOfferings_maximumFramerate - Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

ListOfferings, listOfferings_nextToken - Undocumented member.

ListOfferings, listOfferings_resolution - Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'

ListOfferings, listOfferings_resourceType - Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

ListOfferings, listOfferings_specialFeature - Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

ListOfferings, listOfferings_videoQuality - Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

Request Lenses

listOfferings_channelClass :: Lens' ListOfferings (Maybe Text) Source #

Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

listOfferings_channelConfiguration :: Lens' ListOfferings (Maybe Text) Source #

Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)

listOfferings_codec :: Lens' ListOfferings (Maybe Text) Source #

Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'

listOfferings_duration :: Lens' ListOfferings (Maybe Text) Source #

Filter by offering duration, e.g. '12'

listOfferings_maxResults :: Lens' ListOfferings (Maybe Natural) Source #

Undocumented member.

listOfferings_maximumBitrate :: Lens' ListOfferings (Maybe Text) Source #

Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

listOfferings_maximumFramerate :: Lens' ListOfferings (Maybe Text) Source #

Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

listOfferings_nextToken :: Lens' ListOfferings (Maybe Text) Source #

Undocumented member.

listOfferings_resolution :: Lens' ListOfferings (Maybe Text) Source #

Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'

listOfferings_resourceType :: Lens' ListOfferings (Maybe Text) Source #

Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

listOfferings_specialFeature :: Lens' ListOfferings (Maybe Text) Source #

Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

listOfferings_videoQuality :: Lens' ListOfferings (Maybe Text) Source #

Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

Destructuring the Response

data ListOfferingsResponse Source #

Placeholder documentation for ListOfferingsResponse

See: newListOfferingsResponse smart constructor.

Constructors

ListOfferingsResponse'
Fields nextToken :: Maybe Text Token to retrieve the next page of results offerings :: Maybe [Offering] List of offerings httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListOfferingsResponse Source #

Arguments

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

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

ListOfferings, listOfferingsResponse_nextToken - Token to retrieve the next page of results

$sel:offerings:ListOfferingsResponse', listOfferingsResponse_offerings - List of offerings

$sel:httpStatus:ListOfferingsResponse', listOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

listOfferingsResponse_nextToken :: Lens' ListOfferingsResponse (Maybe Text) Source #

Token to retrieve the next page of results

listOfferingsResponse_offerings :: Lens' ListOfferingsResponse (Maybe [Offering]) Source #

List of offerings

listOfferingsResponse_httpStatus :: Lens' ListOfferingsResponse Int Source #

The response's http status code.