Did this page help you? Yes No Tell us about it...

CancelJob

Description

This action cancels a specified job. Only the job owner can cancel it. The action fails if the job has already started or is complete.

Request Parameters

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

Name Description Required

Name	Description	Required
Action	Specifies the action to invoke. Type: String Default: None Valid Values: CancelJob	Yes
JobId	Identifier returned by `CreateJob` that specifies the job you want to cancel. Type: String Default: None	Yes

Action

Specifies the action to invoke.

Type: String

Default: None

Valid Values: CancelJob

Yes

JobId

Identifier returned by CreateJob that specifies the job you want to cancel.

Type: String

Default: None

Yes

Response Elements

Name	Description
CancelJobResponse	Container for the response. Type: None Ancestor: None Children: CancelJobResult, ResponseMetadata
CancelJobResult	Container for the result. Type: None Ancestor: CancelJobResponse Children: Success
RequestId	Identifier that uniquely identifies the request. Type: String Ancestor: CancelJobResponse.ResponseMetadata Children: None
ResponseMetadata	Container for the response metadata. Type: String Ancestor: CancelJobResponse Children: RequestId
Success	Specifies whether (`true`) or not (`false`) AWS Import/Export canceled the job. Type: Boolean Valid Values: `true` \| `false` Ancestor: CancelJobResponse.CancelJobResult Children: None

Errors

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

Examples

The following examples show sample requests and responses.

Sample Request

The following request cancels a specified job.

Example Request

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

Action=CancelJob&SignatureMethod=HmacSHA256&JobId=JOBID& 
AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&SignatureVersion=2& 
Signature=%2FVfkltRBOoSUi1sWxRzN8rw%3D&Timestamp=2011-06-20T23%3A53%3A37.232Z

Sample Response

The response shows that the job was successfully canceled.

Example Response

<CancelJobResponse xmlns="http://importexport.amazonaws.com/">
  <CancelJobResult>
    <Success>true</Success>
  </CancelJobResult>
  <ResponseMetadata>
    <RequestId>a4f704fc-0ad8-11df-b085-4384d3e37ae5</RequestId>
  </ResponseMetadata>
</CancelJobResponse>

Related actions

The following actions are related to CancelJob.

CreateJob

Document Conventions
Terms of Use

Did this page help you? Yes No Tell us about it...