Amazon SageMaker Service

{'PipelineExecutionSteps': {'Metadata': {'TuningJob': {'Arn': 'string'}}}}

Gets a list of PipeLineExecutionStep objects.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_execution_steps(
    PipelineExecutionArn='string',
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending'
)

type PipelineExecutionArn

string

param PipelineExecutionArn

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

type NextToken

string

param 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 MaxResults

integer

param MaxResults

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

type SortOrder

string

param SortOrder

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

rtype

dict

returns

Response Syntax

{
    'PipelineExecutionSteps': [
        {
            'StepName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StepStatus': 'Starting'|'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
            'CacheHitResult': {
                'SourcePipelineExecutionArn': 'string'
            },
            'FailureReason': 'string',
            'Metadata': {
                'TrainingJob': {
                    'Arn': 'string'
                },
                'ProcessingJob': {
                    'Arn': 'string'
                },
                'TransformJob': {
                    'Arn': 'string'
                },
                'TuningJob': {
                    'Arn': 'string'
                },
                'Model': {
                    'Arn': 'string'
                },
                'RegisterModel': {
                    'Arn': 'string'
                },
                'Condition': {
                    'Outcome': 'True'|'False'
                },
                'Callback': {
                    'CallbackToken': 'string',
                    'SqsQueueUrl': 'string',
                    'OutputParameters': [
                        {
                            'Name': 'string',
                            'Value': 'string'
                        },
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • 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.

    • (dict) --

      An execution of a step in a pipeline.

      • StepName (string) --

        The name of the step that is executed.

      • StartTime (datetime) --

        The time that the step started executing.

      • EndTime (datetime) --

        The time that the step stopped executing.

      • StepStatus (string) --

        The status of the step execution.

      • CacheHitResult (dict) --

        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 (dict) --

        Metadata for the step execution.

        • TrainingJob (dict) --

          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 (dict) --

          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 (dict) --

          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.

        • TuningJob (dict) --

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

          • Arn (string) --

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

        • Model (dict) --

          Metadata for the Model step.

          • Arn (string) --

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

        • RegisterModel (dict) --

          Metadata for the RegisterModel step.

          • Arn (string) --

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

        • Condition (dict) --

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

          • Outcome (string) --

            The outcome of the Condition step evaluation.

        • Callback (dict) --

          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.

            • (dict) --

              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.