Skip to main content

notebook_sessions

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

Overview

Namenotebook_sessions
TypeResource
Idaws.athena.notebook_sessions

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
next_tokenstringA 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_sessions_listarrayA list of the sessions belonging to the notebook.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_notebook_sessionsselectregionLists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.

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