Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPipelineVersions

Gets a list of all versions of the pipeline.

Request Syntax


{
   "CreatedAfter": number,
   "CreatedBefore": number,
   "MaxResults": number,
   "NextToken": "string",
   "PipelineName": "string",
   "SortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreatedAfter

A filter that returns the pipeline versions that were created after a specified time.

Type: Timestamp

Required: No

CreatedBefore

A filter that returns the pipeline versions that were created before a specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of pipeline versions to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

PipelineName

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})

Required: Yes

SortOrder

The sort order for the results.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "NextToken": "string",
   "PipelineVersionSummaries": [ 
      { 
         "CreationTime": number,
         "LastExecutionPipelineExecutionArn": "string",
         "PipelineArn": "string",
         "PipelineVersionDescription": "string",
         "PipelineVersionDisplayName": "string",
         "PipelineVersionId": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

PipelineVersionSummaries

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.

Type: Array of PipelineVersionSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400