| Copyright | (c) 2013-2021 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 |
Amazonka.ElasticTranscoder.ListJobsByPipeline
Description
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.
Synopsis
- data ListJobsByPipeline = ListJobsByPipeline' {}
- newListJobsByPipeline :: Text -> ListJobsByPipeline
- listJobsByPipeline_ascending :: Lens' ListJobsByPipeline (Maybe Text)
- listJobsByPipeline_pageToken :: Lens' ListJobsByPipeline (Maybe Text)
- listJobsByPipeline_pipelineId :: Lens' ListJobsByPipeline Text
- data ListJobsByPipelineResponse = ListJobsByPipelineResponse' {
- nextPageToken :: Maybe Text
- jobs :: Maybe [Job]
- httpStatus :: Int
- newListJobsByPipelineResponse :: Int -> ListJobsByPipelineResponse
- listJobsByPipelineResponse_nextPageToken :: Lens' ListJobsByPipelineResponse (Maybe Text)
- listJobsByPipelineResponse_jobs :: Lens' ListJobsByPipelineResponse (Maybe [Job])
- listJobsByPipelineResponse_httpStatus :: Lens' ListJobsByPipelineResponse Int
Creating a Request
data ListJobsByPipeline Source #
The ListJobsByPipelineRequest structure.
See: newListJobsByPipeline smart constructor.
Constructors
| ListJobsByPipeline' | |
Fields
| |
Instances
newListJobsByPipeline Source #
Arguments
| :: Text | |
| -> ListJobsByPipeline |
Create a value of ListJobsByPipeline 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:ascending:ListJobsByPipeline', listJobsByPipeline_ascending - 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.
$sel:pageToken:ListJobsByPipeline', listJobsByPipeline_pageToken - When Elastic Transcoder returns more than one page of results, use
pageToken in subsequent GET requests to get each successive page of
results.
$sel:pipelineId:ListJobsByPipeline', listJobsByPipeline_pipelineId - The ID of the pipeline for which you want to get job information.
Request Lenses
listJobsByPipeline_ascending :: 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.
listJobsByPipeline_pageToken :: 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.
listJobsByPipeline_pipelineId :: Lens' ListJobsByPipeline Text Source #
The ID of the pipeline for which you want to get job information.
Destructuring the Response
data ListJobsByPipelineResponse Source #
The ListJobsByPipelineResponse structure.
See: newListJobsByPipelineResponse smart constructor.
Constructors
| ListJobsByPipelineResponse' | |
Fields
| |
Instances
newListJobsByPipelineResponse Source #
Create a value of ListJobsByPipelineResponse 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:nextPageToken:ListJobsByPipelineResponse', listJobsByPipelineResponse_nextPageToken - 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.
$sel:jobs:ListJobsByPipelineResponse', listJobsByPipelineResponse_jobs - An array of Job objects that are in the specified pipeline.
$sel:httpStatus:ListJobsByPipelineResponse', listJobsByPipelineResponse_httpStatus - The response's http status code.
Response Lenses
listJobsByPipelineResponse_nextPageToken :: 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.
listJobsByPipelineResponse_jobs :: Lens' ListJobsByPipelineResponse (Maybe [Job]) Source #
An array of Job objects that are in the specified pipeline.
listJobsByPipelineResponse_httpStatus :: Lens' ListJobsByPipelineResponse Int Source #
The response's http status code.