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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListJobTemplates = ListJobTemplates' {
- category :: Maybe Text
- listBy :: Maybe JobTemplateListBy
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- order :: Maybe Order
}
newListJobTemplates :: ListJobTemplates
listJobTemplates_category :: Lens' ListJobTemplates (Maybe Text)
listJobTemplates_listBy :: Lens' ListJobTemplates (Maybe JobTemplateListBy)
listJobTemplates_maxResults :: Lens' ListJobTemplates (Maybe Natural)
listJobTemplates_nextToken :: Lens' ListJobTemplates (Maybe Text)
listJobTemplates_order :: Lens' ListJobTemplates (Maybe Order)
data ListJobTemplatesResponse = ListJobTemplatesResponse' {
- jobTemplates :: Maybe [JobTemplate]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListJobTemplatesResponse :: Int -> ListJobTemplatesResponse
listJobTemplatesResponse_jobTemplates :: Lens' ListJobTemplatesResponse (Maybe [JobTemplate])
listJobTemplatesResponse_nextToken :: Lens' ListJobTemplatesResponse (Maybe Text)
listJobTemplatesResponse_httpStatus :: Lens' ListJobTemplatesResponse Int

Creating a Request

data ListJobTemplates Source #

See: newListJobTemplates smart constructor.

Constructors

ListJobTemplates'

Fields

category :: Maybe Text
Optionally, specify a job template category to limit responses to only job templates from that category.
listBy :: Maybe JobTemplateListBy
Optional. When you request a list of job templates, 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 job templates, 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 job templates.
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 ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods toHeaders :: ListJobTemplates -> [Header] #
ToPath ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods toPath :: ListJobTemplates -> ByteString #
ToQuery ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods toQuery :: ListJobTemplates -> QueryString #
AWSPager ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods page :: ListJobTemplates -> AWSResponse ListJobTemplates -> Maybe ListJobTemplates #
AWSRequest ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Associated Types type AWSResponse ListJobTemplates # Methods request :: (Service -> Service) -> ListJobTemplates -> Request ListJobTemplates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListJobTemplates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListJobTemplates))) #
Generic ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Associated Types type Rep ListJobTemplates :: Type -> Type # Methods from :: ListJobTemplates -> Rep ListJobTemplates x # to :: Rep ListJobTemplates x -> ListJobTemplates #
Read ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods readsPrec :: Int -> ReadS ListJobTemplates # readList :: ReadS [ListJobTemplates] # readPrec :: ReadPrec ListJobTemplates # readListPrec :: ReadPrec [ListJobTemplates] #
Show ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods showsPrec :: Int -> ListJobTemplates -> ShowS # show :: ListJobTemplates -> String # showList :: [ListJobTemplates] -> ShowS #
NFData ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods rnf :: ListJobTemplates -> () #
Eq ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods (==) :: ListJobTemplates -> ListJobTemplates -> Bool # (/=) :: ListJobTemplates -> ListJobTemplates -> Bool #
Hashable ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates Methods hashWithSalt :: Int -> ListJobTemplates -> Int # hash :: ListJobTemplates -> Int #
type AWSResponse ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates type AWSResponse ListJobTemplates = ListJobTemplatesResponse
type Rep ListJobTemplates Source #
Instance details Defined in Amazonka.MediaConvert.ListJobTemplates type Rep ListJobTemplates = D1 ('MetaData "ListJobTemplates" "Amazonka.MediaConvert.ListJobTemplates" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "ListJobTemplates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "listBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTemplateListBy))) :: (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))))))

newListJobTemplates :: ListJobTemplates Source #

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

ListJobTemplates, listJobTemplates_category - Optionally, specify a job template category to limit responses to only job templates from that category.

$sel:listBy:ListJobTemplates', listJobTemplates_listBy - Optional. When you request a list of job templates, 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:ListJobTemplates', listJobTemplates_maxResults - Optional. Number of job templates, up to twenty, that will be returned at one time.

ListJobTemplates, listJobTemplates_nextToken - Use this string, provided with the response to a previous request, to request the next batch of job templates.

$sel:order:ListJobTemplates', listJobTemplates_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

listJobTemplates_category :: Lens' ListJobTemplates (Maybe Text) Source #

Optionally, specify a job template category to limit responses to only job templates from that category.

listJobTemplates_listBy :: Lens' ListJobTemplates (Maybe JobTemplateListBy) Source #

Optional. When you request a list of job templates, 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.

listJobTemplates_maxResults :: Lens' ListJobTemplates (Maybe Natural) Source #

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

listJobTemplates_nextToken :: Lens' ListJobTemplates (Maybe Text) Source #

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

listJobTemplates_order :: Lens' ListJobTemplates (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 ListJobTemplatesResponse Source #

See: newListJobTemplatesResponse smart constructor.

Constructors

ListJobTemplatesResponse'
Fields jobTemplates :: Maybe [JobTemplate] List of Job templates. nextToken :: Maybe Text Use this string to request the next batch of job templates. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListJobTemplatesResponse Source #

Arguments

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

Create a value of ListJobTemplatesResponse 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:jobTemplates:ListJobTemplatesResponse', listJobTemplatesResponse_jobTemplates - List of Job templates.

ListJobTemplates, listJobTemplatesResponse_nextToken - Use this string to request the next batch of job templates.

$sel:httpStatus:ListJobTemplatesResponse', listJobTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

listJobTemplatesResponse_jobTemplates :: Lens' ListJobTemplatesResponse (Maybe [JobTemplate]) Source #

List of Job templates.

listJobTemplatesResponse_nextToken :: Lens' ListJobTemplatesResponse (Maybe Text) Source #

Use this string to request the next batch of job templates.

listJobTemplatesResponse_httpStatus :: Lens' ListJobTemplatesResponse Int Source #

The response's http status code.