Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Gets a list of PipeLineExecutionStep
objects.
This operation returns paginated results.
Synopsis
- data ListPipelineExecutionSteps = ListPipelineExecutionSteps' {}
- newListPipelineExecutionSteps :: ListPipelineExecutionSteps
- listPipelineExecutionSteps_maxResults :: Lens' ListPipelineExecutionSteps (Maybe Natural)
- listPipelineExecutionSteps_nextToken :: Lens' ListPipelineExecutionSteps (Maybe Text)
- listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text)
- listPipelineExecutionSteps_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder)
- data ListPipelineExecutionStepsResponse = ListPipelineExecutionStepsResponse' {}
- newListPipelineExecutionStepsResponse :: Int -> ListPipelineExecutionStepsResponse
- listPipelineExecutionStepsResponse_nextToken :: Lens' ListPipelineExecutionStepsResponse (Maybe Text)
- listPipelineExecutionStepsResponse_pipelineExecutionSteps :: Lens' ListPipelineExecutionStepsResponse (Maybe [PipelineExecutionStep])
- listPipelineExecutionStepsResponse_httpStatus :: Lens' ListPipelineExecutionStepsResponse Int
Creating a Request
data ListPipelineExecutionSteps Source #
See: newListPipelineExecutionSteps
smart constructor.
ListPipelineExecutionSteps' | |
|
Instances
newListPipelineExecutionSteps :: ListPipelineExecutionSteps Source #
Create a value of ListPipelineExecutionSteps
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:maxResults:ListPipelineExecutionSteps'
, listPipelineExecutionSteps_maxResults
- The maximum number of pipeline execution steps to return in the
response.
ListPipelineExecutionSteps
, listPipelineExecutionSteps_nextToken
- If the result of the previous ListPipelineExecutionSteps
request was
truncated, the response includes a NextToken
. To retrieve the next set
of pipeline execution steps, use the token in the next request.
ListPipelineExecutionSteps
, listPipelineExecutionSteps_pipelineExecutionArn
- The Amazon Resource Name (ARN) of the pipeline execution.
$sel:sortOrder:ListPipelineExecutionSteps'
, listPipelineExecutionSteps_sortOrder
- The field by which to sort results. The default is CreatedTime
.
Request Lenses
listPipelineExecutionSteps_maxResults :: Lens' ListPipelineExecutionSteps (Maybe Natural) Source #
The maximum number of pipeline execution steps to return in the response.
listPipelineExecutionSteps_nextToken :: Lens' ListPipelineExecutionSteps (Maybe Text) Source #
If the result of the previous ListPipelineExecutionSteps
request was
truncated, the response includes a NextToken
. To retrieve the next set
of pipeline execution steps, use the token in the next request.
listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline execution.
listPipelineExecutionSteps_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder) Source #
The field by which to sort results. The default is CreatedTime
.
Destructuring the Response
data ListPipelineExecutionStepsResponse Source #
See: newListPipelineExecutionStepsResponse
smart constructor.
ListPipelineExecutionStepsResponse' | |
|
Instances
newListPipelineExecutionStepsResponse Source #
Create a value of ListPipelineExecutionStepsResponse
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:
ListPipelineExecutionSteps
, listPipelineExecutionStepsResponse_nextToken
- If the result of the previous ListPipelineExecutionSteps
request was
truncated, the response includes a NextToken
. To retrieve the next set
of pipeline execution steps, use the token in the next request.
$sel:pipelineExecutionSteps:ListPipelineExecutionStepsResponse'
, listPipelineExecutionStepsResponse_pipelineExecutionSteps
- A list of PipeLineExecutionStep
objects. Each PipeLineExecutionStep
consists of StepName, StartTime, EndTime, StepStatus, and Metadata.
Metadata is an object with properties for each job that contains
relevant information about the job created by the step.
$sel:httpStatus:ListPipelineExecutionStepsResponse'
, listPipelineExecutionStepsResponse_httpStatus
- The response's http status code.
Response Lenses
listPipelineExecutionStepsResponse_nextToken :: Lens' ListPipelineExecutionStepsResponse (Maybe Text) Source #
If the result of the previous ListPipelineExecutionSteps
request was
truncated, the response includes a NextToken
. To retrieve the next set
of pipeline execution steps, use the token in the next request.
listPipelineExecutionStepsResponse_pipelineExecutionSteps :: Lens' ListPipelineExecutionStepsResponse (Maybe [PipelineExecutionStep]) Source #
A list of PipeLineExecutionStep
objects. Each PipeLineExecutionStep
consists of StepName, StartTime, EndTime, StepStatus, and Metadata.
Metadata is an object with properties for each job that contains
relevant information about the job created by the step.
listPipelineExecutionStepsResponse_httpStatus :: Lens' ListPipelineExecutionStepsResponse Int Source #
The response's http status code.