Amazonka.SageMaker.ListPipelineExecutionSteps

Gets a list of PipeLineExecutionStep objects.

This operation returns paginated results.

Creating a Request

data ListPipelineExecutionSteps

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

ToJSON ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

toJSON :: ListPipelineExecutionSteps -> Value

toEncoding :: ListPipelineExecutionSteps -> Encoding

toJSONList :: [ListPipelineExecutionSteps] -> Value

toEncodingList :: [ListPipelineExecutionSteps] -> Encoding

ToHeaders ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

toHeaders :: ListPipelineExecutionSteps -> [Header]

ToPath ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

toPath :: ListPipelineExecutionSteps -> ByteString

ToQuery ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

toQuery :: ListPipelineExecutionSteps -> QueryString

AWSPager ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

page :: ListPipelineExecutionSteps -> AWSResponse ListPipelineExecutionSteps -> Maybe ListPipelineExecutionSteps

AWSRequest ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Associated Types

type AWSResponse ListPipelineExecutionSteps

Methods

request :: (Service -> Service) -> ListPipelineExecutionSteps -> Request ListPipelineExecutionSteps

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPipelineExecutionSteps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPipelineExecutionSteps)))

Generic ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Associated Types

type Rep ListPipelineExecutionSteps :: Type -> Type

Methods

from :: ListPipelineExecutionSteps -> Rep ListPipelineExecutionSteps x

to :: Rep ListPipelineExecutionSteps x -> ListPipelineExecutionSteps

Read ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

readsPrec :: Int -> ReadS ListPipelineExecutionSteps

readList :: ReadS [ListPipelineExecutionSteps]

readPrec :: ReadPrec ListPipelineExecutionSteps

readListPrec :: ReadPrec [ListPipelineExecutionSteps]

Show ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

showsPrec :: Int -> ListPipelineExecutionSteps -> ShowS

show :: ListPipelineExecutionSteps -> String

showList :: [ListPipelineExecutionSteps] -> ShowS

NFData ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

rnf :: ListPipelineExecutionSteps -> ()

Eq ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

(==) :: ListPipelineExecutionSteps -> ListPipelineExecutionSteps -> Bool

(/=) :: ListPipelineExecutionSteps -> ListPipelineExecutionSteps -> Bool

Hashable ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

hashWithSalt :: Int -> ListPipelineExecutionSteps -> Int

hash :: ListPipelineExecutionSteps -> Int

type AWSResponse ListPipelineExecutionSteps

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

type AWSResponse ListPipelineExecutionSteps = ListPipelineExecutionStepsResponse

type Rep ListPipelineExecutionSteps

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

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)

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

listPipelineExecutionSteps_nextToken :: Lens' ListPipelineExecutionSteps (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.

listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text)

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

listPipelineExecutionSteps_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder)

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

Destructuring the Response

data ListPipelineExecutionStepsResponse

See: newListPipelineExecutionStepsResponse smart constructor.

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

Generic ListPipelineExecutionStepsResponse

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Associated Types

type Rep ListPipelineExecutionStepsResponse :: Type -> Type

Methods

from :: ListPipelineExecutionStepsResponse -> Rep ListPipelineExecutionStepsResponse x

to :: Rep ListPipelineExecutionStepsResponse x -> ListPipelineExecutionStepsResponse

Read ListPipelineExecutionStepsResponse

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

readsPrec :: Int -> ReadS ListPipelineExecutionStepsResponse

readList :: ReadS [ListPipelineExecutionStepsResponse]

readPrec :: ReadPrec ListPipelineExecutionStepsResponse

readListPrec :: ReadPrec [ListPipelineExecutionStepsResponse]

Show ListPipelineExecutionStepsResponse

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

showsPrec :: Int -> ListPipelineExecutionStepsResponse -> ShowS

show :: ListPipelineExecutionStepsResponse -> String

showList :: [ListPipelineExecutionStepsResponse] -> ShowS

NFData ListPipelineExecutionStepsResponse

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

rnf :: ListPipelineExecutionStepsResponse -> ()

Eq ListPipelineExecutionStepsResponse

Defined in Amazonka.SageMaker.ListPipelineExecutionSteps

Methods

(==) :: ListPipelineExecutionStepsResponse -> ListPipelineExecutionStepsResponse -> Bool

(/=) :: ListPipelineExecutionStepsResponse -> ListPipelineExecutionStepsResponse -> Bool

type Rep ListPipelineExecutionStepsResponse

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

Arguments

:: Int

$sel:httpStatus:ListPipelineExecutionStepsResponse'

-> 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:

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)

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])

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

The response's http status code.