Gets a list of the pipeline executions.
Request Syntax
{
"CreatedAfter": number,
"CreatedBefore": number,
"MaxResults": number,
"NextToken": "string",
"PipelineName": "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 pipeline executions that were created after a specified time.
Type: Timestamp
Required: No
- CreatedBefore
-
A filter that returns the pipeline executions that were created before a specified time.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of pipeline executions 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
ListPipelineExecutionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline executions, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- PipelineName
-
The name or 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
- SortBy
-
The field by which to sort results. The default is
CreatedTime.Type: String
Valid Values:
CreationTime | PipelineExecutionArnRequired: No
- SortOrder
-
The sort order for results.
Type: String
Valid Values:
Ascending | DescendingRequired: No
Response Syntax
{
"NextToken": "string",
"PipelineExecutionSummaries": [
{
"PipelineExecutionArn": "string",
"PipelineExecutionDescription": "string",
"PipelineExecutionDisplayName": "string",
"PipelineExecutionFailureReason": "string",
"PipelineExecutionStatus": "string",
"StartTime": 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
ListPipelineExecutionsrequest was truncated, the response includes aNextToken. To retrieve the next set of pipeline executions, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.* - PipelineExecutionSummaries
-
Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
Type: Array of PipelineExecutionSummary 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
