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

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

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.

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

  • maxResults :: Maybe Natural

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

Instances

Instances details
Eq ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Read ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Show ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Generic ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Associated Types

type Rep ListJobTemplates :: Type -> Type #

NFData ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Methods

rnf :: ListJobTemplates -> () #

Hashable ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

AWSPager ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

AWSRequest ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Associated Types

type AWSResponse ListJobTemplates #

ToHeaders ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

ToPath ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

ToQuery ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

type Rep ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

type Rep ListJobTemplates = D1 ('MetaData "ListJobTemplates" "Amazonka.MediaConvert.ListJobTemplates" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" '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 "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 ListJobTemplates Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

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:

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

$sel:maxResults:ListJobTemplates', listJobTemplates_maxResults - Optional. Number of job templates, up to twenty, that will be returned at one time.

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

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

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

Destructuring the Response

data ListJobTemplatesResponse Source #

See: newListJobTemplatesResponse smart constructor.

Constructors

ListJobTemplatesResponse' 

Fields

Instances

Instances details
Eq ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Read ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Show ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Generic ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

Associated Types

type Rep ListJobTemplatesResponse :: Type -> Type #

NFData ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

type Rep ListJobTemplatesResponse Source # 
Instance details

Defined in Amazonka.MediaConvert.ListJobTemplates

type Rep ListJobTemplatesResponse = D1 ('MetaData "ListJobTemplatesResponse" "Amazonka.MediaConvert.ListJobTemplates" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" '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 #

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.

$sel:nextToken: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_nextToken :: Lens' ListJobTemplatesResponse (Maybe Text) Source #

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