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

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::WorkspaceImage

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a WorkSpace image.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created ⇒ Time

  The date when the image was created.

• #description ⇒ String

  The description of the image.

• #error_code ⇒ String

  The error code that is returned for the image.

• #error_details ⇒ Array<Types::ErrorDetails>

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

• #error_message ⇒ String

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

• #image_id ⇒ String

  The identifier of the image.

• #name ⇒ String

  The name of the image.

• #operating_system ⇒ Types::OperatingSystem

  The operating system that the image is running.

• #owner_account_id ⇒ String

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

• #required_tenancy ⇒ String

  Specifies whether the image is running on dedicated hardware.

• #state ⇒ String

  The status of the image.

• #updates ⇒ Types::UpdateResult

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

Instance Attribute Details

#created ⇒ Time

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.

Returns:

• (Time)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the image.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

The error code that is returned for the image.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#error_details ⇒ Array<Types::ErrorDetails>

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

Returns:

• (Array<Types::ErrorDetails>)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

The identifier of the image.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the image.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#operating_system ⇒ Types::OperatingSystem

The operating system that the image is running.

Returns:

• (Types::OperatingSystem)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The status of the image.

Returns:

• (String)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#updates ⇒ Types::UpdateResult

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

Returns:

• (Types::UpdateResult)

# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5890

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message,
  :created,
  :owner_account_id,
  :updates,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end