Class: Aws::AppStream::Types::ExportImageTask

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

Overview

Information about an export image task, including its current state, timestamps, and any error details.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_description ⇒ String

The description that will be applied to the exported EC2 AMI.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#ami_id ⇒ String

The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#ami_name ⇒ String

The name of the EC2 AMI that will be created by this export task.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The date and time when the export image task was created.

Returns:

  • (Time) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#error_details ⇒ Array<Types::ErrorDetails>

Details about any errors that occurred during the export process. This field is only populated when the task fails.

Returns:



4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#image_arn ⇒ String

The ARN of the WorkSpaces Applications image being exported.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ Hash<String,String>

The tags that will be applied to the exported EC2 AMI.

Returns:

  • (Hash<String,String>) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.

Returns:

  • (String) 


4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
 
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 4382

class ExportImageTask < Struct.new(
  :task_id,
  :image_arn,
  :ami_name,
  :created_date,
  :ami_description,
  :state,
  :ami_id,
  :tag_specifications,
  :error_details)
  SENSITIVE = []
  include Aws::Structure
end