| Column Name | Column Data Type |
|---|
bundle_id Input Column
The identifier of the bundle used to create the WorkSpace. | VARCHAR |
directory_id Input Column
The identifier of the Directory Service directory for the WorkSpace. | VARCHAR |
user_name Input Column
The user for the WorkSpace. | VARCHAR |
workspace_ids Input Column
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned. | VARCHAR[] |
Show child fields- workspace_ids[]
|
workspace_name Input Column
The name of the user-decoupled WorkSpace. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
computer_name
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace. | VARCHAR |
data_replication_settings
Indicates the settings of the data replication. | STRUCT(
"data_replication" VARCHAR,
"recovery_snapshot_time" TIMESTAMP_S
) |
Show child fields- data_replication_settings.data_replication
Indicates whether data replication is enabled, and if enabled, the type of data replication. - data_replication_settings.recovery_snapshot_time
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
|
error_code
The error code that is returned if the WorkSpace cannot be created. | VARCHAR |
error_message
The text of the error message that is returned if the WorkSpace cannot be created. | VARCHAR |
ip_address
The IP address of the WorkSpace. | VARCHAR |
modification_states
The modification states of the WorkSpace. | STRUCT(
"resource" VARCHAR,
"state" VARCHAR
)[] |
Show child fields- modification_states[]
Show child fields- modification_states[].resource
The resource. - modification_states[].state
The modification state.
|
related_workspaces
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace. | STRUCT(
"workspace_id" VARCHAR,
"region" VARCHAR,
"state" VARCHAR,
"type" VARCHAR
)[] |
Show child fields- related_workspaces[]
Show child fields- related_workspaces[].region
The Region of the related WorkSpace. - related_workspaces[].state
Indicates the state of the WorkSpace. - related_workspaces[].type
Indicates the type of WorkSpace. - related_workspaces[].workspace_id
The identifier of the related WorkSpace.
|
root_volume_encryption_enabled
Indicates whether the data stored on the root volume is encrypted. | BOOLEAN |
standby_workspaces_properties
The properties of the standby WorkSpace | STRUCT(
"standby_workspace_id" VARCHAR,
"data_replication" VARCHAR,
"recovery_snapshot_time" TIMESTAMP_S
)[] |
Show child fields- standby_workspaces_properties[]
Show child fields- standby_workspaces_properties[].data_replication
Indicates whether data replication is enabled, and if enabled, the type of data replication. - standby_workspaces_properties[].recovery_snapshot_time
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data. - standby_workspaces_properties[].standby_workspace_id
The identifier of the standby WorkSpace
|
state
The operational state of the WorkSpace. -
PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created). -
AVAILABLE – The WorkSpace is running and has passed the health checks. -
IMPAIRED – Refer to UNHEALTHY state. -
UNHEALTHY – The WorkSpace is not responding to health checks. -
REBOOTING – The WorkSpace is being rebooted (restarted). -
STARTING – The WorkSpace is starting up and health checks are being run. -
REBUILDING – The WorkSpace is being rebuilt. -
RESTORING – The WorkSpace is being restored. -
MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services. -
ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator. -
TERMINATING – The WorkSpace is being deleted. -
TERMINATED – The WorkSpace has been deleted. -
SUSPENDED – The WorkSpace has been suspended for image creation. -
UPDATING – The WorkSpace is undergoing an update. -
STOPPING – The WorkSpace is being stopped. -
STOPPED – The WorkSpace has been stopped. -
ERROR – The WorkSpace is an error state (for example, an error occurred during startup). After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated. | VARCHAR |
subnet_id
The identifier of the subnet for the WorkSpace. | VARCHAR |
user_volume_encryption_enabled
Indicates whether the data stored on the user volume is encrypted. | BOOLEAN |
volume_encryption_key
The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys. | VARCHAR |
workspace_id
The identifier of the WorkSpace. | VARCHAR |
workspace_properties
The properties of the WorkSpace. | STRUCT(
"running_mode" VARCHAR,
"running_mode_auto_stop_timeout_in_minutes" BIGINT,
"root_volume_size_gib" BIGINT,
"user_volume_size_gib" BIGINT,
"compute_type_name" VARCHAR,
"protocols" VARCHAR[],
"operating_system_name" VARCHAR
) |
Show child fields- workspace_properties.compute_type_name
The compute type. For more information, see Amazon WorkSpaces Bundles. - workspace_properties.operating_system_name
The name of the operating system. - workspace_properties.protocols[]
- workspace_properties.root_volume_size_gib
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. - workspace_properties.running_mode
The running mode. For more information, see Manage the WorkSpace Running Mode. The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing? - workspace_properties.running_mode_auto_stop_timeout_in_minutes
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. - workspace_properties.user_volume_size_gib
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
|