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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#created ⇒ Time

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.

Returns:

  • (Time) —

    The date when the image was created.

#description ⇒ String

The description of the image.

Returns:

  • (String) —

    The description of the image.

#error_code ⇒ String

The error code that is returned for the image.

Returns:

  • (String) —

    The error code that is returned for the image.

#error_message ⇒ String

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_id ⇒ String

The identifier of the image.

Returns:

  • (String) —

    The identifier of the image.

#name ⇒ String

The name of the image.

Returns:

  • (String) —

    The name of the image.

#operating_system ⇒ Types::OperatingSystem

The operating system that the image is running.

Returns:

#owner_account_id ⇒ String

The identifier of the AWS account that owns the image.

Returns:

  • (String) —

    The identifier of the AWS account that owns the image.

#required_tenancy ⇒ String

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.

#state ⇒ String

The status of the image.

Possible values:

  • AVAILABLE
  • PENDING
  • ERROR

Returns:

  • (String) —

    The status of the image.