cancel_job

cancel_job(**kwargs)

Cancels an Amazon Braket job.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job(
    jobArn='string'
)
Parameters
jobArn (string) --

[REQUIRED]

The ARN of the Amazon Braket job to cancel.

Return type
dict
Returns
Response Syntax
{
    'cancellationStatus': 'CANCELLING'|'CANCELLED',
    'jobArn': 'string'
}

Response Structure

  • (dict) --
    • cancellationStatus (string) --

      The status of the job cancellation request.

    • jobArn (string) --

      The ARN of the Amazon Braket job.

Exceptions

  • Braket.Client.exceptions.ResourceNotFoundException
  • Braket.Client.exceptions.AccessDeniedException
  • Braket.Client.exceptions.ConflictException
  • Braket.Client.exceptions.ThrottlingException
  • Braket.Client.exceptions.InternalServiceException
  • Braket.Client.exceptions.ValidationException