You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Braket

Inherits:

AWS.Service

Object
AWS.Service
AWS.Braket

show all

Identifier:: braket

API Version:: 2019-09-01

Defined in:: (unknown)

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.

Sending a Request Using Braket

var braket = new AWS.Braket();
braket.cancelQuantumTask(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();

Version:

2019-09-01

Constructor Summary collapse

new AWS.Braket(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

cancelQuantumTask(params = {}, callback) ⇒ AWS.Request
Cancels the specified task.

.
createQuantumTask(params = {}, callback) ⇒ AWS.Request
Creates a quantum task.

.
getDevice(params = {}, callback) ⇒ AWS.Request
Retrieves the devices available in Amazon Braket.

.
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.

.
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.

.

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.

Examples:

Constructing a Braket object

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

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.Braket.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.Braket.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.Braket.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Cancels the specified task.

Service Reference:

CancelQuantumTask

Examples:

Calling the cancelQuantumTask operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  quantumTaskArn: 'STRING_VALUE' /* required */
};
braket.cancelQuantumTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- clientToken — (String)
  The client token associated with the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- quantumTaskArn — (String)
  The ARN of the task to cancel.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - cancellationStatus — (String)
    The status of the cancellation request.
    Possible values include:
    
    "CANCELLING"
    
    "CANCELLED"
  - quantumTaskArn — (String)
    The ARN of the task.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a quantum task.

Service Reference:

CreateQuantumTask

Examples:

Calling the createQuantumTask operation

var params = {
  action: any /* This value will be JSON encoded on your behalf with JSON.stringify() */, /* required */
  clientToken: 'STRING_VALUE', /* required */
  deviceArn: 'STRING_VALUE', /* required */
  outputS3Bucket: 'STRING_VALUE', /* required */
  outputS3KeyPrefix: 'STRING_VALUE', /* required */
  shots: 'NUMBER_VALUE', /* required */
  deviceParameters: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
braket.createQuantumTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- action — (String)
  The action associated with the task.
- clientToken — (String)
  The client token associated with the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- deviceArn — (String)
  The ARN of the device to run the task on.
- deviceParameters — (String)
  The parameters for the device to run the task on.
- outputS3Bucket — (String)
  The S3 bucket to store task result files in.
- outputS3KeyPrefix — (String)
  The key prefix for the location in the S3 bucket to store task results in.
- shots — (Integer)
  The number of shots to use for the task.
- tags — (map<String>)
  Tags to be added to the quantum task you're creating.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - quantumTaskArn — (String)
    The ARN of the task created by the request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Retrieves the devices available in Amazon Braket.

Service Reference:

GetDevice

Examples:

Calling the getDevice operation

var params = {
  deviceArn: 'STRING_VALUE' /* required */
};
braket.getDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- deviceArn — (String)
  The ARN of the device to retrieve.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - deviceArn — (String)
    The ARN of the device.
  - deviceCapabilities — (String)
    Details about the capabilities of the device.
  - deviceName — (String)
    The name of the device.
  - deviceStatus — (String)
    The status of the device.
    Possible values include:
    
    "ONLINE"
    
    "OFFLINE"
    
    "RETIRED"
  - deviceType — (String)
    The type of the device.
    Possible values include:
    
    "QPU"
    
    "SIMULATOR"
  - providerName — (String)
    The name of the partner company for the device.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Retrieves the specified quantum task.

Service Reference:

GetQuantumTask

Examples:

Calling the getQuantumTask operation

var params = {
  quantumTaskArn: 'STRING_VALUE' /* required */
};
braket.getQuantumTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- quantumTaskArn — (String)
  the ARN of the task to retrieve.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - createdAt — (Date)
    The time at which the task was created.
  - deviceArn — (String)
    The ARN of the device the task was run on.
  - deviceParameters — (String)
    The parameters for the device on which the task ran.
  - endedAt — (Date)
    The time at which the task ended.
  - failureReason — (String)
    The reason that a task failed.
  - outputS3Bucket — (String)
    The S3 bucket where task results are stored.
  - outputS3Directory — (String)
    The folder in the S3 bucket where task results are stored.
  - quantumTaskArn — (String)
    The ARN of the task.
  - shots — (Integer)
    The number of shots used in the task.
  - status — (String)
    The status of the task.
    Possible values include:
    
    "CREATED"
    
    "QUEUED"
    
    "RUNNING"
    
    "COMPLETED"
    
    "FAILED"
    
    "CANCELLING"
    
    "CANCELLED"
  - tags — (map<String>)
    The tags that belong to this task.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Shows the tags associated with this resource.

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
braket.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  Specify the resourceArn for the resource whose tags to display.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - tags — (map<String>)
    Displays the key, value pairs of tags associated with this resource.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Searches for devices using the specified filters.

Service Reference:

SearchDevices

Examples:

Calling the searchDevices operation

var params = {
  filters: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
braket.searchDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filters — (Array<map>)
  The filter values to use to search for a device.
  - name — required — (String)
    The name to use to filter results.
  - values — required — (Array<String>)
    The values to use to filter results.
- maxResults — (Integer)
  The maximum number of results to return in the response.
- nextToken — (String)
  A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - devices — (Array<map>)
    An array of DeviceSummary objects for devices that match the specified filter values.
    
    deviceArn — required — (String)
    The ARN of the device.
    
    deviceName — required — (String)
    The name of the device.
    
    deviceStatus — required — (String)
    The status of the device.
    Possible values include:
    
    "ONLINE"
    
    "OFFLINE"
    
    "RETIRED"
    
    deviceType — required — (String)
    The type of the device.
    Possible values include:
    
    "QPU"
    
    "SIMULATOR"
    
    providerName — required — (String)
    The provider of the device.
  - nextToken — (String)
    A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Searches for tasks that match the specified filter values.

Service Reference:

SearchQuantumTasks

Examples:

Calling the searchQuantumTasks operation

var params = {
  filters: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      operator: LT | LTE | EQUAL | GT | GTE | BETWEEN, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
braket.searchQuantumTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- filters — (Array<map>)
  Array of SearchQuantumTasksFilter objects.
  - name — required — (String)
    The name of the device used for the task.
  - operator — required — (String)
    An operator to use in the filter.
    Possible values include:
    - "LT"
    - "LTE"
    - "EQUAL"
    - "GT"
    - "GTE"
    - "BETWEEN"
  - values — required — (Array<String>)
    The values to use for the filter.
- maxResults — (Integer)
  Maximum number of results to return in the response.
- nextToken — (String)
  A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - nextToken — (String)
    A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
  - quantumTasks — (Array<map>)
    An array of QuantumTaskSummary objects for tasks that match the specified filters.
    
    createdAt — required — (Date)
    The time at which the task was created.
    
    deviceArn — required — (String)
    The ARN of the device the task ran on.
    
    endedAt — (Date)
    The time at which the task finished.
    
    outputS3Bucket — required — (String)
    The S3 bucket where the task result file is stored..
    
    outputS3Directory — required — (String)
    The folder in the S3 bucket where the task result file is stored.
    
    quantumTaskArn — required — (String)
    The ARN of the task.
    
    shots — required — (Integer)
    The shots used for the task.
    
    status — required — (String)
    The status of the task.
    Possible values include:
    
    "CREATED"
    
    "QUEUED"
    
    "RUNNING"
    
    "COMPLETED"
    
    "FAILED"
    
    "CANCELLING"
    
    "CANCELLED"
    
    tags — (map<String>)
    Displays the key, value pairs of tags associated with this quantum task.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Add a tag to the specified resource.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
braket.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  Specify the resourceArn of the resource to which a tag will be added.
- tags — (map<String>)
  Specify the tags to add to the resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Remove tags from a resource.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
braket.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- resourceArn — (String)
  Specify the resourceArn for the resource from which to remove the tags.
- tagKeys — (Array<String>)
  Specify the keys for the tags to remove from the resource.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.Braket

Overview

Service Description

Sending a Request Using Braket

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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