CreateInstanceExportTask - Amazon Elastic Compute Cloud

CreateInstanceExportTask

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export 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.

Description

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

Type: String

Required: No

ExportToS3

The format and location for an instance export task.

Type: ExportToS3TaskSpecification object

Required: Yes

InstanceId

The ID of the instance.

Type: String

Required: Yes

TagSpecification.N

The tags to apply to the instance export task during creation.

Type: Array of TagSpecification objects

Required: No

TargetEnvironment

The target virtualization environment.

Type: String

Valid Values: citrix | vmware | microsoft

Required: Yes

Response Elements

The following elements are returned by the service.

exportTask

Information about the instance export task.

Type: ExportTask object

requestId

The ID of the request.

Type: String

Errors

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

Examples

Example

This example request creates an Export VM task that makes a Windows instance available as an OVA.

Sample Request

https://ec2.amazonaws.com/?Action=CreateInstanceExportTask &Description=Example%20for%20docs &InstanceId=i-1234567890abcdef0 &TargetEnvironment=VMWare &ExportToS3.DiskImageFormat=VMDK &ExportToS3.ContainerFormat=OVA &ExportToS3.S3bucket=my-bucket-for-exported-vm &ExportToS3.S3prefix=my-exports/ &AUTHPARAMS

Sample Response

<CreateInstanceExportTaskResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <exportTask> <exportTaskId>export-i-1234wxyz</exportTaskId> <description>Example for docs</description> <state>active</state> <statusMessage>Running</statusMessage> <instanceExport> <instanceId>i-1234567890abcdef0</instanceId> <targetEnvironment>VMWare</targetEnvironment> </instanceExport> <exportToS3> <diskImageFormat>VMDK</diskImageFormat> <containerFormat>OVA</containerFormat> <s3Bucket>my-bucket-for-exported-vm</s3Bucket> <s3Key>my-exports/ export-i-1234wxyz.ova</s3Key> </exportToS3> </exportTask> </CreateInstanceExportTaskResponse>

See Also

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