1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_notebook_instance::_update_notebook_instance_output::UpdateNotebookInstanceOutputBuilder;
pub use crate::operation::update_notebook_instance::_update_notebook_instance_input::UpdateNotebookInstanceInputBuilder;
/// Fluent builder constructing a request to `UpdateNotebookInstance`.
///
/// <p>Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateNotebookInstanceFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceInputBuilder,
}
impl UpdateNotebookInstanceFluentBuilder {
/// Creates a new `UpdateNotebookInstance`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::update_notebook_instance::UpdateNotebookInstance,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::update_notebook_instance::UpdateNotebookInstanceError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::update_notebook_instance::UpdateNotebookInstanceOutput,
aws_smithy_http::result::SdkError<
crate::operation::update_notebook_instance::UpdateNotebookInstanceError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The name of the notebook instance to update.</p>
pub fn notebook_instance_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.notebook_instance_name(input.into());
self
}
/// <p>The name of the notebook instance to update.</p>
pub fn set_notebook_instance_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_notebook_instance_name(input);
self
}
/// <p>The Amazon ML compute instance type.</p>
pub fn instance_type(mut self, input: crate::types::InstanceType) -> Self {
self.inner = self.inner.instance_type(input);
self
}
/// <p>The Amazon ML compute instance type.</p>
pub fn set_instance_type(
mut self,
input: std::option::Option<crate::types::InstanceType>,
) -> Self {
self.inner = self.inner.set_instance_type(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p> <note>
/// <p>To be able to pass this role to SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</p>
/// </note>
pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </p> <note>
/// <p>To be able to pass this role to SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</p>
/// </note>
pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_role_arn(input);
self
}
/// <p>The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>
pub fn lifecycle_config_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.lifecycle_config_name(input.into());
self
}
/// <p>The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>
pub fn set_lifecycle_config_name(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_lifecycle_config_name(input);
self
}
/// <p>Set to <code>true</code> to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn disassociate_lifecycle_config(mut self, input: bool) -> Self {
self.inner = self.inner.disassociate_lifecycle_config(input);
self
}
/// <p>Set to <code>true</code> to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn set_disassociate_lifecycle_config(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_disassociate_lifecycle_config(input);
self
}
/// <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.</p>
pub fn volume_size_in_gb(mut self, input: i32) -> Self {
self.inner = self.inner.volume_size_in_gb(input);
self
}
/// <p>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.</p>
pub fn set_volume_size_in_gb(mut self, input: std::option::Option<i32>) -> Self {
self.inner = self.inner.set_volume_size_in_gb(input);
self
}
/// <p>The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker Notebook Instances</a>.</p>
pub fn default_code_repository(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.default_code_repository(input.into());
self
}
/// <p>The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker Notebook Instances</a>.</p>
pub fn set_default_code_repository(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_default_code_repository(input);
self
}
/// Appends an item to `AdditionalCodeRepositories`.
///
/// To override the contents of this collection use [`set_additional_code_repositories`](Self::set_additional_code_repositories).
///
/// <p>An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker Notebook Instances</a>.</p>
pub fn additional_code_repositories(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.additional_code_repositories(input.into());
self
}
/// <p>An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker Notebook Instances</a>.</p>
pub fn set_additional_code_repositories(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_additional_code_repositories(input);
self
}
/// Appends an item to `AcceleratorTypes`.
///
/// To override the contents of this collection use [`set_accelerator_types`](Self::set_accelerator_types).
///
/// <p>A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in Amazon SageMaker</a>.</p>
pub fn accelerator_types(
mut self,
input: crate::types::NotebookInstanceAcceleratorType,
) -> Self {
self.inner = self.inner.accelerator_types(input);
self
}
/// <p>A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in Amazon SageMaker</a>.</p>
pub fn set_accelerator_types(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::NotebookInstanceAcceleratorType>>,
) -> Self {
self.inner = self.inner.set_accelerator_types(input);
self
}
/// <p>A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn disassociate_accelerator_types(mut self, input: bool) -> Self {
self.inner = self.inner.disassociate_accelerator_types(input);
self
}
/// <p>A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn set_disassociate_accelerator_types(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_disassociate_accelerator_types(input);
self
}
/// <p>The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn disassociate_default_code_repository(mut self, input: bool) -> Self {
self.inner = self.inner.disassociate_default_code_repository(input);
self
}
/// <p>The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn set_disassociate_default_code_repository(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self.inner.set_disassociate_default_code_repository(input);
self
}
/// <p>A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn disassociate_additional_code_repositories(mut self, input: bool) -> Self {
self.inner = self.inner.disassociate_additional_code_repositories(input);
self
}
/// <p>A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</p>
pub fn set_disassociate_additional_code_repositories(
mut self,
input: std::option::Option<bool>,
) -> Self {
self.inner = self
.inner
.set_disassociate_additional_code_repositories(input);
self
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</p> <note>
/// <p>If you set this to <code>Disabled</code>, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.</p>
/// </note>
pub fn root_access(mut self, input: crate::types::RootAccess) -> Self {
self.inner = self.inner.root_access(input);
self
}
/// <p>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</p> <note>
/// <p>If you set this to <code>Disabled</code>, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.</p>
/// </note>
pub fn set_root_access(mut self, input: std::option::Option<crate::types::RootAccess>) -> Self {
self.inner = self.inner.set_root_access(input);
self
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn instance_metadata_service_configuration(
mut self,
input: crate::types::InstanceMetadataServiceConfiguration,
) -> Self {
self.inner = self.inner.instance_metadata_service_configuration(input);
self
}
/// <p>Information on the IMDS configuration of the notebook instance</p>
pub fn set_instance_metadata_service_configuration(
mut self,
input: std::option::Option<crate::types::InstanceMetadataServiceConfiguration>,
) -> Self {
self.inner = self
.inner
.set_instance_metadata_service_configuration(input);
self
}
}