Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeNotebookInstance

Returns information about a notebook instance.

Request Syntax


{
   "NotebookInstanceName": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

NotebookInstanceName

The name of the notebook instance that you want information about.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax


{
   "AcceleratorTypes": [ "string" ],
   "AdditionalCodeRepositories": [ "string" ],
   "CreationTime": number,
   "DefaultCodeRepository": "string",
   "DirectInternetAccess": "string",
   "FailureReason": "string",
   "InstanceMetadataServiceConfiguration": { 
      "MinimumInstanceMetadataServiceVersion": "string"
   },
   "InstanceType": "string",
   "KmsKeyId": "string",
   "LastModifiedTime": number,
   "NetworkInterfaceId": "string",
   "NotebookInstanceArn": "string",
   "NotebookInstanceLifecycleConfigName": "string",
   "NotebookInstanceName": "string",
   "NotebookInstanceStatus": "string",
   "PlatformIdentifier": "string",
   "RoleArn": "string",
   "RootAccess": "string",
   "SecurityGroups": [ "string" ],
   "SubnetId": "string",
   "Url": "string",
   "VolumeSizeInGB": number
}

Response Elements

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

The following data is returned in JSON format by the service.

AcceleratorTypes

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.

Type: Array of strings

AdditionalCodeRepositories

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 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 SageMaker AI 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])*

CreationTime

A timestamp. Use this parameter to return the time when the notebook instance was created

Type: Timestamp

DefaultCodeRepository

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*

DirectInternetAccess

Describes 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.

Type: String

Valid Values: Enabled | Disabled

FailureReason

If status is Failed, the reason it failed.

Type: String

Length Constraints: Maximum length of 1024.

InstanceMetadataServiceConfiguration

Information on the IMDS configuration of the notebook instance

Type: InstanceMetadataServiceConfiguration object

InstanceType

The type of ML compute instance running on the notebook instance.

Type: String

KmsKeyId

The AWS KMS key ID SageMaker AI uses to encrypt data when storing it on the ML storage volume attached to the instance.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[a-zA-Z0-9:/_-]*$

LastModifiedTime

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

Type: Timestamp

NetworkInterfaceId

The network interface IDs that SageMaker AI created at the time of creating the instance.

Type: String

NotebookInstanceArn

The Amazon Resource Name (ARN) of the notebook instance.

Type: String

Length Constraints: Maximum length of 256.

NotebookInstanceLifecycleConfigName

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

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

NotebookInstanceName

The name of the SageMaker AI notebook instance.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

NotebookInstanceStatus

The status of the notebook instance.

Type: String

PlatformIdentifier

The platform identifier of the notebook instance runtime environment.

Type: String

Length Constraints: Maximum length of 15.

Pattern: ^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2|notebook-al2-v3)$

RoleArn

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

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+=,.@\-_/]+$

RootAccess

Whether root access is enabled or disabled for users of the notebook instance.

Note

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.

Type: String

Valid Values: Enabled | Disabled

SecurityGroups

The IDs of the VPC security groups.

Type: Array of strings

Array Members: Maximum number of 5 items.

Length Constraints: Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

SubnetId

The ID of the VPC subnet.

Type: String

Length Constraints: Maximum length of 32.

Pattern: [-0-9a-zA-Z]+

Url

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

Type: String

VolumeSizeInGB

The size, in GB, of the ML storage volume attached to the notebook instance.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 16384.

Errors

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