SageMaker / Paginator / ListPipelineVersions

ListPipelineVersions

class SageMaker.Paginator.ListPipelineVersions

paginator = client.get_paginator('list_pipeline_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• PipelineName (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the pipeline.

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

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

• SortOrder (string) – The sort order for the 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

{
    'PipelineVersionSummaries': [
        {
            'PipelineArn': 'string',
            'PipelineVersionId': 123,
            'CreationTime': datetime(2015, 1, 1),
            'PipelineVersionDescription': 'string',
            'PipelineVersionDisplayName': 'string',
            'LastExecutionPipelineExecutionArn': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • PipelineVersionSummaries (list) –

    Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.

    • (dict) –

      The summary of the pipeline version.

      • PipelineArn (string) –

        The Amazon Resource Name (ARN) of the pipeline.

      • PipelineVersionId (integer) –

        The ID of the pipeline version.

      • CreationTime (datetime) –

        The creation time of the pipeline version.

      • PipelineVersionDescription (string) –

        The description of the pipeline version.

      • PipelineVersionDisplayName (string) –

        The display name of the pipeline version.

      • LastExecutionPipelineExecutionArn (string) –

        The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.