notebook_metadatas

Creates, updates, deletes, gets or lists a notebook_metadatas resource.

Overview

Name	notebook_metadatas
Type	Resource
Id	aws.athena.notebook_metadatas

Fields

The following fields are returned by SELECT queries:

get_notebook_metadata

Name	Datatype	Description
creation_time	string (date-time)	The time when the notebook was created.
last_modified_time	string (date-time)	The time when the notebook was last modified.
name	string	The name of the notebook. (pattern: <code>(?!.*[/:\])[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]+</code>)
notebook_id	string	The notebook ID. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
type	string	The type of notebook. Currently, the only valid type is IPYNB. (IPYNB)
work_group	string	The name of the Spark enabled workgroup to which the notebook belongs. (pattern: <code>[a-zA-Z0-9._-]{1,128}</code>)

list_notebook_metadata

Name	Datatype	Description
next_token	string	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.
notebook_metadata_list	array	The list of notebook metadata for the specified workgroup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notebook_metadata	select	region		Retrieves notebook metadata for the specified notebook ID.
list_notebook_metadata	select	region		Displays the notebook files for the specified workgroup in paginated format.
update_notebook_metadata	update	region, NotebookId, Name		Updates the metadata for a notebook.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_notebook_metadata

Retrieves notebook metadata for the specified notebook ID.

SELECT
creation_time,
last_modified_time,
name,
notebook_id,
type,
work_group
FROM aws.athena.notebook_metadatas
WHERE region = '{{ region }}' -- required
;

list_notebook_metadata

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

SELECT
next_token,
notebook_metadata_list
FROM aws.athena.notebook_metadatas
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_notebook_metadata

Updates the metadata for a notebook.

UPDATE aws.athena.notebook_metadatas
SET 
NotebookId = '{{ NotebookId }}',
ClientRequestToken = '{{ ClientRequestToken }}',
Name = '{{ Name }}'
WHERE 
region = '{{ region }}' --required
AND NotebookId = '{{ NotebookId }}' --required
AND Name = '{{ Name }}' --required;