Cancels an Amazon Braket hybrid job.
Request Syntax
PUT /job/jobArn/cancel HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- jobArn
-
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"cancellationStatus": "string",
"jobArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- cancellationStatus
-
The status of the hybrid job.
Type: String
Valid Values:
CANCELLING | CANCELLED - jobArn
-
The ARN of the Amazon Braket job.
Type: String
Pattern:
^arn:aws[a-z\-]*:braket:[a-z0-9\-]+:[0-9]{12}:job/.*$
Errors
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
