environment

Gets an individual environment resource

Overview

Name	environment
Type	Resource
Description	environment
Id	awscc.workspacesthinclient.environment

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

Currently only SELECT is supported for this resource resource.

Example

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,
tags
FROM awscc.workspacesthinclient.environment
WHERE data__Identifier = '<Id>';

Permissions

To operate on the environment resource, the following permissions are required:

Read

thinclient:GetEnvironment,
thinclient:ListTagsForResource,
kms:DescribeKey,
kms:Encrypt,
kms:Decrypt

Update

appstream:DescribeStacks,
workspaces:DescribeWorkspaceDirectories,
workspaces-web:GetPortal,
workspaces-web:GetUserSettings,
thinclient:UpdateEnvironment,
thinclient:GetEnvironment,
thinclient:TagResource,
thinclient:UntagResource,
thinclient:ListTagsForResource,
kms:DescribeKey,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:RetireGrant

Delete

thinclient:DeleteEnvironment,
thinclient:UntagResource,
kms:DescribeKey,
kms:RetireGrant