Skip to content
AWS for Query.Farm

aws.athena.list_notebook_metadata

Example SQL Queries

SELECT * FROM
aws.athena.list_notebook_metadata
WHERE
"work_group" = 'VALUE';

Description

Displays the notebook files for the specified workgroup in paginated format.

Table Definition

Column NameColumn Data Type
work_group Required Input Column

The name of the Spark enabled workgroup to retrieve notebook metadata for.

VARCHAR
filters Input Column

Search filter string.

STRUCT(
    "name" VARCHAR
)
Show child fields
filters.name

The name of the notebook to search for.

max_results Input Column

Specifies the maximum number of results to return.

BIGINT
next_token Input Column

A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
notebook_metadata_list

The list of notebook metadata for the specified workgroup.

STRUCT(
    "notebook_id" VARCHAR,
    "name" VARCHAR,
    "work_group" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "type" VARCHAR,
    "last_modified_time" TIMESTAMP_S
)[]
Show child fields
notebook_metadata_list[]
Show child fields
notebook_metadata_list[].creation_time

The time when the notebook was created.

notebook_metadata_list[].last_modified_time

The time when the notebook was last modified.

notebook_metadata_list[].name

The name of the notebook.

notebook_metadata_list[].notebook_id

The notebook ID.

notebook_metadata_list[].type

The type of notebook. Currently, the only valid type is IPYNB.

notebook_metadata_list[].work_group

The name of the Spark enabled workgroup to which the notebook belongs.