Skip to content

aws.athena.list_sessions

Example SQL Queries

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

Description

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.

Table Definition

Column NameColumn Data Type
work_group Required Input Column

The workgroup to which the session belongs.

VARCHAR
max_results Input Column

The maximum number of sessions 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
state_filter Input Column

A filter for a specific session state. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

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
sessions

A list of sessions.

STRUCT(
"session_id" VARCHAR,
"description" VARCHAR,
"engine_version" STRUCT(
"selected_engine_version" VARCHAR,
"effective_engine_version" VARCHAR
),
"notebook_version" VARCHAR,
"status" STRUCT(
"start_date_time" TIMESTAMP_S,
"last_modified_date_time" TIMESTAMP_S,
"end_date_time" TIMESTAMP_S,
"idle_since_date_time" TIMESTAMP_S,
"state" VARCHAR,
"state_change_reason" VARCHAR
)
)[]
Show child fields
sessions[]
Show child fields
sessions[].description

The session description.

sessions[].engine_version

The engine version used by the session (for example, PySpark engine version 3).

Show child fields
sessions[].engine_version.effective_engine_version

Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a CreateWorkGroup or UpdateWorkGroup operation, the EffectiveEngineVersion field is ignored.

sessions[].engine_version.selected_engine_version

The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including AUTO. The default is AUTO.

sessions[].notebook_version

The notebook version.

sessions[].session_id

The session ID.

sessions[].status

Contains information about the session status.

Show child fields
sessions[].status.end_date_time

The date and time that the session ended.

sessions[].status.idle_since_date_time

The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

sessions[].status.last_modified_date_time

The most recent date and time that the session was modified.

sessions[].status.start_date_time

The date and time that the session started.

sessions[].status.state

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

sessions[].status.state_change_reason

The reason for the session state change (for example, canceled because the session was terminated).