@aws-sdk/client-braket 3.321.1 → 3.326.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.
@@ -31,6 +31,11 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
31
31
  * };
32
32
  * const command = new CancelJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // CancelJobResponse
35
+ * // jobArn: "STRING_VALUE", // required
36
+ * // cancellationStatus: "STRING_VALUE", // required
37
+ * // };
38
+ *
34
39
  * ```
35
40
  *
36
41
  * @param CancelJobCommandInput - {@link CancelJobCommandInput}
@@ -58,6 +63,8 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea
58
63
  * @throws {@link ValidationException} (client fault)
59
64
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
60
65
  *
66
+ * @throws {@link BraketServiceException}
67
+ * <p>Base exception class for all service exceptions from Braket service.</p>
61
68
  *
62
69
  */
63
70
  export declare class CancelJobCommand extends $Command<CancelJobCommandInput, CancelJobCommandOutput, BraketClientResolvedConfig> {
@@ -32,6 +32,11 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons
32
32
  * };
33
33
  * const command = new CancelQuantumTaskCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // CancelQuantumTaskResponse
36
+ * // quantumTaskArn: "STRING_VALUE", // required
37
+ * // cancellationStatus: "STRING_VALUE", // required
38
+ * // };
39
+ *
35
40
  * ```
36
41
  *
37
42
  * @param CancelQuantumTaskCommandInput - {@link CancelQuantumTaskCommandInput}
@@ -59,6 +64,8 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons
59
64
  * @throws {@link ValidationException} (client fault)
60
65
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
61
66
  *
67
+ * @throws {@link BraketServiceException}
68
+ * <p>Base exception class for all service exceptions from Braket service.</p>
62
69
  *
63
70
  */
64
71
  export declare class CancelQuantumTaskCommand extends $Command<CancelQuantumTaskCommandInput, CancelQuantumTaskCommandOutput, BraketClientResolvedConfig> {
@@ -79,6 +79,10 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
79
79
  * };
80
80
  * const command = new CreateJobCommand(input);
81
81
  * const response = await client.send(command);
82
+ * // { // CreateJobResponse
83
+ * // jobArn: "STRING_VALUE", // required
84
+ * // };
85
+ *
82
86
  * ```
83
87
  *
84
88
  * @param CreateJobCommandInput - {@link CreateJobCommandInput}
@@ -109,6 +113,8 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea
109
113
  * @throws {@link ValidationException} (client fault)
110
114
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
111
115
  *
116
+ * @throws {@link BraketServiceException}
117
+ * <p>Base exception class for all service exceptions from Braket service.</p>
112
118
  *
113
119
  */
114
120
  export declare class CreateJobCommand extends $Command<CreateJobCommandInput, CreateJobCommandOutput, BraketClientResolvedConfig> {
@@ -41,6 +41,10 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
41
41
  * };
42
42
  * const command = new CreateQuantumTaskCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // CreateQuantumTaskResponse
45
+ * // quantumTaskArn: "STRING_VALUE", // required
46
+ * // };
47
+ *
44
48
  * ```
45
49
  *
46
50
  * @param CreateQuantumTaskCommandInput - {@link CreateQuantumTaskCommandInput}
@@ -71,6 +75,8 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons
71
75
  * @throws {@link ValidationException} (client fault)
72
76
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
73
77
  *
78
+ * @throws {@link BraketServiceException}
79
+ * <p>Base exception class for all service exceptions from Braket service.</p>
74
80
  *
75
81
  */
76
82
  export declare class CreateQuantumTaskCommand extends $Command<CreateQuantumTaskCommandInput, CreateQuantumTaskCommandOutput, BraketClientResolvedConfig> {
@@ -40,6 +40,15 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
40
40
  * };
41
41
  * const command = new GetDeviceCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // GetDeviceResponse
44
+ * // deviceArn: "STRING_VALUE", // required
45
+ * // deviceName: "STRING_VALUE", // required
46
+ * // providerName: "STRING_VALUE", // required
47
+ * // deviceType: "STRING_VALUE", // required
48
+ * // deviceStatus: "STRING_VALUE", // required
49
+ * // deviceCapabilities: "STRING_VALUE", // required
50
+ * // };
51
+ *
43
52
  * ```
44
53
  *
45
54
  * @param GetDeviceCommandInput - {@link GetDeviceCommandInput}
@@ -64,6 +73,8 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
64
73
  * @throws {@link ValidationException} (client fault)
65
74
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
66
75
  *
76
+ * @throws {@link BraketServiceException}
77
+ * <p>Base exception class for all service exceptions from Braket service.</p>
67
78
  *
68
79
  */
69
80
  export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, BraketClientResolvedConfig> {
@@ -31,6 +31,71 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
31
31
  * };
32
32
  * const command = new GetJobCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetJobResponse
35
+ * // status: "STRING_VALUE", // required
36
+ * // jobArn: "STRING_VALUE", // required
37
+ * // roleArn: "STRING_VALUE", // required
38
+ * // failureReason: "STRING_VALUE",
39
+ * // jobName: "STRING_VALUE", // required
40
+ * // hyperParameters: { // HyperParameters
41
+ * // "<keys>": "STRING_VALUE",
42
+ * // },
43
+ * // inputDataConfig: [ // InputConfigList
44
+ * // { // InputFileConfig
45
+ * // channelName: "STRING_VALUE", // required
46
+ * // contentType: "STRING_VALUE",
47
+ * // dataSource: { // DataSource
48
+ * // s3DataSource: { // S3DataSource
49
+ * // s3Uri: "STRING_VALUE", // required
50
+ * // },
51
+ * // },
52
+ * // },
53
+ * // ],
54
+ * // outputDataConfig: { // JobOutputDataConfig
55
+ * // kmsKeyId: "STRING_VALUE",
56
+ * // s3Path: "STRING_VALUE", // required
57
+ * // },
58
+ * // stoppingCondition: { // JobStoppingCondition
59
+ * // maxRuntimeInSeconds: Number("int"),
60
+ * // },
61
+ * // checkpointConfig: { // JobCheckpointConfig
62
+ * // localPath: "STRING_VALUE",
63
+ * // s3Uri: "STRING_VALUE", // required
64
+ * // },
65
+ * // algorithmSpecification: { // AlgorithmSpecification
66
+ * // scriptModeConfig: { // ScriptModeConfig
67
+ * // entryPoint: "STRING_VALUE", // required
68
+ * // s3Uri: "STRING_VALUE", // required
69
+ * // compressionType: "STRING_VALUE",
70
+ * // },
71
+ * // containerImage: { // ContainerImage
72
+ * // uri: "STRING_VALUE", // required
73
+ * // },
74
+ * // },
75
+ * // instanceConfig: { // InstanceConfig
76
+ * // instanceType: "STRING_VALUE", // required
77
+ * // volumeSizeInGb: Number("int"), // required
78
+ * // instanceCount: Number("int"),
79
+ * // },
80
+ * // createdAt: new Date("TIMESTAMP"), // required
81
+ * // startedAt: new Date("TIMESTAMP"),
82
+ * // endedAt: new Date("TIMESTAMP"),
83
+ * // billableDuration: Number("int"),
84
+ * // deviceConfig: { // DeviceConfig
85
+ * // device: "STRING_VALUE", // required
86
+ * // },
87
+ * // events: [ // JobEvents
88
+ * // { // JobEventDetails
89
+ * // eventType: "STRING_VALUE",
90
+ * // timeOfEvent: new Date("TIMESTAMP"),
91
+ * // message: "STRING_VALUE",
92
+ * // },
93
+ * // ],
94
+ * // tags: { // TagsMap
95
+ * // "<keys>": "STRING_VALUE",
96
+ * // },
97
+ * // };
98
+ *
34
99
  * ```
35
100
  *
36
101
  * @param GetJobCommandInput - {@link GetJobCommandInput}
@@ -55,6 +120,8 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
55
120
  * @throws {@link ValidationException} (client fault)
56
121
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
57
122
  *
123
+ * @throws {@link BraketServiceException}
124
+ * <p>Base exception class for all service exceptions from Braket service.</p>
58
125
  *
59
126
  */
60
127
  export declare class GetJobCommand extends $Command<GetJobCommandInput, GetJobCommandOutput, BraketClientResolvedConfig> {
@@ -31,6 +31,23 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M
31
31
  * };
32
32
  * const command = new GetQuantumTaskCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetQuantumTaskResponse
35
+ * // quantumTaskArn: "STRING_VALUE", // required
36
+ * // status: "STRING_VALUE", // required
37
+ * // failureReason: "STRING_VALUE",
38
+ * // deviceArn: "STRING_VALUE", // required
39
+ * // deviceParameters: "STRING_VALUE", // required
40
+ * // shots: Number("long"), // required
41
+ * // outputS3Bucket: "STRING_VALUE", // required
42
+ * // outputS3Directory: "STRING_VALUE", // required
43
+ * // createdAt: new Date("TIMESTAMP"), // required
44
+ * // endedAt: new Date("TIMESTAMP"),
45
+ * // tags: { // TagsMap
46
+ * // "<keys>": "STRING_VALUE",
47
+ * // },
48
+ * // jobArn: "STRING_VALUE",
49
+ * // };
50
+ *
34
51
  * ```
35
52
  *
36
53
  * @param GetQuantumTaskCommandInput - {@link GetQuantumTaskCommandInput}
@@ -55,6 +72,8 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M
55
72
  * @throws {@link ValidationException} (client fault)
56
73
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
57
74
  *
75
+ * @throws {@link BraketServiceException}
76
+ * <p>Base exception class for all service exceptions from Braket service.</p>
58
77
  *
59
78
  */
60
79
  export declare class GetQuantumTaskCommand extends $Command<GetQuantumTaskCommandInput, GetQuantumTaskCommandOutput, BraketClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // TagsMap
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -49,6 +55,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
49
55
  * @throws {@link ValidationException} (client fault)
50
56
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
51
57
  *
58
+ * @throws {@link BraketServiceException}
59
+ * <p>Base exception class for all service exceptions from Braket service.</p>
52
60
  *
53
61
  */
54
62
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, BraketClientResolvedConfig> {
@@ -40,6 +40,19 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met
40
40
  * };
41
41
  * const command = new SearchDevicesCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // SearchDevicesResponse
44
+ * // devices: [ // DeviceSummaryList // required
45
+ * // { // DeviceSummary
46
+ * // deviceArn: "STRING_VALUE", // required
47
+ * // deviceName: "STRING_VALUE", // required
48
+ * // providerName: "STRING_VALUE", // required
49
+ * // deviceType: "STRING_VALUE", // required
50
+ * // deviceStatus: "STRING_VALUE", // required
51
+ * // },
52
+ * // ],
53
+ * // nextToken: "STRING_VALUE",
54
+ * // };
55
+ *
43
56
  * ```
44
57
  *
45
58
  * @param SearchDevicesCommandInput - {@link SearchDevicesCommandInput}
@@ -61,6 +74,8 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met
61
74
  * @throws {@link ValidationException} (client fault)
62
75
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
63
76
  *
77
+ * @throws {@link BraketServiceException}
78
+ * <p>Base exception class for all service exceptions from Braket service.</p>
64
79
  *
65
80
  */
66
81
  export declare class SearchDevicesCommand extends $Command<SearchDevicesCommandInput, SearchDevicesCommandOutput, BraketClientResolvedConfig> {
@@ -41,6 +41,24 @@ export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataB
41
41
  * };
42
42
  * const command = new SearchJobsCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // SearchJobsResponse
45
+ * // jobs: [ // JobSummaryList // required
46
+ * // { // JobSummary
47
+ * // status: "STRING_VALUE", // required
48
+ * // jobArn: "STRING_VALUE", // required
49
+ * // jobName: "STRING_VALUE", // required
50
+ * // device: "STRING_VALUE", // required
51
+ * // createdAt: new Date("TIMESTAMP"), // required
52
+ * // startedAt: new Date("TIMESTAMP"),
53
+ * // endedAt: new Date("TIMESTAMP"),
54
+ * // tags: { // TagsMap
55
+ * // "<keys>": "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // nextToken: "STRING_VALUE",
60
+ * // };
61
+ *
44
62
  * ```
45
63
  *
46
64
  * @param SearchJobsCommandInput - {@link SearchJobsCommandInput}
@@ -62,6 +80,8 @@ export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataB
62
80
  * @throws {@link ValidationException} (client fault)
63
81
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
64
82
  *
83
+ * @throws {@link BraketServiceException}
84
+ * <p>Base exception class for all service exceptions from Braket service.</p>
65
85
  *
66
86
  */
67
87
  export declare class SearchJobsCommand extends $Command<SearchJobsCommandInput, SearchJobsCommandOutput, BraketClientResolvedConfig> {
@@ -41,6 +41,25 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo
41
41
  * };
42
42
  * const command = new SearchQuantumTasksCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // SearchQuantumTasksResponse
45
+ * // quantumTasks: [ // QuantumTaskSummaryList // required
46
+ * // { // QuantumTaskSummary
47
+ * // quantumTaskArn: "STRING_VALUE", // required
48
+ * // status: "STRING_VALUE", // required
49
+ * // deviceArn: "STRING_VALUE", // required
50
+ * // shots: Number("long"), // required
51
+ * // outputS3Bucket: "STRING_VALUE", // required
52
+ * // outputS3Directory: "STRING_VALUE", // required
53
+ * // createdAt: new Date("TIMESTAMP"), // required
54
+ * // endedAt: new Date("TIMESTAMP"),
55
+ * // tags: { // TagsMap
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // ],
60
+ * // nextToken: "STRING_VALUE",
61
+ * // };
62
+ *
44
63
  * ```
45
64
  *
46
65
  * @param SearchQuantumTasksCommandInput - {@link SearchQuantumTasksCommandInput}
@@ -62,6 +81,8 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo
62
81
  * @throws {@link ValidationException} (client fault)
63
82
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
64
83
  *
84
+ * @throws {@link BraketServiceException}
85
+ * <p>Base exception class for all service exceptions from Braket service.</p>
65
86
  *
66
87
  */
67
88
  export declare class SearchQuantumTasksCommand extends $Command<SearchQuantumTasksCommandInput, SearchQuantumTasksCommandOutput, BraketClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
52
54
  * @throws {@link ValidationException} (client fault)
53
55
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
54
56
  *
57
+ * @throws {@link BraketServiceException}
58
+ * <p>Base exception class for all service exceptions from Braket service.</p>
55
59
  *
56
60
  */
57
61
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BraketClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
52
54
  * @throws {@link ValidationException} (client fault)
53
55
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
54
56
  *
57
+ * @throws {@link BraketServiceException}
58
+ * <p>Base exception class for all service exceptions from Braket service.</p>
55
59
  *
56
60
  */
57
61
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BraketClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-braket",
3
3
  "description": "AWS SDK for JavaScript Braket Client for Node.js, Browser and React Native",
4
- "version": "3.321.1",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,33 +21,33 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.321.1",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.321.1",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
30
- "@aws-sdk/middleware-content-length": "3.310.0",
31
- "@aws-sdk/middleware-endpoint": "3.310.0",
32
- "@aws-sdk/middleware-host-header": "3.310.0",
33
- "@aws-sdk/middleware-logger": "3.310.0",
34
- "@aws-sdk/middleware-recursion-detection": "3.310.0",
35
- "@aws-sdk/middleware-retry": "3.310.0",
36
- "@aws-sdk/middleware-serde": "3.310.0",
37
- "@aws-sdk/middleware-signing": "3.310.0",
38
- "@aws-sdk/middleware-stack": "3.310.0",
39
- "@aws-sdk/middleware-user-agent": "3.319.0",
30
+ "@aws-sdk/middleware-content-length": "3.325.0",
31
+ "@aws-sdk/middleware-endpoint": "3.325.0",
32
+ "@aws-sdk/middleware-host-header": "3.325.0",
33
+ "@aws-sdk/middleware-logger": "3.325.0",
34
+ "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.325.0",
36
+ "@aws-sdk/middleware-serde": "3.325.0",
37
+ "@aws-sdk/middleware-signing": "3.325.0",
38
+ "@aws-sdk/middleware-stack": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.325.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.316.0",
43
+ "@aws-sdk/smithy-client": "3.325.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.316.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.316.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
51
  "@aws-sdk/util-endpoints": "3.319.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",