aws_sdk_sagemaker/client/

update_notebook_instance.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateNotebookInstance`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`notebook_instance_name(impl Into<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::notebook_instance_name) / [`set_notebook_instance_name(Option<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_notebook_instance_name):<br>required: **true**<br><p>The name of the notebook instance to update.</p><br>
    ///   - [`instance_type(InstanceType)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::instance_type) / [`set_instance_type(Option<InstanceType>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_instance_type):<br>required: **false**<br><p>The Amazon ML compute instance type.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role that SageMaker AI 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 AI Roles</a>.</p><note>  <p>To be able to pass this role to SageMaker AI, the caller of this API must have the <code>iam:PassRole</code> permission.</p> </note><br>
    ///   - [`lifecycle_config_name(impl Into<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::lifecycle_config_name) / [`set_lifecycle_config_name(Option<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_lifecycle_config_name):<br>required: **false**<br><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><br>
    ///   - [`disassociate_lifecycle_config(bool)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::disassociate_lifecycle_config) / [`set_disassociate_lifecycle_config(Option<bool>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_disassociate_lifecycle_config):<br>required: **false**<br><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><br>
    ///   - [`volume_size_in_gb(i32)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::volume_size_in_gb) / [`set_volume_size_in_gb(Option<i32>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_volume_size_in_gb):<br>required: **false**<br><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 AI 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><br>
    ///   - [`default_code_repository(impl Into<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::default_code_repository) / [`set_default_code_repository(Option<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_default_code_repository):<br>required: **false**<br><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 AI Notebook Instances</a>.</p><br>
    ///   - [`additional_code_repositories(impl Into<String>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::additional_code_repositories) / [`set_additional_code_repositories(Option<Vec::<String>>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_additional_code_repositories):<br>required: **false**<br><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 AI Notebook Instances</a>.</p><br>
    ///   - [`accelerator_types(NotebookInstanceAcceleratorType)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::accelerator_types) / [`set_accelerator_types(Option<Vec::<NotebookInstanceAcceleratorType>>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_accelerator_types):<br>required: **false**<br><p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify a list of the EI instance types to associate with this notebook instance.</p><br>
    ///   - [`disassociate_accelerator_types(bool)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::disassociate_accelerator_types) / [`set_disassociate_accelerator_types(Option<bool>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_disassociate_accelerator_types):<br>required: **false**<br><p>This parameter is no longer supported. Elastic Inference (EI) is no longer available.</p> <p>This parameter was used to specify a list of the EI instance types to remove from this notebook instance.</p><br>
    ///   - [`disassociate_default_code_repository(bool)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::disassociate_default_code_repository) / [`set_disassociate_default_code_repository(Option<bool>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_disassociate_default_code_repository):<br>required: **false**<br><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><br>
    ///   - [`disassociate_additional_code_repositories(bool)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::disassociate_additional_code_repositories) / [`set_disassociate_additional_code_repositories(Option<bool>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_disassociate_additional_code_repositories):<br>required: **false**<br><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><br>
    ///   - [`root_access(RootAccess)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::root_access) / [`set_root_access(Option<RootAccess>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_root_access):<br>required: **false**<br><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><br>
    ///   - [`instance_metadata_service_configuration(InstanceMetadataServiceConfiguration)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::instance_metadata_service_configuration) / [`set_instance_metadata_service_configuration(Option<InstanceMetadataServiceConfiguration>)`](crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::set_instance_metadata_service_configuration):<br>required: **false**<br><p>Information on the IMDS configuration of the notebook instance</p><br>
    /// - On success, responds with [`UpdateNotebookInstanceOutput`](crate::operation::update_notebook_instance::UpdateNotebookInstanceOutput)
    /// - On failure, responds with [`SdkError<UpdateNotebookInstanceError>`](crate::operation::update_notebook_instance::UpdateNotebookInstanceError)
    pub fn update_notebook_instance(&self) -> crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder {
        crate::operation::update_notebook_instance::builders::UpdateNotebookInstanceFluentBuilder::new(self.handle.clone())
    }
}