Menu
AWS Snowball
API Reference

CancelCluster

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Request Syntax

{
   "ClusterId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterId

The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

Type: String

Length Constraints: Fixed length of 39.

Pattern: CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidJobStateException

The action can't be performed because the job's current state doesn't allow that action to be performed.

HTTP Status Code: 400

InvalidResourceException

The specified resource can't be found. Check the information you provided in your last request, and try again.

HTTP Status Code: 400

KMSRequestFailedException

The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: