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.

Create Your First Amazon Glacier Import Job

With an Amazon Glacier import job, AWS creates a virtual copy of your device as a single image. The device's file system is never mounted. The entire image for one device is uploaded to one Amazon Glacier archive in an existing Glacier vault. If your device is encrypted, then the device image is also encrypted. AWS does not decrypt your device before importing the device image.

After the import operation completes, AWS Import/Export erases the device before shipping it.

You must submit a separate job request for each device.

Note

You can send multiple devices in the same shipment. If you do, however, there are specific guidelines and limitations that govern what devices you can ship and how your devices must be packaged. If your shipment is not prepared and packed correctly, AWS Import/Export cannot process your jobs. Regardless of how many devices you ship at one time, you must submit a separate job request for each device. For complete details about packaging requirements when shipping multiple devices, see Shipping Multiple Devices.

For more information, see Guidelines and Limitations

To create an Amazon Glacier import job

  1. Create a manifest file.

  2. Prepare your device for shipping.

  3. Send a CreateJob request.

    AWS Import/Export sends a response and a PDF file with a barcode and job information.

  4. Attach the barcode to your device.

  5. Ship your device.

In your request, you must identify an existing Amazon S3 bucket for logging. You must have write permissions on the bucket.

Tip

You can create a bucket using AWS S3 Console. For more information, go to http://docs.aws.amazon.com/AmazonS3/latest/UG/CreatingaBucket.html.

These steps assume that you have signed up for an AWS account and created your AWScredentials.properties file as described in the earlier tasks.

Create a Manifest File

The manifest file is a YAML-formatted text file that instructs AWS about how to handle your job. It consists of a set of name-value pairs that supply required information such as your device ID, log bucket, return address, and so on. For more information about YAML, go to http://yaml.org.

The AWS Import/Export Web Service Tool provides examples of manifest files that you can modify for your import and export jobs.

  1. Go to the Examples folder in the folder where you installed the AWS Import/Export Web Service Tool.

  2. Open the glacier-import-manifest.txt file in a text editor.

    manifestVersion: 3.0
    deviceId:[Enter device serial number]
    pinCode: [Optional – PIN code]
    logPrefix: [Optional - a prefix for your log bucket]
    logBucket:[Your log bucket]
    generator: AWS Import/Export Command Line Tool
    eraseDevice: yes
    notificationEmail: [Email addresses, semicolon separated]
    returnAddress:
        name:[Your name]
        company:[Optional - your company]
        street1:[Your street]
        street2:[Optional - additional street info]
        street3:[Optional - additional street info]
        city:[Your city]
        stateOrProvince:[Required for USA and Canada. Your state or province.]
        postalCode:[Your postal code]
        country:[Your country]
        phoneNumber:[Contact number]
    operations:
        - destination: glacier
          source: device
          region: [us-east-1|us-west-1|us-west-2|eu-west-1]
          vaultName: [Your Glacier vault]
          archiveComment: [Your description for the new Glacier archive]
    

    Important

    When shipping devices internationally except within the European Union you must include the customs option in the manifest. For more information about the customs-related manifest options, see Customs Manifest File Option.

  3. In the file, replace all text in brackets with the appropriate values. Delete any unused optional lines.

  4. Provide the name of the existing Amazon S3 bucket for logging. For the logBucket option, provide only the name of your bucket, for example s3examplebucket.

  5. For the eraseDevice field, specify yes to acknowledge that AWS will erase your device following the import operation before shipping it. If the eraseDevice field is missing or if the value is not yes, the job request will fail.

  6. For the notificationEmail field, enter one or more email addresses, separated by semicolons, so we can contact you if there are any problems. If the notificationEmail field is missing or empty, the job request will fail.

  7. The destination subfield in the operations option specifies that the data is imported into an Amazon Glacier vault. Change the region parameter to specify the correct region. For more information about regions go to the AWS Import/Export Calculator. For more information about how to specify the operations option, see Creating Import Manifests.

  8. Save the file as MyGlacierImportManifest.txt in the same folder as your AWSCredentials.properties file.

For more information about manifest file options, see Manifest File Options Reference.

Prepare Your Device for Import

Next, you need to prepare your device for import.

  1. Optionally encrypt your data. For added security, we strongly recommend that you encrypt your data. If your device requires a PIN code for access, you must provide the PIN code to enable AWS to access the device. The entire device image is imported. AWS does not decrypt your device.

  2. Copy your data to the device. Do not ship the only copy of your data. AWS will erase your device, even if we cannot perform an import.

If your device is not properly prepared for shipping and import, AWS might erase the device and return it without processing the request. If we are unable to erase the data on the device, we will schedule it for destruction and our support team will contact you using the email address specified in the manifest file. For more information, see Shipping Your Storage Device.

Send a CreateJob Request

Now that you have your credentials file and manifest file in place, you send a CreateJob request to AWS Import/Export.

  1. Open a command prompt (or, on a Mac, use the Terminal application), and change to the directory where you unzipped the AWS Import/Export tool.

  2. Enter the following CreateJob request on the command line.

    CmdPrompt>java -jar lib/AWSImportExportWebServiceTool-1.0.jar CreateJob Import MyGlacierImportManifest.txt .  

    The CreateJob request includes a directory name for where you want the shipping instructions PDF file saved. In this example, the closing period (.) at the end of the command refers to the current directory. Either include the period, as shown above, or replace it with a directory name.

If there is an error, AWS Import/Export returns an error message.

If there are no errors in the request, AWS Import/Export returns a JOB CREATED response.The following is a sample response.

JOB CREATED 

JobId: ABCDE 
JobType: Import

Shipping instructions saved to C:\DirectoryName\.\shipping-instructions-ABCDE.pdf

SHIPPING INSTRUCTIONS:

1. Open the Shipping Instructions file with a PDF reader.
2. Print out the Shipping Instructions which includes the AWS Shipping Address 
and Signature barcode.
3. Follow the directions in the PDF file, which includes cutting out and securely
 attaching the Signature barcode to your device.

*IMPORTANT* - Failure to attach the Signature barcode to your device will prevent 
AWS from loading your data.  This barcode can only be used with 1 device. 

Attach the Barcode

After the CreateJob request completes successfully, AWS Import/Export places the shipping instructions and a barcode as a PDF file in the directory you specified in the CreateJob request. AWS Import/Export also places a copy of the PDF file in the Amazon S3 bucket that you specified with the logBucket manifest option. The name of the PDF file is shipping-instructions-YOURJOBID.pdf where YOURJOBID is the name of the job for your request.

The shipping instructions contain information about how and where to ship your device and a barcode that uniquely associates your device with your job request.

Print the PDF and attach the barcode securely to your device.

You must submit a separate job request for each device, and each job request generates a unique barcode. AWS Import/Export validates the barcode on your storage device before starting the data load. If the barcode is invalid (for example, it doesn't match your device), it's missing, or it's illegible, AWS Import/Export will not perform the data load and we will return your storage device.

Important

Attach the barcode securely to your device, with tape on all four sides. Do not shrink the barcode or obscure it in any way. If the barcode is separated from your device, we cannot validate it and we will return your device without performing the data load.

Ship Your Device

It is essential that you prepare your device properly before shipping.

Note

If an error occurs during the CreateJob process, an error message will indicate the cause. You can then either get the shipping instructions from the Amazon S3 bucket, or you can retry the download using the GetShipInfo operation. For more information, see Getting Shipping Information.

  1. Attach the barcode securely to your device.

  2. Pack the power supply, power cable, and interface cables with your storage device. Without these, we can't transfer your data and will return your device.

  3. Send your package to the address provided in the PDF.

    For detailed instructions for preparing and shipping your device, see Shipping Your Storage Device.

Important

Your job expires after 30 days. If you do not send a device, there is no charge. You are billed only after AWS Import/Export receives your device. If we receive your package after your job expires, we will return your device. You will only be charged for the shipping fees, if any.

Now, you have explored the getting started steps of AWS Import/Export. To learn more about the product, see Where Do I Go from Here?.