Skip to content
AWS for Query.Farm

aws.sagemaker.describe_notebook_instance

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_notebook_instance
WHERE
"notebook_instance_name" = 'VALUE';

Description

Returns information about a notebook instance.

Table Definition

Column NameColumn Data Type
notebook_instance_name Required Input Column

The name of the SageMaker notebook instance. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

accelerator_types

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.

VARCHAR[]
Show child fields
accelerator_types[]
additional_code_repositories

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.

VARCHAR[]
Show child fields
additional_code_repositories[]
creation_time

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

TIMESTAMP_S
default_code_repository

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.

VARCHAR
direct_internet_access

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.

VARCHAR
failure_reason

If status is Failed, the reason it failed.

VARCHAR
instance_metadata_service_configuration

Information on the IMDS configuration of the notebook instance

STRUCT(
    "minimum_instance_metadata_service_version" VARCHAR
)
Show child fields
instance_metadata_service_configuration.minimum_instance_metadata_service_version

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

instance_type

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

VARCHAR
kms_key_id

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

VARCHAR
last_modified_time

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

TIMESTAMP_S
network_interface_id

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

VARCHAR
notebook_instance_arn

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

VARCHAR
notebook_instance_lifecycle_config_name

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 

VARCHAR
notebook_instance_status

The status of the notebook instance.

VARCHAR
platform_identifier

The platform identifier of the notebook instance runtime environment.

VARCHAR
role_arn

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

VARCHAR
root_access

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.

VARCHAR
security_groups

The IDs of the VPC security groups.

VARCHAR[]
Show child fields
security_groups[]
subnet_id

The ID of the VPC subnet.

VARCHAR
url

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

VARCHAR
volume_size_in_gb

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

BIGINT