| 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.Snowball.ListJobs
Description
Returns an array of JobListEntry objects of the specified length. Each
JobListEntry object contains a job's state, a job's ID, and a value
that indicates whether the job is a job part, in the case of export
jobs. Calling this API action in one of the US regions will return jobs
from the list of all jobs associated with this account in all US
regions.
This operation returns paginated results.
Synopsis
- data ListJobs = ListJobs' {}
- newListJobs :: ListJobs
- listJobs_maxResults :: Lens' ListJobs (Maybe Natural)
- listJobs_nextToken :: Lens' ListJobs (Maybe Text)
- data ListJobsResponse = ListJobsResponse' {
- jobListEntries :: Maybe [JobListEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListJobsResponse :: Int -> ListJobsResponse
- listJobsResponse_jobListEntries :: Lens' ListJobsResponse (Maybe [JobListEntry])
- listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)
- listJobsResponse_httpStatus :: Lens' ListJobsResponse Int
Creating a Request
See: newListJobs smart constructor.
Constructors
| ListJobs' | |
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:maxResults:ListJobs', listJobs_maxResults - The number of JobListEntry objects to return.
ListJobs, listJobs_nextToken - HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry objects, you have the option of specifying
NextToken as the starting point for your returned list.
Request Lenses
listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #
The number of JobListEntry objects to return.
listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #
HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry objects, you have the option of specifying
NextToken as the starting point for your returned list.
Destructuring the Response
data ListJobsResponse Source #
See: newListJobsResponse smart constructor.
Constructors
| ListJobsResponse' | |
Fields
| |
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:jobListEntries:ListJobsResponse', listJobsResponse_jobListEntries - Each JobListEntry object contains a job's state, a job's ID, and a
value that indicates whether the job is a job part, in the case of
export jobs.
ListJobs, listJobsResponse_nextToken - HTTP requests are stateless. If you use this automatically generated
NextToken value in your next ListJobs call, your returned
JobListEntry objects will start from this point in the array.
$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.
Response Lenses
listJobsResponse_jobListEntries :: Lens' ListJobsResponse (Maybe [JobListEntry]) Source #
Each JobListEntry object contains a job's state, a job's ID, and a
value that indicates whether the job is a job part, in the case of
export jobs.
listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #
HTTP requests are stateless. If you use this automatically generated
NextToken value in your next ListJobs call, your returned
JobListEntry objects will start from this point in the array.
listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #
The response's http status code.