StopPipelineExecution
Stops a pipeline execution.
Callback Step
A pipeline execution won't stop while a callback step is running.
When you call StopPipelineExecution
on a pipeline execution with a running callback step, SageMaker Pipelines sends an
additional Amazon SQS message to the specified SQS queue. The body of the SQS message
contains a "Status" field which is set to "Stopping".
You should add logic to your Amazon SQS message consumer to take any needed action (for
example, resource cleanup) upon receipt of the message followed by a call to
SendPipelineExecutionStepSuccess
or
SendPipelineExecutionStepFailure
.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
Lambda Step
A pipeline execution can't be stopped while a lambda step is running because the Lambda
function invoked by the lambda step can't be stopped. If you attempt to stop the execution
while the Lambda function is running, the pipeline waits for the Lambda function to finish
or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function
finishes, the pipeline execution status is Stopped
. If the timeout is hit
the pipeline execution status is Failed
.
Request Syntax
{
"ClientRequestToken": "string
",
"PipelineExecutionArn": "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
- 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\/.*$
Required: Yes
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
- 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: