Braket

Client

class Braket.Client

A low-level client representing Braket

The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.

To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.

In this guide:

• CommonParameters

• CommonErrors

Available languages for AWS SDK:

• .NET

• C++

• Go API reference

• Java

• JavaScript

• PHP

• Python (Boto)

• Ruby

Code examples from the Amazon Braket Tutorials GitHub repository:

• Amazon Braket Examples

client = session.create_client('braket')

These are the available methods:

• can_paginate
• cancel_job
• cancel_quantum_task
• close
• create_job
• create_quantum_task
• get_device
• get_job
• get_paginator
• get_quantum_task
• get_waiter
• list_tags_for_resource
• search_devices
• search_jobs
• search_quantum_tasks
• tag_resource
• untag_resource

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

• AccessDeniedException
• ConflictException
• DeviceOfflineException
• DeviceRetiredException
• InternalServiceException
• ResourceNotFoundException
• ServiceQuotaExceededException
• ThrottlingException
• ValidationException

Paginators

Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.

The available paginators are:

• SearchDevices
• SearchJobs
• SearchQuantumTasks