aws_sdk_sagemaker/operation/create_mlflow_tracking_server/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_mlflow_tracking_server::_create_mlflow_tracking_server_output::CreateMlflowTrackingServerOutputBuilder;
3
4pub use crate::operation::create_mlflow_tracking_server::_create_mlflow_tracking_server_input::CreateMlflowTrackingServerInputBuilder;
5
6impl crate::operation::create_mlflow_tracking_server::builders::CreateMlflowTrackingServerInputBuilder {
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::create_mlflow_tracking_server::CreateMlflowTrackingServerOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_mlflow_tracking_server();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateMlflowTrackingServer`.
24///
25/// <p>Creates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server.html">Create an MLflow Tracking Server</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateMlflowTrackingServerFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_mlflow_tracking_server::builders::CreateMlflowTrackingServerInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerOutput,
35        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerError,
36    > for CreateMlflowTrackingServerFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerOutput,
44            crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateMlflowTrackingServerFluentBuilder {
51    /// Creates a new `CreateMlflowTrackingServerFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateMlflowTrackingServer as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_mlflow_tracking_server::builders::CreateMlflowTrackingServerInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServer::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServer::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerOutput,
97        crate::operation::create_mlflow_tracking_server::CreateMlflowTrackingServerError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>A unique string identifying the tracking server name. This string is part of the tracking server ARN.</p>
112    pub fn tracking_server_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.tracking_server_name(input.into());
114        self
115    }
116    /// <p>A unique string identifying the tracking server name. This string is part of the tracking server ARN.</p>
117    pub fn set_tracking_server_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_tracking_server_name(input);
119        self
120    }
121    /// <p>A unique string identifying the tracking server name. This string is part of the tracking server ARN.</p>
122    pub fn get_tracking_server_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_tracking_server_name()
124    }
125    /// <p>The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.</p>
126    pub fn artifact_store_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.artifact_store_uri(input.into());
128        self
129    }
130    /// <p>The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.</p>
131    pub fn set_artifact_store_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_artifact_store_uri(input);
133        self
134    }
135    /// <p>The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store.</p>
136    pub fn get_artifact_store_uri(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_artifact_store_uri()
138    }
139    /// <p>The size of the tracking server you want to create. You can choose between <code>"Small"</code>, <code>"Medium"</code>, and <code>"Large"</code>. The default MLflow Tracking Server configuration size is <code>"Small"</code>. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.</p>
140    /// <p>We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.</p>
141    pub fn tracking_server_size(mut self, input: crate::types::TrackingServerSize) -> Self {
142        self.inner = self.inner.tracking_server_size(input);
143        self
144    }
145    /// <p>The size of the tracking server you want to create. You can choose between <code>"Small"</code>, <code>"Medium"</code>, and <code>"Large"</code>. The default MLflow Tracking Server configuration size is <code>"Small"</code>. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.</p>
146    /// <p>We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.</p>
147    pub fn set_tracking_server_size(mut self, input: ::std::option::Option<crate::types::TrackingServerSize>) -> Self {
148        self.inner = self.inner.set_tracking_server_size(input);
149        self
150    }
151    /// <p>The size of the tracking server you want to create. You can choose between <code>"Small"</code>, <code>"Medium"</code>, and <code>"Large"</code>. The default MLflow Tracking Server configuration size is <code>"Small"</code>. You can choose a size depending on the projected use of the tracking server such as the volume of data logged, number of users, and frequency of use.</p>
152    /// <p>We recommend using a small tracking server for teams of up to 25 users, a medium tracking server for teams of up to 50 users, and a large tracking server for teams of up to 100 users.</p>
153    pub fn get_tracking_server_size(&self) -> &::std::option::Option<crate::types::TrackingServerSize> {
154        self.inner.get_tracking_server_size()
155    }
156    /// <p>The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow.html#mlflow-create-tracking-server-how-it-works">How it works</a>.</p>
157    pub fn mlflow_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
158        self.inner = self.inner.mlflow_version(input.into());
159        self
160    }
161    /// <p>The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow.html#mlflow-create-tracking-server-how-it-works">How it works</a>.</p>
162    pub fn set_mlflow_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
163        self.inner = self.inner.set_mlflow_version(input);
164        self
165    }
166    /// <p>The version of MLflow that the tracking server uses. To see which MLflow versions are available to use, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow.html#mlflow-create-tracking-server-how-it-works">How it works</a>.</p>
167    pub fn get_mlflow_version(&self) -> &::std::option::Option<::std::string::String> {
168        self.inner.get_mlflow_version()
169    }
170    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have <code>AmazonS3FullAccess</code> permissions. For more information on IAM permissions for tracking server creation, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html">Set up IAM permissions for MLflow</a>.</p>
171    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
172        self.inner = self.inner.role_arn(input.into());
173        self
174    }
175    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have <code>AmazonS3FullAccess</code> permissions. For more information on IAM permissions for tracking server creation, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html">Set up IAM permissions for MLflow</a>.</p>
176    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
177        self.inner = self.inner.set_role_arn(input);
178        self
179    }
180    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have <code>AmazonS3FullAccess</code> permissions. For more information on IAM permissions for tracking server creation, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html">Set up IAM permissions for MLflow</a>.</p>
181    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
182        self.inner.get_role_arn()
183    }
184    /// <p>Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to <code>True</code>. To disable automatic model registration, set this value to <code>False</code>. If not specified, <code>AutomaticModelRegistration</code> defaults to <code>False</code>.</p>
185    pub fn automatic_model_registration(mut self, input: bool) -> Self {
186        self.inner = self.inner.automatic_model_registration(input);
187        self
188    }
189    /// <p>Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to <code>True</code>. To disable automatic model registration, set this value to <code>False</code>. If not specified, <code>AutomaticModelRegistration</code> defaults to <code>False</code>.</p>
190    pub fn set_automatic_model_registration(mut self, input: ::std::option::Option<bool>) -> Self {
191        self.inner = self.inner.set_automatic_model_registration(input);
192        self
193    }
194    /// <p>Whether to enable or disable automatic registration of new MLflow models to the SageMaker Model Registry. To enable automatic model registration, set this value to <code>True</code>. To disable automatic model registration, set this value to <code>False</code>. If not specified, <code>AutomaticModelRegistration</code> defaults to <code>False</code>.</p>
195    pub fn get_automatic_model_registration(&self) -> &::std::option::Option<bool> {
196        self.inner.get_automatic_model_registration()
197    }
198    /// <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.</p>
199    pub fn weekly_maintenance_window_start(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
200        self.inner = self.inner.weekly_maintenance_window_start(input.into());
201        self
202    }
203    /// <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.</p>
204    pub fn set_weekly_maintenance_window_start(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
205        self.inner = self.inner.set_weekly_maintenance_window_start(input);
206        self
207    }
208    /// <p>The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.</p>
209    pub fn get_weekly_maintenance_window_start(&self) -> &::std::option::Option<::std::string::String> {
210        self.inner.get_weekly_maintenance_window_start()
211    }
212    ///
213    /// Appends an item to `Tags`.
214    ///
215    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
216    ///
217    /// <p>Tags consisting of key-value pairs used to manage metadata for the tracking server.</p>
218    pub fn tags(mut self, input: crate::types::Tag) -> Self {
219        self.inner = self.inner.tags(input);
220        self
221    }
222    /// <p>Tags consisting of key-value pairs used to manage metadata for the tracking server.</p>
223    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
224        self.inner = self.inner.set_tags(input);
225        self
226    }
227    /// <p>Tags consisting of key-value pairs used to manage metadata for the tracking server.</p>
228    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
229        self.inner.get_tags()
230    }
231}