aws_sdk_sagemaker/operation/stop_hyper_parameter_tuning_job/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::stop_hyper_parameter_tuning_job::_stop_hyper_parameter_tuning_job_output::StopHyperParameterTuningJobOutputBuilder;
3
4pub use crate::operation::stop_hyper_parameter_tuning_job::_stop_hyper_parameter_tuning_job_input::StopHyperParameterTuningJobInputBuilder;
5
6impl crate::operation::stop_hyper_parameter_tuning_job::builders::StopHyperParameterTuningJobInputBuilder {
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_hyper_parameter_tuning_job::StopHyperParameterTuningJobOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.stop_hyper_parameter_tuning_job();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StopHyperParameterTuningJob`.
24///
25/// <p>Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.</p>
26/// <p>All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the <code>Stopped</code> state, it releases all reserved resources for the tuning job.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StopHyperParameterTuningJobFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::stop_hyper_parameter_tuning_job::builders::StopHyperParameterTuningJobInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobOutput,
36        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobError,
37    > for StopHyperParameterTuningJobFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobOutput,
45            crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl StopHyperParameterTuningJobFluentBuilder {
52    /// Creates a new `StopHyperParameterTuningJobFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the StopHyperParameterTuningJob as a reference.
61    pub fn as_input(&self) -> &crate::operation::stop_hyper_parameter_tuning_job::builders::StopHyperParameterTuningJobInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJob::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJob::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobOutput,
98        crate::operation::stop_hyper_parameter_tuning_job::StopHyperParameterTuningJobError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// <p>The name of the tuning job to stop.</p>
113    pub fn hyper_parameter_tuning_job_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.hyper_parameter_tuning_job_name(input.into());
115        self
116    }
117    /// <p>The name of the tuning job to stop.</p>
118    pub fn set_hyper_parameter_tuning_job_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_hyper_parameter_tuning_job_name(input);
120        self
121    }
122    /// <p>The name of the tuning job to stop.</p>
123    pub fn get_hyper_parameter_tuning_job_name(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_hyper_parameter_tuning_job_name()
125    }
126}