Braket
The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket. To learn about the permissions required…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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
Endpoints 17
Job
- PUTCancel job
/job/:jobArn/cancelCancels an Amazon Braket hybrid job. - POSTCreate job
/jobCreates an Amazon Braket hybrid job. - GETGet job
/job/:jobArn?additionalAttributeNames=Retrieves the specified Amazon Braket hybrid job. - POSTSearch jobs
/jobsSearches for Amazon Braket hybrid jobs that match the specified filter values.
Quantum task
- PUTCancel quantum task
/quantum-task/:quantumTaskArn/cancelCancels the specified task. - POSTCreate quantum task
/quantum-taskCreates a quantum task. - GETGet quantum task
/quantum-task/:quantumTaskArn?additionalAttributeNames=Retrieves the specified quantum task. - POSTSearch quantum tasks
/quantum-tasksSearches for tasks that match the specified filter values.
Spending limit
- POSTCreate spending limit
/spending-limitCreates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum… - DELETEDelete spending limit
/spending-limit/:spendingLimitArn/deleteDeletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes… - POSTSearch spending limits
/spending-limitsSearches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific… - PATCHUpdate spending limit
/spending-limit/:spendingLimitArn/updateUpdates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.
Device
- GETGet device
/device/:deviceArnRetrieves the devices available in Amazon Braket. For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from… - POSTSearch devices
/devicesSearches for devices using the specified filters.
- GETList tags for resource
/tags/:resourceArnShows the tags associated with this resource. - POSTTag resource
/tags/:resourceArnAdd a tag to the specified resource. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Remove tags from a resource.
API details
- Base URL
https://api.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 17 operations on 15 pathsPOST 8GET 4PUT 2DELETE 2PATCH 1
- Main resources
- Job 4Quantum task 4Spending limit 4Device 2
- Description format
- AWS Smithy model, API version
2019-09-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Braket in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Braket collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Cancel job” (PUT /job/:jobArn/cancel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Braket?
The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket. To learn about the permissions required… It is listed under Developer tools and has 17 endpoints.
Who publishes the Braket?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Braket?
Requests go to https://api.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Braket?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Braket have?
17 operations on 15 paths (8 POST, 4 GET, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are Job, Quantum task, Spending limit, Device.
Is forking the Braket free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.