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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-workspaces/types.rb

Overview

Describes a WorkSpace image.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description of the image.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#error_code ⇒ String

The error code that is returned for the image.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#error_message ⇒ String

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

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#image_id ⇒ String

The identifier of the image.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#name ⇒ String

The name of the image.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#operating_system ⇒ Types::OperatingSystem

The operating system that the image is running.

Returns:



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  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.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end

#state ⇒ String

The status of the image.

Returns:

  • (String) 


1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/aws-sdk-workspaces/types.rb', line 1875

class WorkspaceImage < Struct.new(
  :image_id,
  :name,
  :description,
  :operating_system,
  :state,
  :required_tenancy,
  :error_code,
  :error_message)
  include Aws::Structure
end