Skip to content

aws.workspaces_thin_client.get_environment

Example SQL Queries

SELECT * FROM
aws.workspaces_thin_client.get_environment
WHERE
"id" = 'VALUE';

Description

Returns information for an environment.

Table Definition

Column NameColumn Data Type
id Required Input Column

The ID of the environment for which to return information.

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.

environment

Describes an environment.

STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"desktop_arn" VARCHAR,
"desktop_endpoint" VARCHAR,
"desktop_type" VARCHAR,
"activation_code" VARCHAR,
"registered_devices_count" BIGINT,
"software_set_update_schedule" VARCHAR,
"maintenance_window" STRUCT(
"type" VARCHAR,
"start_time_hour" BIGINT,
"start_time_minute" BIGINT,
"end_time_hour" BIGINT,
"end_time_minute" BIGINT,
"days_of_the_week" VARCHAR[],
"apply_time_of" VARCHAR
),
"software_set_update_mode" VARCHAR,
"desired_software_set_id" VARCHAR,
"pending_software_set_id" VARCHAR,
"pending_software_set_version" VARCHAR,
"software_set_compliance_status" VARCHAR,
"created_at" TIMESTAMP_S,
"updated_at" TIMESTAMP_S,
"arn" VARCHAR,
"kms_key_arn" VARCHAR,
"tags" MAP(VARCHAR, VARCHAR),
"device_creation_tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
environment.activation_code

The activation code to register a device to the environment.

environment.arn

The Amazon Resource Name (ARN) of the environment.

environment.created_at

The timestamp of when the environment was created.

environment.desired_software_set_id

The ID of the software set to apply.

environment.desktop_arn

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.

environment.desktop_endpoint

The URL for the identity provider login (only for environments that use AppStream 2.0).

environment.desktop_type

The type of streaming desktop for the environment.

environment.device_creation_tags

The tag keys and optional values for the newly created devices for this environment.

environment.id

The ID of the environment.

environment.kms_key_arn

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

environment.maintenance_window

A specification for a time window to apply software updates.

Show child fields
environment.maintenance_window.apply_time_of

The option to set the maintenance window during the device local time or Universal Coordinated Time (UTC).

environment.maintenance_window.days_of_the_week[]
environment.maintenance_window.end_time_hour

The hour for the maintenance window end (00-23).

environment.maintenance_window.end_time_minute

The minutes for the maintenance window end (00-59).

environment.maintenance_window.start_time_hour

The hour for the maintenance window start (00-23).

environment.maintenance_window.start_time_minute

The minutes past the hour for the maintenance window start (00-59).

environment.maintenance_window.type

An option to select the default or custom maintenance window.

environment.name

The name of the environment.

environment.pending_software_set_id

The ID of the software set that is pending to be installed.

environment.pending_software_set_version

The version of the software set that is pending to be installed.

environment.registered_devices_count

The number of devices registered to the environment.

environment.software_set_compliance_status

Describes if the software currently installed on all devices in the environment is a supported version.

environment.software_set_update_mode

An option to define which software updates to apply.

environment.software_set_update_schedule

An option to define if software updates should be applied within a maintenance window.

environment.tags

The tag keys and optional values for the resource.

environment.updated_at

The timestamp of when the device was updated.