aws_sdk_sagemaker/operation/stop_pipeline_execution/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::stop_pipeline_execution::_stop_pipeline_execution_output::StopPipelineExecutionOutputBuilder;
3
4pub use crate::operation::stop_pipeline_execution::_stop_pipeline_execution_input::StopPipelineExecutionInputBuilder;
5
6impl crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.stop_pipeline_execution();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StopPipelineExecution`.
24///
25/// <p>Stops a pipeline execution.</p>
26/// <p><b>Callback Step</b></p>
27/// <p>A pipeline execution won't stop while a callback step is running. When you call <code>StopPipelineExecution</code> 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".</p>
28/// <p>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 <code>SendPipelineExecutionStepSuccess</code> or <code>SendPipelineExecutionStepFailure</code>.</p>
29/// <p>Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.</p>
30/// <p><b>Lambda Step</b></p>
31/// <p>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 <code>Stopped</code>. If the timeout is hit the pipeline execution status is <code>Failed</code>.</p>
32#[derive(::std::clone::Clone, ::std::fmt::Debug)]
33pub struct StopPipelineExecutionFluentBuilder {
34    handle: ::std::sync::Arc<crate::client::Handle>,
35    inner: crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionInputBuilder,
36    config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39    crate::client::customize::internal::CustomizableSend<
40        crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
41        crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
42    > for StopPipelineExecutionFluentBuilder
43{
44    fn send(
45        self,
46        config_override: crate::config::Builder,
47    ) -> crate::client::customize::internal::BoxFuture<
48        crate::client::customize::internal::SendResult<
49            crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
50            crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
51        >,
52    > {
53        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54    }
55}
56impl StopPipelineExecutionFluentBuilder {
57    /// Creates a new `StopPipelineExecutionFluentBuilder`.
58    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
59        Self {
60            handle,
61            inner: ::std::default::Default::default(),
62            config_override: ::std::option::Option::None,
63        }
64    }
65    /// Access the StopPipelineExecution as a reference.
66    pub fn as_input(&self) -> &crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionInputBuilder {
67        &self.inner
68    }
69    /// Sends the request and returns the response.
70    ///
71    /// If an error occurs, an `SdkError` will be returned with additional details that
72    /// can be matched against.
73    ///
74    /// By default, any retryable failures will be retried twice. Retry behavior
75    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
76    /// set when configuring the client.
77    pub async fn send(
78        self,
79    ) -> ::std::result::Result<
80        crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
81        ::aws_smithy_runtime_api::client::result::SdkError<
82            crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
83            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
84        >,
85    > {
86        let input = self
87            .inner
88            .build()
89            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
90        let runtime_plugins = crate::operation::stop_pipeline_execution::StopPipelineExecution::operation_runtime_plugins(
91            self.handle.runtime_plugins.clone(),
92            &self.handle.conf,
93            self.config_override,
94        );
95        crate::operation::stop_pipeline_execution::StopPipelineExecution::orchestrate(&runtime_plugins, input).await
96    }
97
98    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
99    pub fn customize(
100        self,
101    ) -> crate::client::customize::CustomizableOperation<
102        crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
103        crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
104        Self,
105    > {
106        crate::client::customize::CustomizableOperation::new(self)
107    }
108    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
109        self.set_config_override(::std::option::Option::Some(config_override.into()));
110        self
111    }
112
113    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
114        self.config_override = config_override;
115        self
116    }
117    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
118    pub fn pipeline_execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.pipeline_execution_arn(input.into());
120        self
121    }
122    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
123    pub fn set_pipeline_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_pipeline_execution_arn(input);
125        self
126    }
127    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
128    pub fn get_pipeline_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_pipeline_execution_arn()
130    }
131    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</p>
132    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.client_request_token(input.into());
134        self
135    }
136    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</p>
137    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_client_request_token(input);
139        self
140    }
141    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</p>
142    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_client_request_token()
144    }
145}
aws_sdk_sagemaker/operation/stop_pipeline_execution/builders.rs

aws_sdk_sagemaker/operation/stop_pipeline_execution/
builders.rs
