SageMaker / Paginator / ListPipelineExecutions

ListPipelineExecutions

class SageMaker.Paginator.ListPipelineExecutions

paginator = client.get_paginator('list_pipeline_executions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_pipeline_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PipelineName='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='CreationTime'|'PipelineExecutionArn',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PipelineName (string) –

  [REQUIRED]

  The name 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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous 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'
        },
    ],

}

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.