AWS Import/Export
Developer Guide (API Version 2010-06-03)
Did this page help you?  Yes | No |  Tell us about it...
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.

Import to Amazon EBS Manifest File Options

The Amazon EBS import manifest file includes information related to importing your data into Amazon EBS and returning your storage device. This section explains options that are unique to Amazon EBS import manifest files. For information about options that are common to all manifest files, see Common Manifest File Options.

Note

Amazon EBS and Amazon Glacier use only manifest file version 3.0. Set manifestVersion to 3.0 for all Amazon EBS and Amazon Glacier manifest files.

An Amazon EBS import creates a virtual copy of your device as a single image. The device's file system is never mounted.

The capacity of your device determines how the device image is stored. The maximum capacity of an Amazon EBS volume is 1 TB. If the capacity of the device is greater than 1 TB, we cannot import the disk directly into an EBS snapshot.

Note

The maximum capacity of a device is independent of the amount of data stored on the device.

If your device capacity is 1 TB or less, we store the device image directly to an EBS snapshot.

If your device capacity is greater than 1 TB, we store the device image as a series of objects in the Amazon S3 log bucket you specified in the manifest. You can then create a RAID of Amazon EBS volumes using software such as Logical Volume Manager, and copy the image from Amazon S3 to the new volume.

OptionDescriptionRequired
eraseDevice

Acknowledges that AWS will erase the contents of your storage device after importing the data. All writable blocks on your storage device will be overwritten with zeros. You will need to repartition and format your device after the wipe.

Example

eraseDevice: yes

Type: String

Default: None

Valid Values: yes | true

Yes
operations

The operations option is a container for one or more subfields. You specify operations parameters by a dash followed by a set of subfields.

 

The following example shows the operations option with the required Amazon EBS subfields.

operations:
  - destination: ebs-snapshot
    source: device
    region: us-east-1
    deviceCapacityGreaterThan1TB: no

See Operations Subfields for details about each subfield.

Type: String

Default: None

Yes

pinCode

If a storage device with hardware-based encryption was supplied, the PIN code for the device. For more information, see Encrypting Your Data.

pinCode: 1234

Important

Do not lose your PIN code, or you will not be able to decrypt your data. AWS Import/Export will not send the PIN code with the encrypted device.

Type: Integer

Default: None

No

Operations Subfields

The following table describes the subfields of the Operations parameter

Operations SubfieldsDescriptionRequired
destination

The destination of the data.

For an Amazon EBS import operation the destination is ebs-snapshot.

Type: String

Default: None

Valid Values: ebs-snapshot

Yes
deviceCapacityGreaterThan1TB

Specifies if the device capacity is larger than the maximum Amazon EBS volume size of 1TB.

The capacity of your device determines how the device image is stored. The maximum capacity of an Amazon EBS volume is 1 TB. If the capacity of the device is greater than 1 TB, we cannot import the disk directly into an EBS snapshot.

The maximum capacity of a device is independent of the amount of data stored on the device.

If your device capacity is 1 TB or less, we store the device image directly to an EBS snapshot.

If your device capacity is greater than 1 TB, we store the device image as a series of objects in the Amazon S3 log bucket you specified in the manifest. You can then create a RAID of Amazon EBS volumes using software such as Logical Volume Manager, and copy the image from Amazon S3 to the new volume.

If the deviceCapacityGreaterThan1TB option is not set correctly for your device, AWS Import/Export will not perform the import and we will return your storage device.

Type: String

Default: None

Valid Values: yes | no

Yes
region

The region to target for the import operation.

Type: String

Default: None

Valid Values: us-east-1 | us-west-1 | us-west-2 | eu-west-1 | ap-southeast-1

For more information about regions go to the AWS Import/Export Calculator.

Yes
source

The originator of the data. For an import job the origin is the device.

Type: String

Default: None

Valid Values: device

Yes

Example Import to Amazon EBS Manifest

The following example is the manifest file content for an import job to Amazon EBS, including expedited shipping.

manifestVersion: 3.0
deviceId: ABCDE
eraseDevice: yes
generator: AWS Import Export Docs
logPrefix: logs
logBucket: iemanifest-bucket
notificationEmail: john.doe@example.com;jane.roe@example.com
operations:
  - destination: ebs-snapshot
    source: device
    region: us-east-1
    deviceCapacityGreaterThan1TB: no
returnAddress:
   name: Jane Roe 
   company: Example Corp.   
   street1: 123 Any Street
   city: Anytown
   stateOrProvince: WA
   postalCode: 91011-1111
   phoneNumber: 206-555-1111
   country: USA
serviceLevel: expeditedShipping