Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

cancel_quantum_task

cancel_quantum_task(**kwargs)

Cancels the specified task.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The client token associated with the request.

    This field is autopopulated if not provided.

  • quantumTaskArn (string) --

    [REQUIRED]

    The ARN of the task to cancel.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • cancellationStatus (string) --

      The status of the cancellation request.

    • quantumTaskArn (string) --

      The ARN of the task.

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