Skip to content

aws.appstream.describe_sessions

Example SQL Queries

SELECT * FROM
aws.appstream.describe_sessions
WHERE
"stack_name" = 'VALUE'
AND "fleet_name" = 'VALUE';

Description

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Table Definition

Column NameColumn Data Type
fleet_name Required Input Column

The name of the fleet for the streaming session.

VARCHAR
stack_name Required Input Column

The name of the stack for the streaming session.

VARCHAR
authentication_type Input Column

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

VARCHAR
instance_id Input Column

The identifier for the instance hosting the session.

VARCHAR
user_id Input Column

The identifier of the user for whom the session was created.

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.

connection_state

Specifies whether a user is connected to the streaming session.

VARCHAR
id

The identifier of the streaming session.

VARCHAR
max_expiration_time

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

TIMESTAMP_S
network_access_configuration

The network details for the streaming session.

STRUCT(
"eni_private_ip_address" VARCHAR,
"eni_id" VARCHAR
)
Show child fields
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.

network_access_configuration.eni_private_ip_address

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

start_time

The time when a streaming instance is dedicated for the user.

TIMESTAMP_S
state

The current state of the streaming session.

VARCHAR