You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkSpaces::Types::WorkspaceImage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a WorkSpace image.

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the image.

Returns:

  • (String)

    The description of the image.

#error_codeString

The error code that is returned for the image.

Returns:

  • (String)

    The error code that is returned for the image.

#error_messageString

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

Returns:

  • (String)

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

#image_idString

The identifier of the image.

Returns:

  • (String)

    The identifier of the image.

#nameString

The name of the image.

Returns:

  • (String)

    The name of the image.

#operating_systemTypes::OperatingSystem

The operating system that the image is running.

Returns:

#required_tenancyString

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.

Returns:

  • (String)

    Specifies whether the image is running on dedicated hardware.

#stateString

The status of the image.

Possible values:

  • AVAILABLE
  • PENDING
  • ERROR

Returns:

  • (String)

    The status of the image.