feat(client-braket): This release enables Braket Hybrid Jobs with Emb…

…edded Simulators to have multiple instances.
aws · Apr 28, 2022 · 2de9086 · 2de9086
1 parent ff576e7
commit 2de9086
Show file tree

Hide file tree

Showing 7 changed files with 198 additions and 134 deletions.
diff --git a/clients/client-braket/README.md b/clients/client-braket/README.md
@@ -7,7 +7,16 @@
 
 AWS SDK for JavaScript Braket Client for Node.js, Browser and React Native.
 
-<p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
+<p>The Amazon Braket API Reference provides information about the operations and structures
+supported in Amazon Braket.</p>
+<p>Additional Resources:</p>
+<ul>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
+</p>
+</li>
+</ul>
 
 ## Installing
 

diff --git a/clients/client-braket/src/Braket.ts b/clients/client-braket/src/Braket.ts
@@ -44,7 +44,16 @@ import {
 } from "./commands/UntagResourceCommand";
 
 /**
- * <p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
+ * <p>The Amazon Braket API Reference provides information about the operations and structures
+ *          supported in Amazon Braket.</p>
+ *          <p>Additional Resources:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export class Braket extends BraketClient {
   /**
@@ -165,6 +174,15 @@ export class Braket extends BraketClient {
 
   /**
    * <p>Retrieves the devices available in Amazon Braket.</p>
+   *          <note>
+   *             <p>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.</p>
+   *          </note>
    */
   public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<GetDeviceCommandOutput>;
   public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;

diff --git a/clients/client-braket/src/BraketClient.ts b/clients/client-braket/src/BraketClient.ts
@@ -253,7 +253,16 @@ type BraketClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandle
 export interface BraketClientResolvedConfig extends BraketClientResolvedConfigType {}
 
 /**
- * <p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
+ * <p>The Amazon Braket API Reference provides information about the operations and structures
+ *          supported in Amazon Braket.</p>
+ *          <p>Additional Resources:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  */
 export class BraketClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-braket/src/commands/GetDeviceCommand.ts b/clients/client-braket/src/commands/GetDeviceCommand.ts
@@ -23,6 +23,15 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
 
 /**
  * <p>Retrieves the devices available in Amazon Braket.</p>
+ *          <note>
+ *             <p>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.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript