Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

WorkspaceImage

Describes a WorkSpace image.

Contents

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

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

RequiredTenancy

Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED.

Type: String

Valid Values: DEFAULT | DEDICATED

Required: No

State

The status of the image.

Type: String

Valid Values: AVAILABLE | PENDING | ERROR

Required: No

See Also

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

On this page: