environments_list_only

Lists environments in a region or regions, for all properties use environments

Overview

Name	environments_list_only
Type	Resource
Description	Resource type definition for AWS::WorkSpacesThinClient::Environment.
Id	aws.workspacesthinclient.environments_list_only

Fields

Name	Datatype	Description
id	string	Unique identifier of the environment.
name	string	The name of the environment.
desktop_arn	string	The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.
desktop_endpoint	string	The URL for the identity provider login (only for environments that use AppStream 2.0).
desktop_type	string	The type of VDI.
activation_code	string	Activation code for devices associated with environment.
registered_devices_count	integer	Number of devices registered to the environment.
software_set_update_schedule	string	An option to define if software updates should be applied within a maintenance window.
maintenance_window	object	A specification for a time window to apply software updates.
software_set_update_mode	string	An option to define which software updates to apply.
desired_software_set_id	string	The ID of the software set to apply.
pending_software_set_id	string	The ID of the software set that is pending to be installed.
pending_software_set_version	string	The version of the software set that is pending to be installed.
software_set_compliance_status	string	Describes if the software currently installed on all devices in the environment is a supported version.
created_at	string	The timestamp in unix epoch format when environment was created.
updated_at	string	The timestamp in unix epoch format when environment was last updated.
arn	string	The environment ARN.
kms_key_arn	string	The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the environment.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all environments in a region.

SELECT
region,
id
FROM aws.workspacesthinclient.environments_list_only
WHERE region = 'us-east-1';

Permissions

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