Class: Aws::AppStream::Types::Image

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::Image

Defined in:

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

Overview

Describes an image.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #applications ⇒ Array<Types::Application>

  The applications associated with the image.

• #appstream_agent_version ⇒ String

  The version of the WorkSpaces Applications agent to use for instances that are launched from this image.

• #arn ⇒ String

  The ARN of the image.

• #base_image_arn ⇒ String

  The ARN of the image from which this image was created.

• #created_time ⇒ Time

  The time the image was created.

• #description ⇒ String

  The description to display.

• #display_name ⇒ String

  The image name to display.

• #dynamic_app_providers_enabled ⇒ String

  Indicates whether dynamic app providers are enabled within an WorkSpaces Applications image or not.

• #image_builder_name ⇒ String

  The name of the image builder that was used to create the private image.

• #image_builder_supported ⇒ Boolean

  Indicates whether an image builder can be launched from this image.

• #image_errors ⇒ Array<Types::ResourceError>

  Describes the errors that are returned when a new image can't be created.

• #image_permissions ⇒ Types::ImagePermissions

  The permissions to provide to the destination AWS account for the specified image.

• #image_shared_with_others ⇒ String

  Indicates whether the image is shared with another account ID.

• #image_software_metadata ⇒ Types::ImageSoftwareMetadata

  The software metadata associated with the image.

• #image_type ⇒ String

  The type of the image.

• #latest_appstream_agent_version ⇒ String

  Indicates whether the image is using the latest WorkSpaces Applications agent version or not.

• #managed_software_included ⇒ Boolean

  Indicates whether the image includes license-included applications.

• #name ⇒ String

  The name of the image.

• #platform ⇒ String

  The operating system platform of the image.

• #public_base_image_released_date ⇒ Time

  The release date of the public base image.

• #state ⇒ String

  The image starts in the PENDING state.

• #state_change_reason ⇒ Types::ImageStateChangeReason

  The reason why the last state change occurred.

• #supported_instance_families ⇒ Array<String>

  The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder.

• #visibility ⇒ String

  Indicates whether the image is public or private.

Instance Attribute Details

#applications ⇒ Array<Types::Application>

The applications associated with the image.

Returns:

• (Array<Types::Application>)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#appstream_agent_version ⇒ String

The version of the WorkSpaces Applications agent to use for instances that are launched from this image.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN of the image.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#base_image_arn ⇒ String

The ARN of the image from which this image was created.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The time the image was created.

Returns:

• (Time)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description to display.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The image name to display.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#dynamic_app_providers_enabled ⇒ String

Indicates whether dynamic app providers are enabled within an WorkSpaces Applications image or not.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_builder_name ⇒ String

The name of the image builder that was used to create the private image. If the image is shared, copied, or updated by using Managed Image Updates, this value is null.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_builder_supported ⇒ Boolean

Indicates whether an image builder can be launched from this image.

Returns:

• (Boolean)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_errors ⇒ Array<Types::ResourceError>

Describes the errors that are returned when a new image can't be created.

Returns:

• (Array<Types::ResourceError>)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_permissions ⇒ Types::ImagePermissions

The permissions to provide to the destination AWS account for the specified image.

Returns:

• (Types::ImagePermissions)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_shared_with_others ⇒ String

Indicates whether the image is shared with another account ID.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_software_metadata ⇒ Types::ImageSoftwareMetadata

The software metadata associated with the image.

Returns:

• (Types::ImageSoftwareMetadata)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#image_type ⇒ String

The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#latest_appstream_agent_version ⇒ String

Indicates whether the image is using the latest WorkSpaces Applications agent version or not.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#managed_software_included ⇒ Boolean

Indicates whether the image includes license-included applications.

Returns:

• (Boolean)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the image.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#platform ⇒ String

The operating system platform of the image.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#public_base_image_released_date ⇒ Time

The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

Returns:

• (Time)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#state_change_reason ⇒ Types::ImageStateChangeReason

The reason why the last state change occurred.

Returns:

• (Types::ImageStateChangeReason)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#supported_instance_families ⇒ Array<String>

The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

• General Purpose

• Compute Optimized

• Memory Optimized

• Graphics G4

• Graphics G5

• Graphics G6

Returns:

• (Array<String>)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#visibility ⇒ String

Indicates whether the image is public or private.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4898

class Image < Struct.new(
  :name,
  :arn,
  :base_image_arn,
  :display_name,
  :state,
  :visibility,
  :image_builder_supported,
  :image_builder_name,
  :platform,
  :description,
  :state_change_reason,
  :applications,
  :created_time,
  :public_base_image_released_date,
  :appstream_agent_version,
  :image_permissions,
  :image_errors,
  :latest_appstream_agent_version,
  :supported_instance_families,
  :dynamic_app_providers_enabled,
  :image_shared_with_others,
  :managed_software_included,
  :image_type,
  :image_software_metadata)
  SENSITIVE = []
  include Aws::Structure
end