Skip to content
AWS for Query.Farm

aws.glue.list_sessions

Example SQL Queries

SELECT * FROM
aws.glue.list_sessions;

Description

Retrieve a list of sessions.

Table Definition

Column NameColumn Data Type
max_results Input Column

The maximum number of results. 

BIGINT
next_token Input Column

The token for the next set of results, or null if there are no more result. 

VARCHAR
request_origin Input Column

The origin of the request. 

VARCHAR
tags Input Column

Tags belonging to the session. 

MAP(VARCHAR, 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
ids

Returns the ID of the session. 

VARCHAR[]
Show child fields
ids[]
sessions

Returns the session object. 

STRUCT(
    "id" VARCHAR,
    "created_on" TIMESTAMP_S,
    "status" VARCHAR,
    "error_message" VARCHAR,
    "description" VARCHAR,
    "role" VARCHAR,
    "command" STRUCT(
        "name" VARCHAR,
        "python_version" VARCHAR
    ),
    "default_arguments" MAP(VARCHAR, VARCHAR),
    "connections" STRUCT(
        "connections" VARCHAR[]
    ),
    "progress" DOUBLE,
    "max_capacity" DOUBLE,
    "security_configuration" VARCHAR,
    "glue_version" VARCHAR,
    "number_of_workers" BIGINT,
    "worker_type" VARCHAR,
    "completed_on" TIMESTAMP_S,
    "execution_time" DOUBLE,
    "dpu_seconds" DOUBLE,
    "idle_timeout" BIGINT,
    "profile_name" VARCHAR
)[]
Show child fields
sessions[]
Show child fields
sessions[].command

The command object.See SessionCommand.

Show child fields
sessions[].command.name

Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.

sessions[].command.python_version

Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.

sessions[].completed_on

The date and time that this session is completed.

sessions[].connections

The number of connections used for the session.

Show child fields
sessions[].connections.connections[]
sessions[].created_on

The time and date when the session was created.

sessions[].default_arguments

A map array of key-value pairs. Max is 75 pairs.

sessions[].description

The description of the session.

sessions[].dpu_seconds

The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).

sessions[].error_message

The error message displayed during the session.

sessions[].execution_time

The total time the session ran for.

sessions[].glue_version

The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

sessions[].id

The ID of the session.

sessions[].idle_timeout

The number of minutes when idle before the session times out.

sessions[].max_capacity

The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.

sessions[].number_of_workers

The number of workers of a defined WorkerType to use for the session.

sessions[].profile_name

The name of an Glue usage profile associated with the session.

sessions[].progress

The code execution progress of the session.

sessions[].role

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

sessions[].security_configuration

The name of the SecurityConfiguration structure to be used with the session.

sessions[].status

The session status.

sessions[].worker_type

The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.