AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the UpdateNotebookInstance operation. 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.
Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z
public class UpdateNotebookInstanceRequest : AmazonSageMakerRequest IAmazonWebServiceRequest
The UpdateNotebookInstanceRequest type exposes the following members
Name | Description | |
---|---|---|
UpdateNotebookInstanceRequest() |
Name | Type | Description | |
---|---|---|---|
AcceleratorTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property 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. |
|
AdditionalCodeRepositories | System.Collections.Generic.List<System.String> |
Gets and sets the property 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 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. |
|
DefaultCodeRepository | System.String |
Gets and sets the property 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 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. |
|
DisassociateAcceleratorTypes | System.Boolean |
Gets and sets the property 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. |
|
DisassociateAdditionalCodeRepositories | System.Boolean |
Gets and sets the property 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. |
|
DisassociateDefaultCodeRepository | System.Boolean |
Gets and sets the property 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. |
|
DisassociateLifecycleConfig | System.Boolean |
Gets and sets the property DisassociateLifecycleConfig.
Set to |
|
InstanceMetadataServiceConfiguration | Amazon.SageMaker.Model.InstanceMetadataServiceConfiguration |
Gets and sets the property InstanceMetadataServiceConfiguration. Information on the IMDS configuration of the notebook instance |
|
InstanceType | Amazon.SageMaker.InstanceType |
Gets and sets the property InstanceType. The Amazon ML compute instance type. |
|
LifecycleConfigName | System.String |
Gets and sets the property 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. |
|
NotebookInstanceName | System.String |
Gets and sets the property NotebookInstanceName. The name of the notebook instance to update. |
|
RoleArn | System.String |
Gets and sets the property RoleArn. 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 |
|
RootAccess | Amazon.SageMaker.RootAccess |
Gets and sets the property RootAccess.
Whether root access is enabled or disabled for users of the notebook instance. The
default value is
If you set this to |
|
VolumeSizeInGB | System.Int32 |
Gets and sets the property 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 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. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5