AWS.Braket — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Braket

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Additional Resources:

Sending a Request Using Braket

var braket = new AWS.Braket();
braket.cancelJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Braket object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var braket = new AWS.Braket({apiVersion: '2019-09-01'});

You can also set the API version globally in AWS.config.apiVersions using the braket service identifier:

AWS.config.apiVersions = {
  braket: '2019-09-01',
  // other service API versions
};

var braket = new AWS.Braket();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Braket(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelJob(params = {}, callback) ⇒ AWS.Request

Cancels an Amazon Braket job.

cancelQuantumTask(params = {}, callback) ⇒ AWS.Request

Cancels the specified task.

createJob(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Braket job.

createQuantumTask(params = {}, callback) ⇒ AWS.Request

getDevice(params = {}, callback) ⇒ AWS.Request

Retrieves the devices available in Amazon Braket.

Note: For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

getJob(params = {}, callback) ⇒ AWS.Request

Retrieves the specified Amazon Braket job.

getQuantumTask(params = {}, callback) ⇒ AWS.Request

Retrieves the specified quantum task.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Shows the tags associated with this resource.

searchDevices(params = {}, callback) ⇒ AWS.Request

Searches for devices using the specified filters.

searchJobs(params = {}, callback) ⇒ AWS.Request

Searches for Amazon Braket jobs that match the specified filter values.

searchQuantumTasks(params = {}, callback) ⇒ AWS.Request

Searches for tasks that match the specified filter values.

tagResource(params = {}, callback) ⇒ AWS.Request

Add a tag to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Remove tags from a resource.