ExportImageTask - Amazon WorkSpaces Applications

ExportImageTask

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

Contents

AmiName

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

Type: String

Pattern: ^[a-zA-Z0-9().\-/_]{3,128}$

Required: Yes

CreatedDate

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

Type: Timestamp

Required: Yes

ImageArn

The ARN of the WorkSpaces Applications image being exported.

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Required: Yes

TaskId

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

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

AmiDescription

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

Type: String

Length Constraints: Maximum length of 256.

Required: No

AmiId

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

Type: String

Pattern: ^ami-[a-z0-9]{8,17}$

Required: No

ErrorDetails

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

Type: Array of ErrorDetails objects

Required: No

State

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

Type: String

Valid Values: EXPORTING | COMPLETED | FAILED

Required: No

TagSpecifications

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(^(?!aws:).[\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: