notebook_sessions
Creates, updates, deletes, gets or lists a notebook_sessions resource.
Overview
| Name | notebook_sessions |
| Type | Resource |
| Id | aws.athena.notebook_sessions |
Fields
The following fields are returned by SELECT queries:
- list_notebook_sessions
| 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_sessions_list | array | A list of the sessions belonging to the notebook. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_notebook_sessions | select | region | 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. |
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
- list_notebook_sessions
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
;