Copyright | (c) 2013-2016 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 ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.
This operation returns paginated results.
- listJobsByPipeline :: Text -> ListJobsByPipeline
- data ListJobsByPipeline
- ljbpAscending :: Lens' ListJobsByPipeline (Maybe Text)
- ljbpPageToken :: Lens' ListJobsByPipeline (Maybe Text)
- ljbpPipelineId :: Lens' ListJobsByPipeline Text
- listJobsByPipelineResponse :: Int -> ListJobsByPipelineResponse
- data ListJobsByPipelineResponse
- ljbprsNextPageToken :: Lens' ListJobsByPipelineResponse (Maybe Text)
- ljbprsJobs :: Lens' ListJobsByPipelineResponse [Job']
- ljbprsResponseStatus :: Lens' ListJobsByPipelineResponse Int
Creating a Request
Creates a value of ListJobsByPipeline
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListJobsByPipeline Source #
The ListJobsByPipelineRequest
structure.
See: listJobsByPipeline
smart constructor.
Request Lenses
ljbpAscending :: Lens' ListJobsByPipeline (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
.
ljbpPageToken :: Lens' ListJobsByPipeline (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.
ljbpPipelineId :: Lens' ListJobsByPipeline Text Source #
The ID of the pipeline for which you want to get job information.
Destructuring the Response
listJobsByPipelineResponse Source #
Creates a value of ListJobsByPipelineResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListJobsByPipelineResponse Source #
The ListJobsByPipelineResponse
structure.
See: listJobsByPipelineResponse
smart constructor.
Response Lenses
ljbprsNextPageToken :: Lens' ListJobsByPipelineResponse (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
.
ljbprsJobs :: Lens' ListJobsByPipelineResponse [Job'] Source #
An array of Job
objects that are in the specified pipeline.
ljbprsResponseStatus :: Lens' ListJobsByPipelineResponse Int Source #
The response status code.