Skip to main content

environment_tags

Expands all tag keys and values for environments in a region

Overview

Nameenvironment_tags
TypeResource
DescriptionResource type definition for AWS::WorkSpacesThinClient::Environment.
Idaws.workspacesthinclient.environment_tags

Fields

NameDatatypeDescription
idstringUnique identifier of the environment.
namestringThe name of the environment.
desktop_arnstringThe Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
desktop_endpointstringThe URL for the identity provider login (only for environments that use AppStream 2.0).
desktop_typestringThe type of VDI.
activation_codestringActivation code for devices associated with environment.
registered_devices_countintegerNumber of devices registered to the environment.
software_set_update_schedulestringAn option to define if software updates should be applied within a maintenance window.
maintenance_windowobjectA specification for a time window to apply software updates.
software_set_update_modestringAn option to define which software updates to apply.
desired_software_set_idstringThe ID of the software set to apply.
pending_software_set_idstringThe ID of the software set that is pending to be installed.
pending_software_set_versionstringThe version of the software set that is pending to be installed.
software_set_compliance_statusstringDescribes if the software currently installed on all devices in the environment is a supported version.
created_atstringThe timestamp in unix epoch format when environment was created.
updated_atstringThe timestamp in unix epoch format when environment was last updated.
arnstringThe environment ARN.
kms_key_arnstringThe Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all environments in a region.

SELECT
region,
id,
name,
desktop_arn,
desktop_endpoint,
desktop_type,
activation_code,
registered_devices_count,
software_set_update_schedule,
maintenance_window,
software_set_update_mode,
desired_software_set_id,
pending_software_set_id,
pending_software_set_version,
software_set_compliance_status,
created_at,
updated_at,
arn,
kms_key_arn,
tag_key,
tag_value
FROM aws.workspacesthinclient.environment_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the environment_tags resource, see environments