ListPipelineExecutionSteps - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListPipelineExecutionSteps

Gets a list of PipeLineExecutionStep objects.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "PipelineExecutionArn": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

PipelineExecutionArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "NextToken": "string", "PipelineExecutionSteps": [ { "CacheHitResult": { "SourcePipelineExecutionArn": "string" }, "EndTime": number, "FailureReason": "string", "Metadata": { "Callback": { "CallbackToken": "string", "OutputParameters": [ { "Name": "string", "Value": "string" } ], "SqsQueueUrl": "string" }, "Condition": { "Outcome": "string" }, "Lambda": { "Arn": "string", "OutputParameters": [ { "Name": "string", "Value": "string" } ] }, "Model": { "Arn": "string" }, "ProcessingJob": { "Arn": "string" }, "RegisterModel": { "Arn": "string" }, "TrainingJob": { "Arn": "string" }, "TransformJob": { "Arn": "string" }, "TuningJob": { "Arn": "string" } }, "StartTime": number, "StepName": "string", "StepStatus": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

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.

Type: Array of PipelineExecutionStep objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: