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 |
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.
Synopsis
- listJobs :: ListJobs
- data ListJobs
- ljStatus :: Lens' ListJobs (Maybe JobStatus)
- ljQueue :: Lens' ListJobs (Maybe Text)
- ljNextToken :: Lens' ListJobs (Maybe Text)
- ljOrder :: Lens' ListJobs (Maybe Order)
- ljMaxResults :: Lens' ListJobs (Maybe Int)
- listJobsResponse :: Int -> ListJobsResponse
- data ListJobsResponse
- ljrsNextToken :: Lens' ListJobsResponse (Maybe Text)
- ljrsJobs :: Lens' ListJobsResponse [Job]
- 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:
ljStatus
- Undocumented member.ljQueue
- Provide a queue name to get back only jobs from that queue.ljNextToken
- Use this string, provided with the response to a previous request, to request the next batch of jobs.ljOrder
- Undocumented member.ljMaxResults
- Optional. Number of jobs, up to twenty, that will be returned at one time.
See: listJobs
smart constructor.
Instances
Request Lenses
ljQueue :: Lens' ListJobs (Maybe Text) Source #
Provide a queue name to get back only jobs from that queue.
ljNextToken :: Lens' ListJobs (Maybe Text) Source #
Use this string, provided with the response to a previous request, to request the next batch of jobs.
ljMaxResults :: Lens' ListJobs (Maybe Int) Source #
Optional. Number of jobs, up to twenty, that will be returned at one time.
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:
ljrsNextToken
- Use this string to request the next batch of jobs.ljrsJobs
- List of jobsljrsResponseStatus
- -- | The response status code.
data ListJobsResponse Source #
See: listJobsResponse
smart constructor.
Instances
Response Lenses
ljrsNextToken :: Lens' ListJobsResponse (Maybe Text) Source #
Use this string to request the next batch of jobs.
ljrsResponseStatus :: Lens' ListJobsResponse Int Source #
- - | The response status code.