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.

{
   "[AcceleratorTypes](#SageMaker-UpdateNotebookInstance-request-AcceleratorTypes)": [ "string" ],
   "[AdditionalCodeRepositories](#SageMaker-UpdateNotebookInstance-request-AdditionalCodeRepositories)": [ "string" ],
   "[DefaultCodeRepository](#SageMaker-UpdateNotebookInstance-request-DefaultCodeRepository)": "string",
   "[DisassociateAcceleratorTypes](#SageMaker-UpdateNotebookInstance-request-DisassociateAcceleratorTypes)": boolean,
   "[DisassociateAdditionalCodeRepositories](#SageMaker-UpdateNotebookInstance-request-DisassociateAdditionalCodeRepositories)": boolean,
   "[DisassociateDefaultCodeRepository](#SageMaker-UpdateNotebookInstance-request-DisassociateDefaultCodeRepository)": boolean,
   "[DisassociateLifecycleConfig](#SageMaker-UpdateNotebookInstance-request-DisassociateLifecycleConfig)": boolean,
   "[InstanceType](#SageMaker-UpdateNotebookInstance-request-InstanceType)": "string",
   "[LifecycleConfigName](#SageMaker-UpdateNotebookInstance-request-LifecycleConfigName)": "string",
   "[NotebookInstanceName](#SageMaker-UpdateNotebookInstance-request-NotebookInstanceName)": "string",
   "[RoleArn](#SageMaker-UpdateNotebookInstance-request-RoleArn)": "string",
   "[RootAccess](#SageMaker-UpdateNotebookInstance-request-RootAccess)": "string",
   "[VolumeSizeInGB](#SageMaker-UpdateNotebookInstance-request-VolumeSizeInGB)": number
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** AcceleratorTypes ** 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.
Type: Array of strings
Valid Values:ml.eia1.medium | ml.eia1.large | ml.eia1.xlarge
Required: No

** AdditionalCodeRepositories ** 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 AWS 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 Amazon SageMaker Notebook Instances.
Type: Array of strings
Array Members: Maximum number of 3 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No

** DefaultCodeRepository ** 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 AWS 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 Amazon SageMaker Notebook Instances.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No

** DisassociateAcceleratorTypes ** 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.
Type: Boolean
Required: No

** DisassociateAdditionalCodeRepositories ** 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.
Type: Boolean
Required: No

** DisassociateDefaultCodeRepository ** 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.
Type: Boolean
Required: No

** DisassociateLifecycleConfig ** 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.
Type: Boolean
Required: No

** LifecycleConfigName ** 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.
Type: String
Length Constraints: Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No

** NotebookInstanceName ** The name of the notebook instance to update.
Type: String
Length Constraints: Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: Yes

** RoleArn ** 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.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Required: No

** RootAccess ** 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. Type: String
Valid Values:Enabled | Disabled
Required: No

** VolumeSizeInGB ** 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.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 16384.
Required: No

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded
You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2