/AWS1/CL_SGM=>UPDATENOTEBOOKINSTANCE()

About UpdateNotebookInstance

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.

Method Signature

IMPORTING

Required arguments:

IV_NOTEBOOKINSTANCENAME TYPE /AWS1/SGMNOTEBOOKINSTANCENAME /AWS1/SGMNOTEBOOKINSTANCENAME

The name of the notebook instance to update.

Optional arguments:

IV_INSTANCETYPE TYPE /AWS1/SGMINSTANCETYPE /AWS1/SGMINSTANCETYPE

The Amazon ML compute instance type.

IV_ROLEARN TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

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

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

IV_LIFECYCLECONFIGNAME TYPE /AWS1/SGMNOTEBOOKINSTLCCFGNAME /AWS1/SGMNOTEBOOKINSTLCCFGNAME

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.

IV_DISASSOCIATELCCONFIG TYPE /AWS1/SGMDISASCNOTEBOOKINSTL00 /AWS1/SGMDISASCNOTEBOOKINSTL00

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.

IV_VOLUMESIZEINGB TYPE /AWS1/SGMNOTEBOOKINSTVOLSIZE00 /AWS1/SGMNOTEBOOKINSTVOLSIZE00

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.

IV_DEFAULTCODEREPOSITORY TYPE /AWS1/SGMCODEREPOSITORYNAMEO00 /AWS1/SGMCODEREPOSITORYNAMEO00

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 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 SageMaker Notebook Instances.

IT_ADDLCODEREPOSITORIES TYPE /AWS1/CL_SGMADDLCODEREPOSITO00=>TT_ADDLCODEREPOSITORYNAMESOR00 TT_ADDLCODEREPOSITORYNAMESOR00

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 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 SageMaker Notebook Instances.

IT_ACCELERATORTYPES TYPE /AWS1/CL_SGMNOTEBOOKINSTACCE00=>TT_NOTEBOOKINSTACCELERATORTY00 TT_NOTEBOOKINSTACCELERATORTY00

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.

IV_DISASSOCACCELERATORTYPES TYPE /AWS1/SGMDISASCNOTEBOOKINSTA00 /AWS1/SGMDISASCNOTEBOOKINSTA00

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.

IV_DISASSOCDEFCODEREPOSITORY TYPE /AWS1/SGMDISASCDEFCODEREPOSI00 /AWS1/SGMDISASCDEFCODEREPOSI00

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.

IV_DISASSOCADDLCODEREPOSIT00 TYPE /AWS1/SGMDISASCADDLCODEREPOS00 /AWS1/SGMDISASCADDLCODEREPOS00

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.

IV_ROOTACCESS TYPE /AWS1/SGMROOTACCESS /AWS1/SGMROOTACCESS

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

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.

IO_INSTANCEMETSERVICECONF TYPE REF TO /AWS1/CL_SGMINSTMETSERVICECONF /AWS1/CL_SGMINSTMETSERVICECONF

Information on the IMDS configuration of the notebook instance

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SGMUPDNOTEBOOKINSTOUT /AWS1/CL_SGMUPDNOTEBOOKINSTOUT