@aws-sdk/client-braket 3.864.0 → 3.872.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -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
 
package/dist-cjs/index.js CHANGED
@@ -60,6 +60,7 @@ __export(index_exports, {
60
60
  ThrottlingException: () => ThrottlingException,
61
61
  UntagResourceCommand: () => UntagResourceCommand,
62
62
  ValidationException: () => ValidationException,
63
+ ValidationExceptionReason: () => ValidationExceptionReason,
63
64
  _InstanceType: () => _InstanceType,
64
65
  __Client: () => import_smithy_client.Client,
65
66
  paginateSearchDevices: () => paginateSearchDevices,
@@ -335,12 +336,25 @@ var ThrottlingException = class _ThrottlingException extends BraketServiceExcept
335
336
  Object.setPrototypeOf(this, _ThrottlingException.prototype);
336
337
  }
337
338
  };
339
+ var ValidationExceptionReason = {
340
+ PROGRAM_SET_VALIDATION_FAILED: "ProgramSetValidationFailed"
341
+ };
338
342
  var ValidationException = class _ValidationException extends BraketServiceException {
339
343
  static {
340
344
  __name(this, "ValidationException");
341
345
  }
342
346
  name = "ValidationException";
343
347
  $fault = "client";
348
+ /**
349
+ * <p>The reason for validation failure.</p>
350
+ * @public
351
+ */
352
+ reason;
353
+ /**
354
+ * <p>The validation failures in the program set submitted in the request.</p>
355
+ * @public
356
+ */
357
+ programSetValidationFailures;
344
358
  /**
345
359
  * @internal
346
360
  */
@@ -351,6 +365,8 @@ var ValidationException = class _ValidationException extends BraketServiceExcept
351
365
  ...opts
352
366
  });
353
367
  Object.setPrototypeOf(this, _ValidationException.prototype);
368
+ this.reason = opts.reason;
369
+ this.programSetValidationFailures = opts.programSetValidationFailures;
354
370
  }
355
371
  };
356
372
  var CancellationStatus = {
@@ -843,6 +859,7 @@ var de_GetQuantumTaskCommand = /* @__PURE__ */ __name(async (output, context) =>
843
859
  });
844
860
  const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
845
861
  const doc = (0, import_smithy_client.take)(data, {
862
+ actionMetadata: import_smithy_client._json,
846
863
  associations: import_smithy_client._json,
847
864
  createdAt: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseRfc3339DateTimeWithOffset)(_)), "createdAt"),
848
865
  deviceArn: import_smithy_client.expectString,
@@ -850,6 +867,7 @@ var de_GetQuantumTaskCommand = /* @__PURE__ */ __name(async (output, context) =>
850
867
  endedAt: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseRfc3339DateTimeWithOffset)(_)), "endedAt"),
851
868
  failureReason: import_smithy_client.expectString,
852
869
  jobArn: import_smithy_client.expectString,
870
+ numSuccessfulShots: import_smithy_client.expectLong,
853
871
  outputS3Bucket: import_smithy_client.expectString,
854
872
  outputS3Directory: import_smithy_client.expectString,
855
873
  quantumTaskArn: import_smithy_client.expectString,
@@ -1092,7 +1110,9 @@ var de_ValidationExceptionRes = /* @__PURE__ */ __name(async (parsedOutput, cont
1092
1110
  const contents = (0, import_smithy_client.map)({});
1093
1111
  const data = parsedOutput.body;
1094
1112
  const doc = (0, import_smithy_client.take)(data, {
1095
- message: import_smithy_client.expectString
1113
+ message: import_smithy_client.expectString,
1114
+ programSetValidationFailures: import_smithy_client._json,
1115
+ reason: import_smithy_client.expectString
1096
1116
  });
1097
1117
  Object.assign(contents, doc);
1098
1118
  const exception = new ValidationException({
@@ -1420,6 +1440,7 @@ var paginateSearchQuantumTasks = (0, import_core.createPaginator)(BraketClient,
1420
1440
  InternalServiceException,
1421
1441
  ResourceNotFoundException,
1422
1442
  ThrottlingException,
1443
+ ValidationExceptionReason,
1423
1444
  ValidationException,
1424
1445
  CancellationStatus,
1425
1446
  ConflictException,
@@ -71,9 +71,14 @@ export class ThrottlingException extends __BaseException {
71
71
  Object.setPrototypeOf(this, ThrottlingException.prototype);
72
72
  }
73
73
  }
74
+ export const ValidationExceptionReason = {
75
+ PROGRAM_SET_VALIDATION_FAILED: "ProgramSetValidationFailed",
76
+ };
74
77
  export class ValidationException extends __BaseException {
75
78
  name = "ValidationException";
76
79
  $fault = "client";
80
+ reason;
81
+ programSetValidationFailures;
77
82
  constructor(opts) {
78
83
  super({
79
84
  name: "ValidationException",
@@ -81,6 +86,8 @@ export class ValidationException extends __BaseException {
81
86
  ...opts,
82
87
  });
83
88
  Object.setPrototypeOf(this, ValidationException.prototype);
89
+ this.reason = opts.reason;
90
+ this.programSetValidationFailures = opts.programSetValidationFailures;
84
91
  }
85
92
  }
86
93
  export const CancellationStatus = {
@@ -308,6 +308,7 @@ export const de_GetQuantumTaskCommand = async (output, context) => {
308
308
  });
309
309
  const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
310
310
  const doc = take(data, {
311
+ actionMetadata: _json,
311
312
  associations: _json,
312
313
  createdAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
313
314
  deviceArn: __expectString,
@@ -315,6 +316,7 @@ export const de_GetQuantumTaskCommand = async (output, context) => {
315
316
  endedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
316
317
  failureReason: __expectString,
317
318
  jobArn: __expectString,
319
+ numSuccessfulShots: __expectLong,
318
320
  outputS3Bucket: __expectString,
319
321
  outputS3Directory: __expectString,
320
322
  quantumTaskArn: __expectString,
@@ -558,6 +560,8 @@ const de_ValidationExceptionRes = async (parsedOutput, context) => {
558
560
  const data = parsedOutput.body;
559
561
  const doc = take(data, {
560
562
  message: __expectString,
563
+ programSetValidationFailures: _json,
564
+ reason: __expectString,
561
565
  });
562
566
  Object.assign(contents, doc);
563
567
  const exception = new ValidationException({
@@ -94,16 +94,7 @@ export interface Braket {
94
94
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
95
95
  }
96
96
  /**
97
- * <p>The Amazon Braket API Reference provides information about the operations and structures
98
- * supported in Amazon Braket.</p>
99
- * <p>Additional Resources:</p>
100
- * <ul>
101
- * <li>
102
- * <p>
103
- * <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
104
- * </p>
105
- * </li>
106
- * </ul>
97
+ * <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>
107
98
  * @public
108
99
  */
109
100
  export declare class Braket extends BraketClient implements Braket {
@@ -182,16 +182,7 @@ export type BraketClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
182
182
  export interface BraketClientResolvedConfig extends BraketClientResolvedConfigType {
183
183
  }
184
184
  /**
185
- * <p>The Amazon Braket API Reference provides information about the operations and structures
186
- * supported in Amazon Braket.</p>
187
- * <p>Additional Resources:</p>
188
- * <ul>
189
- * <li>
190
- * <p>
191
- * <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
192
- * </p>
193
- * </li>
194
- * </ul>
185
+ * <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>
195
186
  * @public
196
187
  */
197
188
  export declare class BraketClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BraketClientResolvedConfig> {
@@ -27,7 +27,7 @@ declare const CancelJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels an Amazon Braket job.</p>
30
+ * <p>Cancels an Amazon Braket hybrid job.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -53,23 +53,22 @@ declare const CancelJobCommand_base: {
53
53
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
54
54
  *
55
55
  * @throws {@link AccessDeniedException} (client fault)
56
- * <p>You do not have sufficient access to perform this action.</p>
56
+ * <p>You do not have sufficient permissions to perform this action.</p>
57
57
  *
58
58
  * @throws {@link ConflictException} (client fault)
59
59
  * <p>An error occurred due to a conflict.</p>
60
60
  *
61
61
  * @throws {@link InternalServiceException} (server fault)
62
- * <p>The request processing has failed because of an unknown error, exception, or
63
- * failure.</p>
62
+ * <p>The request failed because of an unknown error.</p>
64
63
  *
65
64
  * @throws {@link ResourceNotFoundException} (client fault)
66
65
  * <p>The specified resource was not found.</p>
67
66
  *
68
67
  * @throws {@link ThrottlingException} (client fault)
69
- * <p>The throttling rate limit is met.</p>
68
+ * <p>The API throttling rate limit is exceeded.</p>
70
69
  *
71
70
  * @throws {@link ValidationException} (client fault)
72
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
71
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
73
72
  *
74
73
  * @throws {@link BraketServiceException}
75
74
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -54,23 +54,22 @@ declare const CancelQuantumTaskCommand_base: {
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>
@@ -27,7 +27,7 @@ declare const CreateJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an Amazon Braket job.</p>
30
+ * <p>Creates an Amazon Braket hybrid job.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -106,7 +106,7 @@ declare const CreateJobCommand_base: {
106
106
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
107
107
  *
108
108
  * @throws {@link AccessDeniedException} (client fault)
109
- * <p>You do not have sufficient access to perform this action.</p>
109
+ * <p>You do not have sufficient permissions to perform this action.</p>
110
110
  *
111
111
  * @throws {@link ConflictException} (client fault)
112
112
  * <p>An error occurred due to a conflict.</p>
@@ -118,17 +118,16 @@ declare const CreateJobCommand_base: {
118
118
  * <p>The specified device has been retired.</p>
119
119
  *
120
120
  * @throws {@link InternalServiceException} (server fault)
121
- * <p>The request processing has failed because of an unknown error, exception, or
122
- * failure.</p>
121
+ * <p>The request failed because of an unknown error.</p>
123
122
  *
124
123
  * @throws {@link ServiceQuotaExceededException} (client fault)
125
124
  * <p>The request failed because a service quota is exceeded.</p>
126
125
  *
127
126
  * @throws {@link ThrottlingException} (client fault)
128
- * <p>The throttling rate limit is met.</p>
127
+ * <p>The API throttling rate limit is exceeded.</p>
129
128
  *
130
129
  * @throws {@link ValidationException} (client fault)
131
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
130
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
132
131
  *
133
132
  * @throws {@link BraketServiceException}
134
133
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -68,7 +68,7 @@ declare const CreateQuantumTaskCommand_base: {
68
68
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
69
69
  *
70
70
  * @throws {@link AccessDeniedException} (client fault)
71
- * <p>You do not have sufficient access to perform this action.</p>
71
+ * <p>You do not have sufficient permissions to perform this action.</p>
72
72
  *
73
73
  * @throws {@link DeviceOfflineException} (client fault)
74
74
  * <p>The specified device is currently offline.</p>
@@ -77,17 +77,16 @@ declare const CreateQuantumTaskCommand_base: {
77
77
  * <p>The specified device has been retired.</p>
78
78
  *
79
79
  * @throws {@link InternalServiceException} (server fault)
80
- * <p>The request processing has failed because of an unknown error, exception, or
81
- * failure.</p>
80
+ * <p>The request failed because of an unknown error.</p>
82
81
  *
83
82
  * @throws {@link ServiceQuotaExceededException} (client fault)
84
83
  * <p>The request failed because a service quota is exceeded.</p>
85
84
  *
86
85
  * @throws {@link ThrottlingException} (client fault)
87
- * <p>The throttling rate limit is met.</p>
86
+ * <p>The API throttling rate limit is exceeded.</p>
88
87
  *
89
88
  * @throws {@link ValidationException} (client fault)
90
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
89
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
91
90
  *
92
91
  * @throws {@link BraketServiceException}
93
92
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -27,16 +27,7 @@ declare const GetDeviceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the devices available in Amazon Braket.</p>
31
- * <note>
32
- * <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
33
- * information is omitted from GetDevice API calls. To get this information the user-agent
34
- * needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK
35
- * automatically reports this for you. If you do not see OpenQASM results in the GetDevice
36
- * response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment
37
- * variable to configure user-agent. See the code examples provided below for how to do
38
- * this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p>
39
- * </note>
30
+ * <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>
40
31
  * @example
41
32
  * Use a bare-bones client and the command you need to make an API call.
42
33
  * ```javascript
@@ -73,20 +64,19 @@ declare const GetDeviceCommand_base: {
73
64
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
74
65
  *
75
66
  * @throws {@link AccessDeniedException} (client fault)
76
- * <p>You do not have sufficient access to perform this action.</p>
67
+ * <p>You do not have sufficient permissions to perform this action.</p>
77
68
  *
78
69
  * @throws {@link InternalServiceException} (server fault)
79
- * <p>The request processing has failed because of an unknown error, exception, or
80
- * failure.</p>
70
+ * <p>The request failed because of an unknown error.</p>
81
71
  *
82
72
  * @throws {@link ResourceNotFoundException} (client fault)
83
73
  * <p>The specified resource was not found.</p>
84
74
  *
85
75
  * @throws {@link ThrottlingException} (client fault)
86
- * <p>The throttling rate limit is met.</p>
76
+ * <p>The API throttling rate limit is exceeded.</p>
87
77
  *
88
78
  * @throws {@link ValidationException} (client fault)
89
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
79
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
90
80
  *
91
81
  * @throws {@link BraketServiceException}
92
82
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -27,7 +27,7 @@ declare const GetJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the specified Amazon Braket job.</p>
30
+ * <p>Retrieves the specified Amazon Braket hybrid job.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -127,20 +127,19 @@ declare const GetJobCommand_base: {
127
127
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
128
128
  *
129
129
  * @throws {@link AccessDeniedException} (client fault)
130
- * <p>You do not have sufficient access to perform this action.</p>
130
+ * <p>You do not have sufficient permissions to perform this action.</p>
131
131
  *
132
132
  * @throws {@link InternalServiceException} (server fault)
133
- * <p>The request processing has failed because of an unknown error, exception, or
134
- * failure.</p>
133
+ * <p>The request failed because of an unknown error.</p>
135
134
  *
136
135
  * @throws {@link ResourceNotFoundException} (client fault)
137
136
  * <p>The specified resource was not found.</p>
138
137
  *
139
138
  * @throws {@link ThrottlingException} (client fault)
140
- * <p>The throttling rate limit is met.</p>
139
+ * <p>The API throttling rate limit is exceeded.</p>
141
140
  *
142
141
  * @throws {@link ValidationException} (client fault)
143
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
142
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
144
143
  *
145
144
  * @throws {@link BraketServiceException}
146
145
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -69,6 +69,12 @@ declare const GetQuantumTaskCommand_base: {
69
69
  * // type: "STRING_VALUE", // required
70
70
  * // },
71
71
  * // ],
72
+ * // numSuccessfulShots: Number("long"),
73
+ * // actionMetadata: { // ActionMetadata
74
+ * // actionType: "STRING_VALUE", // required
75
+ * // programCount: Number("long"),
76
+ * // executableCount: Number("long"),
77
+ * // },
72
78
  * // };
73
79
  *
74
80
  * ```
@@ -80,20 +86,19 @@ declare const GetQuantumTaskCommand_base: {
80
86
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
81
87
  *
82
88
  * @throws {@link AccessDeniedException} (client fault)
83
- * <p>You do not have sufficient access to perform this action.</p>
89
+ * <p>You do not have sufficient permissions to perform this action.</p>
84
90
  *
85
91
  * @throws {@link InternalServiceException} (server fault)
86
- * <p>The request processing has failed because of an unknown error, exception, or
87
- * failure.</p>
92
+ * <p>The request failed because of an unknown error.</p>
88
93
  *
89
94
  * @throws {@link ResourceNotFoundException} (client fault)
90
95
  * <p>The specified resource was not found.</p>
91
96
  *
92
97
  * @throws {@link ThrottlingException} (client fault)
93
- * <p>The throttling rate limit is met.</p>
98
+ * <p>The API throttling rate limit is exceeded.</p>
94
99
  *
95
100
  * @throws {@link ValidationException} (client fault)
96
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
101
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
97
102
  *
98
103
  * @throws {@link BraketServiceException}
99
104
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -54,14 +54,13 @@ declare const ListTagsForResourceCommand_base: {
54
54
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
55
55
  *
56
56
  * @throws {@link InternalServiceException} (server fault)
57
- * <p>The request processing has failed because of an unknown error, exception, or
58
- * failure.</p>
57
+ * <p>The request failed because of an unknown error.</p>
59
58
  *
60
59
  * @throws {@link ResourceNotFoundException} (client fault)
61
60
  * <p>The specified resource was not found.</p>
62
61
  *
63
62
  * @throws {@link ValidationException} (client fault)
64
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
63
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
65
64
  *
66
65
  * @throws {@link BraketServiceException}
67
66
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -70,17 +70,16 @@ declare const SearchDevicesCommand_base: {
70
70
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
71
71
  *
72
72
  * @throws {@link AccessDeniedException} (client fault)
73
- * <p>You do not have sufficient access to perform this action.</p>
73
+ * <p>You do not have sufficient permissions to perform this action.</p>
74
74
  *
75
75
  * @throws {@link InternalServiceException} (server fault)
76
- * <p>The request processing has failed because of an unknown error, exception, or
77
- * failure.</p>
76
+ * <p>The request failed because of an unknown error.</p>
78
77
  *
79
78
  * @throws {@link ThrottlingException} (client fault)
80
- * <p>The throttling rate limit is met.</p>
79
+ * <p>The API throttling rate limit is exceeded.</p>
81
80
  *
82
81
  * @throws {@link ValidationException} (client fault)
83
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
82
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
84
83
  *
85
84
  * @throws {@link BraketServiceException}
86
85
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -27,7 +27,7 @@ declare const SearchJobsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Searches for Amazon Braket jobs that match the specified filter values.</p>
30
+ * <p>Searches for Amazon Braket hybrid jobs that match the specified filter values.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -76,17 +76,16 @@ declare const SearchJobsCommand_base: {
76
76
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
77
77
  *
78
78
  * @throws {@link AccessDeniedException} (client fault)
79
- * <p>You do not have sufficient access to perform this action.</p>
79
+ * <p>You do not have sufficient permissions to perform this action.</p>
80
80
  *
81
81
  * @throws {@link InternalServiceException} (server fault)
82
- * <p>The request processing has failed because of an unknown error, exception, or
83
- * failure.</p>
82
+ * <p>The request failed because of an unknown error.</p>
84
83
  *
85
84
  * @throws {@link ThrottlingException} (client fault)
86
- * <p>The throttling rate limit is met.</p>
85
+ * <p>The API throttling rate limit is exceeded.</p>
87
86
  *
88
87
  * @throws {@link ValidationException} (client fault)
89
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
88
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
90
89
  *
91
90
  * @throws {@link BraketServiceException}
92
91
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -77,17 +77,16 @@ declare const SearchQuantumTasksCommand_base: {
77
77
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
78
78
  *
79
79
  * @throws {@link AccessDeniedException} (client fault)
80
- * <p>You do not have sufficient access to perform this action.</p>
80
+ * <p>You do not have sufficient permissions to perform this action.</p>
81
81
  *
82
82
  * @throws {@link InternalServiceException} (server fault)
83
- * <p>The request processing has failed because of an unknown error, exception, or
84
- * failure.</p>
83
+ * <p>The request failed because of an unknown error.</p>
85
84
  *
86
85
  * @throws {@link ThrottlingException} (client fault)
87
- * <p>The throttling rate limit is met.</p>
86
+ * <p>The API throttling rate limit is exceeded.</p>
88
87
  *
89
88
  * @throws {@link ValidationException} (client fault)
90
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
89
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
91
90
  *
92
91
  * @throws {@link BraketServiceException}
93
92
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -53,14 +53,13 @@ declare const TagResourceCommand_base: {
53
53
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
54
54
  *
55
55
  * @throws {@link InternalServiceException} (server fault)
56
- * <p>The request processing has failed because of an unknown error, exception, or
57
- * failure.</p>
56
+ * <p>The request failed because of an unknown error.</p>
58
57
  *
59
58
  * @throws {@link ResourceNotFoundException} (client fault)
60
59
  * <p>The specified resource was not found.</p>
61
60
  *
62
61
  * @throws {@link ValidationException} (client fault)
63
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
62
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
64
63
  *
65
64
  * @throws {@link BraketServiceException}
66
65
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -53,14 +53,13 @@ declare const UntagResourceCommand_base: {
53
53
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
54
54
  *
55
55
  * @throws {@link InternalServiceException} (server fault)
56
- * <p>The request processing has failed because of an unknown error, exception, or
57
- * failure.</p>
56
+ * <p>The request failed because of an unknown error.</p>
58
57
  *
59
58
  * @throws {@link ResourceNotFoundException} (client fault)
60
59
  * <p>The specified resource was not found.</p>
61
60
  *
62
61
  * @throws {@link ValidationException} (client fault)
63
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
62
+ * <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
64
63
  *
65
64
  * @throws {@link BraketServiceException}
66
65
  * <p>Base exception class for all service exceptions from Braket service.</p>
@@ -1,14 +1,5 @@
1
1
  /**
2
- * <p>The Amazon Braket API Reference provides information about the operations and structures
3
- * supported in Amazon Braket.</p>
4
- * <p>Additional Resources:</p>
5
- * <ul>
6
- * <li>
7
- * <p>
8
- * <a href="https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html">Amazon Braket Developer Guide</a>
9
- * </p>
10
- * </li>
11
- * </ul>
2
+ * <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>
12
3
  *
13
4
  * @packageDocumentation
14
5
  */