SageMaker / Paginator / ListPipelines

ListPipelines#

class SageMaker.Paginator.ListPipelines#
paginator = client.get_paginator('list_pipelines')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • PipelineNamePrefix (string) – The prefix of the pipeline name.

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

  • CreatedBefore (datetime) – A filter that returns the pipelines 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

{
    'PipelineSummaries': [
        {
            'PipelineArn': 'string',
            'PipelineName': 'string',
            'PipelineDisplayName': 'string',
            'PipelineDescription': 'string',
            'RoleArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastExecutionTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • PipelineSummaries (list) –

      Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

      • (dict) –

        A summary of a pipeline.

        • PipelineArn (string) –

          The Amazon Resource Name (ARN) of the pipeline.

        • PipelineName (string) –

          The name of the pipeline.

        • PipelineDisplayName (string) –

          The display name of the pipeline.

        • PipelineDescription (string) –

          The description of the pipeline.

        • RoleArn (string) –

          The Amazon Resource Name (ARN) that the pipeline used to execute.

        • CreationTime (datetime) –

          The creation time of the pipeline.

        • LastModifiedTime (datetime) –

          The time that the pipeline was last modified.

        • LastExecutionTime (datetime) –

          The last time that a pipeline execution began.