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.ListJobs
Description
Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.
This operation returns paginated results.
Synopsis
- data ListJobs = ListJobs' {}
- newListJobs :: ListJobs
- listJobs_status :: Lens' ListJobs (Maybe JobStatus)
- listJobs_queue :: Lens' ListJobs (Maybe Text)
- listJobs_nextToken :: Lens' ListJobs (Maybe Text)
- listJobs_order :: Lens' ListJobs (Maybe Order)
- listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
- data ListJobsResponse = ListJobsResponse' {}
- newListJobsResponse :: Int -> ListJobsResponse
- listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
- listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [Job])
- listJobsResponse_httpStatus :: Lens' ListJobsResponse Int
Creating a Request
See: newListJobs
smart constructor.
Constructors
ListJobs' | |
Fields
|
Instances
newListJobs :: ListJobs Source #
Create a value of ListJobs
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:status:ListJobs'
, listJobs_status
- Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE,
CANCELED, or ERROR.
$sel:queue:ListJobs'
, listJobs_queue
- Optional. Provide a queue name to get back only jobs from that queue.
$sel:nextToken:ListJobs'
, listJobs_nextToken
- Optional. Use this string, provided with the response to a previous
request, to request the next batch of jobs.
$sel:order:ListJobs'
, listJobs_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:ListJobs'
, listJobs_maxResults
- Optional. Number of jobs, up to twenty, that will be returned at one
time.
Request Lenses
listJobs_status :: Lens' ListJobs (Maybe JobStatus) Source #
Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
listJobs_queue :: Lens' ListJobs (Maybe Text) Source #
Optional. Provide a queue name to get back only jobs from that queue.
listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #
Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.
listJobs_order :: Lens' ListJobs (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.
listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #
Optional. Number of jobs, up to twenty, that will be returned at one time.
Destructuring the Response
data ListJobsResponse Source #
See: newListJobsResponse
smart constructor.
Constructors
ListJobsResponse' | |
Instances
Arguments
:: Int | |
-> ListJobsResponse |
Create a value of ListJobsResponse
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:nextToken:ListJobs'
, listJobsResponse_nextToken
- Use this string to request the next batch of jobs.
$sel:jobs:ListJobsResponse'
, listJobsResponse_jobs
- List of jobs
$sel:httpStatus:ListJobsResponse'
, listJobsResponse_httpStatus
- The response's http status code.
Response Lenses
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #
Use this string to request the next batch of jobs.
listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [Job]) Source #
List of jobs
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #
The response's http status code.