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.MediaConvert.ListPresets

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPresets Source #

See: newListPresets smart constructor.

Constructors

ListPresets'

Fields

category :: Maybe Text
Optionally, specify a preset category to limit responses to only presets from that category.
listBy :: Maybe PresetListBy
Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.
maxResults :: Maybe Natural
Optional. Number of presets, up to twenty, that will be returned at one time
nextToken :: Maybe Text
Use this string, provided with the response to a previous request, to request the next batch of presets.
order :: Maybe Order
Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Instances

Instances details

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

newListPresets :: ListPresets Source #

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

ListPresets, listPresets_category - Optionally, specify a preset category to limit responses to only presets from that category.

$sel:listBy:ListPresets', listPresets_listBy - Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.

$sel:maxResults:ListPresets', listPresets_maxResults - Optional. Number of presets, up to twenty, that will be returned at one time

ListPresets, listPresets_nextToken - Use this string, provided with the response to a previous request, to request the next batch of presets.

$sel:order:ListPresets', listPresets_order - Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Request Lenses

listPresets_category :: Lens' ListPresets (Maybe Text) Source #

Optionally, specify a preset category to limit responses to only presets from that category.

listPresets_listBy :: Lens' ListPresets (Maybe PresetListBy) Source #

Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.

listPresets_maxResults :: Lens' ListPresets (Maybe Natural) Source #

Optional. Number of presets, up to twenty, that will be returned at one time

listPresets_nextToken :: Lens' ListPresets (Maybe Text) Source #

Use this string, provided with the response to a previous request, to request the next batch of presets.

listPresets_order :: Lens' ListPresets (Maybe Order) Source #

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Destructuring the Response

data ListPresetsResponse Source #

See: newListPresetsResponse smart constructor.

Constructors

ListPresetsResponse'
Fields nextToken :: Maybe Text Use this string to request the next batch of presets. presets :: Maybe [Preset] List of presets httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListPresetsResponse Source #

Arguments

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

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

ListPresets, listPresetsResponse_nextToken - Use this string to request the next batch of presets.

$sel:presets:ListPresetsResponse', listPresetsResponse_presets - List of presets

$sel:httpStatus:ListPresetsResponse', listPresetsResponse_httpStatus - The response's http status code.

Response Lenses

listPresetsResponse_nextToken :: Lens' ListPresetsResponse (Maybe Text) Source #

Use this string to request the next batch of presets.

listPresetsResponse_presets :: Lens' ListPresetsResponse (Maybe [Preset]) Source #

List of presets

listPresetsResponse_httpStatus :: Lens' ListPresetsResponse Int Source #

The response's http status code.