@aws-sdk/client-braket 3.300.0 → 3.303.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.
@@ -35,7 +35,7 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
35
35
  * import { BraketClient, GetDeviceCommand } from "@aws-sdk/client-braket"; // ES Modules import
36
36
  * // const { BraketClient, GetDeviceCommand } = require("@aws-sdk/client-braket"); // CommonJS import
37
37
  * const client = new BraketClient(config);
38
- * const input = {
38
+ * const input = { // GetDeviceRequest
39
39
  * deviceArn: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new GetDeviceCommand(input);
@@ -26,7 +26,7 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {
26
26
  * import { BraketClient, GetJobCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, GetJobCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // GetJobRequest
30
30
  * jobArn: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new GetJobCommand(input);
@@ -26,7 +26,7 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M
26
26
  * import { BraketClient, GetQuantumTaskCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, GetQuantumTaskCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // GetQuantumTaskRequest
30
30
  * quantumTaskArn: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new GetQuantumTaskCommand(input);
@@ -26,7 +26,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { BraketClient, ListTagsForResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, ListTagsForResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // ListTagsForResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
@@ -26,13 +26,13 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met
26
26
  * import { BraketClient, SearchDevicesCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, SearchDevicesCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // SearchDevicesRequest
30
30
  * nextToken: "STRING_VALUE",
31
31
  * maxResults: Number("int"),
32
- * filters: [ // required
33
- * {
32
+ * filters: [ // SearchDevicesFilterList // required
33
+ * { // SearchDevicesFilter
34
34
  * name: "STRING_VALUE", // required
35
- * values: [ // required
35
+ * values: [ // String256List // required
36
36
  * "STRING_VALUE",
37
37
  * ],
38
38
  * },
@@ -26,13 +26,13 @@ export interface SearchJobsCommandOutput extends SearchJobsResponse, __MetadataB
26
26
  * import { BraketClient, SearchJobsCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, SearchJobsCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // SearchJobsRequest
30
30
  * nextToken: "STRING_VALUE",
31
31
  * maxResults: Number("int"),
32
- * filters: [ // required
33
- * {
32
+ * filters: [ // SearchJobsFilterList // required
33
+ * { // SearchJobsFilter
34
34
  * name: "STRING_VALUE", // required
35
- * values: [ // required
35
+ * values: [ // String256List // required
36
36
  * "STRING_VALUE",
37
37
  * ],
38
38
  * operator: "STRING_VALUE", // required
@@ -26,13 +26,13 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo
26
26
  * import { BraketClient, SearchQuantumTasksCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, SearchQuantumTasksCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // SearchQuantumTasksRequest
30
30
  * nextToken: "STRING_VALUE",
31
31
  * maxResults: Number("int"),
32
- * filters: [ // required
33
- * {
32
+ * filters: [ // SearchQuantumTasksFilterList // required
33
+ * { // SearchQuantumTasksFilter
34
34
  * name: "STRING_VALUE", // required
35
- * values: [ // required
35
+ * values: [ // String256List // required
36
36
  * "STRING_VALUE",
37
37
  * ],
38
38
  * operator: "STRING_VALUE", // required
@@ -26,9 +26,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
26
  * import { BraketClient, TagResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, TagResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // TagResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
- * tags: { // required
31
+ * tags: { // TagsMap // required
32
32
  * "<keys>": "STRING_VALUE",
33
33
  * },
34
34
  * };
@@ -26,9 +26,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
26
  * import { BraketClient, UntagResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import
27
27
  * // const { BraketClient, UntagResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import
28
28
  * const client = new BraketClient(config);
29
- * const input = {
29
+ * const input = { // UntagResourceRequest
30
30
  * resourceArn: "STRING_VALUE", // required
31
- * tagKeys: [ // required
31
+ * tagKeys: [ // TagKeys // required
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * };
@@ -24,11 +24,16 @@ export interface ContainerImage {
24
24
  }
25
25
  /**
26
26
  * @public
27
+ * @enum
27
28
  */
28
- export declare enum CompressionType {
29
- GZIP = "GZIP",
30
- NONE = "NONE"
31
- }
29
+ export declare const CompressionType: {
30
+ readonly GZIP: "GZIP";
31
+ readonly NONE: "NONE";
32
+ };
33
+ /**
34
+ * @public
35
+ */
36
+ export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType];
32
37
  /**
33
38
  * @public
34
39
  * <p>Contains information about the Python scripts used for entry and by an Amazon Braket
@@ -76,19 +81,29 @@ export interface GetDeviceRequest {
76
81
  }
77
82
  /**
78
83
  * @public
84
+ * @enum
79
85
  */
80
- export declare enum DeviceStatus {
81
- OFFLINE = "OFFLINE",
82
- ONLINE = "ONLINE",
83
- RETIRED = "RETIRED"
84
- }
86
+ export declare const DeviceStatus: {
87
+ readonly OFFLINE: "OFFLINE";
88
+ readonly ONLINE: "ONLINE";
89
+ readonly RETIRED: "RETIRED";
90
+ };
85
91
  /**
86
92
  * @public
87
93
  */
88
- export declare enum DeviceType {
89
- QPU = "QPU",
90
- SIMULATOR = "SIMULATOR"
91
- }
94
+ export type DeviceStatus = (typeof DeviceStatus)[keyof typeof DeviceStatus];
95
+ /**
96
+ * @public
97
+ * @enum
98
+ */
99
+ export declare const DeviceType: {
100
+ readonly QPU: "QPU";
101
+ readonly SIMULATOR: "SIMULATOR";
102
+ };
103
+ /**
104
+ * @public
105
+ */
106
+ export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType];
92
107
  /**
93
108
  * @public
94
109
  */
@@ -252,11 +267,16 @@ export interface CancelJobRequest {
252
267
  }
253
268
  /**
254
269
  * @public
270
+ * @enum
255
271
  */
256
- export declare enum CancellationStatus {
257
- CANCELLED = "CANCELLED",
258
- CANCELLING = "CANCELLING"
259
- }
272
+ export declare const CancellationStatus: {
273
+ readonly CANCELLED: "CANCELLED";
274
+ readonly CANCELLING: "CANCELLING";
275
+ };
276
+ /**
277
+ * @public
278
+ */
279
+ export type CancellationStatus = (typeof CancellationStatus)[keyof typeof CancellationStatus];
260
280
  /**
261
281
  * @public
262
282
  */
@@ -352,48 +372,53 @@ export interface InputFileConfig {
352
372
  }
353
373
  /**
354
374
  * @public
375
+ * @enum
355
376
  */
356
- export declare enum _InstanceType {
357
- ML_C4_2XLARGE = "ml.c4.2xlarge",
358
- ML_C4_4XLARGE = "ml.c4.4xlarge",
359
- ML_C4_8XLARGE = "ml.c4.8xlarge",
360
- ML_C4_XLARGE = "ml.c4.xlarge",
361
- ML_C5N_18XLARGE = "ml.c5n.18xlarge",
362
- ML_C5N_2XLARGE = "ml.c5n.2xlarge",
363
- ML_C5N_4XLARGE = "ml.c5n.4xlarge",
364
- ML_C5N_9XLARGE = "ml.c5n.9xlarge",
365
- ML_C5N_XLARGE = "ml.c5n.xlarge",
366
- ML_C5_18XLARGE = "ml.c5.18xlarge",
367
- ML_C5_2XLARGE = "ml.c5.2xlarge",
368
- ML_C5_4XLARGE = "ml.c5.4xlarge",
369
- ML_C5_9XLARGE = "ml.c5.9xlarge",
370
- ML_C5_XLARGE = "ml.c5.xlarge",
371
- ML_G4DN_12XLARGE = "ml.g4dn.12xlarge",
372
- ML_G4DN_16XLARGE = "ml.g4dn.16xlarge",
373
- ML_G4DN_2XLARGE = "ml.g4dn.2xlarge",
374
- ML_G4DN_4XLARGE = "ml.g4dn.4xlarge",
375
- ML_G4DN_8XLARGE = "ml.g4dn.8xlarge",
376
- ML_G4DN_XLARGE = "ml.g4dn.xlarge",
377
- ML_M4_10XLARGE = "ml.m4.10xlarge",
378
- ML_M4_16XLARGE = "ml.m4.16xlarge",
379
- ML_M4_2XLARGE = "ml.m4.2xlarge",
380
- ML_M4_4XLARGE = "ml.m4.4xlarge",
381
- ML_M4_XLARGE = "ml.m4.xlarge",
382
- ML_M5_12XLARGE = "ml.m5.12xlarge",
383
- ML_M5_24XLARGE = "ml.m5.24xlarge",
384
- ML_M5_2XLARGE = "ml.m5.2xlarge",
385
- ML_M5_4XLARGE = "ml.m5.4xlarge",
386
- ML_M5_LARGE = "ml.m5.large",
387
- ML_M5_XLARGE = "ml.m5.xlarge",
388
- ML_P2_16XLARGE = "ml.p2.16xlarge",
389
- ML_P2_8XLARGE = "ml.p2.8xlarge",
390
- ML_P2_XLARGE = "ml.p2.xlarge",
391
- ML_P3DN_24XLARGE = "ml.p3dn.24xlarge",
392
- ML_P3_16XLARGE = "ml.p3.16xlarge",
393
- ML_P3_2XLARGE = "ml.p3.2xlarge",
394
- ML_P3_8XLARGE = "ml.p3.8xlarge",
395
- ML_P4D_24XLARGE = "ml.p4d.24xlarge"
396
- }
377
+ export declare const _InstanceType: {
378
+ readonly ML_C4_2XLARGE: "ml.c4.2xlarge";
379
+ readonly ML_C4_4XLARGE: "ml.c4.4xlarge";
380
+ readonly ML_C4_8XLARGE: "ml.c4.8xlarge";
381
+ readonly ML_C4_XLARGE: "ml.c4.xlarge";
382
+ readonly ML_C5N_18XLARGE: "ml.c5n.18xlarge";
383
+ readonly ML_C5N_2XLARGE: "ml.c5n.2xlarge";
384
+ readonly ML_C5N_4XLARGE: "ml.c5n.4xlarge";
385
+ readonly ML_C5N_9XLARGE: "ml.c5n.9xlarge";
386
+ readonly ML_C5N_XLARGE: "ml.c5n.xlarge";
387
+ readonly ML_C5_18XLARGE: "ml.c5.18xlarge";
388
+ readonly ML_C5_2XLARGE: "ml.c5.2xlarge";
389
+ readonly ML_C5_4XLARGE: "ml.c5.4xlarge";
390
+ readonly ML_C5_9XLARGE: "ml.c5.9xlarge";
391
+ readonly ML_C5_XLARGE: "ml.c5.xlarge";
392
+ readonly ML_G4DN_12XLARGE: "ml.g4dn.12xlarge";
393
+ readonly ML_G4DN_16XLARGE: "ml.g4dn.16xlarge";
394
+ readonly ML_G4DN_2XLARGE: "ml.g4dn.2xlarge";
395
+ readonly ML_G4DN_4XLARGE: "ml.g4dn.4xlarge";
396
+ readonly ML_G4DN_8XLARGE: "ml.g4dn.8xlarge";
397
+ readonly ML_G4DN_XLARGE: "ml.g4dn.xlarge";
398
+ readonly ML_M4_10XLARGE: "ml.m4.10xlarge";
399
+ readonly ML_M4_16XLARGE: "ml.m4.16xlarge";
400
+ readonly ML_M4_2XLARGE: "ml.m4.2xlarge";
401
+ readonly ML_M4_4XLARGE: "ml.m4.4xlarge";
402
+ readonly ML_M4_XLARGE: "ml.m4.xlarge";
403
+ readonly ML_M5_12XLARGE: "ml.m5.12xlarge";
404
+ readonly ML_M5_24XLARGE: "ml.m5.24xlarge";
405
+ readonly ML_M5_2XLARGE: "ml.m5.2xlarge";
406
+ readonly ML_M5_4XLARGE: "ml.m5.4xlarge";
407
+ readonly ML_M5_LARGE: "ml.m5.large";
408
+ readonly ML_M5_XLARGE: "ml.m5.xlarge";
409
+ readonly ML_P2_16XLARGE: "ml.p2.16xlarge";
410
+ readonly ML_P2_8XLARGE: "ml.p2.8xlarge";
411
+ readonly ML_P2_XLARGE: "ml.p2.xlarge";
412
+ readonly ML_P3DN_24XLARGE: "ml.p3dn.24xlarge";
413
+ readonly ML_P3_16XLARGE: "ml.p3.16xlarge";
414
+ readonly ML_P3_2XLARGE: "ml.p3.2xlarge";
415
+ readonly ML_P3_8XLARGE: "ml.p3.8xlarge";
416
+ readonly ML_P4D_24XLARGE: "ml.p4d.24xlarge";
417
+ };
418
+ /**
419
+ * @public
420
+ */
421
+ export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
397
422
  /**
398
423
  * @public
399
424
  * <p>Configures the resource instances to use while running the Amazon Braket hybrid job on
@@ -549,20 +574,25 @@ export interface GetJobRequest {
549
574
  }
550
575
  /**
551
576
  * @public
577
+ * @enum
552
578
  */
553
- export declare enum JobEventType {
554
- CANCELLED = "CANCELLED",
555
- COMPLETED = "COMPLETED",
556
- DEPRIORITIZED_DUE_TO_INACTIVITY = "DEPRIORITIZED_DUE_TO_INACTIVITY",
557
- DOWNLOADING_DATA = "DOWNLOADING_DATA",
558
- FAILED = "FAILED",
559
- MAX_RUNTIME_EXCEEDED = "MAX_RUNTIME_EXCEEDED",
560
- QUEUED_FOR_EXECUTION = "QUEUED_FOR_EXECUTION",
561
- RUNNING = "RUNNING",
562
- STARTING_INSTANCE = "STARTING_INSTANCE",
563
- UPLOADING_RESULTS = "UPLOADING_RESULTS",
564
- WAITING_FOR_PRIORITY = "WAITING_FOR_PRIORITY"
565
- }
579
+ export declare const JobEventType: {
580
+ readonly CANCELLED: "CANCELLED";
581
+ readonly COMPLETED: "COMPLETED";
582
+ readonly DEPRIORITIZED_DUE_TO_INACTIVITY: "DEPRIORITIZED_DUE_TO_INACTIVITY";
583
+ readonly DOWNLOADING_DATA: "DOWNLOADING_DATA";
584
+ readonly FAILED: "FAILED";
585
+ readonly MAX_RUNTIME_EXCEEDED: "MAX_RUNTIME_EXCEEDED";
586
+ readonly QUEUED_FOR_EXECUTION: "QUEUED_FOR_EXECUTION";
587
+ readonly RUNNING: "RUNNING";
588
+ readonly STARTING_INSTANCE: "STARTING_INSTANCE";
589
+ readonly UPLOADING_RESULTS: "UPLOADING_RESULTS";
590
+ readonly WAITING_FOR_PRIORITY: "WAITING_FOR_PRIORITY";
591
+ };
592
+ /**
593
+ * @public
594
+ */
595
+ export type JobEventType = (typeof JobEventType)[keyof typeof JobEventType];
566
596
  /**
567
597
  * @public
568
598
  * <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
@@ -583,15 +613,20 @@ export interface JobEventDetails {
583
613
  }
584
614
  /**
585
615
  * @public
616
+ * @enum
586
617
  */
587
- export declare enum JobPrimaryStatus {
588
- CANCELLED = "CANCELLED",
589
- CANCELLING = "CANCELLING",
590
- COMPLETED = "COMPLETED",
591
- FAILED = "FAILED",
592
- QUEUED = "QUEUED",
593
- RUNNING = "RUNNING"
594
- }
618
+ export declare const JobPrimaryStatus: {
619
+ readonly CANCELLED: "CANCELLED";
620
+ readonly CANCELLING: "CANCELLING";
621
+ readonly COMPLETED: "COMPLETED";
622
+ readonly FAILED: "FAILED";
623
+ readonly QUEUED: "QUEUED";
624
+ readonly RUNNING: "RUNNING";
625
+ };
626
+ /**
627
+ * @public
628
+ */
629
+ export type JobPrimaryStatus = (typeof JobPrimaryStatus)[keyof typeof JobPrimaryStatus];
595
630
  /**
596
631
  * @public
597
632
  */
@@ -684,16 +719,21 @@ export interface GetJobResponse {
684
719
  }
685
720
  /**
686
721
  * @public
722
+ * @enum
687
723
  */
688
- export declare enum SearchJobsFilterOperator {
689
- BETWEEN = "BETWEEN",
690
- CONTAINS = "CONTAINS",
691
- EQUAL = "EQUAL",
692
- GT = "GT",
693
- GTE = "GTE",
694
- LT = "LT",
695
- LTE = "LTE"
696
- }
724
+ export declare const SearchJobsFilterOperator: {
725
+ readonly BETWEEN: "BETWEEN";
726
+ readonly CONTAINS: "CONTAINS";
727
+ readonly EQUAL: "EQUAL";
728
+ readonly GT: "GT";
729
+ readonly GTE: "GTE";
730
+ readonly LT: "LT";
731
+ readonly LTE: "LTE";
732
+ };
733
+ /**
734
+ * @public
735
+ */
736
+ export type SearchJobsFilterOperator = (typeof SearchJobsFilterOperator)[keyof typeof SearchJobsFilterOperator];
697
737
  /**
698
738
  * @public
699
739
  * <p>A filter used to search for Amazon Braket jobs.</p>
@@ -903,16 +943,21 @@ export interface GetQuantumTaskRequest {
903
943
  }
904
944
  /**
905
945
  * @public
946
+ * @enum
906
947
  */
907
- export declare enum QuantumTaskStatus {
908
- CANCELLED = "CANCELLED",
909
- CANCELLING = "CANCELLING",
910
- COMPLETED = "COMPLETED",
911
- CREATED = "CREATED",
912
- FAILED = "FAILED",
913
- QUEUED = "QUEUED",
914
- RUNNING = "RUNNING"
915
- }
948
+ export declare const QuantumTaskStatus: {
949
+ readonly CANCELLED: "CANCELLED";
950
+ readonly CANCELLING: "CANCELLING";
951
+ readonly COMPLETED: "COMPLETED";
952
+ readonly CREATED: "CREATED";
953
+ readonly FAILED: "FAILED";
954
+ readonly QUEUED: "QUEUED";
955
+ readonly RUNNING: "RUNNING";
956
+ };
957
+ /**
958
+ * @public
959
+ */
960
+ export type QuantumTaskStatus = (typeof QuantumTaskStatus)[keyof typeof QuantumTaskStatus];
916
961
  /**
917
962
  * @public
918
963
  */
@@ -968,15 +1013,20 @@ export interface GetQuantumTaskResponse {
968
1013
  }
969
1014
  /**
970
1015
  * @public
1016
+ * @enum
971
1017
  */
972
- export declare enum SearchQuantumTasksFilterOperator {
973
- BETWEEN = "BETWEEN",
974
- EQUAL = "EQUAL",
975
- GT = "GT",
976
- GTE = "GTE",
977
- LT = "LT",
978
- LTE = "LTE"
979
- }
1018
+ export declare const SearchQuantumTasksFilterOperator: {
1019
+ readonly BETWEEN: "BETWEEN";
1020
+ readonly EQUAL: "EQUAL";
1021
+ readonly GT: "GT";
1022
+ readonly GTE: "GTE";
1023
+ readonly LT: "LT";
1024
+ readonly LTE: "LTE";
1025
+ };
1026
+ /**
1027
+ * @public
1028
+ */
1029
+ export type SearchQuantumTasksFilterOperator = (typeof SearchQuantumTasksFilterOperator)[keyof typeof SearchQuantumTasksFilterOperator];
980
1030
  /**
981
1031
  * @public
982
1032
  * <p>A filter to use to search for tasks.</p>