aws_sagemaker_notebook_instance
accelerator_types
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorTypes
Description: A list of the Elastic Inference (EI) instance types associated 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.
account_id
Type: STRING
additional_code_repositories
Type: UNORDERED_LIST_STRING
Provider name: AdditionalCodeRepositories
Description: 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 Notebook Instances.
creation_time
Type: TIMESTAMP
Provider name: CreationTime
Description: A timestamp. Use this parameter to return the time when the notebook instance was created
default_code_repository
Type: STRING
Provider name: DefaultCodeRepository
Description: The 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 Notebook Instances.
direct_internet_access
Type: STRING
Provider name: DirectInternetAccess
Description: Describes whether SageMaker 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 training and endpoint services. For more information, see Notebook Instances Are Internet-Enabled by Default.
failure_reason
Type: STRING
Provider name: FailureReason
Description: If status is Failed, the reason it failed.
Type: STRUCT
Provider name: InstanceMetadataServiceConfiguration
Description: Information on the IMDS configuration of the notebook instance
minimum_instance_metadata_service_version
Type: STRING
Provider name: MinimumInstanceMetadataServiceVersion
Description: Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
instance_type
Type: STRING
Provider name: InstanceType
Description: The type of ML compute instance running on the notebook instance.
kms_key_id
Type: STRING
Provider name: KmsKeyId
Description: The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
last_modified_time
Type: TIMESTAMP
Provider name: LastModifiedTime
Description: A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.
network_interface_id
Type: STRING
Provider name: NetworkInterfaceId
Description: The network interface IDs that SageMaker created at the time of creating the instance.
notebook_instance_arn
Type: STRING
Provider name: NotebookInstanceArn
Description: The Amazon Resource Name (ARN) of the notebook instance.
notebook_instance_lifecycle_config_name
Type: STRING
Provider name: NotebookInstanceLifecycleConfigName
Description: Returns 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_name
Type: STRING
Provider name: NotebookInstanceName
Description: The name of the SageMaker notebook instance.
notebook_instance_status
Type: STRING
Provider name: NotebookInstanceStatus
Description: The status of the notebook instance.
Type: STRING
Provider name: PlatformIdentifier
Description: The platform identifier of the notebook instance runtime environment.
role_arn
Type: STRING
Provider name: RoleArn
Description: The Amazon Resource Name (ARN) of the IAM role associated with the instance.
root_access
Type: STRING
Provider name: RootAccess
Description: Whether 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_groups
Type: UNORDERED_LIST_STRING
Provider name: SecurityGroups
Description: The IDs of the VPC security groups.
subnet_id
Type: STRING
Provider name: SubnetId
Description: The ID of the VPC subnet.
Type: UNORDERED_LIST_STRING
url
Type: STRING
Provider name: Url
Description: The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
volume_size_in_gb
Type: INT32
Provider name: VolumeSizeInGB
Description: The size, in GB, of the ML storage volume attached to the notebook instance.
