CancelJob

Cancels an Amazon Braket hybrid job.

Request Syntax


PUT /job/jobArn/cancel HTTP/1.1

The request uses the following URI parameters.

The ARN of the Amazon Braket hybrid job to cancel.

Pattern: ^arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:job/.*$

Required: Yes

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "cancellationStatus": "string",
   "jobArn": "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 hybrid job.

Type: String

Valid Values: CANCELLING | CANCELLED

The ARN of the Amazon Braket job.

Type: String

Pattern: ^arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:job/.*$

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