Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.
See: AWS API Reference for ListJobsByStatus.
This operation returns paginated results.
- listJobsByStatus :: Text -> ListJobsByStatus
- data ListJobsByStatus
- ljbsAscending :: Lens' ListJobsByStatus (Maybe Text)
- ljbsPageToken :: Lens' ListJobsByStatus (Maybe Text)
- ljbsStatus :: Lens' ListJobsByStatus Text
- listJobsByStatusResponse :: Int -> ListJobsByStatusResponse
- data ListJobsByStatusResponse
- ljbsrsNextPageToken :: Lens' ListJobsByStatusResponse (Maybe Text)
- ljbsrsJobs :: Lens' ListJobsByStatusResponse [Job']
- ljbsrsResponseStatus :: Lens' ListJobsByStatusResponse Int
Creating a Request
Creates a value of ListJobsByStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListJobsByStatus Source
The ListJobsByStatusRequest
structure.
See: listJobsByStatus
smart constructor.
Request Lenses
ljbsAscending :: Lens' ListJobsByStatus (Maybe Text) Source
To list jobs in chronological order by the date and time that they were
submitted, enter true
. To list jobs in reverse chronological order,
enter false
.
ljbsPageToken :: Lens' ListJobsByStatus (Maybe Text) Source
When Elastic Transcoder returns more than one page of results, use
pageToken
in subsequent GET
requests to get each successive page of
results.
ljbsStatus :: Lens' ListJobsByStatus Text Source
To get information about all of the jobs associated with the current AWS
account that have a given status, specify the following status:
Submitted
, Progressing
, Complete
, Canceled
, or Error
.
Destructuring the Response
listJobsByStatusResponse Source
Creates a value of ListJobsByStatusResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListJobsByStatusResponse Source
The ListJobsByStatusResponse
structure.
See: listJobsByStatusResponse
smart constructor.
Response Lenses
ljbsrsNextPageToken :: Lens' ListJobsByStatusResponse (Maybe Text) Source
A value that you use to access the second and subsequent pages of
results, if any. When the jobs in the specified pipeline fit on one page
or when you've reached the last page of results, the value of
NextPageToken
is null
.
ljbsrsJobs :: Lens' ListJobsByStatusResponse [Job'] Source
An array of Job
objects that have the specified status.
ljbsrsResponseStatus :: Lens' ListJobsByStatusResponse Int Source
The response status code.