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...

CreateJob

Description

This action initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other actions, a signature that you use to identify your storage device, and the address you should ship your storage device to.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters

NameDescriptionRequired

Action

Specifies the action to invoke.

Type: String

Default: None

Valid Values: CreateJob

Yes

JobType

Specifies whether the job to initiate is an import or export job.

Type: Enum

Default: None

Valid Values: Import | Export

Yes

Manifest

The UTF-8 encoded text of a manifest file. For information about manifest parameters, see Manifest File Options Reference.

Type: String

Default: None

Yes

ValidateOnly

Validate the manifest and parameter values in the request, but do not actually create a job.

Type: Boolean

Default: false

Valid Values: true | false

No

Response Elements

NameDescription
AwsShippingAddress

Address you ship your storage device to.

Type: String

Ancestor: CreateJobResponse.CreateJobResult

CreateJobResponse

Container for the response.

Type: None

Ancestor: None

Children: CreateJobResult, ResponseMetadata

CreateJobResult

Container.

Type: None

Ancestor: CreateJobResponse

Children: JobId, AwsShippingAddress, Signature

JobId

The ID created by AWS that uniquely identifies your AWS Import/Export job.

Type: String

Ancestor: CreateJobResponse.CreateJobResult

JobType

Specifies whether the job is an import or export job.

Type: String

Ancestor: GetStatusResponse.GetStatusResult

Children: None

RequestId

ID that uniquely identifies the request.

Type: String

Ancestor: CreateJobResponse.ResponseMetadata

ResponseMetadata

Container.

Type: None

Ancestor: CreateJobResponse

Children: RequestId

Signature

An encrypted code used to authenticate the request and response, for example, DV+TpDfx1/TdSE9ktyK9k/bDTVI=. Only use this value if you want to create the signature file yourself.

Type: String

Ancestor: CreateJobResponse.CreateJobResult

SignatureFileContents

The actual text of the SIGNATURE file to be written to disk, for example:

version:2.0
signingMethod:HmacSHA1
jobId:<the customer's job id>
signature:DV+TpDfx1/TdSE9ktyK9k/bDTVI=

Type: String

Ancestor: CreateJobResponse.CreateJobResult

WarningMessage

An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name.

Type: String

Ancestor: CreateJobResponse.CreateJobResult

Errors

For a list of common errors, see Error and Status Codes.

Examples

Sample Request

POST / HTTP/1.1
content-type:application/x-www-form-urlencoded;charset=utf-8
host: https://importexport.amazonaws.com
content-length:639

Manifest=manifestVersion%3A%202.0%0Abucket%3A%20myawsbucket 
%0AreturnAddress%3A%0A%20%20%20%20name%3A%20 
Amazon.com%20ATTN%20Joe%20Random%20%0A%20%20%20%20street1%3A%201200%20AAAA%20Ave%20 
S.%0A%20%20%20%20city%3A%20Seattle%0A%20%20%20%20stateOrProvince%3A%20WA%0A%20%20%20%20 
postalCode%3A%2098114%0A%20%20%20%20phoneNumber%3A%20206-266-0000%0A%20%20%20%20 
country%3A%20USA&JobType=Import&Action=CreateJob&SignatureMethod=HmacSHA256 
&SignatureVersion=2&Version=2010-06-01 
&Signature=%2F5UvjcJOE1PqUa%2BcmnzadQYs2frTAt8LSo3M5o%2BEH0%3D&Timestamp= 
2011-06-20T18%3A49%3A14.981Z

Sample Response

<CreateJobResponse xmlns="http://importexport.amazonaws.com/">
  <CreateJobResult>
    <JobId>TEST1</JobId>
    <AwsShippingAddress>AWS Import/Export
JOBID TEST1
123 Any Street
Seattle, WA 98144</AwsShippingAddress>
    <Signature>O3qG7xnI46ZEm9gi+eOy9dnSS9k=</Signature>
  </CreateJobResult>
  <ResponseMetadata>
    <RequestId>ace8cb5b-0ada-11df-a381-155bec6f7c93</RequestId>
  </ResponseMetadata>
</CreateJobResponse>

Related actions

The following actions are related to CreateJob.