SageMaker / Client / list_pipeline_versions

list_pipeline_versions

SageMaker.Client.list_pipeline_versions(**kwargs)

Gets a list of all versions of the pipeline.

See also: AWS API Documentation

Request Syntax

response = client.list_pipeline_versions(
    PipelineName='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
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.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'PipelineVersionSummaries': [
        {
            'PipelineArn': 'string',
            'PipelineVersionId': 123,
            'CreationTime': datetime(2015, 1, 1),
            'PipelineVersionDescription': 'string',
            'PipelineVersionDisplayName': 'string',
            'LastExecutionPipelineExecutionArn': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound