AWS Import/Export
Developer Guide (API Version 2010-06-03)
« 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.Did this page help you?  Yes | No |  Tell us about it...

Common Manifest File Options

The manifest file includes information related to processing your data and returning your storage device. The following table explains options that are common to all manifest files.

OptionDescriptionRequired
accessKeyId

The Access Key ID of the person responsible for paying for the data transfer. For more information about the Access Key ID, go to Security Credentials.

The accessKeyId value must be the same as the one used to make the CreateJob request.

The following is an example of accessKeyId.

accessKeyId: 

Type: String

Default: None

Yes
deviceId

Your storage device's serial number or other unique identifier. If your device does not have a unique number, please place a sticker with its own unique identifier onto the device and then enter that identifier as the deviceId. The following is an example device ID.

deviceId: MyCompany489732

Type: String

Default: None

Yes
generator

A field describing the application that put together the manifest file and submitted the CreateJob or UpdateJob request. The following is an example of generator.

generator: AWS Import/Export Sample App 1.0

Type: String

Default: None

No
logBucket

The Amazon S3 bucket where AWS Import/Export saves your log. You must create a bucket before we can save log data to it; we do not create the bucket for you. Your account (accessKeyId) must have write permissions on this bucket. The following is an example of a logBucket value.

Note

For import to Amazon EBS, if your storage device’s capacity exceeds 1TB, a device image is stored as two or more objects to your specified Amazon S3 log bucket.

logBucket: logging-bucket

Type: String

Default: The import bucket for import to Amazon S3, otherwise None.

Constraints: Must be an existing Amazon S3 bucket name

Yes, except for import to Amazon S3.
logPrefix

A string to insert between the bucket name and log report name to prevent name collisions. For more information, go to Preventing Log File Name Collisions. The following is an example of a logPrefix.

logPrefix: logs/

Type: String

Default: None

No
manifestVersion

The version of the manifest specification used to write the manifest file. The manifest version must be 2.0 for import and export to Amazon S3 and 3.0 for import to Amazon EBS and Amazon Glacier.

Type: String

Default: None

Valid Values: 2.0 | 3.0

Yes
notificationEmail

A semicolon delimited list of email addresses to which you want us to send job completed notification emails.

notificationEmail: joe.random@noreply.com

Type: String

Default: None

No
returnAddress

The address we return your storage device to after completing the job.

The returnAddress option includes subfields, as shown in the following example.

returnAddress:
    name: John Doe 
    company: Amazon
    street1: 123 Any Street    
    city: Shenzhen
    stateOrProvince: Nanshan
    postalCode: 518054
    phoneNumber: 555-555-0100
    country: China
        

The subfields street2 and street3 are optional.

Type: String

Default: None

Constraints: Your return address must be a physical street address and not a post office box.

Yes

serviceLevel

The service level for the job. For more information about specifying your job’s service levels, go to Expediting the Return of Your Storage Device.

serviceLevel: expeditedShipping

Type: String

Default: standard

Valid Values: standard | expeditedShipping

No

trueCryptPassword

If the device was encrypted using TrueCrypt, the password that was provided when the device was encrypted. For more information about encrypting a device using TrueCrypt, go to Encrypting Your Device Using TrueCrypt.

The following is an example of trueCryptPassword

trueCryptPassword: SimpleButEasi1yCrackedEXAMPLE

Type: String

Default: none

No

Example Import to Amazon S3 Manifest Using Common Options

The following example is the manifest file content for an import job showing most of the common manifest file options, including expedited shipping. It also includes the bucket option and the eraseDevice option because they required for Amazon S3 manifest files.

manifestVersion: 2.0
accessKeyId: 
bucket: data-load-bucket
deviceId: ABCDE
generator: AWS ImportExport Web Service Tool 1.0
logPrefix: logs
logBucket: iemanifest-log-bucket
prefix: imported/
eraseDevice: no
notificationEmail: john.doe@example.com;jane.doe@example.com
returnAddress:
    name: Joe Random 
    company: Amazon Web Services
    street1: 123 Any Street    
    city: Anytown
    stateOrProvince: WA
    postalCode: 91111
    phoneNumber: 555-555-0100
    country: USA
serviceLevel: expeditedShipping