StartPipelineExecution
Starts a pipeline execution.
Request Syntax
{
"ClientRequestToken": "string
",
"ParallelismConfiguration": {
"MaxParallelExecutionSteps": number
},
"PipelineExecutionDescription": "string
",
"PipelineExecutionDisplayName": "string
",
"PipelineName": "string
",
"PipelineParameters": [
{
"Name": "string
",
"Value": "string
"
}
],
"SelectiveExecutionConfig": {
"SelectedSteps": [
{
"StepName": "string
"
}
],
"SourcePipelineExecutionArn": "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.
- ClientRequestToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 128.
Required: Yes
- ParallelismConfiguration
-
This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
Type: ParallelismConfiguration object
Required: No
- PipelineExecutionDescription
-
The description of the pipeline execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern:
.*
Required: No
- PipelineExecutionDisplayName
-
The display name of the pipeline execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 82.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}
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
- PipelineParameters
-
Contains a list of pipeline parameters. This list can be empty.
Type: Array of Parameter objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- SelectiveExecutionConfig
-
The selective execution configuration applied to the pipeline run.
Type: SelectiveExecutionConfig object
Required: No
Response Syntax
{
"PipelineExecutionArn": "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.
- PipelineExecutionArn
-
The Amazon Resource Name (ARN) of the pipeline execution.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
There was a conflict when you attempted to modify a SageMaker entity such as an
Experiment
orArtifact
.HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
- 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 Amazon SDKs, see the following: