Skip to content
AWS for Query.Farm

aws.workspaces.describe_workspaces_pool_sessions

Example SQL Queries

SELECT * FROM
aws.workspaces.describe_workspaces_pool_sessions
WHERE
"pool_id" = 'VALUE';

Description

Retrieves a list that describes the streaming sessions for a specified pool.

Table Definition

Column NameColumn Data Type
pool_id Required Input Column

The identifier of the pool.

VARCHAR
limit Input Column

The maximum number of items to return.

BIGINT
next_token Input Column

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

VARCHAR
user_id Input Column

The identifier of the user.

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

Describes the pool sessions.

STRUCT(
    "authentication_type" VARCHAR,
    "connection_state" VARCHAR,
    "session_id" VARCHAR,
    "instance_id" VARCHAR,
    "pool_id" VARCHAR,
    "expiration_time" TIMESTAMP_S,
    "network_access_configuration" STRUCT(
        "eni_private_ip_address" VARCHAR,
        "eni_id" VARCHAR
    ),
    "start_time" TIMESTAMP_S,
    "user_id" VARCHAR
)[]
Show child fields
sessions[]
Show child fields
sessions[].authentication_type

The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).

sessions[].connection_state

Specifies whether a user is connected to the pool session.

sessions[].expiration_time

The time that the pool session ended.

sessions[].instance_id

The identifier for the instance hosting the session.

sessions[].network_access_configuration

Describes the network details of the pool.

Show child fields
sessions[].network_access_configuration.eni_id

The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

sessions[].network_access_configuration.eni_private_ip_address

The private IP address of the elastic network interface that is attached to instances in your VPC.

sessions[].pool_id

The identifier of the pool.

sessions[].session_id

The identifier of the session.

sessions[].start_time

The time that the pool sission started.

sessions[].user_id

The identifier of the user.