AWS Import/Export
Developer Guide (API Version 2010-06-03)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid 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: AKIAIOSFODNN7EXAMPLE

Type: String

Default: None

Yes

company

Suboption of returnAddress, which you use to specify the name of the company we should return your storage device to. For an example, go to Create Your First Amazon S3 Export Job.

Type: String

Default: None

No
deviceId

This ID is 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

Specifies 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]Note

If your storage device is less than or equal to the maximum volume size of 1TB, its contents are loaded directly into an Amazon EBS snapshot. If your storage device’s capacity exceeds 1TB, a device image is stored within your specified Amazon S3 log bucket. 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 this new volume.

logBucket: logging-bucket

Type: String

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

Constraints: Must be an existing Amazon S3 bucket name

No for import to Amazon S3. Yes for export from Amazon S3 and import to Amazon EBS.
logPrefix

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

logPrefix: logs/

Type: String

Default: None

No
manifestVersion

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

Type: String

Default: None

Valid Values: 2.0 | 3.0

Yes

name

street1

city

stateOrProvince

postalCode

phoneNumber

country

All of these options are suboptions of returnAddress. Use these options to specify where we should return your storage device. For an example, go to Create Your First Amazon S3 Export Job.

Type: String

Default: None

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

Yes
notificationEmail

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

notificationEmail: joe.random@noreply.com

Type: String

Default: None

No
returnAddressThe address we return your storage device to after completing the job. This option has a number of suboptions, including company, name, street1, street2, street3, city, stateOrProvince, postalCode, phoneNumber, and country. For an example, see Create Your First Amazon S3 Export Job.

Type: String

Default: None

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

Yes

serviceLevel

Specifies 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: Enum

Default: standard

Valid Values: standard | expeditedShipping

No

street2

street3

Suboptions of returnAddress, which you use to specify where we should return your storage device. For an example, go to Create Your First Amazon S3 Export Job.

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 because it is required for importing data to Amazon S3.

manifestVersion: 2.0
accessKeyId: AKIAIOSFODNN7EXAMPLE
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