Skip to content
AWS for Query.Farm

aws.sagemaker.list_notebook_instances

Example SQL Queries

SELECT * FROM
aws.sagemaker.list_notebook_instances;

Description

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

Table Definition

Column NameColumn Data Type
additional_code_repository_equals Input Column

A filter that returns only notebook instances with associated with the specified git repository.

VARCHAR
creation_time_after Input Column

A filter that returns only notebook instances that were created after the specified time (timestamp).

TIMESTAMP_S
creation_time_before Input Column

A filter that returns only notebook instances that were created before the specified time (timestamp). 

TIMESTAMP_S
default_code_repository_contains Input Column

A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

VARCHAR
last_modified_time_after Input Column

A filter that returns only notebook instances that were modified after the specified time (timestamp).

TIMESTAMP_S
last_modified_time_before Input Column

A filter that returns only notebook instances that were modified before the specified time (timestamp).

TIMESTAMP_S
name_contains Input Column

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

VARCHAR
notebook_instance_lifecycle_config_name_contains Input Column

A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

VARCHAR
sort_by Input Column

The field to sort results by. The default is Name.

VARCHAR
sort_order Input Column

The sort order for results. 

VARCHAR
status_equals Input Column

A filter that returns only notebook instances with the specified status.

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.

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

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

VARCHAR
last_modified_time

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

TIMESTAMP_S
notebook_instance_arn

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

VARCHAR
notebook_instance_lifecycle_config_name

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.

VARCHAR
notebook_instance_name

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

VARCHAR
notebook_instance_status

The status of the notebook instance.

VARCHAR
url

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

VARCHAR