Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ExportImage

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM Directory from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

Token to enable idempotency for export image requests.

Type: String

Required: No

Description

A description of the image being exported. The maximum length is 255 bytes.

Type: String

Required: No

DiskImageFormat

The disk image format.

Type: String

Valid Values: VMDK | RAW | VHD

Required: Yes

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

ImageId

The ID of the image.

Type: String

Required: Yes

RoleName

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Type: String

Required: No

S3ExportLocation

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

Type: ExportTaskS3LocationRequest object

Required: Yes

Response Elements

The following elements are returned by the service.

description

A description of the image being exported.

Type: String

diskImageFormat

The disk image format for the exported image.

Type: String

Valid Values: VMDK | RAW | VHD

exportImageTaskId

The ID of the export image task.

Type: String

imageId

The ID of the image.

Type: String

progress

The percent complete of the export image task.

Type: String

requestId

The ID of the request.

Type: String

roleName

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

Type: String

s3ExportLocation

Information about the destination S3 bucket.

Type: ExportTaskS3Location object

status

The status of the export image task. The possible values are active, completed, deleting, and deleted.

Type: String

statusMessage

The status message for the export image task.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

See Also

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