| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data ListJobTemplates = ListJobTemplates' {}
- newListJobTemplates :: ListJobTemplates
- listJobTemplates_category :: Lens' ListJobTemplates (Maybe Text)
- listJobTemplates_listBy :: Lens' ListJobTemplates (Maybe JobTemplateListBy)
- listJobTemplates_nextToken :: Lens' ListJobTemplates (Maybe Text)
- listJobTemplates_order :: Lens' ListJobTemplates (Maybe Order)
- listJobTemplates_maxResults :: Lens' ListJobTemplates (Maybe Natural)
- 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
| |
Instances
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
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_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.