@aws-sdk/client-braket 3.296.0 → 3.298.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.
Files changed (51) hide show
  1. package/dist-cjs/commands/CancelJobCommand.js +2 -3
  2. package/dist-cjs/commands/CancelQuantumTaskCommand.js +2 -3
  3. package/dist-cjs/commands/CreateJobCommand.js +2 -3
  4. package/dist-cjs/commands/CreateQuantumTaskCommand.js +2 -3
  5. package/dist-cjs/commands/GetDeviceCommand.js +2 -3
  6. package/dist-cjs/commands/GetJobCommand.js +2 -3
  7. package/dist-cjs/commands/GetQuantumTaskCommand.js +2 -3
  8. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  9. package/dist-cjs/commands/SearchDevicesCommand.js +2 -3
  10. package/dist-cjs/commands/SearchJobsCommand.js +2 -3
  11. package/dist-cjs/commands/SearchQuantumTasksCommand.js +2 -3
  12. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  13. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  14. package/dist-cjs/models/models_0.js +1 -178
  15. package/dist-es/commands/CancelJobCommand.js +2 -3
  16. package/dist-es/commands/CancelQuantumTaskCommand.js +2 -3
  17. package/dist-es/commands/CreateJobCommand.js +2 -3
  18. package/dist-es/commands/CreateQuantumTaskCommand.js +2 -3
  19. package/dist-es/commands/GetDeviceCommand.js +2 -3
  20. package/dist-es/commands/GetJobCommand.js +2 -3
  21. package/dist-es/commands/GetQuantumTaskCommand.js +2 -3
  22. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  23. package/dist-es/commands/SearchDevicesCommand.js +2 -3
  24. package/dist-es/commands/SearchJobsCommand.js +2 -3
  25. package/dist-es/commands/SearchQuantumTasksCommand.js +2 -3
  26. package/dist-es/commands/TagResourceCommand.js +2 -3
  27. package/dist-es/commands/UntagResourceCommand.js +2 -3
  28. package/dist-es/models/models_0.js +0 -132
  29. package/dist-types/Braket.d.ts +14 -0
  30. package/dist-types/BraketClient.d.ts +24 -4
  31. package/dist-types/commands/CancelJobCommand.d.ts +16 -0
  32. package/dist-types/commands/CancelQuantumTaskCommand.d.ts +16 -0
  33. package/dist-types/commands/CreateJobCommand.d.ts +16 -0
  34. package/dist-types/commands/CreateQuantumTaskCommand.d.ts +16 -0
  35. package/dist-types/commands/GetDeviceCommand.d.ts +16 -0
  36. package/dist-types/commands/GetJobCommand.d.ts +16 -0
  37. package/dist-types/commands/GetQuantumTaskCommand.d.ts +16 -0
  38. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/SearchDevicesCommand.d.ts +16 -0
  40. package/dist-types/commands/SearchJobsCommand.d.ts +16 -0
  41. package/dist-types/commands/SearchQuantumTasksCommand.d.ts +16 -0
  42. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  43. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  44. package/dist-types/models/BraketServiceException.d.ts +2 -0
  45. package/dist-types/models/models_0.d.ts +135 -176
  46. package/dist-types/pagination/Interfaces.d.ts +3 -0
  47. package/dist-types/pagination/SearchDevicesPaginator.d.ts +3 -0
  48. package/dist-types/pagination/SearchJobsPaginator.d.ts +3 -0
  49. package/dist-types/pagination/SearchQuantumTasksPaginator.d.ts +3 -0
  50. package/dist-types/ts3.4/models/models_0.d.ts +0 -124
  51. package/package.json +4 -3
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { SearchJobsRequestFilterSensitiveLog, SearchJobsResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1SearchJobsCommand, serializeAws_restJson1SearchJobsCommand, } from "../protocols/Aws_restJson1";
6
5
  export class SearchJobsCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class SearchJobsCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: SearchJobsRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: SearchJobsResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { SearchQuantumTasksRequestFilterSensitiveLog, SearchQuantumTasksResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1SearchQuantumTasksCommand, serializeAws_restJson1SearchQuantumTasksCommand, } from "../protocols/Aws_restJson1";
6
5
  export class SearchQuantumTasksCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class SearchQuantumTasksCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: SearchQuantumTasksRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: SearchQuantumTasksResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { TagResourceRequestFilterSensitiveLog, TagResourceResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1TagResourceCommand, serializeAws_restJson1TagResourceCommand, } from "../protocols/Aws_restJson1";
6
5
  export class TagResourceCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class TagResourceCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: TagResourceRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: TagResourceResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -1,7 +1,6 @@
1
1
  import { getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@aws-sdk/middleware-serde";
3
3
  import { Command as $Command } from "@aws-sdk/smithy-client";
4
- import { UntagResourceRequestFilterSensitiveLog, UntagResourceResponseFilterSensitiveLog, } from "../models/models_0";
5
4
  import { deserializeAws_restJson1UntagResourceCommand, serializeAws_restJson1UntagResourceCommand, } from "../protocols/Aws_restJson1";
6
5
  export class UntagResourceCommand extends $Command {
7
6
  static getEndpointParameterInstructions() {
@@ -27,8 +26,8 @@ export class UntagResourceCommand extends $Command {
27
26
  logger,
28
27
  clientName,
29
28
  commandName,
30
- inputFilterSensitiveLog: UntagResourceRequestFilterSensitiveLog,
31
- outputFilterSensitiveLog: UntagResourceResponseFilterSensitiveLog,
29
+ inputFilterSensitiveLog: (_) => _,
30
+ outputFilterSensitiveLog: (_) => _,
32
31
  };
33
32
  const { requestHandler } = configuration;
34
33
  return stack.resolve((request) => requestHandler.handle(request.request, options || {}), handlerExecutionContext);
@@ -222,135 +222,3 @@ export var SearchQuantumTasksFilterOperator;
222
222
  SearchQuantumTasksFilterOperator["LT"] = "LT";
223
223
  SearchQuantumTasksFilterOperator["LTE"] = "LTE";
224
224
  })(SearchQuantumTasksFilterOperator || (SearchQuantumTasksFilterOperator = {}));
225
- export const ContainerImageFilterSensitiveLog = (obj) => ({
226
- ...obj,
227
- });
228
- export const ScriptModeConfigFilterSensitiveLog = (obj) => ({
229
- ...obj,
230
- });
231
- export const AlgorithmSpecificationFilterSensitiveLog = (obj) => ({
232
- ...obj,
233
- });
234
- export const GetDeviceRequestFilterSensitiveLog = (obj) => ({
235
- ...obj,
236
- });
237
- export const GetDeviceResponseFilterSensitiveLog = (obj) => ({
238
- ...obj,
239
- });
240
- export const SearchDevicesFilterFilterSensitiveLog = (obj) => ({
241
- ...obj,
242
- });
243
- export const SearchDevicesRequestFilterSensitiveLog = (obj) => ({
244
- ...obj,
245
- });
246
- export const DeviceSummaryFilterSensitiveLog = (obj) => ({
247
- ...obj,
248
- });
249
- export const SearchDevicesResponseFilterSensitiveLog = (obj) => ({
250
- ...obj,
251
- });
252
- export const CancelJobRequestFilterSensitiveLog = (obj) => ({
253
- ...obj,
254
- });
255
- export const CancelJobResponseFilterSensitiveLog = (obj) => ({
256
- ...obj,
257
- });
258
- export const JobCheckpointConfigFilterSensitiveLog = (obj) => ({
259
- ...obj,
260
- });
261
- export const DeviceConfigFilterSensitiveLog = (obj) => ({
262
- ...obj,
263
- });
264
- export const S3DataSourceFilterSensitiveLog = (obj) => ({
265
- ...obj,
266
- });
267
- export const DataSourceFilterSensitiveLog = (obj) => ({
268
- ...obj,
269
- });
270
- export const InputFileConfigFilterSensitiveLog = (obj) => ({
271
- ...obj,
272
- });
273
- export const InstanceConfigFilterSensitiveLog = (obj) => ({
274
- ...obj,
275
- });
276
- export const JobOutputDataConfigFilterSensitiveLog = (obj) => ({
277
- ...obj,
278
- });
279
- export const JobStoppingConditionFilterSensitiveLog = (obj) => ({
280
- ...obj,
281
- });
282
- export const CreateJobRequestFilterSensitiveLog = (obj) => ({
283
- ...obj,
284
- });
285
- export const CreateJobResponseFilterSensitiveLog = (obj) => ({
286
- ...obj,
287
- });
288
- export const GetJobRequestFilterSensitiveLog = (obj) => ({
289
- ...obj,
290
- });
291
- export const JobEventDetailsFilterSensitiveLog = (obj) => ({
292
- ...obj,
293
- });
294
- export const GetJobResponseFilterSensitiveLog = (obj) => ({
295
- ...obj,
296
- });
297
- export const SearchJobsFilterFilterSensitiveLog = (obj) => ({
298
- ...obj,
299
- });
300
- export const SearchJobsRequestFilterSensitiveLog = (obj) => ({
301
- ...obj,
302
- });
303
- export const JobSummaryFilterSensitiveLog = (obj) => ({
304
- ...obj,
305
- });
306
- export const SearchJobsResponseFilterSensitiveLog = (obj) => ({
307
- ...obj,
308
- });
309
- export const ListTagsForResourceRequestFilterSensitiveLog = (obj) => ({
310
- ...obj,
311
- });
312
- export const ListTagsForResourceResponseFilterSensitiveLog = (obj) => ({
313
- ...obj,
314
- });
315
- export const CancelQuantumTaskRequestFilterSensitiveLog = (obj) => ({
316
- ...obj,
317
- });
318
- export const CancelQuantumTaskResponseFilterSensitiveLog = (obj) => ({
319
- ...obj,
320
- });
321
- export const CreateQuantumTaskRequestFilterSensitiveLog = (obj) => ({
322
- ...obj,
323
- });
324
- export const CreateQuantumTaskResponseFilterSensitiveLog = (obj) => ({
325
- ...obj,
326
- });
327
- export const GetQuantumTaskRequestFilterSensitiveLog = (obj) => ({
328
- ...obj,
329
- });
330
- export const GetQuantumTaskResponseFilterSensitiveLog = (obj) => ({
331
- ...obj,
332
- });
333
- export const SearchQuantumTasksFilterFilterSensitiveLog = (obj) => ({
334
- ...obj,
335
- });
336
- export const SearchQuantumTasksRequestFilterSensitiveLog = (obj) => ({
337
- ...obj,
338
- });
339
- export const QuantumTaskSummaryFilterSensitiveLog = (obj) => ({
340
- ...obj,
341
- });
342
- export const SearchQuantumTasksResponseFilterSensitiveLog = (obj) => ({
343
- ...obj,
344
- });
345
- export const TagResourceRequestFilterSensitiveLog = (obj) => ({
346
- ...obj,
347
- });
348
- export const TagResourceResponseFilterSensitiveLog = (obj) => ({
349
- ...obj,
350
- });
351
- export const UntagResourceRequestFilterSensitiveLog = (obj) => ({
352
- ...obj,
353
- });
354
- export const UntagResourceResponseFilterSensitiveLog = (obj) => ({
355
- ...obj,
356
- });
@@ -14,6 +14,7 @@ import { SearchQuantumTasksCommandInput, SearchQuantumTasksCommandOutput } from
14
14
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
15
15
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
16
16
  /**
17
+ * @public
17
18
  * <p>The Amazon Braket API Reference provides information about the operations and structures
18
19
  * supported in Amazon Braket.</p>
19
20
  * <p>Additional Resources:</p>
@@ -27,30 +28,35 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
27
28
  */
28
29
  export declare class Braket extends BraketClient {
29
30
  /**
31
+ * @public
30
32
  * <p>Cancels an Amazon Braket job.</p>
31
33
  */
32
34
  cancelJob(args: CancelJobCommandInput, options?: __HttpHandlerOptions): Promise<CancelJobCommandOutput>;
33
35
  cancelJob(args: CancelJobCommandInput, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
34
36
  cancelJob(args: CancelJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelJobCommandOutput) => void): void;
35
37
  /**
38
+ * @public
36
39
  * <p>Cancels the specified task.</p>
37
40
  */
38
41
  cancelQuantumTask(args: CancelQuantumTaskCommandInput, options?: __HttpHandlerOptions): Promise<CancelQuantumTaskCommandOutput>;
39
42
  cancelQuantumTask(args: CancelQuantumTaskCommandInput, cb: (err: any, data?: CancelQuantumTaskCommandOutput) => void): void;
40
43
  cancelQuantumTask(args: CancelQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelQuantumTaskCommandOutput) => void): void;
41
44
  /**
45
+ * @public
42
46
  * <p>Creates an Amazon Braket job.</p>
43
47
  */
44
48
  createJob(args: CreateJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateJobCommandOutput>;
45
49
  createJob(args: CreateJobCommandInput, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
46
50
  createJob(args: CreateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateJobCommandOutput) => void): void;
47
51
  /**
52
+ * @public
48
53
  * <p>Creates a quantum task.</p>
49
54
  */
50
55
  createQuantumTask(args: CreateQuantumTaskCommandInput, options?: __HttpHandlerOptions): Promise<CreateQuantumTaskCommandOutput>;
51
56
  createQuantumTask(args: CreateQuantumTaskCommandInput, cb: (err: any, data?: CreateQuantumTaskCommandOutput) => void): void;
52
57
  createQuantumTask(args: CreateQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQuantumTaskCommandOutput) => void): void;
53
58
  /**
59
+ * @public
54
60
  * <p>Retrieves the devices available in Amazon Braket.</p>
55
61
  * <note>
56
62
  * <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
@@ -66,48 +72,56 @@ export declare class Braket extends BraketClient {
66
72
  getDevice(args: GetDeviceCommandInput, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;
67
73
  getDevice(args: GetDeviceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDeviceCommandOutput) => void): void;
68
74
  /**
75
+ * @public
69
76
  * <p>Retrieves the specified Amazon Braket job.</p>
70
77
  */
71
78
  getJob(args: GetJobCommandInput, options?: __HttpHandlerOptions): Promise<GetJobCommandOutput>;
72
79
  getJob(args: GetJobCommandInput, cb: (err: any, data?: GetJobCommandOutput) => void): void;
73
80
  getJob(args: GetJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobCommandOutput) => void): void;
74
81
  /**
82
+ * @public
75
83
  * <p>Retrieves the specified quantum task.</p>
76
84
  */
77
85
  getQuantumTask(args: GetQuantumTaskCommandInput, options?: __HttpHandlerOptions): Promise<GetQuantumTaskCommandOutput>;
78
86
  getQuantumTask(args: GetQuantumTaskCommandInput, cb: (err: any, data?: GetQuantumTaskCommandOutput) => void): void;
79
87
  getQuantumTask(args: GetQuantumTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQuantumTaskCommandOutput) => void): void;
80
88
  /**
89
+ * @public
81
90
  * <p>Shows the tags associated with this resource.</p>
82
91
  */
83
92
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
84
93
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
85
94
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
86
95
  /**
96
+ * @public
87
97
  * <p>Searches for devices using the specified filters.</p>
88
98
  */
89
99
  searchDevices(args: SearchDevicesCommandInput, options?: __HttpHandlerOptions): Promise<SearchDevicesCommandOutput>;
90
100
  searchDevices(args: SearchDevicesCommandInput, cb: (err: any, data?: SearchDevicesCommandOutput) => void): void;
91
101
  searchDevices(args: SearchDevicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchDevicesCommandOutput) => void): void;
92
102
  /**
103
+ * @public
93
104
  * <p>Searches for Amazon Braket jobs that match the specified filter values.</p>
94
105
  */
95
106
  searchJobs(args: SearchJobsCommandInput, options?: __HttpHandlerOptions): Promise<SearchJobsCommandOutput>;
96
107
  searchJobs(args: SearchJobsCommandInput, cb: (err: any, data?: SearchJobsCommandOutput) => void): void;
97
108
  searchJobs(args: SearchJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchJobsCommandOutput) => void): void;
98
109
  /**
110
+ * @public
99
111
  * <p>Searches for tasks that match the specified filter values.</p>
100
112
  */
101
113
  searchQuantumTasks(args: SearchQuantumTasksCommandInput, options?: __HttpHandlerOptions): Promise<SearchQuantumTasksCommandOutput>;
102
114
  searchQuantumTasks(args: SearchQuantumTasksCommandInput, cb: (err: any, data?: SearchQuantumTasksCommandOutput) => void): void;
103
115
  searchQuantumTasks(args: SearchQuantumTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchQuantumTasksCommandOutput) => void): void;
104
116
  /**
117
+ * @public
105
118
  * <p>Add a tag to the specified resource.</p>
106
119
  */
107
120
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
108
121
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
109
122
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
110
123
  /**
124
+ * @public
111
125
  * <p>Remove tags from a resource.</p>
112
126
  */
113
127
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
@@ -21,15 +21,24 @@ import { SearchQuantumTasksCommandInput, SearchQuantumTasksCommandOutput } from
21
21
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
22
22
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
23
23
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
24
+ /**
25
+ * @public
26
+ */
24
27
  export type ServiceInputTypes = CancelJobCommandInput | CancelQuantumTaskCommandInput | CreateJobCommandInput | CreateQuantumTaskCommandInput | GetDeviceCommandInput | GetJobCommandInput | GetQuantumTaskCommandInput | ListTagsForResourceCommandInput | SearchDevicesCommandInput | SearchJobsCommandInput | SearchQuantumTasksCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
28
+ /**
29
+ * @public
30
+ */
25
31
  export type ServiceOutputTypes = CancelJobCommandOutput | CancelQuantumTaskCommandOutput | CreateJobCommandOutput | CreateQuantumTaskCommandOutput | GetDeviceCommandOutput | GetJobCommandOutput | GetQuantumTaskCommandOutput | ListTagsForResourceCommandOutput | SearchDevicesCommandOutput | SearchJobsCommandOutput | SearchQuantumTasksCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
32
+ /**
33
+ * @public
34
+ */
26
35
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
27
36
  /**
28
37
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
29
38
  */
30
39
  requestHandler?: __HttpHandler;
31
40
  /**
32
- * A constructor for a class implementing the {@link __Checksum} interface
41
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
33
42
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
34
43
  * @internal
35
44
  */
@@ -119,23 +128,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
119
128
  */
120
129
  logger?: __Logger;
121
130
  /**
122
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
123
132
  */
124
133
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
125
134
  }
135
+ /**
136
+ * @public
137
+ */
126
138
  type BraketClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
127
139
  /**
128
- * The configuration interface of BraketClient class constructor that set the region, credentials and other options.
140
+ * @public
141
+ *
142
+ * The configuration interface of BraketClient class constructor that set the region, credentials and other options.
129
143
  */
130
144
  export interface BraketClientConfig extends BraketClientConfigType {
131
145
  }
146
+ /**
147
+ * @public
148
+ */
132
149
  type BraketClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
133
150
  /**
134
- * The resolved configuration interface of BraketClient class. This is resolved and normalized from the {@link BraketClientConfig | constructor configuration interface}.
151
+ * @public
152
+ *
153
+ * The resolved configuration interface of BraketClient class. This is resolved and normalized from the {@link BraketClientConfig | constructor configuration interface}.
135
154
  */
136
155
  export interface BraketClientResolvedConfig extends BraketClientResolvedConfigType {
137
156
  }
138
157
  /**
158
+ * @public
139
159
  * <p>The Amazon Braket API Reference provides information about the operations and structures
140
160
  * supported in Amazon Braket.</p>
141
161
  * <p>Additional Resources:</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
5
5
  import { CancelJobRequest, CancelJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelJobCommand}.
8
10
  */
9
11
  export interface CancelJobCommandInput extends CancelJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelJobCommand}.
13
17
  */
14
18
  export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancels an Amazon Braket job.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CancelJobCommandInput - {@link CancelJobCommandInput}
34
+ * @returns {@link CancelJobCommandOutput}
28
35
  * @see {@link CancelJobCommandInput} for command's `input` shape.
29
36
  * @see {@link CancelJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
53
60
  export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, BraketClientResolvedConfig> {
54
61
  readonly input: CancelJobCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CancelJobCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelJobCommandInput, CancelJobCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
5
5
  import { CancelQuantumTaskRequest, CancelQuantumTaskResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CancelQuantumTaskCommand}.
8
10
  */
9
11
  export interface CancelQuantumTaskCommandInput extends CancelQuantumTaskRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CancelQuantumTaskCommand}.
13
17
  */
14
18
  export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Cancels the specified task.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CancelQuantumTaskCommandInput - {@link CancelQuantumTaskCommandInput}
34
+ * @returns {@link CancelQuantumTaskCommandOutput}
28
35
  * @see {@link CancelQuantumTaskCommandInput} for command's `input` shape.
29
36
  * @see {@link CancelQuantumTaskCommandOutput} for command's `response` shape.
30
37
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -53,11 +60,20 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons
53
60
  export declare class CancelQuantumTaskCommand extends $Command<CancelQuantumTaskCommandInput, CancelQuantumTaskCommandOutput, BraketClientResolvedConfig> {
54
61
  readonly input: CancelQuantumTaskCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: CancelQuantumTaskCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelQuantumTaskCommandInput, CancelQuantumTaskCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
5
5
  import { CreateJobRequest, CreateJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateJobCommand}.
8
10
  */
9
11
  export interface CreateJobCommandInput extends CreateJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateJobCommand}.
13
17
  */
14
18
  export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Braket job.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateJobCommandInput - {@link CreateJobCommandInput}
34
+ * @returns {@link CreateJobCommandOutput}
28
35
  * @see {@link CreateJobCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateJobCommandOutput} for command's `response` shape.
30
37
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
56
63
  export declare class CreateJobCommand extends $Command<CreateJobCommandInput, CreateJobCommandOutput, BraketClientResolvedConfig> {
57
64
  readonly input: CreateJobCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateJobCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateJobCommandInput, CreateJobCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
5
5
  import { CreateQuantumTaskRequest, CreateQuantumTaskResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateQuantumTaskCommand}.
8
10
  */
9
11
  export interface CreateQuantumTaskCommandInput extends CreateQuantumTaskRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateQuantumTaskCommand}.
13
17
  */
14
18
  export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a quantum task.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateQuantumTaskCommandInput - {@link CreateQuantumTaskCommandInput}
34
+ * @returns {@link CreateQuantumTaskCommandOutput}
28
35
  * @see {@link CreateQuantumTaskCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateQuantumTaskCommandOutput} for command's `response` shape.
30
37
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
56
63
  export declare class CreateQuantumTaskCommand extends $Command<CreateQuantumTaskCommandInput, CreateQuantumTaskCommandOutput, BraketClientResolvedConfig> {
57
64
  readonly input: CreateQuantumTaskCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateQuantumTaskCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateQuantumTaskCommandInput, CreateQuantumTaskCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { BraketClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BraketClient";
5
5
  import { GetDeviceRequest, GetDeviceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDeviceCommand}.
8
10
  */
9
11
  export interface GetDeviceCommandInput extends GetDeviceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDeviceCommand}.
13
17
  */
14
18
  export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the devices available in Amazon Braket.</p>
18
23
  * <note>
19
24
  * <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM
@@ -34,6 +39,8 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param GetDeviceCommandInput - {@link GetDeviceCommandInput}
43
+ * @returns {@link GetDeviceCommandOutput}
37
44
  * @see {@link GetDeviceCommandInput} for command's `input` shape.
38
45
  * @see {@link GetDeviceCommandOutput} for command's `response` shape.
39
46
  * @see {@link BraketClientResolvedConfig | config} for BraketClient's `config` shape.
@@ -59,11 +66,20 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
59
66
  export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, BraketClientResolvedConfig> {
60
67
  readonly input: GetDeviceCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: GetDeviceCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: BraketClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeviceCommandInput, GetDeviceCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }