accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	aws.workspaces.accounts

Fields

The following fields are returned by SELECT queries:

describe_account

Name	Datatype	Description
dedicated_tenancy_account_type	string	The type of linked account. (SOURCE_ACCOUNT, TARGET_ACCOUNT)
dedicated_tenancy_management_cidr_range	string	The IP address range, specified as an IPv4 CIDR block, used for the management network interface. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace. (pattern: <code>(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]).0.0)(/(16$))$</code>)
dedicated_tenancy_support	string	The status of BYOL (whether BYOL is enabled or disabled). (ENABLED, DISABLED)
message	string	The text message to describe the status of BYOL.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_account	select	region		Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
modify_account	update	region		Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

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_account

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

SELECT
dedicated_tenancy_account_type,
dedicated_tenancy_management_cidr_range,
dedicated_tenancy_support,
message
FROM aws.workspaces.accounts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

modify_account

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

UPDATE aws.workspaces.accounts
SET 
DedicatedTenancySupport = '{{ DedicatedTenancySupport }}',
DedicatedTenancyManagementCidrRange = '{{ DedicatedTenancyManagementCidrRange }}'
WHERE 
region = '{{ region }}' --required
RETURNING
message;