Documentation

Provides summary information for an SageMaker notebook instance.

See: newNotebookInstanceSummary smart constructor.

Create a value of NotebookInstanceSummary 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:additionalCodeRepositories:NotebookInstanceSummary', notebookInstanceSummary_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.

$sel:creationTime:NotebookInstanceSummary', notebookInstanceSummary_creationTime - A timestamp that shows when the notebook instance was created.

$sel:defaultCodeRepository:NotebookInstanceSummary', notebookInstanceSummary_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:instanceType:NotebookInstanceSummary', notebookInstanceSummary_instanceType - The type of ML compute instance that the notebook instance is running on.

$sel:lastModifiedTime:NotebookInstanceSummary', notebookInstanceSummary_lastModifiedTime - A timestamp that shows when the notebook instance was last modified.

$sel:notebookInstanceLifecycleConfigName:NotebookInstanceSummary', notebookInstanceSummary_notebookInstanceLifecycleConfigName - The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

$sel:notebookInstanceStatus:NotebookInstanceSummary', notebookInstanceSummary_notebookInstanceStatus - The status of the notebook instance.

$sel:url:NotebookInstanceSummary', notebookInstanceSummary_url - The URL that you use to connect to the Jupyter notebook running in your notebook instance.

$sel:notebookInstanceName:NotebookInstanceSummary', notebookInstanceSummary_notebookInstanceName - The name of the notebook instance that you want a summary for.

$sel:notebookInstanceArn:NotebookInstanceSummary', notebookInstanceSummary_notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.

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 that shows 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.

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

A timestamp that shows when the notebook instance was last modified.

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

The status of the notebook instance.

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

The name of the notebook instance that you want a summary for.

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