Skip to content

NotebookInstanceSummary

Source code in docs_src/capo_sagemaker/types/notebook_instance_summary.py
class NotebookInstanceSummary(TypedDict, closed=True):
    notebook_instance_name: NotRequired[
        "capo_sagemaker.types.notebook_instance_name.NotebookInstanceName"
    ]
    """<p>The name of the notebook instance that you want a summary for.</p>"""
    notebook_instance_arn: NotRequired[
        "capo_sagemaker.types.notebook_instance_arn.NotebookInstanceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the notebook instance.</p>"""
    notebook_instance_status: NotRequired[
        "capo_sagemaker.types.notebook_instance_status.NotebookInstanceStatus"
    ]
    """<p>The status of the notebook instance.</p>"""
    url: NotRequired["capo_sagemaker.types.notebook_instance_url.NotebookInstanceUrl"]
    """<p>The URL that you use to connect to the Jupyter notebook running in your notebook instance. </p>"""
    instance_type: NotRequired["capo_sagemaker.types.instance_type.InstanceType"]
    """<p>The type of ML compute instance that the notebook instance is running on.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>A timestamp that shows when the notebook instance was created.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>A timestamp that shows when the notebook instance was last modified.</p>"""
    notebook_instance_lifecycle_config_name: NotRequired[
        "capo_sagemaker.types.notebook_instance_lifecycle_config_name.NotebookInstanceLifecycleConfigName"
    ]
    """<p>The name of a notebook instance lifecycle configuration associated with this notebook instance.</p> <p>For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>"""
    default_code_repository: NotRequired[
        "capo_sagemaker.types.code_repository_name_or_url.CodeRepositoryNameOrUrl"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>"""
    additional_code_repositories: NotRequired[
        "capo_sagemaker.types.additional_code_repository_names_or_urls.AdditionalCodeRepositoryNamesOrUrls"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services CodeCommit</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with SageMaker AI Notebook Instances</a>.</p>"""

additional_code_repositories instance-attribute

additional_code_repositories: NotRequired[AdditionalCodeRepositoryNamesOrUrls]

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

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

A timestamp that shows when the notebook instance was created.

default_code_repository instance-attribute

default_code_repository: NotRequired[CodeRepositoryNameOrUrl]

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

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

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

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

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

notebook_instance_arn instance-attribute

notebook_instance_arn: NotRequired[NotebookInstanceArn]

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

notebook_instance_lifecycle_config_name instance-attribute

notebook_instance_lifecycle_config_name: NotRequired[
    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.

notebook_instance_name instance-attribute

notebook_instance_name: NotRequired[NotebookInstanceName]

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

notebook_instance_status instance-attribute

notebook_instance_status: NotRequired[NotebookInstanceStatus]

The status of the notebook instance.

url instance-attribute

url: NotRequired[NotebookInstanceUrl]

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