| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
GetStatus
Description
This action returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters
| Name | Description | Required |
|---|---|---|
|
Action | Specifies the action to invoke. Type: String Default: None Valid Values: GetStatus |
Yes |
|
JobId |
Specifies the job to return information about. Type: String Default: Constraints: Must be a valid job ID for a job you own. |
Yes |
Response Elements
| Name | Description |
|---|---|
| AwsShippingAddress |
The physical address where you ship your storage device. Type: String Ancestor: GetStatusResponse.GetStatusResult |
|
Name of the shipping company. This value is included when the
Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None | |
| CreationDate |
Timestamp of the CreateJob request in ISO8601 date format. For example 2010-03-28T20:27:35Z. For more information, go to ISO 8601. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| GetStatusResponse |
Container. Type: String Ancestor: None Children: GetStatusResult |
| GetStatusResult |
Container. Type: String Ancestor: GetStatusResponse Children: Carrier | CreationDate | ErrorCount | JobId | JobType | LocationCode | LocationMessage | LogBucket | LogKey | ProgressCode | ProgressMessage | Signature | TrackingNumber |
| ErrorCount |
Number of errors. We return this value when the Type: Integer Ancestor: GetStatusResponse.GetStatusResult Children: None |
| JobId |
Unique identifier created by AWS Import/Export that specifies a job you want the status of. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| JobType |
Specifies whether the job is an import or export job. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| LocationCode |
A token representing the location of the storage device, such as
Type: Enum Valid Values: Ancestor: GetStatusResponse.GetStatusResult Children: None |
| LocationMessage |
A human readable message describing the physical location of the storage device. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| LogBucket |
Amazon S3 bucket for user logs. Type: String (63 bytes) Ancestor: GetStatusResponse.GetStatusResult Children: None |
| LogKey |
The key where the user logs were stored. Type: String (1024 bytes) Ancestor: GetStatusResponse.GetStatusResult Children: None |
| ProgressCode |
A token representing the state of the job, such as
Type: Enum Ancestor: GetStatusResponse.GetStatusResult Children: None |
| ProgressMessage |
A more human readable form of the job status. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| RequestId |
A string that uniquely identifies the request. Type: String Ancestor: GetStatusResponse Children: None |
| ResponseMetadata |
Container. Type: String Ancestor: GetStatusResponse 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 yourself. Type: String Ancestor: GetStatusResponse.GetStatusResult Children: None |
| SignatureFileContents |
The actual text of the version:2.0
signingMethod:HmacSHA1
jobId:<
Type: String Ancestor: GetStatusResponse.GetStatusResult |
| TrackingNumber |
The shipping tracking number assigned by AWS Import/Export to the
storage device when it's returned to you. We return this value when
the Type: String (32 bytes) Ancestor: GetStatusResponse.GetStatusResult Children: None |
| 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: GetStatusResponse.GetStatusResult |
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:207
Action=GetStatus&SignatureMethod=HmacSHA256&JobId=JOBID&AWSAccessKeyId=
&SignatureVersion=2&Version=2010-06-01&Signature=
%2FVfkltRBOoSUi1sWxRzN8rw%3D&Timestamp=2011-06-20T22%3A30%3A59.556ZSample Response
<GetStatusResponse xmlns="http://importexport.amazonaws.com/">
<GetStatusResult>
<JobType>Import</JobType>
<CurrentManifest>manifestVersion: 2.0
accessKeyId:
deviceId: TestDevice1
bucket: myawsbucket
returnAddress:
name: Joe Random
street1: 123 Any Street
city: Seattle
stateOrProvince: WA
postalCode: 91111
country: United States
eraseDevice: no</CurrentManifest>
<JobId>A36BC</JobId>
<LocationMessage>AWS has not received your device.</LocationDescription>
<ProgressCode>Pending</ProgressCode>
<SignatureFileContents>version:2.0
signingMethod:HmacSHA1
jobId:A36BC
signature:O8WnNGMfs6cwbpQHvJ0qXLrUdqI=
</SignatureFileContents>
<ErrorCount>0</ErrorCount>
<ProgressMessage>The specified job has not started.</ProgressDescription>
<LocationCode>NotReceived</LocationCode>
<CreationDate>2010-04-17T00:09:02Z</CreationDate>
<AwsShippingAddress>AWS Import/Export
JOBID A36BC
1111 Nosuch Ave South
Seattle, WA 92222</AwsShippingAddress>
<Signature>O8WnNGMfs6cwbpQHvJ0qXLrUdqI=</Signature>
</GetStatusResult>
<ResponseMetadata>
<RequestId>a5f302fa-4bd8-11df-b17e-6b34e254a573</RequestId>
</ResponseMetadata>
</GetStatusResponse>Related actions
The following actions are related to GetStatus.
ListJobs
