workspaces_pool_sessions
Creates, updates, deletes, gets or lists a workspaces_pool_sessions resource.
Overview
| Name | workspaces_pool_sessions |
| Type | Resource |
| Id | aws.workspaces.workspaces_pool_sessions |
Fields
The following fields are returned by SELECT queries:
- describe_workspaces_pool_sessions
| 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. |
sessions | array | Describes the pool sessions. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_workspaces_pool_sessions | 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. Retrieves a list that describes the streaming sessions for a specified pool. | |
terminate_workspaces_pool_session | 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 pool session. |
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_pool_sessions
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. Retrieves a list that describes the streaming sessions for a specified pool.
SELECT
next_token,
sessions
FROM aws.workspaces.workspaces_pool_sessions
WHERE region = '{{ region }}' -- required
;
DELETE examples
- terminate_workspaces_pool_session
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 pool session.
DELETE FROM aws.workspaces.workspaces_pool_sessions
WHERE region = '{{ region }}' --required
;