Skip to content
AWS for Query.Farm

aws.appstream.describe_fleets

Example SQL Queries

SELECT * FROM
aws.appstream.describe_fleets;

Description

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

Table Definition

Column NameColumn Data Type
names Input Column

The names of the fleets to describe.

VARCHAR[]
Show child fields
names[]
_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.

arn

The Amazon Resource Name (ARN) for the fleet.

VARCHAR
compute_capacity_status

The capacity status for the fleet.

STRUCT(
    "desired" BIGINT,
    "running" BIGINT,
    "in_use" BIGINT,
    "available" BIGINT,
    "desired_user_sessions" BIGINT,
    "available_user_sessions" BIGINT,
    "active_user_sessions" BIGINT,
    "actual_user_sessions" BIGINT
)
Show child fields
compute_capacity_status.active_user_sessions

The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

compute_capacity_status.actual_user_sessions

The total number of session slots that are available for streaming or are currently streaming.

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

This only applies to multi-session fleets.

compute_capacity_status.available

The number of currently available instances that can be used to stream sessions.

compute_capacity_status.available_user_sessions

The number of idle session slots currently available for user sessions.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

This only applies to multi-session fleets.

compute_capacity_status.desired

The desired number of streaming instances.

compute_capacity_status.desired_user_sessions

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

This only applies to multi-session fleets.

compute_capacity_status.in_use

The number of instances in use for streaming.

compute_capacity_status.running

The total number of simultaneous streaming instances that are running.

created_time

The time the fleet was created.

TIMESTAMP_S
description

The description to display.

VARCHAR
disconnect_timeout_in_seconds

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 36000.

BIGINT
display_name

The fleet name to display.

VARCHAR
domain_join_info

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. 

STRUCT(
    "directory_name" VARCHAR,
    "organizational_unit_distinguished_name" VARCHAR
)
Show child fields
domain_join_info.directory_name

The fully qualified name of the directory (for example, corp.example.com).

domain_join_info.organizational_unit_distinguished_name

The distinguished name of the organizational unit for computer accounts.

enable_default_internet_access

Indicates whether default internet access is enabled for the fleet.

BOOLEAN
fleet_errors

The fleet errors.

STRUCT(
    "error_code" VARCHAR,
    "error_message" VARCHAR
)[]
Show child fields
fleet_errors[]
Show child fields
fleet_errors[].error_code

The error code.

fleet_errors[].error_message

The error message.

fleet_type

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

VARCHAR
iam_role_arn

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

VARCHAR
idle_disconnect_timeout_in_seconds

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 36000. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. 

BIGINT
image_arn

The ARN for the public, private, or shared image.

VARCHAR
image_name

The name of the image used to create the fleet.

VARCHAR
instance_type

The instance type to use when launching fleet instances. The following instance types are available:

  • stream.standard.small

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.memory.z1d.large

  • stream.memory.z1d.xlarge

  • stream.memory.z1d.2xlarge

  • stream.memory.z1d.3xlarge

  • stream.memory.z1d.6xlarge

  • stream.memory.z1d.12xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics.g4dn.xlarge

  • stream.graphics.g4dn.2xlarge

  • stream.graphics.g4dn.4xlarge

  • stream.graphics.g4dn.8xlarge

  • stream.graphics.g4dn.12xlarge

  • stream.graphics.g4dn.16xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

VARCHAR
max_concurrent_sessions

The maximum number of concurrent sessions for the fleet.

BIGINT
max_sessions_per_instance

The maximum number of user sessions on an instance. This only applies to multi-session fleets.

BIGINT
max_user_duration_in_seconds

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

BIGINT
name

The name of the fleet.

VARCHAR
platform

The platform of the fleet.

VARCHAR
session_script_s3_location

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

STRUCT(
    "s3_bucket" VARCHAR,
    "s3_key" VARCHAR
)
Show child fields
session_script_s3_location.s3_bucket

The S3 bucket of the S3 object.

session_script_s3_location.s3_key

The S3 key of the S3 object.

This is required when used for the following:

  • IconS3Location (Actions: CreateApplication and UpdateApplication)

  • SessionScriptS3Location (Actions: CreateFleet and UpdateFleet)

  • ScriptDetails (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock)

  • SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)

state

The current state for the fleet.

VARCHAR
stream_view

The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.

The default value is APP.

VARCHAR
usb_device_filter_strings

The USB device filter strings associated with the fleet.

VARCHAR[]
Show child fields
usb_device_filter_strings[]
vpc_config

The VPC configuration for the fleet.

STRUCT(
    "subnet_ids" VARCHAR[],
    "security_group_ids" VARCHAR[]
)
Show child fields
vpc_config.security_group_ids[]
vpc_config.subnet_ids[]