Struct aws_sdk_sagemaker::client::fluent_builders::StopPipelineExecution

pub struct StopPipelineExecution { /* private fields */ }

Fluent builder constructing a request to 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.

Implementations

impl StopPipelineExecution

pub async fn send(
    self
) -> Result<StopPipelineExecutionOutput, SdkError<StopPipelineExecutionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn pipeline_execution_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the pipeline execution.

pub fn set_pipeline_execution_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the pipeline execution.

pub fn client_request_token(self, input: impl Into<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

pub fn set_client_request_token(self, input: Option<String>) -> Self

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Trait Implementations

impl Clone for StopPipelineExecution

fn clone(&self) -> StopPipelineExecution

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StopPipelineExecution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.