+572
-486
lines changedFilter options
+572
-486
lines changed Original file line number Diff line number Diff line change
@@ -6,16 +6,7 @@
6 6 7 7
AWS SDK for JavaScript Braket Client for Node.js, Browser and React Native.
8 8 9 -
<p>The Amazon Braket API Reference provides information about the operations and structures
10 -
supported in Amazon Braket.</p>
11 -
<p>Additional Resources:</p>
12 -
<ul>
13 -
<li>
14 -
<p>
15 -
<a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
16 -
</p>
17 -
</li>
18 -
</ul>
9 +
<p>The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.</p> <p>To learn about the permissions required to call an Amazon Braket API action, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonbraket.html">Actions, resources, and condition keys for Amazon Braket</a>. <a href="https://amazon-braket-sdk-python.readthedocs.io/en/latest/#">Amazon Braket Python SDK</a> and the <a href="https://docs.aws.amazon.com/cli/latest/reference/braket/">AWS Command Line Interface</a> can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">What is Amazon Braket?</a> and important <a href="https://docs.aws.amazon.com/braket/latest/developerguide/braket-terms.html">terms and concepts</a> in the <i>Amazon Braket Developer Guide</i>.</p> <p> <b>In this guide:</b> </p> <ul> <li> <p/> </li> <li> <p/> </li> <li> <p> <a>CommonParameters</a> </p> </li> <li> <p> <a>CommonErrors</a> </p> </li> </ul> <p> <b>Available languages for AWS SDK:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Braket/NBraket.html">.NET</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/cpp/api/LATEST/root/html/index.html">C++</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/braket/">Go API reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/braket/package-summary.html">Java</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Braket.html">JavaScript</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Braket.BraketClient.html">PHP</a> </p> </li> <li> <p> <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/braket.html">Python (Boto)</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Braket.html">Ruby</a> </p> </li> </ul> <p> <b>Code examples from the Amazon Braket Tutorials GitHub repository:</b> </p> <ul> <li> <p> <a href="https://github.com/amazon-braket/amazon-braket-examples">Amazon Braket Examples</a> </p> </li> </ul>
19 10 20 11
## Installing
21 12
@@ -234,16 +234,7 @@ export interface Braket {
234 234
}
235 235 236 236
/**
237 -
* <p>The Amazon Braket API Reference provides information about the operations and structures
238 -
* supported in Amazon Braket.</p>
239 -
* <p>Additional Resources:</p>
240 -
* <ul>
241 -
* <li>
242 -
* <p>
243 -
* <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
244 -
* </p>
245 -
* </li>
246 -
* </ul>
237 +
* <p>The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.</p> <p>To learn about the permissions required to call an Amazon Braket API action, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonbraket.html">Actions, resources, and condition keys for Amazon Braket</a>. <a href="https://amazon-braket-sdk-python.readthedocs.io/en/latest/#">Amazon Braket Python SDK</a> and the <a href="https://docs.aws.amazon.com/cli/latest/reference/braket/">AWS Command Line Interface</a> can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">What is Amazon Braket?</a> and important <a href="https://docs.aws.amazon.com/braket/latest/developerguide/braket-terms.html">terms and concepts</a> in the <i>Amazon Braket Developer Guide</i>.</p> <p> <b>In this guide:</b> </p> <ul> <li> <p/> </li> <li> <p/> </li> <li> <p> <a>CommonParameters</a> </p> </li> <li> <p> <a>CommonErrors</a> </p> </li> </ul> <p> <b>Available languages for AWS SDK:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Braket/NBraket.html">.NET</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/cpp/api/LATEST/root/html/index.html">C++</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/braket/">Go API reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/braket/package-summary.html">Java</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Braket.html">JavaScript</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Braket.BraketClient.html">PHP</a> </p> </li> <li> <p> <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/braket.html">Python (Boto)</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Braket.html">Ruby</a> </p> </li> </ul> <p> <b>Code examples from the Amazon Braket Tutorials GitHub repository:</b> </p> <ul> <li> <p> <a href="https://github.com/amazon-braket/amazon-braket-examples">Amazon Braket Examples</a> </p> </li> </ul>
247 238
* @public
248 239
*/
249 240
export class Braket extends BraketClient implements Braket {}
@@ -307,16 +307,7 @@ export type BraketClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
307 307
export interface BraketClientResolvedConfig extends BraketClientResolvedConfigType {}
308 308 309 309
/**
310 -
* <p>The Amazon Braket API Reference provides information about the operations and structures
311 -
* supported in Amazon Braket.</p>
312 -
* <p>Additional Resources:</p>
313 -
* <ul>
314 -
* <li>
315 -
* <p>
316 -
* <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
317 -
* </p>
318 -
* </li>
319 -
* </ul>
310 +
* <p>The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.</p> <p>To learn about the permissions required to call an Amazon Braket API action, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonbraket.html">Actions, resources, and condition keys for Amazon Braket</a>. <a href="https://amazon-braket-sdk-python.readthedocs.io/en/latest/#">Amazon Braket Python SDK</a> and the <a href="https://docs.aws.amazon.com/cli/latest/reference/braket/">AWS Command Line Interface</a> can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">What is Amazon Braket?</a> and important <a href="https://docs.aws.amazon.com/braket/latest/developerguide/braket-terms.html">terms and concepts</a> in the <i>Amazon Braket Developer Guide</i>.</p> <p> <b>In this guide:</b> </p> <ul> <li> <p/> </li> <li> <p/> </li> <li> <p> <a>CommonParameters</a> </p> </li> <li> <p> <a>CommonErrors</a> </p> </li> </ul> <p> <b>Available languages for AWS SDK:</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Braket/NBraket.html">.NET</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/cpp/api/LATEST/root/html/index.html">C++</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/braket/">Go API reference</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/braket/package-summary.html">Java</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Braket.html">JavaScript</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Braket.BraketClient.html">PHP</a> </p> </li> <li> <p> <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/braket.html">Python (Boto)</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Braket.html">Ruby</a> </p> </li> </ul> <p> <b>Code examples from the Amazon Braket Tutorials GitHub repository:</b> </p> <ul> <li> <p> <a href="https://github.com/amazon-braket/amazon-braket-examples">Amazon Braket Examples</a> </p> </li> </ul>
320 311
* @public
321 312
*/
322 313
export class BraketClient extends __Client<
@@ -28,7 +28,7 @@ export interface CancelJobCommandInput extends CancelJobRequest {}
28 28
export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Cancels an Amazon Braket job.</p>
31 +
* <p>Cancels an Amazon Braket hybrid job.</p>
32 32
* @example
33 33
* Use a bare-bones client and the command you need to make an API call.
34 34
* ```javascript
@@ -54,23 +54,22 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
54 54
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
55 55
*
56 56
* @throws {@link AccessDeniedException} (client fault)
57 -
* <p>You do not have sufficient access to perform this action.</p>
57 +
* <p>You do not have sufficient permissions to perform this action.</p>
58 58
*
59 59
* @throws {@link ConflictException} (client fault)
60 60
* <p>An error occurred due to a conflict.</p>
61 61
*
62 62
* @throws {@link InternalServiceException} (server fault)
63 -
* <p>The request processing has failed because of an unknown error, exception, or
64 -
* failure.</p>
63 +
* <p>The request failed because of an unknown error.</p>
65 64
*
66 65
* @throws {@link ResourceNotFoundException} (client fault)
67 66
* <p>The specified resource was not found.</p>
68 67
*
69 68
* @throws {@link ThrottlingException} (client fault)
70 -
* <p>The throttling rate limit is met.</p>
69 +
* <p>The API throttling rate limit is exceeded.</p>
71 70
*
72 71
* @throws {@link ValidationException} (client fault)
73 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
72 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
74 73
*
75 74
* @throws {@link BraketServiceException}
76 75
* <p>Base exception class for all service exceptions from Braket service.</p>
@@ -55,23 +55,22 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons
55 55
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
56 56
*
57 57
* @throws {@link AccessDeniedException} (client fault)
58 -
* <p>You do not have sufficient access to perform this action.</p>
58 +
* <p>You do not have sufficient permissions to perform this action.</p>
59 59
*
60 60
* @throws {@link ConflictException} (client fault)
61 61
* <p>An error occurred due to a conflict.</p>
62 62
*
63 63
* @throws {@link InternalServiceException} (server fault)
64 -
* <p>The request processing has failed because of an unknown error, exception, or
65 -
* failure.</p>
64 +
* <p>The request failed because of an unknown error.</p>
66 65
*
67 66
* @throws {@link ResourceNotFoundException} (client fault)
68 67
* <p>The specified resource was not found.</p>
69 68
*
70 69
* @throws {@link ThrottlingException} (client fault)
71 -
* <p>The throttling rate limit is met.</p>
70 +
* <p>The API throttling rate limit is exceeded.</p>
72 71
*
73 72
* @throws {@link ValidationException} (client fault)
74 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
73 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
75 74
*
76 75
* @throws {@link BraketServiceException}
77 76
* <p>Base exception class for all service exceptions from Braket service.</p>
@@ -28,7 +28,7 @@ export interface CreateJobCommandInput extends CreateJobRequest {}
28 28
export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Creates an Amazon Braket job.</p>
31 +
* <p>Creates an Amazon Braket hybrid job.</p>
32 32
* @example
33 33
* Use a bare-bones client and the command you need to make an API call.
34 34
* ```javascript
@@ -107,7 +107,7 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
107 107
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
108 108
*
109 109
* @throws {@link AccessDeniedException} (client fault)
110 -
* <p>You do not have sufficient access to perform this action.</p>
110 +
* <p>You do not have sufficient permissions to perform this action.</p>
111 111
*
112 112
* @throws {@link ConflictException} (client fault)
113 113
* <p>An error occurred due to a conflict.</p>
@@ -119,17 +119,16 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
119 119
* <p>The specified device has been retired.</p>
120 120
*
121 121
* @throws {@link InternalServiceException} (server fault)
122 -
* <p>The request processing has failed because of an unknown error, exception, or
123 -
* failure.</p>
122 +
* <p>The request failed because of an unknown error.</p>
124 123
*
125 124
* @throws {@link ServiceQuotaExceededException} (client fault)
126 125
* <p>The request failed because a service quota is exceeded.</p>
127 126
*
128 127
* @throws {@link ThrottlingException} (client fault)
129 -
* <p>The throttling rate limit is met.</p>
128 +
* <p>The API throttling rate limit is exceeded.</p>
130 129
*
131 130
* @throws {@link ValidationException} (client fault)
132 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
131 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
133 132
*
134 133
* @throws {@link BraketServiceException}
135 134
* <p>Base exception class for all service exceptions from Braket service.</p>
@@ -69,7 +69,7 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
69 69
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
70 70
*
71 71
* @throws {@link AccessDeniedException} (client fault)
72 -
* <p>You do not have sufficient access to perform this action.</p>
72 +
* <p>You do not have sufficient permissions to perform this action.</p>
73 73
*
74 74
* @throws {@link DeviceOfflineException} (client fault)
75 75
* <p>The specified device is currently offline.</p>
@@ -78,17 +78,16 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
78 78
* <p>The specified device has been retired.</p>
79 79
*
80 80
* @throws {@link InternalServiceException} (server fault)
81 -
* <p>The request processing has failed because of an unknown error, exception, or
82 -
* failure.</p>
81 +
* <p>The request failed because of an unknown error.</p>
83 82
*
84 83
* @throws {@link ServiceQuotaExceededException} (client fault)
85 84
* <p>The request failed because a service quota is exceeded.</p>
86 85
*
87 86
* @throws {@link ThrottlingException} (client fault)
88 -
* <p>The throttling rate limit is met.</p>
87 +
* <p>The API throttling rate limit is exceeded.</p>
89 88
*
90 89
* @throws {@link ValidationException} (client fault)
91 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
90 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
92 91
*
93 92
* @throws {@link BraketServiceException}
94 93
* <p>Base exception class for all service exceptions from Braket service.</p>
@@ -28,16 +28,7 @@ export interface GetDeviceCommandInput extends GetDeviceRequest {}
28 28
export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Retrieves the devices available in Amazon Braket.</p>
32 -
* <note>
33 -
* <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
34 -
* information is omitted from GetDevice API calls. To get this information the user-agent
35 -
* needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK
36 -
* automatically reports this for you. If you do not see OpenQASM results in the GetDevice
37 -
* response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment
38 -
* variable to configure user-agent. See the code examples provided below for how to do
39 -
* this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p>
40 -
* </note>
31 +
* <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>
41 32
* @example
42 33
* Use a bare-bones client and the command you need to make an API call.
43 34
* ```javascript
@@ -74,20 +65,19 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
74 65
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
75 66
*
76 67
* @throws {@link AccessDeniedException} (client fault)
77 -
* <p>You do not have sufficient access to perform this action.</p>
68 +
* <p>You do not have sufficient permissions to perform this action.</p>
78 69
*
79 70
* @throws {@link InternalServiceException} (server fault)
80 -
* <p>The request processing has failed because of an unknown error, exception, or
81 -
* failure.</p>
71 +
* <p>The request failed because of an unknown error.</p>
82 72
*
83 73
* @throws {@link ResourceNotFoundException} (client fault)
84 74
* <p>The specified resource was not found.</p>
85 75
*
86 76
* @throws {@link ThrottlingException} (client fault)
87 -
* <p>The throttling rate limit is met.</p>
77 +
* <p>The API throttling rate limit is exceeded.</p>
88 78
*
89 79
* @throws {@link ValidationException} (client fault)
90 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
80 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
91 81
*
92 82
* @throws {@link BraketServiceException}
93 83
* <p>Base exception class for all service exceptions from Braket service.</p>
@@ -28,7 +28,7 @@ export interface GetJobCommandInput extends GetJobRequest {}
28 28
export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {}
29 29 30 30
/**
31 -
* <p>Retrieves the specified Amazon Braket job.</p>
31 +
* <p>Retrieves the specified Amazon Braket hybrid job.</p>
32 32
* @example
33 33
* Use a bare-bones client and the command you need to make an API call.
34 34
* ```javascript
@@ -128,20 +128,19 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {}
128 128
* @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
129 129
*
130 130
* @throws {@link AccessDeniedException} (client fault)
131 -
* <p>You do not have sufficient access to perform this action.</p>
131 +
* <p>You do not have sufficient permissions to perform this action.</p>
132 132
*
133 133
* @throws {@link InternalServiceException} (server fault)
134 -
* <p>The request processing has failed because of an unknown error, exception, or
135 -
* failure.</p>
134 +
* <p>The request failed because of an unknown error.</p>
136 135
*
137 136
* @throws {@link ResourceNotFoundException} (client fault)
138 137
* <p>The specified resource was not found.</p>
139 138
*
140 139
* @throws {@link ThrottlingException} (client fault)
141 -
* <p>The throttling rate limit is met.</p>
140 +
* <p>The API throttling rate limit is exceeded.</p>
142 141
*
143 142
* @throws {@link ValidationException} (client fault)
144 -
* <p>The input fails to satisfy the constraints specified by an AWS service.</p>
143 +
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
145 144
*
146 145
* @throws {@link BraketServiceException}
147 146
* <p>Base exception class for all service exceptions from Braket service.</p>
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4