

******
Braket
******



======
Client
======



.. py: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 <https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonbraket.html>`__. `Amazon Braket Python SDK <https://amazon-braket-sdk-python.readthedocs.io/en/latest/#>`__ and the `AWS Command Line Interface <https://docs.aws.amazon.com/cli/latest/reference/braket/>`__ can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see `What is Amazon Braket? <https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html>`__ and important `terms and concepts <https://docs.aws.amazon.com/braket/latest/developerguide/braket-terms.html>`__ in the *Amazon Braket Developer Guide*.

   

  **In this guide:**

   

  
  *  CommonParameters
   
  *  CommonErrors
  

   

  **Available languages for AWS SDK:**

   

  
  * `.NET <https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Braket/NBraket.html>`__
   
  * `C++ <https://sdk.amazonaws.com/cpp/api/LATEST/root/html/index.html>`__
   
  * `Go API reference <https://docs.aws.amazon.com/sdk-for-go/api/service/braket/>`__
   
  * `Java <https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/braket/package-summary.html>`__
   
  * `JavaScript <https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Braket.html>`__
   
  * `PHP <https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Braket.BraketClient.html>`__
   
  * `Python (Boto) <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/braket.html>`__
   
  * `Ruby <https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Braket.html>`__
  

   

  **Code examples from the Amazon Braket Tutorials GitHub repository:**

   

  
  * `Amazon Braket Examples <https://github.com/amazon-braket/amazon-braket-examples>`__
  

  ::

    
    import boto3
    
    client = boto3.client('braket')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  braket/client/can_paginate
  braket/client/cancel_job
  braket/client/cancel_quantum_task
  braket/client/close
  braket/client/create_job
  braket/client/create_quantum_task
  braket/client/create_spending_limit
  braket/client/delete_spending_limit
  braket/client/get_device
  braket/client/get_job
  braket/client/get_paginator
  braket/client/get_quantum_task
  braket/client/get_waiter
  braket/client/list_tags_for_resource
  braket/client/search_devices
  braket/client/search_jobs
  braket/client/search_quantum_tasks
  braket/client/search_spending_limits
  braket/client/tag_resource
  braket/client/untag_resource
  braket/client/update_spending_limit


==========
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 <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  braket/paginator/SearchDevices
  braket/paginator/SearchJobs
  braket/paginator/SearchQuantumTasks
  braket/paginator/SearchSpendingLimits
