libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConvert.ListPresets

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.

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

  • maxResults :: Maybe Natural

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

Instances

Instances details
Eq ListPresets Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

Methods

(==) :: ListPresets -> ListPresets -> Bool #

(/=) :: ListPresets -> ListPresets -> Bool #

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 #

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 #

NFData ListPresets Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

Methods

rnf :: ListPresets -> () #

Hashable ListPresets Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

Methods

hashWithSalt :: Int -> ListPresets -> Int #

hash :: ListPresets -> Int #

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 :: ListPresets -> Request ListPresets #

response :: MonadResource m => Logger -> Service -> Proxy ListPresets -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPresets))) #

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 #

type Rep ListPresets Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

type Rep ListPresets = D1 ('MetaData "ListPresets" "Amazonka.MediaConvert.ListPresets" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" '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 "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "order") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Order)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListPresets Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

type AWSResponse ListPresets = ListPresetsResponse

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:

$sel:category: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:nextToken: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.

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

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

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

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

Destructuring the Response

data ListPresetsResponse Source #

See: newListPresetsResponse smart constructor.

Constructors

ListPresetsResponse' 

Fields

Instances

Instances details
Eq ListPresetsResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

Methods

(==) :: ListPresetsResponse -> ListPresetsResponse -> Bool #

(/=) :: ListPresetsResponse -> ListPresetsResponse -> Bool #

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 #

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 #

NFData ListPresetsResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

Methods

rnf :: ListPresetsResponse -> () #

type Rep ListPresetsResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListPresets

type Rep ListPresetsResponse = D1 ('MetaData "ListPresetsResponse" "Amazonka.MediaConvert.ListPresets" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "ListPresetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "presets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Preset])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

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

$sel:nextToken:ListPresets', listPresetsResponse_nextToken - Use this string to request the next batch of presets.

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

Response Lenses

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

List of presets

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

Use this string to request the next batch of presets.

listPresetsResponse_httpStatus :: Lens' ListPresetsResponse Int Source #

The response's http status code.