SageMaker / Client / list_pipeline_executions

list_pipeline_executions#

SageMaker.Client.list_pipeline_executions(**kwargs)#

Gets a list of the pipeline executions.

See also: AWS API Documentation

Request Syntax

response = client.list_pipeline_executions(
    PipelineName='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='CreationTime'|'PipelineExecutionArn',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • PipelineName (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the pipeline.

  • CreatedAfter (datetime) – A filter that returns the pipeline executions that were created after a specified time.

  • CreatedBefore (datetime) – A filter that returns the pipeline executions that were created before a specified time.

  • SortBy (string) – The field by which to sort results. The default is CreatedTime.

  • SortOrder (string) – The sort order for results.

  • NextToken (string) – If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

  • MaxResults (integer) – The maximum number of pipeline executions to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineExecutionSummaries': [
        {
            'PipelineExecutionArn': 'string',
            'StartTime': datetime(2015, 1, 1),
            'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
            'PipelineExecutionDescription': 'string',
            'PipelineExecutionDisplayName': 'string',
            'PipelineExecutionFailureReason': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PipelineExecutionSummaries (list) –

      Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

      • (dict) –

        A pipeline execution summary.

        • PipelineExecutionArn (string) –

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

        • StartTime (datetime) –

          The start time of the pipeline execution.

        • PipelineExecutionStatus (string) –

          The status of the pipeline execution.

        • PipelineExecutionDescription (string) –

          The description of the pipeline execution.

        • PipelineExecutionDisplayName (string) –

          The display name of the pipeline execution.

        • PipelineExecutionFailureReason (string) –

          A message generated by SageMaker Pipelines describing why the pipeline execution failed.

    • NextToken (string) –

      If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

Exceptions