Table: aws_workspaces_workspace - Query Amazon WorkSpaces Workspace using SQL

The Amazon WorkSpaces service provides fully managed, persistent desktops in the cloud. A Workspace is a cloud-based virtual desktop that can integrate with your corporate Active Directory so that your users can use their existing credentials to access their WorkSpaces. It offers a choice of bundles providing different amounts of CPU, memory, and solid-state storage to meet your users' performance needs.

Table Usage Guide

The aws_workspaces_workspace table in Steampipe provides you with information about each workspace within Amazon WorkSpaces. This table allows you, as a DevOps engineer, to query workspace-specific details, including workspace properties, state, type, and associated metadata. You can utilize this table to gather insights on workspaces, such as workspace status, user properties, root volume, user volume, and more. The schema outlines the various attributes of the workspace for you, including the workspace ID, directory ID, bundle ID, and associated tags.

Examples

Basic info

select
  name,
  workspace_id,
  arn,
  state
from
  aws_workspaces_workspace;

select
  name,
  workspace_id,
  arn,
  state
from
  aws_workspaces_workspace;

List terminated workspaces

select
  name,
  workspace_id,
  arn,
  state
from
  aws_workspaces_workspace
where
  state = 'TERMINATED';

select
  name,
  workspace_id,
  arn,
  state
from
  aws_workspaces_workspace
where
  state = 'TERMINATED';

Schema for aws_workspaces_workspace

Name	Type	Operators	Description
_ctx	jsonb		Steampipe context in JSON form.
account_id	text	=, !=, ~~, ~~, !~~, !~~	The AWS Account ID in which the resource is located.
akas	jsonb		Array of globally unique identifier strings (also known as) for the resource.
arn	text		The arn of the WorkSpace.
bundle_id	text	=	The identifier of the bundle used to create the WorkSpace.
directory_id	text	=	The identifier of the AWS Directory Service directory for the WorkSpace.
error_code	text		The error code that is returned if the WorkSpace cannot be created.
error_message	text		The text of the error message that is returned if the WorkSpace cannot be created.
ip_address	inet		The IP address of the WorkSpace.
modification_states	jsonb		The modification states of the WorkSpace.
name	text		The name of the WorkSpace.
partition	text		The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
region	text		The AWS Region in which the resource is located.
root_volume_encryption_enabled	boolean		Indicates whether the data stored on the root volume is encrypted.
sp_connection_name	text	=, !=, ~~, ~~, !~~, !~~	Steampipe connection name.
sp_ctx	jsonb		Steampipe context in JSON form.
state	text		The operational state of the WorkSpace.
subnet_id	text		The identifier of the subnet for the WorkSpace.
tags	jsonb		A map of tags for the resource.
tags_src	jsonb		The list of tags for the WorkSpace.
title	text		Title of the resource.
user_name	text	=	The user for the WorkSpace.
user_volume_encryption_enabled	boolean		Indicates whether the data stored on the user volume is encrypted.
volume_encryption_key	text		The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
workspace_id	text	=	The id of the WorkSpace.
workspace_properties	jsonb		The properties of the WorkSpace.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- aws

You can pass the configuration to the command with the --config argument:

steampipe_export_aws --config '<your_config>' aws_workspaces_workspace