CreateVolumeExportTask#

Description#

Creates a volume export task.

Request Parameters#

Required parameters#

  • ExportToS3:

    • S3Bucket — User’s S3 bucket where the resulting exported image will be uploaded.

      • Type: String

      • Required: Yes

    • DiskImageFormat — The format for the exported image (VMDK | RAW | VHD).

      • Type: String

      • Required: No

    • S3Prefix — The export result will get a name in the format s3prefix + "-" + exportTaskId + "/" + VolumeId + DiskImageFormat .

      • Type: String

      • Required: No

  • VolumeId — The ID of the volume.

    • Type: String

    • Required: Yes

Optional parameters#

  • Description — The description of the task.

    • Type: String

    • Required: No

  • Email — An email address for notifications.

    • Type: String

    • Required: No

  • Notify — Notify about the state of the task by email.

    • Type: String

    • Required: No

Response Elements#

  • exportTask

    • description — The description of the task.

    • exportTaskId — The task ID.

    • exportToS3Task

      • diskImageFormat — The format of the image.

      • s3Bucket — The user bucket where the exported image will be uploaded.

      • s3Key — The S3 key name for the destination image.

    • progress — The export progress for the volume.

    • state — The current state of the task.

    • statusMessage — The description of the status.

    • volumeId — The ID of the exported volume.

Examples#

c2-ec2 CreateVolumeExportTask VolumeId <volume_id> Description <description> ExportToS3.DiskImageFormat <disk_image_format> ExportToS3.S3Bucket <s3_bucket> ExportToS3.S3Prefix <s3_prefix>