Skip to content

Commit 2de9086

Browse files
author
awstools
committed
feat(client-braket): This release enables Braket Hybrid Jobs with Embedded Simulators to have multiple instances.
1 parent ff576e7 commit 2de9086

File tree

7 files changed

+198
-134
lines changed

7 files changed

+198
-134
lines changed

clients/client-braket/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,16 @@
77

88
AWS SDK for JavaScript Braket Client for Node.js, Browser and React Native.
99

10-
<p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
10+
<p>The Amazon Braket API Reference provides information about the operations and structures
11+
supported in Amazon Braket.</p>
12+
<p>Additional Resources:</p>
13+
<ul>
14+
<li>
15+
<p>
16+
<a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
17+
</p>
18+
</li>
19+
</ul>
1120

1221
## Installing
1322

clients/client-braket/src/Braket.ts

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,16 @@ import {
4444
} from "./commands/UntagResourceCommand";
4545

4646
/**
47-
* <p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
47+
* <p>The Amazon Braket API Reference provides information about the operations and structures
48+
* supported in Amazon Braket.</p>
49+
* <p>Additional Resources:</p>
50+
* <ul>
51+
* <li>
52+
* <p>
53+
* <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
54+
* </p>
55+
* </li>
56+
* </ul>
4857
*/
4958
export class Braket extends BraketClient {
5059
/**
@@ -165,6 +174,15 @@ export class Braket extends BraketClient {
165174

166175
/**
167176
* <p>Retrieves the devices available in Amazon Braket.</p>
177+
* <note>
178+
* <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
179+
* information is omitted from GetDevice API calls. To get this information the user-agent
180+
* needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK
181+
* automatically reports this for you. If you do not see OpenQASM results in the GetDevice
182+
* response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment
183+
* variable to configure user-agent. See the code examples provided below for how to do
184+
* this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p>
185+
* </note>
168186
*/
169187
public getDevice(args: GetDeviceCommandInput, options?: __HttpHandlerOptions): Promise<GetDeviceCommandOutput>;
170188
public getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;

clients/client-braket/src/BraketClient.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,16 @@ type BraketClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandle
253253
export interface BraketClientResolvedConfig extends BraketClientResolvedConfigType {}
254254

255255
/**
256-
* <p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>
256+
* <p>The Amazon Braket API Reference provides information about the operations and structures
257+
* supported in Amazon Braket.</p>
258+
* <p>Additional Resources:</p>
259+
* <ul>
260+
* <li>
261+
* <p>
262+
* <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
263+
* </p>
264+
* </li>
265+
* </ul>
257266
*/
258267
export class BraketClient extends __Client<
259268
__HttpHandlerOptions,

clients/client-braket/src/commands/GetDeviceCommand.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
2323

2424
/**
2525
* <p>Retrieves the devices available in Amazon Braket.</p>
26+
* <note>
27+
* <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
28+
* information is omitted from GetDevice API calls. To get this information the user-agent
29+
* needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK
30+
* automatically reports this for you. If you do not see OpenQASM results in the GetDevice
31+
* response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment
32+
* variable to configure user-agent. See the code examples provided below for how to do
33+
* this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p>
34+
* </note>
2635
* @example
2736
* Use a bare-bones client and the command you need to make an API call.
2837
* ```javascript

0 commit comments

Comments
 (0)