We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected
Cancels an Amazon Braket job.
Use a bare-bones client and the command you need to make an API call.
import { BraketClient, CancelJobCommand } from "@aws-sdk/client-braket"; // ES Modules import// const { BraketClient, CancelJobCommand } = require("@aws-sdk/client-braket"); // CommonJS importconst client = new BraketClient(config);const input = { // CancelJobRequest jobArn: "STRING_VALUE", // required};const command = new CancelJobCommand(input);const response = await client.send(command);// { // CancelJobResponse// jobArn: "STRING_VALUE", // required// cancellationStatus: "STRING_VALUE", // required// };
CancelJobCommandInput
CancelJobCommandOutput
input
response
config
AccessDeniedException (client fault)
You do not have sufficient access to perform this action.
ConflictException (client fault)
An error occurred due to a conflict.
InternalServiceException (server fault)
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException (client fault)
The specified resource was not found.
ThrottlingException (client fault)
The throttling rate limit is met.
ValidationException (client fault)
The input fails to satisfy the constraints specified by an AWS service.
BraketServiceException
Base exception class for all service exceptions from Braket service.
Readonly
Static
Cancels an Amazon Braket job.
Example
Use a bare-bones client and the command you need to make an API call.
Param
CancelJobCommandInput
Returns
CancelJobCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
You do not have sufficient access to perform this action.
Throws
ConflictException (client fault)
An error occurred due to a conflict.
Throws
InternalServiceException (server fault)
The request processing has failed because of an unknown error, exception, or failure.
Throws
ResourceNotFoundException (client fault)
The specified resource was not found.
Throws
ThrottlingException (client fault)
The throttling rate limit is met.
Throws
ValidationException (client fault)
The input fails to satisfy the constraints specified by an AWS service.
Throws
BraketServiceException
Base exception class for all service exceptions from Braket service.