DescribeNotebookInstance

Returns information about a notebook instance.

{
   "[NotebookInstanceName](#SageMaker-DescribeNotebookInstance-request-NotebookInstanceName)": "string"
}

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

{
   "[AcceleratorTypes](#SageMaker-DescribeNotebookInstance-response-AcceleratorTypes)": [ "string" ],
   "[AdditionalCodeRepositories](#SageMaker-DescribeNotebookInstance-response-AdditionalCodeRepositories)": [ "string" ],
   "[CreationTime](#SageMaker-DescribeNotebookInstance-response-CreationTime)": number,
   "[DefaultCodeRepository](#SageMaker-DescribeNotebookInstance-response-DefaultCodeRepository)": "string",
   "[DirectInternetAccess](#SageMaker-DescribeNotebookInstance-response-DirectInternetAccess)": "string",
   "[FailureReason](#SageMaker-DescribeNotebookInstance-response-FailureReason)": "string",
   "[InstanceType](#SageMaker-DescribeNotebookInstance-response-InstanceType)": "string",
   "[KmsKeyId](#SageMaker-DescribeNotebookInstance-response-KmsKeyId)": "string",
   "[LastModifiedTime](#SageMaker-DescribeNotebookInstance-response-LastModifiedTime)": number,
   "[NetworkInterfaceId](#SageMaker-DescribeNotebookInstance-response-NetworkInterfaceId)": "string",
   "[NotebookInstanceArn](#SageMaker-DescribeNotebookInstance-response-NotebookInstanceArn)": "string",
   "[NotebookInstanceLifecycleConfigName](#SageMaker-DescribeNotebookInstance-response-NotebookInstanceLifecycleConfigName)": "string",
   "[NotebookInstanceName](#SageMaker-DescribeNotebookInstance-response-NotebookInstanceName)": "string",
   "[NotebookInstanceStatus](#SageMaker-DescribeNotebookInstance-response-NotebookInstanceStatus)": "string",
   "[RoleArn](#SageMaker-DescribeNotebookInstance-response-RoleArn)": "string",
   "[RootAccess](#SageMaker-DescribeNotebookInstance-response-RootAccess)": "string",
   "[SecurityGroups](#SageMaker-DescribeNotebookInstance-response-SecurityGroups)": [ "string" ],
   "[SubnetId](#SageMaker-DescribeNotebookInstance-response-SubnetId)": "string",
   "[Url](#SageMaker-DescribeNotebookInstance-response-Url)": "string",
   "[VolumeSizeInGB](#SageMaker-DescribeNotebookInstance-response-VolumeSizeInGB)": number
}

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

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

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

** DirectInternetAccess ** Describes whether Amazon 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 Amazon SageMaker 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.

** KmsKeyId ** The AWS KMS key ID Amazon SageMaker 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: .*

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

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

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

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