workspaces_connection_status
Creates, updates, deletes, gets or lists a workspaces_connection_status resource.
Overview
| Name | workspaces_connection_status |
| Type | Resource |
| Id | aws.workspaces.workspaces_connection_status |
Fields
The following fields are returned by SELECT queries:
- describe_workspaces_connection_status
| Name | Datatype | Description |
|---|---|---|
connection_state | string | The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped. (CONNECTED, DISCONNECTED, UNKNOWN) |
connection_state_check_timestamp | string (date-time) | The timestamp of the connection status check. |
last_known_user_connection_timestamp | string (date-time) | The timestamp of the last known user connection. |
workspace_id | string | The identifier of the WorkSpace. (pattern: <code>^ws-[0-9a-z]{8,63}$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_workspaces_connection_status | select | region | Describes the connection status of the specified WorkSpaces. |
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_connection_status
Describes the connection status of the specified WorkSpaces.
SELECT
connection_state,
connection_state_check_timestamp,
last_known_user_connection_timestamp,
workspace_id
FROM aws.workspaces.workspaces_connection_status
WHERE region = '{{ region }}' -- required
;