Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

WorkspaceImage - Amazon WorkSpaces Service

WorkspaceImage

Describes a WorkSpace image.

Contents

Created

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

Type: Timestamp

Required: No

Description

The description of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: No

ErrorCode

The error code that is returned for the image.

Type: String

Required: No

ErrorDetails

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

Type: Array of ErrorDetails objects

Required: No

ErrorMessage

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

Type: String

Required: No

ImageId

The identifier of the image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: No

Name

The name of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_./()\\-]+$

Required: No

OperatingSystem

The operating system that the image is running.

Type: OperatingSystem object

Required: No

OwnerAccountId

The identifier of the AWS account that owns the image.

Type: String

Pattern: ^\d{12}$

Required: No

RequiredTenancy

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.

Type: String

Valid Values: DEFAULT | DEDICATED

Required: No

State

The status of the image.

Type: String

Valid Values: AVAILABLE | PENDING | ERROR

Required: No

Updates

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

Type: UpdateResult object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.