Skip to content

aws.workspaces.describe_workspace_images

Example SQL Queries

SELECT * FROM
aws.workspaces.describe_workspace_images;

Description

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Table Definition

Column NameColumn Data Type
image_ids Input Column

The identifier of the image.

VARCHAR[]
Show child fields
image_ids[]
image_type Input Column

The type (owned or shared) of the image.

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
created

The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.

TIMESTAMP_S
description

The description of the image.

VARCHAR
error_code

The error code that is returned for the image.

VARCHAR
error_details

Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.

STRUCT(
"error_code" VARCHAR,
"error_message" VARCHAR
)[]
Show child fields
error_details[]
Show child fields
error_details[].error_code

Indicates the error code returned.

error_details[].error_message

The text of the error message related the error code.

error_message

The text of the error message that is returned for the image.

VARCHAR
image_id

The identifier of the image.

VARCHAR
name

The name of the image.

VARCHAR
operating_system

The operating system that the image is running.

STRUCT(
"type" VARCHAR
)
Show child fields
operating_system.type

The operating system.

owner_account_id

The identifier of the Amazon Web Services account that owns the image.

VARCHAR
required_tenancy

Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

VARCHAR
state

The status of the image.

VARCHAR
updates

The updates (if any) that are available for the specified image.

STRUCT(
"update_available" BOOLEAN,
"description" VARCHAR
)
Show child fields
updates.description

A description of whether updates for the WorkSpace image are pending or available.

updates.update_available

Indicates whether updated drivers or other components are available for the specified WorkSpace image.