| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SageMaker.StopPipelineExecution
Description
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.
Synopsis
- data StopPipelineExecution = StopPipelineExecution' {}
- newStopPipelineExecution :: Text -> Text -> StopPipelineExecution
- stopPipelineExecution_pipelineExecutionArn :: Lens' StopPipelineExecution Text
- stopPipelineExecution_clientRequestToken :: Lens' StopPipelineExecution Text
- data StopPipelineExecutionResponse = StopPipelineExecutionResponse' {}
- newStopPipelineExecutionResponse :: Int -> StopPipelineExecutionResponse
- stopPipelineExecutionResponse_pipelineExecutionArn :: Lens' StopPipelineExecutionResponse (Maybe Text)
- stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int
Creating a Request
data StopPipelineExecution Source #
See: newStopPipelineExecution smart constructor.
Constructors
| StopPipelineExecution' | |
Fields
| |
Instances
newStopPipelineExecution Source #
Arguments
| :: Text | |
| -> Text | |
| -> StopPipelineExecution |
Create a value of StopPipelineExecution with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineExecutionArn:StopPipelineExecution', stopPipelineExecution_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.
$sel:clientRequestToken:StopPipelineExecution', stopPipelineExecution_clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the operation. An idempotent operation completes no more
than once.
Request Lenses
stopPipelineExecution_pipelineExecutionArn :: Lens' StopPipelineExecution Text Source #
The Amazon Resource Name (ARN) of the pipeline execution.
stopPipelineExecution_clientRequestToken :: Lens' StopPipelineExecution Text Source #
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
Destructuring the Response
data StopPipelineExecutionResponse Source #
See: newStopPipelineExecutionResponse smart constructor.
Constructors
| StopPipelineExecutionResponse' | |
Fields
| |
Instances
newStopPipelineExecutionResponse Source #
Create a value of StopPipelineExecutionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pipelineExecutionArn:StopPipelineExecution', stopPipelineExecutionResponse_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.
$sel:httpStatus:StopPipelineExecutionResponse', stopPipelineExecutionResponse_httpStatus - The response's http status code.
Response Lenses
stopPipelineExecutionResponse_pipelineExecutionArn :: Lens' StopPipelineExecutionResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the pipeline execution.
stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int Source #
The response's http status code.