workspaces_pools

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

Overview

Name	workspaces_pools
Type	Resource
Id	aws.workspaces.workspaces_pools

Fields

The following fields are returned by SELECT queries:

describe_workspaces_pools

Name	Datatype	Description
next_token	string	If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
workspaces_pools	array	Information about the WorkSpaces Pools.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_workspaces_pools	select	region		End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Describes the specified WorkSpaces Pools.
create_workspaces_pool	insert	region, PoolName, Description, BundleId, DirectoryId, Capacity		End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Creates a pool of WorkSpaces.
update_workspaces_pool	update	region, PoolId		End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Updates the specified pool.
terminate_workspaces_pool	delete	region		End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Terminates the specified pool.

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_workspaces_pools

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Describes the specified WorkSpaces Pools.

SELECT
next_token,
workspaces_pools
FROM aws.workspaces.workspaces_pools
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_workspaces_pool

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Creates a pool of WorkSpaces.

INSERT INTO aws.workspaces.workspaces_pools (
PoolName,
Description,
BundleId,
DirectoryId,
Capacity,
Tags,
ApplicationSettings,
TimeoutSettings,
RunningMode,
region
)
SELECT 
'{{ PoolName }}' /* required */,
'{{ Description }}' /* required */,
'{{ BundleId }}' /* required */,
'{{ DirectoryId }}' /* required */,
'{{ Capacity }}' /* required */,
'{{ Tags }}',
'{{ ApplicationSettings }}',
'{{ TimeoutSettings }}',
'{{ RunningMode }}',
'{{ region }}'
RETURNING
workspaces_pool
;

Manifest

# Description fields are for documentation purposes
- name: workspaces_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workspaces_pools resource.
  - name: PoolName
    value: "{{ PoolName }}"
    description: |
      The name of the pool.
  - name: Description
    value: "{{ Description }}"
    description: |
      The pool description.
  - name: BundleId
    value: "{{ BundleId }}"
    description: |
      The identifier of the bundle for the pool.
  - name: DirectoryId
    value: "{{ DirectoryId }}"
    description: |
      The identifier of the directory for the pool.
  - name: Capacity
    description: |
      The user capacity of the pool.
    value:
      DesiredUserSessions: {{ DesiredUserSessions }}
  - name: Tags
    description: |
      The tags for the pool.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ApplicationSettings
    description: |
      Indicates the application settings of the pool.
    value:
      Status: "{{ Status }}"
      SettingsGroup: "{{ SettingsGroup }}"
  - name: TimeoutSettings
    description: |
      Indicates the timeout settings of the pool.
    value:
      DisconnectTimeoutInSeconds: {{ DisconnectTimeoutInSeconds }}
      IdleDisconnectTimeoutInSeconds: {{ IdleDisconnectTimeoutInSeconds }}
      MaxUserDurationInSeconds: {{ MaxUserDurationInSeconds }}
  - name: RunningMode
    value: "{{ RunningMode }}"
    description: |
      The running mode for the pool.
    valid_values: ['AUTO_STOP', 'ALWAYS_ON']

UPDATE examples

update_workspaces_pool

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Updates the specified pool.

UPDATE aws.workspaces.workspaces_pools
SET 
PoolId = '{{ PoolId }}',
Description = '{{ Description }}',
BundleId = '{{ BundleId }}',
DirectoryId = '{{ DirectoryId }}',
Capacity = '{{ Capacity }}',
ApplicationSettings = '{{ ApplicationSettings }}',
TimeoutSettings = '{{ TimeoutSettings }}',
RunningMode = '{{ RunningMode }}'
WHERE 
region = '{{ region }}' --required
AND PoolId = '{{ PoolId }}' --required
RETURNING
workspaces_pool;

DELETE examples

terminate_workspaces_pool

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support. Terminates the specified pool.

DELETE FROM aws.workspaces.workspaces_pools
WHERE region = '{{ region }}' --required
;