CancelQuantumTask

Cancels the specified task.

Request Syntax


PUT /quantum-task/quantumTaskArn/cancel HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}

The request uses the following URI parameters.

The ARN of the quantum task to cancel.

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

The request accepts the following data in JSON format.

The client token associated with the cancellation request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes


HTTP/1.1 200
Content-type: application/json

{
   "cancellationStatus": "string",
   "quantumTaskArn": "string"
}

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

The following data is returned in JSON format by the service.

The status of the quantum task.

Type: String

Valid Values: CANCELLING | CANCELLED

The ARN of the quantum task.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

An error occurred due to a conflict.

HTTP Status Code: 409

InternalServiceException

The request failed because of an unknown error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The API throttling rate limit is exceeded.

HTTP Status Code: 429

ValidationException

The input request failed to satisfy constraints expected by Amazon Braket.

HTTP Status Code: 400