Skip to content

aws.appstream.describe_stacks

Example SQL Queries

SELECT * FROM
aws.appstream.describe_stacks;

Description

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

Table Definition

Column NameColumn Data Type
names Input Column

The names of the stacks 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.

access_endpoints

The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

STRUCT(
"endpoint_type" VARCHAR,
"vpce_id" VARCHAR
)[]
Show child fields
access_endpoints[]
Show child fields
access_endpoints[].endpoint_type

The type of interface endpoint.

access_endpoints[].vpce_id

The identifier (ID) of the VPC in which the interface endpoint is used.

application_settings

The persistent application settings for users of the stack.

STRUCT(
"enabled" BOOLEAN,
"settings_group" VARCHAR,
"s3_bucket_name" VARCHAR
)
Show child fields
application_settings.enabled

Specifies whether persistent application settings are enabled for users during their streaming sessions.

application_settings.s3_bucket_name

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

application_settings.settings_group

The path prefix for the S3 bucket where users’ persistent application settings are stored.

arn

The ARN of the stack.

VARCHAR
created_time

The time the stack was created.

TIMESTAMP_S
description

The description to display.

VARCHAR
display_name

The stack name to display.

VARCHAR
embed_host_domains

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

VARCHAR[]
Show child fields
embed_host_domains[]
feedback_url

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

VARCHAR
name

The name of the stack.

VARCHAR
redirect_url

The URL that users are redirected to after their streaming session ends.

VARCHAR
stack_errors

The errors for the stack.

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

The error code.

stack_errors[].error_message

The error message.

storage_connectors

The storage connectors to enable.

STRUCT(
"connector_type" VARCHAR,
"resource_identifier" VARCHAR,
"domains" VARCHAR[]
)[]
Show child fields
storage_connectors[]
Show child fields
storage_connectors[].connector_type

The type of storage connector.

storage_connectors[].domains[]
storage_connectors[].resource_identifier

The ARN of the storage connector.

streaming_experience_settings

The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.

STRUCT(
"preferred_protocol" VARCHAR
)
Show child fields
streaming_experience_settings.preferred_protocol

The preferred protocol that you want to use while streaming your application.

user_settings

The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

STRUCT(
"action" VARCHAR,
"permission" VARCHAR,
"maximum_length" BIGINT
)[]
Show child fields
user_settings[]
Show child fields
user_settings[].action

The action that is enabled or disabled.

user_settings[].maximum_length

Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.

This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.

This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.

The value can be between 1 and 20,971,520 (20 MB).

user_settings[].permission

Indicates whether the action is enabled or disabled.