Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

list-pipeline-execution-steps

Description

Gets a list of PipeLineExecutionStep objects.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-pipeline-execution-steps is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PipelineExecutionSteps

Synopsis

  list-pipeline-execution-steps
[--pipeline-execution-arn <value>]
[--sort-order <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--pipeline-execution-arn (string)

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

--sort-order (string)

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

Possible values:

  • Ascending
  • Descending

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

PipelineExecutionSteps -> (list)

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.

(structure)

An execution of a step in a pipeline.

StepName -> (string)

The name of the step that is executed.

StartTime -> (timestamp)

The time that the step started executing.

EndTime -> (timestamp)

The time that the step stopped executing.

StepStatus -> (string)

The status of the step execution.

CacheHitResult -> (structure)

If this pipeline execution step was cached, details on the cache hit.

SourcePipelineExecutionArn -> (string)

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

FailureReason -> (string)

The reason why the step failed execution. This is only returned if the step failed its execution.

Metadata -> (structure)

Metadata for the step execution.

TrainingJob -> (structure)

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

Arn -> (string)

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

ProcessingJob -> (structure)

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

Arn -> (string)

The Amazon Resource Name (ARN) of the processing job.

TransformJob -> (structure)

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

Arn -> (string)

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

Model -> (structure)

Metadata for the Model step.

Arn -> (string)

The Amazon Resource Name (ARN) of the created model.

RegisterModel -> (structure)

Metadata for the RegisterModel step.

Arn -> (string)

The Amazon Resource Name (ARN) of the model package.

Condition -> (structure)

If this is a Condition step metadata object, details on the condition.

Outcome -> (string)

The outcome of the Condition step evaluation.

Callback -> (structure)

Metadata about a callback step.

CallbackToken -> (string)

The pipeline generated token from the Amazon SQS queue.

SqsQueueUrl -> (string)

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

OutputParameters -> (list)

A list of the output parameters of the callback step.

(structure)

An output parameter of a pipeline step.

Name -> (string)

The name of the output parameter.

Value -> (string)

The value of the output parameter.

NextToken -> (string)

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.