Braket / Client / cancel_quantum_task

cancel_quantum_task

Braket.Client.cancel_quantum_task(**kwargs)

Cancels the specified task.

See also: AWS API Documentation

Request Syntax

response = client.cancel_quantum_task(
    quantumTaskArn='string',
    clientToken='string'
)
Parameters:

  • quantumTaskArn (string) –

    [REQUIRED]

    The ARN of the quantum task to cancel.

  • clientToken (string) –

    [REQUIRED]

    The client token associated with the cancellation request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • quantumTaskArn (string) –

      The ARN of the quantum task.

    • cancellationStatus (string) –

      The status of the quantum task.

Exceptions