amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.ListPipelineExecutionSteps

Description

Gets a list of PipeLineExecutionStep objects.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPipelineExecutionSteps Source #

See: newListPipelineExecutionSteps smart constructor.

Constructors

ListPipelineExecutionSteps' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of pipeline execution steps to return in the response.

  • nextToken :: Maybe Text

    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.

  • pipelineExecutionArn :: Maybe Text

    The Amazon Resource Name (ARN) of the pipeline execution.

  • sortOrder :: Maybe SortOrder

    The field by which to sort results. The default is CreatedTime.

Instances

Instances details
ToJSON ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

ToHeaders ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

ToPath ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

ToQuery ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

AWSPager ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

AWSRequest ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Generic ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Associated Types

type Rep ListPipelineExecutionSteps :: Type -> Type #

Read ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Show ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

NFData ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Eq ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Hashable ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type AWSResponse ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type Rep ListPipelineExecutionSteps Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type Rep ListPipelineExecutionSteps = D1 ('MetaData "ListPipelineExecutionSteps" "Amazonka.SageMaker.ListPipelineExecutionSteps" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListPipelineExecutionSteps'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pipelineExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)))))

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 #

Constructors

ListPipelineExecutionStepsResponse' 

Fields

  • nextToken :: Maybe Text

    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.

  • pipelineExecutionSteps :: Maybe [PipelineExecutionStep]

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Associated Types

type Rep ListPipelineExecutionStepsResponse :: Type -> Type #

Read ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Show ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

NFData ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Eq ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type Rep ListPipelineExecutionStepsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type Rep ListPipelineExecutionStepsResponse = D1 ('MetaData "ListPipelineExecutionStepsResponse" "Amazonka.SageMaker.ListPipelineExecutionSteps" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListPipelineExecutionStepsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pipelineExecutionSteps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PipelineExecutionStep])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.