We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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

Inherits:
AWS.Service 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.

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();

Version:

  • 2019-09-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

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

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

Cancels an Amazon Braket job.

Service Reference:

Examples:

Calling the cancelJob operation

var params = {
  jobArn: 'STRING_VALUE' /* required */
};
braket.cancelJob(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: {})
    • jobArn — (String)

      The ARN of the Amazon Braket job 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 job cancellation request.

        Possible values include:
        • "CANCELLING"
        • "CANCELLED"
      • jobArn — (String)

        The ARN of the Amazon Braket job.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Cancels the specified task.

Service Reference:

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.

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

Creates an Amazon Braket job.

Service Reference:

Examples:

Calling the createJob operation

var params = {
  algorithmSpecification: { /* required */
    containerImage: {
      uri: 'STRING_VALUE' /* required */
    },
    scriptModeConfig: {
      entryPoint: 'STRING_VALUE', /* required */
      s3Uri: 'STRING_VALUE', /* required */
      compressionType: NONE | GZIP
    }
  },
  clientToken: 'STRING_VALUE', /* required */
  deviceConfig: { /* required */
    device: 'STRING_VALUE' /* required */
  },
  instanceConfig: { /* required */
    instanceType: ml.m4.xlarge | ml.m4.2xlarge | ml.m4.4xlarge | ml.m4.10xlarge | ml.m4.16xlarge | ml.g4dn.xlarge | ml.g4dn.2xlarge | ml.g4dn.4xlarge | ml.g4dn.8xlarge | ml.g4dn.12xlarge | ml.g4dn.16xlarge | ml.m5.large | ml.m5.xlarge | ml.m5.2xlarge | ml.m5.4xlarge | ml.m5.12xlarge | ml.m5.24xlarge | ml.c4.xlarge | ml.c4.2xlarge | ml.c4.4xlarge | ml.c4.8xlarge | ml.p2.xlarge | ml.p2.8xlarge | ml.p2.16xlarge | ml.p3.2xlarge | ml.p3.8xlarge | ml.p3.16xlarge | ml.p3dn.24xlarge | ml.p4d.24xlarge | ml.c5.xlarge | ml.c5.2xlarge | ml.c5.4xlarge | ml.c5.9xlarge | ml.c5.18xlarge | ml.c5n.xlarge | ml.c5n.2xlarge | ml.c5n.4xlarge | ml.c5n.9xlarge | ml.c5n.18xlarge, /* required */
    volumeSizeInGb: 'NUMBER_VALUE', /* required */
    instanceCount: 'NUMBER_VALUE'
  },
  jobName: 'STRING_VALUE', /* required */
  outputDataConfig: { /* required */
    s3Path: 'STRING_VALUE', /* required */
    kmsKeyId: 'STRING_VALUE'
  },
  roleArn: 'STRING_VALUE', /* required */
  associations: [
    {
      arn: 'STRING_VALUE', /* required */
      type: RESERVATION_TIME_WINDOW_ARN /* required */
    },
    /* more items */
  ],
  checkpointConfig: {
    s3Uri: 'STRING_VALUE', /* required */
    localPath: 'STRING_VALUE'
  },
  hyperParameters: {
    '<String256>': 'STRING_VALUE',
    /* '<String256>': ... */
  },
  inputDataConfig: [
    {
      channelName: 'STRING_VALUE', /* required */
      dataSource: { /* required */
        s3DataSource: { /* required */
          s3Uri: 'STRING_VALUE' /* required */
        }
      },
      contentType: 'STRING_VALUE'
    },
    /* more items */
  ],
  stoppingCondition: {
    maxRuntimeInSeconds: 'NUMBER_VALUE'
  },
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
braket.createJob(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: {})
    • algorithmSpecification — (map)

      Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

      • containerImage — (map)

        The container image used to create an Amazon Braket job.

        • urirequired — (String)

          The URI locating the container image.

      • scriptModeConfig — (map)

        Configures the paths to the Python scripts used for entry and training.

        • compressionType — (String)

          The type of compression used by the Python scripts for an Amazon Braket job.

          Possible values include:
          • "NONE"
          • "GZIP"
        • entryPointrequired — (String)

          The path to the Python script that serves as the entry point for an Amazon Braket job.

        • s3Urirequired — (String)

          The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.

    • associations — (Array<map>)

      The list of Amazon Braket resources associated with the hybrid job.

      • arnrequired — (String)

        The Amazon Braket resource arn.

      • typerequired — (String)

        The association type for the specified Amazon Braket resource arn.

        Possible values include:
        • "RESERVATION_TIME_WINDOW_ARN"
    • checkpointConfig — (map)

      Information about the output locations for job checkpoint data.

      • localPath — (String)

        (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

      • s3Urirequired — (String)

        Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

    • clientToken — (String)

      A unique token that guarantees that the call to this API is idempotent.

      If a token is not provided, the SDK will use a version 4 UUID.
    • deviceConfig — (map)

      The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

      • devicerequired — (String)

        The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.

    • hyperParameters — (map<String>)

      Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

    • inputDataConfig — (Array<map>)

      A list of parameters that specify the name and type of input data and where it is located.

      • channelNamerequired — (String)

        A named input source that an Amazon Braket job can consume.

      • contentType — (String)

        The MIME type of the data.

      • dataSourcerequired — (map)

        The location of the channel data.

        • s3DataSourcerequired — (map)

          Information about the data stored in Amazon S3 used by the Amazon Braket job.

          • s3Urirequired — (String)

            Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.

    • instanceConfig — (map)

      Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

      • instanceCount — (Integer)

        Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.

      • instanceTyperequired — (String)

        Configures the type resource instances to use while running an Amazon Braket hybrid job.

        Possible values include:
        • "ml.m4.xlarge"
        • "ml.m4.2xlarge"
        • "ml.m4.4xlarge"
        • "ml.m4.10xlarge"
        • "ml.m4.16xlarge"
        • "ml.g4dn.xlarge"
        • "ml.g4dn.2xlarge"
        • "ml.g4dn.4xlarge"
        • "ml.g4dn.8xlarge"
        • "ml.g4dn.12xlarge"
        • "ml.g4dn.16xlarge"
        • "ml.m5.large"
        • "ml.m5.xlarge"
        • "ml.m5.2xlarge"
        • "ml.m5.4xlarge"
        • "ml.m5.12xlarge"
        • "ml.m5.24xlarge"
        • "ml.c4.xlarge"
        • "ml.c4.2xlarge"
        • "ml.c4.4xlarge"
        • "ml.c4.8xlarge"
        • "ml.p2.xlarge"
        • "ml.p2.8xlarge"
        • "ml.p2.16xlarge"
        • "ml.p3.2xlarge"
        • "ml.p3.8xlarge"
        • "ml.p3.16xlarge"
        • "ml.p3dn.24xlarge"
        • "ml.p4d.24xlarge"
        • "ml.c5.xlarge"
        • "ml.c5.2xlarge"
        • "ml.c5.4xlarge"
        • "ml.c5.9xlarge"
        • "ml.c5.18xlarge"
        • "ml.c5n.xlarge"
        • "ml.c5n.2xlarge"
        • "ml.c5n.4xlarge"
        • "ml.c5n.9xlarge"
        • "ml.c5n.18xlarge"
      • volumeSizeInGbrequired — (Integer)

        The size of the storage volume, in GB, that user wants to provision.

    • jobName — (String)

      The name of the Amazon Braket job.

    • outputDataConfig — (map)

      The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

      • kmsKeyId — (String)

        The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.

      • s3Pathrequired — (String)

        Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

    • stoppingCondition — (map)

      The user-defined criteria that specifies when a job stops running.

      • maxRuntimeInSeconds — (Integer)

        The maximum length of time, in seconds, that an Amazon Braket job can run.

    • tags — (map<String>)

      A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

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:

      • jobArn — (String)

        The ARN of the Amazon Braket job created.

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:

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 */
  associations: [
    {
      arn: 'STRING_VALUE', /* required */
      type: RESERVATION_TIME_WINDOW_ARN /* required */
    },
    /* more items */
  ],
  deviceParameters: any /* This value will be JSON encoded on your behalf with JSON.stringify() */,
  jobToken: 'STRING_VALUE',
  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.

    • associations — (Array<map>)

      The list of Amazon Braket resources associated with the quantum task.

      • arnrequired — (String)

        The Amazon Braket resource arn.

      • typerequired — (String)

        The association type for the specified Amazon Braket resource arn.

        Possible values include:
        • "RESERVATION_TIME_WINDOW_ARN"
    • 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.

    • jobToken — (String)

      The token for an Amazon Braket job that associates it with the quantum task.

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

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.

Service Reference:

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.

      • deviceQueueInfo — (Array<map>)

        List of information about tasks and jobs queued on a device.

        • queuerequired — (String)

          The name of the queue.

          Possible values include:
          • "QUANTUM_TASKS_QUEUE"
          • "JOBS_QUEUE"
        • queuePriority — (String)

          Optional. Specifies the priority of the queue. Tasks in a priority queue are processed before the tasks in a normal queue.

          Possible values include:
          • "Normal"
          • "Priority"
        • queueSizerequired — (String)

          The number of jobs or tasks in the queue for a given 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.

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

Retrieves the specified Amazon Braket job.

Service Reference:

Examples:

Calling the getJob operation

var params = {
  jobArn: 'STRING_VALUE', /* required */
  additionalAttributeNames: [
    QueueInfo,
    /* more items */
  ]
};
braket.getJob(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: {})
    • additionalAttributeNames — (Array<String>)

      A list of attributes to return information for.

    • jobArn — (String)

      The ARN of the job 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:

      • algorithmSpecification — (map)

        Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.

        • containerImage — (map)

          The container image used to create an Amazon Braket job.

          • urirequired — (String)

            The URI locating the container image.

        • scriptModeConfig — (map)

          Configures the paths to the Python scripts used for entry and training.

          • compressionType — (String)

            The type of compression used by the Python scripts for an Amazon Braket job.

            Possible values include:
            • "NONE"
            • "GZIP"
          • entryPointrequired — (String)

            The path to the Python script that serves as the entry point for an Amazon Braket job.

          • s3Urirequired — (String)

            The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.

      • associations — (Array<map>)

        The list of Amazon Braket resources associated with the hybrid job.

        • arnrequired — (String)

          The Amazon Braket resource arn.

        • typerequired — (String)

          The association type for the specified Amazon Braket resource arn.

          Possible values include:
          • "RESERVATION_TIME_WINDOW_ARN"
      • billableDuration — (Integer)

        The billable time the Amazon Braket job used to complete.

      • checkpointConfig — (map)

        Information about the output locations for job checkpoint data.

        • localPath — (String)

          (Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

        • s3Urirequired — (String)

          Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

      • createdAt — (Date)

        The date and time that the Amazon Braket job was created.

      • deviceConfig — (map)

        The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

        • devicerequired — (String)

          The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.

      • endedAt — (Date)

        The date and time that the Amazon Braket job ended.

      • events — (Array<map>)

        Details about the type and time events occurred related to the Amazon Braket job.

        • eventType — (String)

          The type of event that occurred related to the Amazon Braket job.

          Possible values include:
          • "WAITING_FOR_PRIORITY"
          • "QUEUED_FOR_EXECUTION"
          • "STARTING_INSTANCE"
          • "DOWNLOADING_DATA"
          • "RUNNING"
          • "DEPRIORITIZED_DUE_TO_INACTIVITY"
          • "UPLOADING_RESULTS"
          • "COMPLETED"
          • "FAILED"
          • "MAX_RUNTIME_EXCEEDED"
          • "CANCELLED"
        • message — (String)

          A message describing the event that occurred related to the Amazon Braket job.

        • timeOfEvent — (Date)

          The type of event that occurred related to the Amazon Braket job.

      • failureReason — (String)

        A description of the reason why an Amazon Braket job failed, if it failed.

      • hyperParameters — (map<String>)

        Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

      • inputDataConfig — (Array<map>)

        A list of parameters that specify the name and type of input data and where it is located.

        • channelNamerequired — (String)

          A named input source that an Amazon Braket job can consume.

        • contentType — (String)

          The MIME type of the data.

        • dataSourcerequired — (map)

          The location of the channel data.

          • s3DataSourcerequired — (map)

            Information about the data stored in Amazon S3 used by the Amazon Braket job.

            • s3Urirequired — (String)

              Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest that locates the S3 data source.

      • instanceConfig — (map)

        The resource instances to use while running the hybrid job on Amazon Braket.

        • instanceCount — (Integer)

          Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.

        • instanceTyperequired — (String)

          Configures the type resource instances to use while running an Amazon Braket hybrid job.

          Possible values include:
          • "ml.m4.xlarge"
          • "ml.m4.2xlarge"
          • "ml.m4.4xlarge"
          • "ml.m4.10xlarge"
          • "ml.m4.16xlarge"
          • "ml.g4dn.xlarge"
          • "ml.g4dn.2xlarge"
          • "ml.g4dn.4xlarge"
          • "ml.g4dn.8xlarge"
          • "ml.g4dn.12xlarge"
          • "ml.g4dn.16xlarge"
          • "ml.m5.large"
          • "ml.m5.xlarge"
          • "ml.m5.2xlarge"
          • "ml.m5.4xlarge"
          • "ml.m5.12xlarge"
          • "ml.m5.24xlarge"
          • "ml.c4.xlarge"
          • "ml.c4.2xlarge"
          • "ml.c4.4xlarge"
          • "ml.c4.8xlarge"
          • "ml.p2.xlarge"
          • "ml.p2.8xlarge"
          • "ml.p2.16xlarge"
          • "ml.p3.2xlarge"
          • "ml.p3.8xlarge"
          • "ml.p3.16xlarge"
          • "ml.p3dn.24xlarge"
          • "ml.p4d.24xlarge"
          • "ml.c5.xlarge"
          • "ml.c5.2xlarge"
          • "ml.c5.4xlarge"
          • "ml.c5.9xlarge"
          • "ml.c5.18xlarge"
          • "ml.c5n.xlarge"
          • "ml.c5n.2xlarge"
          • "ml.c5n.4xlarge"
          • "ml.c5n.9xlarge"
          • "ml.c5n.18xlarge"
        • volumeSizeInGbrequired — (Integer)

          The size of the storage volume, in GB, that user wants to provision.

      • jobArn — (String)

        The ARN of the Amazon Braket job.

      • jobName — (String)

        The name of the Amazon Braket job.

      • outputDataConfig — (map)

        The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

        • kmsKeyId — (String)

          The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.

        • s3Pathrequired — (String)

          Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.

      • queueInfo — (map)

        Queue information for the requested job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

        • message — (String)

          Optional. Provides more information about the queue position. For example, if the job is complete and no longer in the queue, the message field contains that information.

        • positionrequired — (String)

          Current position of the job in the jobs queue.

        • queuerequired — (String)

          The name of the queue.

          Possible values include:
          • "QUANTUM_TASKS_QUEUE"
          • "JOBS_QUEUE"
      • roleArn — (String)

        The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.

      • startedAt — (Date)

        The date and time that the Amazon Braket job was started.

      • status — (String)

        The status of the Amazon Braket job.

        Possible values include:
        • "QUEUED"
        • "RUNNING"
        • "COMPLETED"
        • "FAILED"
        • "CANCELLING"
        • "CANCELLED"
      • stoppingCondition — (map)

        The user-defined criteria that specifies when to stop a job running.

        • maxRuntimeInSeconds — (Integer)

          The maximum length of time, in seconds, that an Amazon Braket job can run.

      • tags — (map<String>)

        A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

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:

Examples:

Calling the getQuantumTask operation

var params = {
  quantumTaskArn: 'STRING_VALUE', /* required */
  additionalAttributeNames: [
    QueueInfo,
    /* more items */
  ]
};
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: {})
    • additionalAttributeNames — (Array<String>)

      A list of attributes to return information for.

    • 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:

      • associations — (Array<map>)

        The list of Amazon Braket resources associated with the quantum task.

        • arnrequired — (String)

          The Amazon Braket resource arn.

        • typerequired — (String)

          The association type for the specified Amazon Braket resource arn.

          Possible values include:
          • "RESERVATION_TIME_WINDOW_ARN"
      • 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.

      • jobArn — (String)

        The ARN of the Amazon Braket job associated with the quantum task.

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

      • queueInfo — (map)

        Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetQuantumTask API request.

        • message — (String)

          Optional. Provides more information about the queue position. For example, if the task is complete and no longer in the queue, the message field contains that information.

        • positionrequired — (String)

          Current position of the task in the quantum tasks queue.

        • queuerequired — (String)

          The name of the queue.

          Possible values include:
          • "QUANTUM_TASKS_QUEUE"
          • "JOBS_QUEUE"
        • queuePriority — (String)

          Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the tasks in a normal queue.

          Possible values include:
          • "Normal"
          • "Priority"
      • 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:

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:

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.

      • namerequired — (String)

        The name to use to filter results.

      • valuesrequired — (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.

        • deviceArnrequired — (String)

          The ARN of the device.

        • deviceNamerequired — (String)

          The name of the device.

        • deviceStatusrequired — (String)

          The status of the device.

          Possible values include:
          • "ONLINE"
          • "OFFLINE"
          • "RETIRED"
        • deviceTyperequired — (String)

          The type of the device.

          Possible values include:
          • "QPU"
          • "SIMULATOR"
        • providerNamerequired — (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.

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

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

Service Reference:

Examples:

Calling the searchJobs operation

var params = {
  filters: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      operator: LT | LTE | EQUAL | GT | GTE | BETWEEN | CONTAINS, /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
braket.searchJobs(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 when searching for a job.

      • namerequired — (String)

        The name to use for the jobs filter.

      • operatorrequired — (String)

        An operator to use for the jobs filter.

        Possible values include:
        • "LT"
        • "LTE"
        • "EQUAL"
        • "GT"
        • "GTE"
        • "BETWEEN"
        • "CONTAINS"
      • valuesrequired — (Array<String>)

        The values to use for the jobs filter.

    • 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 to 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:

      • jobs — (Array<map>)

        An array of JobSummary objects for devices that match the specified filter values.

        • createdAtrequired — (Date)

          The date and time that the Amazon Braket job was created.

        • devicerequired — (String)

          Provides summary information about the primary device used by an Amazon Braket job.

        • endedAt — (Date)

          The date and time that the Amazon Braket job ended.

        • jobArnrequired — (String)

          The ARN of the Amazon Braket job.

        • jobNamerequired — (String)

          The name of the Amazon Braket job.

        • startedAt — (Date)

          The date and time that the Amazon Braket job was started.

        • statusrequired — (String)

          The status of the Amazon Braket job.

          Possible values include:
          • "QUEUED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
          • "CANCELLING"
          • "CANCELLED"
        • tags — (map<String>)

          A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

      • 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:

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.

      • namerequired — (String)

        The name of the device used for the task.

      • operatorrequired — (String)

        An operator to use in the filter.

        Possible values include:
        • "LT"
        • "LTE"
        • "EQUAL"
        • "GT"
        • "GTE"
        • "BETWEEN"
      • valuesrequired — (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.

        • createdAtrequired — (Date)

          The time at which the task was created.

        • deviceArnrequired — (String)

          The ARN of the device the task ran on.

        • endedAt — (Date)

          The time at which the task finished.

        • outputS3Bucketrequired — (String)

          The S3 bucket where the task result file is stored..

        • outputS3Directoryrequired — (String)

          The folder in the S3 bucket where the task result file is stored.

        • quantumTaskArnrequired — (String)

          The ARN of the task.

        • shotsrequired — (Integer)

          The shots used for the task.

        • statusrequired — (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:

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:

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.