AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the StopPipelineExecution operation. 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
.
Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z
public class StopPipelineExecutionRequest : AmazonSageMakerRequest IAmazonWebServiceRequest
The StopPipelineExecutionRequest type exposes the following members
Name | Description | |
---|---|---|
StopPipelineExecutionRequest() |
Name | Type | Description | |
---|---|---|---|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken. A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. |
|
PipelineExecutionArn | System.String |
Gets and sets the property PipelineExecutionArn. The Amazon Resource Name (ARN) of the pipeline execution. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5