Braket / Client / cancel_job

cancel_job

Braket.Client.cancel_job(**kwargs)

Cancels an Amazon Braket hybrid job.

See also: AWS API Documentation

Request Syntax

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

jobArn (string) –

[REQUIRED]

The ARN of the Amazon Braket hybrid job to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'jobArn': 'string',
    'cancellationStatus': 'CANCELLING'|'CANCELLED'
}

Response Structure

  • (dict) –

    • jobArn (string) –

      The ARN of the Amazon Braket job.

    • cancellationStatus (string) –

      The status of the hybrid job.

Exceptions