See: newDescribeNotebookInstance smart constructor.

Create a value of DescribeNotebookInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeNotebookInstance, describeNotebookInstance_notebookInstanceName - The name of the notebook instance that you want information about.

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

See: newDescribeNotebookInstanceResponse smart constructor.

Create a value of DescribeNotebookInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acceleratorTypes:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_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.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_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 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.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_creationTime - A timestamp. Use this parameter to return the time when the notebook instance was created

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_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 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.

$sel:directInternetAccess:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_directInternetAccess - 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.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_failureReason - If status is Failed, the reason it failed.

$sel:instanceMetadataServiceConfiguration:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_instanceMetadataServiceConfiguration - Information on the IMDS configuration of the notebook instance

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_instanceType - The type of ML compute instance running on the notebook instance.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_kmsKeyId - The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

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

$sel:networkInterfaceId:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_networkInterfaceId - The network interface IDs that SageMaker created at the time of creating the instance.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_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

DescribeNotebookInstance, describeNotebookInstanceResponse_notebookInstanceName - The name of the SageMaker notebook instance.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_notebookInstanceStatus - The status of the notebook instance.

$sel:platformIdentifier:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_platformIdentifier - The platform identifier of the notebook instance runtime environment.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the instance.

$sel:rootAccess:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_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.

DescribeNotebookInstanceResponse, describeNotebookInstanceResponse_securityGroups - The IDs of the VPC security groups.

$sel:subnetId:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_subnetId - The ID of the VPC subnet.

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

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

$sel:httpStatus:DescribeNotebookInstanceResponse', describeNotebookInstanceResponse_httpStatus - The response's http status code.

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.

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.

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

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.

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.

If status is Failed, the reason it failed.

Information on the IMDS configuration of the notebook instance

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

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

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

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

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

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

The name of the SageMaker notebook instance.

The status of the notebook instance.

The platform identifier of the notebook instance runtime environment.

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

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.

The IDs of the VPC security groups.

The ID of the VPC subnet.

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

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

The response's http status code.