class Aws::SageMaker::Types::UpdateNotebookInstanceInput

@note When making an API call, you may pass UpdateNotebookInstanceInput

data as a hash:

    {
      notebook_instance_name: "NotebookInstanceName", # required
      instance_type: "ml.t2.medium", # accepts ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.t3.medium, ml.t3.large, ml.t3.xlarge, ml.t3.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.8xlarge, ml.m5d.12xlarge, ml.m5d.16xlarge, ml.m5d.24xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.p3dn.24xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.8xlarge, ml.r5.12xlarge, ml.r5.16xlarge, ml.r5.24xlarge
      role_arn: "RoleArn",
      lifecycle_config_name: "NotebookInstanceLifecycleConfigName",
      disassociate_lifecycle_config: false,
      volume_size_in_gb: 1,
      default_code_repository: "CodeRepositoryNameOrUrl",
      additional_code_repositories: ["CodeRepositoryNameOrUrl"],
      accelerator_types: ["ml.eia1.medium"], # accepts ml.eia1.medium, ml.eia1.large, ml.eia1.xlarge, ml.eia2.medium, ml.eia2.large, ml.eia2.xlarge
      disassociate_accelerator_types: false,
      disassociate_default_code_repository: false,
      disassociate_additional_code_repositories: false,
      root_access: "Enabled", # accepts Enabled, Disabled
    }

@!attribute [rw] notebook_instance_name

The name of the notebook instance to update.
@return [String]

@!attribute [rw] instance_type

The Amazon ML compute instance type.
@return [String]

@!attribute [rw] role_arn

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker
can assume to access the notebook instance. For more information,
see [Amazon SageMaker Roles][1].

<note markdown="1"> To be able to pass this role to Amazon SageMaker, the caller of this
API must have the `iam:PassRole` permission.

 </note>

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html
@return [String]

@!attribute [rw] lifecycle_config_name

The name of a lifecycle configuration to associate with the notebook
instance. For information about lifestyle configurations, see [Step
2.1: (Optional) Customize a Notebook Instance][1].

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html
@return [String]

@!attribute [rw] disassociate_lifecycle_config

Set to `true` 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.
@return [Boolean]

@!attribute [rw] volume_size_in_gb

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 Amazon 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.
@return [Integer]

@!attribute [rw] default_code_repository

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 [Amazon Web Services CodeCommit][1] 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
[Associating Git Repositories with Amazon SageMaker Notebook
Instances][2].

[1]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html
[2]: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
@return [String]

@!attribute [rw] additional_code_repositories

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 [Amazon Web Services CodeCommit][1] 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 [Associating Git Repositories with Amazon SageMaker Notebook
Instances][2].

[1]: https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html
[2]: https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html
@return [Array<String>]

@!attribute [rw] accelerator_types

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
[Using Elastic Inference in Amazon SageMaker][1].

[1]: https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html
@return [Array<String>]

@!attribute [rw] disassociate_accelerator_types

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.
@return [Boolean]

@!attribute [rw] disassociate_default_code_repository

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.
@return [Boolean]

@!attribute [rw] disassociate_additional_code_repositories

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.
@return [Boolean]

@!attribute [rw] root_access

Whether root access is enabled or disabled for users of the notebook
instance. The default value is `Enabled`.

<note markdown="1"> If you set this to `Disabled`, users don't have root access on the
notebook instance, but lifecycle configuration scripts still run
with root permissions.

 </note>
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateNotebookInstanceInput AWS API Documentation

Constants

SENSITIVE