client_properties

Creates, updates, deletes, gets or lists a client_properties resource.

Overview

Name	client_properties
Type	Resource
Id	aws.workspaces.client_properties

Fields

The following fields are returned by SELECT queries:

describe_client_properties

Name	Datatype	Description
client_properties_list	array	Information about the specified Amazon WorkSpaces clients.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_client_properties	select	region		Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
modify_client_properties	update	region, ResourceId, ClientProperties		Modifies the properties of the specified Amazon WorkSpaces clients.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_client_properties

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

SELECT
client_properties_list
FROM aws.workspaces.client_properties
WHERE region = '{{ region }}' -- required
;

UPDATE examples

modify_client_properties

Modifies the properties of the specified Amazon WorkSpaces clients.

UPDATE aws.workspaces.client_properties
SET 
ResourceId = '{{ ResourceId }}',
ClientProperties = '{{ ClientProperties }}'
WHERE 
region = '{{ region }}' --required
AND ResourceId = '{{ ResourceId }}' --required
AND ClientProperties = '{{ ClientProperties }}' --required;