Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
- listJobs :: ListJobs
- data ListJobs
- ljNextToken :: Lens' ListJobs (Maybe Text)
- ljMaxResults :: Lens' ListJobs (Maybe Natural)
- listJobsResponse :: Int -> ListJobsResponse
- data ListJobsResponse
- ljrsJobListEntries :: Lens' ListJobsResponse [JobListEntry]
- ljrsNextToken :: Lens' ListJobsResponse (Maybe Text)
- ljrsResponseStatus :: Lens' ListJobsResponse Int
Creating a Request
Creates a value of ListJobs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljNextToken
- HTTP requests are stateless. To identify what object comes "next" in the list ofJobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.ljMaxResults
- The number ofJobListEntry
objects to return.
See: listJobs
smart constructor.
Request Lenses
ljNextToken :: 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.
ljMaxResults :: Lens' ListJobs (Maybe Natural) Source #
The number of JobListEntry
objects to return.
Destructuring the Response
Creates a value of ListJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljrsJobListEntries
- EachJobListEntry
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.ljrsNextToken
- HTTP requests are stateless. If you use this automatically generatedNextToken
value in your nextListJobs
call, your returnedJobListEntry
objects will start from this point in the array.ljrsResponseStatus
- -- | The response status code.
data ListJobsResponse Source #
See: listJobsResponse
smart constructor.
Response Lenses
ljrsJobListEntries :: Lens' ListJobsResponse [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.
ljrsNextToken :: 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.
ljrsResponseStatus :: Lens' ListJobsResponse Int Source #
- - | The response status code.