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

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

Overview

Describes a WorkSpace image.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#createdTime

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)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#descriptionString

The description of the image.

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#error_codeString

The error code that is returned for the image.

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#error_messageString

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

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#image_idString

The identifier of the image.

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#nameString

The name of the image.

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#operating_systemTypes::OperatingSystem

The operating system that the image is running.



4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#owner_account_idString

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

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

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


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#stateString

The status of the image.

Returns:

  • (String)


4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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

#updatesTypes::UpdateResult

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

Returns:



4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4484

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