ListPipelines - Amazon SageMaker (original) (raw)

Gets a list of pipelines.

Request Syntax

{
   "CreatedAfter": number,
   "CreatedBefore": number,
   "MaxResults": number,
   "NextToken": "string",
   "PipelineNamePrefix": "string",
   "SortBy": "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 pipelines that were created after a specified time.

Type: Timestamp

Required: No

CreatedBefore

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

Type: Timestamp

Required: No

MaxResults

The maximum number of pipelines 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 ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

Type: String

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

Pattern: .*

Required: No

PipelineNamePrefix

The prefix of the pipeline name.

Type: String

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}

Required: No

SortBy

The field by which to sort results. The default is CreatedTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order for results.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{
   "NextToken": "string",
   "PipelineSummaries": [ 
      { 
         "CreationTime": number,
         "LastExecutionTime": number,
         "LastModifiedTime": number,
         "PipelineArn": "string",
         "PipelineDescription": "string",
         "PipelineDisplayName": "string",
         "PipelineName": "string",
         "RoleArn": "string"
      }
   ]
}

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 ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

Type: String

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

Pattern: .*

PipelineSummaries

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.

Type: Array of PipelineSummary 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 Error Types.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: