| 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.SageMaker.ListPipelineExecutionSteps
Description
Gets a list of PipeLineExecutionStep objects.
This operation returns paginated results.
Synopsis
- data ListPipelineExecutionSteps = ListPipelineExecutionSteps' {}
- newListPipelineExecutionSteps :: ListPipelineExecutionSteps
- listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text)
- listPipelineExecutionSteps_nextToken :: Lens' ListPipelineExecutionSteps (Maybe Text)
- listPipelineExecutionSteps_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder)
- listPipelineExecutionSteps_maxResults :: Lens' ListPipelineExecutionSteps (Maybe Natural)
- data ListPipelineExecutionStepsResponse = ListPipelineExecutionStepsResponse' {}
- newListPipelineExecutionStepsResponse :: Int -> ListPipelineExecutionStepsResponse
- listPipelineExecutionStepsResponse_pipelineExecutionSteps :: Lens' ListPipelineExecutionStepsResponse (Maybe [PipelineExecutionStep])
- listPipelineExecutionStepsResponse_nextToken :: Lens' ListPipelineExecutionStepsResponse (Maybe Text)
- listPipelineExecutionStepsResponse_httpStatus :: Lens' ListPipelineExecutionStepsResponse Int
Creating a Request
data ListPipelineExecutionSteps Source #
See: newListPipelineExecutionSteps smart constructor.
Constructors
| ListPipelineExecutionSteps' | |
Fields
| |
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:pipelineExecutionArn:ListPipelineExecutionSteps', listPipelineExecutionSteps_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.
$sel:nextToken: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.
$sel:sortOrder:ListPipelineExecutionSteps', listPipelineExecutionSteps_sortOrder - The field by which to sort results. The default is CreatedTime.
$sel:maxResults:ListPipelineExecutionSteps', listPipelineExecutionSteps_maxResults - The maximum number of pipeline execution steps to return in the
response.
Request Lenses
listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline execution.
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_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder) Source #
The field by which to sort results. The default is CreatedTime.
listPipelineExecutionSteps_maxResults :: Lens' ListPipelineExecutionSteps (Maybe Natural) Source #
The maximum number of pipeline execution steps to return in the response.
Destructuring the Response
data ListPipelineExecutionStepsResponse Source #
See: newListPipelineExecutionStepsResponse smart constructor.
Constructors
| ListPipelineExecutionStepsResponse' | |
Fields
| |
Instances
newListPipelineExecutionStepsResponse Source #
Arguments
| :: Int | |
| -> ListPipelineExecutionStepsResponse |
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:
$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:nextToken: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:httpStatus:ListPipelineExecutionStepsResponse', listPipelineExecutionStepsResponse_httpStatus - The response's http status code.
Response Lenses
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_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_httpStatus :: Lens' ListPipelineExecutionStepsResponse Int Source #
The response's http status code.