SageMaker Notebook Instance

An AWS SageMaker Notebook Instance is a fully managed machine learning compute instance running Jupyter notebooks. It provides a pre-configured environment with popular data science and machine learning libraries, allowing you to build, train, and deploy models without managing infrastructure. You can choose instance types to match your workload, attach storage, and integrate with other AWS services for data access and model deployment.

aws.sagemaker_notebook_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
accelerator_typescorearray<string>This parameter is no longer supported. Elastic Inference (EI) is no longer available. This parameter was used to specify a list of the EI instance types associated with this notebook instance.
account_idcorestring
additional_code_repositoriescorearray<string>An array of up to three Git repositories associated 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 AI Notebook Instances.
creation_timecoretimestampA timestamp. Use this parameter to return the time when the notebook instance was created
default_code_repositorycorestringThe Git repository associated 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 AI Notebook Instances.
direct_internet_accesscorestringDescribes whether SageMaker AI provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker AI training and endpoint services. For more information, see Notebook Instances Are Internet-Enabled by Default.
failure_reasoncorestringIf status is Failed, the reason it failed.
instance_metadata_service_configurationcorejsonInformation on the IMDS configuration of the notebook instance
instance_typecorestringThe type of ML compute instance running on the notebook instance.
kms_key_idcorestringThe Amazon Web Services KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.
last_modified_timecoretimestampA timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
network_interface_idcorestringThe network interface IDs that SageMaker AI created at the time of creating the instance.
notebook_instance_arncorestringThe Amazon Resource Name (ARN) of the notebook instance.
notebook_instance_lifecycle_config_namecorestringReturns the name of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance
notebook_instance_namecorestringThe name of the SageMaker AI notebook instance.
notebook_instance_statuscorestringThe status of the notebook instance.
platform_identifiercorestringThe platform identifier of the notebook instance runtime environment.
role_arncorestringThe Amazon Resource Name (ARN) of the IAM role associated with the instance.
root_accesscorestringWhether root access is enabled or disabled for users of the notebook instance. Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.
security_groupscorearray<string>The IDs of the VPC security groups.
subnet_idcorestringThe ID of the VPC subnet.
tagscorehstore
urlcorestringThe URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
volume_size_in_gbcoreint64The size, in GB, of the ML storage volume attached to the notebook instance.