@aws-sdk/client-braket 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -14,6 +14,7 @@
14
14
  */
15
15
  export * from "./BraketClient";
16
16
  export * from "./Braket";
17
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
17
18
  export * from "./commands";
18
19
  export * from "./pagination";
19
20
  export * from "./models";
@@ -18,6 +18,7 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface ContainerImage {
20
20
  /**
21
+ * @public
21
22
  * <p>The URI locating the container image.</p>
22
23
  */
23
24
  uri: string | undefined;
@@ -41,16 +42,19 @@ export type CompressionType = (typeof CompressionType)[keyof typeof CompressionT
41
42
  */
42
43
  export interface ScriptModeConfig {
43
44
  /**
45
+ * @public
44
46
  * <p>The path to the Python script that serves as the entry point for an Amazon Braket
45
47
  * job.</p>
46
48
  */
47
49
  entryPoint: string | undefined;
48
50
  /**
51
+ * @public
49
52
  * <p>The URI that specifies the S3 path to the Python script module that contains the
50
53
  * training script used by an Amazon Braket job.</p>
51
54
  */
52
55
  s3Uri: string | undefined;
53
56
  /**
57
+ * @public
54
58
  * <p>The type of compression used by the Python scripts for an Amazon Braket job.</p>
55
59
  */
56
60
  compressionType?: CompressionType | string;
@@ -62,10 +66,12 @@ export interface ScriptModeConfig {
62
66
  */
63
67
  export interface AlgorithmSpecification {
64
68
  /**
69
+ * @public
65
70
  * <p>Configures the paths to the Python scripts used for entry and training.</p>
66
71
  */
67
72
  scriptModeConfig?: ScriptModeConfig;
68
73
  /**
74
+ * @public
69
75
  * <p>The container image used to create an Amazon Braket job.</p>
70
76
  */
71
77
  containerImage?: ContainerImage;
@@ -75,6 +81,7 @@ export interface AlgorithmSpecification {
75
81
  */
76
82
  export interface GetDeviceRequest {
77
83
  /**
84
+ * @public
78
85
  * <p>The ARN of the device to retrieve.</p>
79
86
  */
80
87
  deviceArn: string | undefined;
@@ -109,26 +116,32 @@ export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType];
109
116
  */
110
117
  export interface GetDeviceResponse {
111
118
  /**
119
+ * @public
112
120
  * <p>The ARN of the device.</p>
113
121
  */
114
122
  deviceArn: string | undefined;
115
123
  /**
124
+ * @public
116
125
  * <p>The name of the device.</p>
117
126
  */
118
127
  deviceName: string | undefined;
119
128
  /**
129
+ * @public
120
130
  * <p>The name of the partner company for the device.</p>
121
131
  */
122
132
  providerName: string | undefined;
123
133
  /**
134
+ * @public
124
135
  * <p>The type of the device.</p>
125
136
  */
126
137
  deviceType: DeviceType | string | undefined;
127
138
  /**
139
+ * @public
128
140
  * <p>The status of the device.</p>
129
141
  */
130
142
  deviceStatus: DeviceStatus | string | undefined;
131
143
  /**
144
+ * @public
132
145
  * <p>Details about the capabilities of the device.</p>
133
146
  */
134
147
  deviceCapabilities: __LazyJsonString | string | undefined;
@@ -188,10 +201,12 @@ export declare class ValidationException extends __BaseException {
188
201
  */
189
202
  export interface SearchDevicesFilter {
190
203
  /**
204
+ * @public
191
205
  * <p>The name to use to filter results.</p>
192
206
  */
193
207
  name: string | undefined;
194
208
  /**
209
+ * @public
195
210
  * <p>The values to use to filter results.</p>
196
211
  */
197
212
  values: string[] | undefined;
@@ -201,15 +216,18 @@ export interface SearchDevicesFilter {
201
216
  */
202
217
  export interface SearchDevicesRequest {
203
218
  /**
219
+ * @public
204
220
  * <p>A token used for pagination of results returned in the response. Use the token returned
205
221
  * from the previous request continue results where the previous request ended.</p>
206
222
  */
207
223
  nextToken?: string;
208
224
  /**
225
+ * @public
209
226
  * <p>The maximum number of results to return in the response.</p>
210
227
  */
211
228
  maxResults?: number;
212
229
  /**
230
+ * @public
213
231
  * <p>The filter values to use to search for a device.</p>
214
232
  */
215
233
  filters: SearchDevicesFilter[] | undefined;
@@ -220,22 +238,27 @@ export interface SearchDevicesRequest {
220
238
  */
221
239
  export interface DeviceSummary {
222
240
  /**
241
+ * @public
223
242
  * <p>The ARN of the device.</p>
224
243
  */
225
244
  deviceArn: string | undefined;
226
245
  /**
246
+ * @public
227
247
  * <p>The name of the device.</p>
228
248
  */
229
249
  deviceName: string | undefined;
230
250
  /**
251
+ * @public
231
252
  * <p>The provider of the device.</p>
232
253
  */
233
254
  providerName: string | undefined;
234
255
  /**
256
+ * @public
235
257
  * <p>The type of the device.</p>
236
258
  */
237
259
  deviceType: DeviceType | string | undefined;
238
260
  /**
261
+ * @public
239
262
  * <p>The status of the device.</p>
240
263
  */
241
264
  deviceStatus: DeviceStatus | string | undefined;
@@ -245,11 +268,13 @@ export interface DeviceSummary {
245
268
  */
246
269
  export interface SearchDevicesResponse {
247
270
  /**
271
+ * @public
248
272
  * <p>An array of <code>DeviceSummary</code> objects for devices that match the specified
249
273
  * filter values.</p>
250
274
  */
251
275
  devices: DeviceSummary[] | undefined;
252
276
  /**
277
+ * @public
253
278
  * <p>A token used for pagination of results, or null if there are no additional results. Use
254
279
  * the token value in a subsequent request to continue results where the previous request
255
280
  * ended.</p>
@@ -261,6 +286,7 @@ export interface SearchDevicesResponse {
261
286
  */
262
287
  export interface CancelJobRequest {
263
288
  /**
289
+ * @public
264
290
  * <p>The ARN of the Amazon Braket job to cancel.</p>
265
291
  */
266
292
  jobArn: string | undefined;
@@ -282,10 +308,12 @@ export type CancellationStatus = (typeof CancellationStatus)[keyof typeof Cancel
282
308
  */
283
309
  export interface CancelJobResponse {
284
310
  /**
311
+ * @public
285
312
  * <p>The ARN of the Amazon Braket job.</p>
286
313
  */
287
314
  jobArn: string | undefined;
288
315
  /**
316
+ * @public
289
317
  * <p>The status of the job cancellation request.</p>
290
318
  */
291
319
  cancellationStatus: CancellationStatus | string | undefined;
@@ -308,11 +336,13 @@ export declare class ConflictException extends __BaseException {
308
336
  */
309
337
  export interface JobCheckpointConfig {
310
338
  /**
339
+ * @public
311
340
  * <p>(Optional) The local directory where checkpoints are written. The default directory is
312
341
  * <code>/opt/braket/checkpoints/</code>.</p>
313
342
  */
314
343
  localPath?: string;
315
344
  /**
345
+ * @public
316
346
  * <p>Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,
317
347
  * <code>s3://bucket-name/key-name-prefix</code>.</p>
318
348
  */
@@ -325,6 +355,7 @@ export interface JobCheckpointConfig {
325
355
  */
326
356
  export interface DeviceConfig {
327
357
  /**
358
+ * @public
328
359
  * <p>The primary quantum processing unit (QPU) or simulator used to create and run an Amazon
329
360
  * Braket job.</p>
330
361
  */
@@ -336,6 +367,7 @@ export interface DeviceConfig {
336
367
  */
337
368
  export interface S3DataSource {
338
369
  /**
370
+ * @public
339
371
  * <p>Depending on the value specified for the <code>S3DataType</code>, identifies either a
340
372
  * key name prefix or a manifest that locates the S3 data source.</p>
341
373
  */
@@ -347,6 +379,7 @@ export interface S3DataSource {
347
379
  */
348
380
  export interface DataSource {
349
381
  /**
382
+ * @public
350
383
  * <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
351
384
  */
352
385
  s3DataSource: S3DataSource | undefined;
@@ -358,14 +391,17 @@ export interface DataSource {
358
391
  */
359
392
  export interface InputFileConfig {
360
393
  /**
394
+ * @public
361
395
  * <p>A named input source that an Amazon Braket job can consume.</p>
362
396
  */
363
397
  channelName: string | undefined;
364
398
  /**
399
+ * @public
365
400
  * <p>The MIME type of the data.</p>
366
401
  */
367
402
  contentType?: string;
368
403
  /**
404
+ * @public
369
405
  * <p>The location of the channel data.</p>
370
406
  */
371
407
  dataSource: DataSource | undefined;
@@ -426,15 +462,18 @@ export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
426
462
  */
427
463
  export interface InstanceConfig {
428
464
  /**
465
+ * @public
429
466
  * <p>Configures the type resource instances to use while running an Amazon Braket hybrid
430
467
  * job.</p>
431
468
  */
432
469
  instanceType: _InstanceType | string | undefined;
433
470
  /**
471
+ * @public
434
472
  * <p>The size of the storage volume, in GB, that user wants to provision.</p>
435
473
  */
436
474
  volumeSizeInGb: number | undefined;
437
475
  /**
476
+ * @public
438
477
  * <p>Configures the number of resource instances to use while running an Amazon Braket job on
439
478
  * Amazon Braket. The default value is 1.</p>
440
479
  */
@@ -447,11 +486,13 @@ export interface InstanceConfig {
447
486
  */
448
487
  export interface JobOutputDataConfig {
449
488
  /**
489
+ * @public
450
490
  * <p>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job
451
491
  * training artifacts at rest using Amazon S3 server-side encryption.</p>
452
492
  */
453
493
  kmsKeyId?: string;
454
494
  /**
495
+ * @public
455
496
  * <p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts.
456
497
  * For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
457
498
  */
@@ -463,6 +504,7 @@ export interface JobOutputDataConfig {
463
504
  */
464
505
  export interface JobStoppingCondition {
465
506
  /**
507
+ * @public
466
508
  * <p>The maximum length of time, in seconds, that an Amazon Braket job can run.</p>
467
509
  */
468
510
  maxRuntimeInSeconds?: number;
@@ -472,59 +514,71 @@ export interface JobStoppingCondition {
472
514
  */
473
515
  export interface CreateJobRequest {
474
516
  /**
517
+ * @public
475
518
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
476
519
  */
477
520
  clientToken?: string;
478
521
  /**
522
+ * @public
479
523
  * <p>Definition of the Amazon Braket job to be created. Specifies the container image the job
480
524
  * uses and information about the Python scripts used for entry and training.</p>
481
525
  */
482
526
  algorithmSpecification: AlgorithmSpecification | undefined;
483
527
  /**
528
+ * @public
484
529
  * <p>A list of parameters that specify the name and type of input data and where it is
485
530
  * located.</p>
486
531
  */
487
532
  inputDataConfig?: InputFileConfig[];
488
533
  /**
534
+ * @public
489
535
  * <p>The path to the S3 location where you want to store job artifacts and the encryption key
490
536
  * used to store them.</p>
491
537
  */
492
538
  outputDataConfig: JobOutputDataConfig | undefined;
493
539
  /**
540
+ * @public
494
541
  * <p>Information about the output locations for job checkpoint data.</p>
495
542
  */
496
543
  checkpointConfig?: JobCheckpointConfig;
497
544
  /**
545
+ * @public
498
546
  * <p>The name of the Amazon Braket job.</p>
499
547
  */
500
548
  jobName: string | undefined;
501
549
  /**
550
+ * @public
502
551
  * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
503
552
  * tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
504
553
  * on behalf of user, and output resources to the users' s3 buckets.</p>
505
554
  */
506
555
  roleArn: string | undefined;
507
556
  /**
557
+ * @public
508
558
  * <p> The user-defined criteria that specifies when a job stops running.</p>
509
559
  */
510
560
  stoppingCondition?: JobStoppingCondition;
511
561
  /**
562
+ * @public
512
563
  * <p>Configuration of the resource instances to use while running the hybrid job on Amazon
513
564
  * Braket.</p>
514
565
  */
515
566
  instanceConfig: InstanceConfig | undefined;
516
567
  /**
568
+ * @public
517
569
  * <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
518
570
  * the training job. The values are set with a string of JSON key:value pairs, where the key
519
571
  * is the name of the hyperparameter and the value is the value of th hyperparameter.</p>
520
572
  */
521
573
  hyperParameters?: Record<string, string>;
522
574
  /**
575
+ * @public
523
576
  * <p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket
524
577
  * job.</p>
525
578
  */
526
579
  deviceConfig: DeviceConfig | undefined;
527
580
  /**
581
+ * @public
528
582
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
529
583
  * Amazon Braket resources.</p>
530
584
  */
@@ -535,6 +589,7 @@ export interface CreateJobRequest {
535
589
  */
536
590
  export interface CreateJobResponse {
537
591
  /**
592
+ * @public
538
593
  * <p>The ARN of the Amazon Braket job created.</p>
539
594
  */
540
595
  jobArn: string | undefined;
@@ -568,6 +623,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
568
623
  */
569
624
  export interface GetJobRequest {
570
625
  /**
626
+ * @public
571
627
  * <p>The ARN of the job to retrieve.</p>
572
628
  */
573
629
  jobArn: string | undefined;
@@ -599,14 +655,17 @@ export type JobEventType = (typeof JobEventType)[keyof typeof JobEventType];
599
655
  */
600
656
  export interface JobEventDetails {
601
657
  /**
658
+ * @public
602
659
  * <p>The type of event that occurred related to the Amazon Braket job.</p>
603
660
  */
604
661
  eventType?: JobEventType | string;
605
662
  /**
663
+ * @public
606
664
  * <p>TThe type of event that occurred related to the Amazon Braket job.</p>
607
665
  */
608
666
  timeOfEvent?: Date;
609
667
  /**
668
+ * @public
610
669
  * <p>A message describing the event that occurred related to the Amazon Braket job.</p>
611
670
  */
612
671
  message?: string;
@@ -632,86 +691,105 @@ export type JobPrimaryStatus = (typeof JobPrimaryStatus)[keyof typeof JobPrimary
632
691
  */
633
692
  export interface GetJobResponse {
634
693
  /**
694
+ * @public
635
695
  * <p>The status of the Amazon Braket job.</p>
636
696
  */
637
697
  status: JobPrimaryStatus | string | undefined;
638
698
  /**
699
+ * @public
639
700
  * <p>The ARN of the Amazon Braket job.</p>
640
701
  */
641
702
  jobArn: string | undefined;
642
703
  /**
704
+ * @public
643
705
  * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
644
706
  * tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
645
707
  * on behalf of user, and output resources to the s3 buckets of a user.</p>
646
708
  */
647
709
  roleArn: string | undefined;
648
710
  /**
711
+ * @public
649
712
  * <p>A description of the reason why an Amazon Braket job failed, if it failed.</p>
650
713
  */
651
714
  failureReason?: string;
652
715
  /**
716
+ * @public
653
717
  * <p>The name of the Amazon Braket job.</p>
654
718
  */
655
719
  jobName: string | undefined;
656
720
  /**
721
+ * @public
657
722
  * <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
658
723
  * the traiing job. The values are set with a string of JSON key:value pairs, where the key is
659
724
  * the name of the hyperparameter and the value is the value of th hyperparameter.</p>
660
725
  */
661
726
  hyperParameters?: Record<string, string>;
662
727
  /**
728
+ * @public
663
729
  * <p>A list of parameters that specify the name and type of input data and where it is
664
730
  * located.</p>
665
731
  */
666
732
  inputDataConfig?: InputFileConfig[];
667
733
  /**
734
+ * @public
668
735
  * <p>The path to the S3 location where job artifacts are stored and the encryption key used
669
736
  * to store them there.</p>
670
737
  */
671
738
  outputDataConfig: JobOutputDataConfig | undefined;
672
739
  /**
740
+ * @public
673
741
  * <p>The user-defined criteria that specifies when to stop a job running.</p>
674
742
  */
675
743
  stoppingCondition?: JobStoppingCondition;
676
744
  /**
745
+ * @public
677
746
  * <p>Information about the output locations for job checkpoint data.</p>
678
747
  */
679
748
  checkpointConfig?: JobCheckpointConfig;
680
749
  /**
750
+ * @public
681
751
  * <p>Definition of the Amazon Braket job created. Specifies the container image the job uses,
682
752
  * information about the Python scripts used for entry and training, and the user-defined
683
753
  * metrics used to evaluation the job.</p>
684
754
  */
685
755
  algorithmSpecification: AlgorithmSpecification | undefined;
686
756
  /**
757
+ * @public
687
758
  * <p>The resource instances to use while running the hybrid job on Amazon Braket.</p>
688
759
  */
689
760
  instanceConfig: InstanceConfig | undefined;
690
761
  /**
762
+ * @public
691
763
  * <p>The date and time that the Amazon Braket job was created.</p>
692
764
  */
693
765
  createdAt: Date | undefined;
694
766
  /**
767
+ * @public
695
768
  * <p>The date and time that the Amazon Braket job was started.</p>
696
769
  */
697
770
  startedAt?: Date;
698
771
  /**
772
+ * @public
699
773
  * <p>The date and time that the Amazon Braket job ended.</p>
700
774
  */
701
775
  endedAt?: Date;
702
776
  /**
777
+ * @public
703
778
  * <p>The billable time the Amazon Braket job used to complete.</p>
704
779
  */
705
780
  billableDuration?: number;
706
781
  /**
782
+ * @public
707
783
  * <p>The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.</p>
708
784
  */
709
785
  deviceConfig?: DeviceConfig;
710
786
  /**
787
+ * @public
711
788
  * <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
712
789
  */
713
790
  events?: JobEventDetails[];
714
791
  /**
792
+ * @public
715
793
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
716
794
  * Amazon Braket resources.</p>
717
795
  */
@@ -740,14 +818,17 @@ export type SearchJobsFilterOperator = (typeof SearchJobsFilterOperator)[keyof t
740
818
  */
741
819
  export interface SearchJobsFilter {
742
820
  /**
821
+ * @public
743
822
  * <p>The name to use for the jobs filter.</p>
744
823
  */
745
824
  name: string | undefined;
746
825
  /**
826
+ * @public
747
827
  * <p>The values to use for the jobs filter.</p>
748
828
  */
749
829
  values: string[] | undefined;
750
830
  /**
831
+ * @public
751
832
  * <p>An operator to use for the jobs filter.</p>
752
833
  */
753
834
  operator: SearchJobsFilterOperator | string | undefined;
@@ -757,15 +838,18 @@ export interface SearchJobsFilter {
757
838
  */
758
839
  export interface SearchJobsRequest {
759
840
  /**
841
+ * @public
760
842
  * <p>A token used for pagination of results returned in the response. Use the token returned
761
843
  * from the previous request to continue results where the previous request ended.</p>
762
844
  */
763
845
  nextToken?: string;
764
846
  /**
847
+ * @public
765
848
  * <p>The maximum number of results to return in the response.</p>
766
849
  */
767
850
  maxResults?: number;
768
851
  /**
852
+ * @public
769
853
  * <p>The filter values to use when searching for a job.</p>
770
854
  */
771
855
  filters: SearchJobsFilter[] | undefined;
@@ -776,35 +860,43 @@ export interface SearchJobsRequest {
776
860
  */
777
861
  export interface JobSummary {
778
862
  /**
863
+ * @public
779
864
  * <p>The status of the Amazon Braket job.</p>
780
865
  */
781
866
  status: JobPrimaryStatus | string | undefined;
782
867
  /**
868
+ * @public
783
869
  * <p>The ARN of the Amazon Braket job.</p>
784
870
  */
785
871
  jobArn: string | undefined;
786
872
  /**
873
+ * @public
787
874
  * <p>The name of the Amazon Braket job.</p>
788
875
  */
789
876
  jobName: string | undefined;
790
877
  /**
878
+ * @public
791
879
  * <p>Provides summary information about the primary device used by an Amazon Braket
792
880
  * job.</p>
793
881
  */
794
882
  device: string | undefined;
795
883
  /**
884
+ * @public
796
885
  * <p>The date and time that the Amazon Braket job was created.</p>
797
886
  */
798
887
  createdAt: Date | undefined;
799
888
  /**
889
+ * @public
800
890
  * <p>The date and time that the Amazon Braket job was started.</p>
801
891
  */
802
892
  startedAt?: Date;
803
893
  /**
894
+ * @public
804
895
  * <p>The date and time that the Amazon Braket job ended.</p>
805
896
  */
806
897
  endedAt?: Date;
807
898
  /**
899
+ * @public
808
900
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
809
901
  * Amazon Braket resources.</p>
810
902
  */
@@ -815,11 +907,13 @@ export interface JobSummary {
815
907
  */
816
908
  export interface SearchJobsResponse {
817
909
  /**
910
+ * @public
818
911
  * <p>An array of <code>JobSummary</code> objects for devices that match the specified filter
819
912
  * values.</p>
820
913
  */
821
914
  jobs: JobSummary[] | undefined;
822
915
  /**
916
+ * @public
823
917
  * <p>A token used for pagination of results, or <code>null</code> if there are no additional
824
918
  * results. Use the token value in a subsequent request to continue results where the previous
825
919
  * request ended.</p>
@@ -831,6 +925,7 @@ export interface SearchJobsResponse {
831
925
  */
832
926
  export interface ListTagsForResourceRequest {
833
927
  /**
928
+ * @public
834
929
  * <p>Specify the <code>resourceArn</code> for the resource whose tags to display.</p>
835
930
  */
836
931
  resourceArn: string | undefined;
@@ -840,6 +935,7 @@ export interface ListTagsForResourceRequest {
840
935
  */
841
936
  export interface ListTagsForResourceResponse {
842
937
  /**
938
+ * @public
843
939
  * <p>Displays the key, value pairs of tags associated with this resource.</p>
844
940
  */
845
941
  tags?: Record<string, string>;
@@ -849,10 +945,12 @@ export interface ListTagsForResourceResponse {
849
945
  */
850
946
  export interface CancelQuantumTaskRequest {
851
947
  /**
948
+ * @public
852
949
  * <p>The ARN of the task to cancel.</p>
853
950
  */
854
951
  quantumTaskArn: string | undefined;
855
952
  /**
953
+ * @public
856
954
  * <p>The client token associated with the request.</p>
857
955
  */
858
956
  clientToken?: string;
@@ -862,10 +960,12 @@ export interface CancelQuantumTaskRequest {
862
960
  */
863
961
  export interface CancelQuantumTaskResponse {
864
962
  /**
963
+ * @public
865
964
  * <p>The ARN of the task.</p>
866
965
  */
867
966
  quantumTaskArn: string | undefined;
868
967
  /**
968
+ * @public
869
969
  * <p>The status of the cancellation request.</p>
870
970
  */
871
971
  cancellationStatus: CancellationStatus | string | undefined;
@@ -875,38 +975,47 @@ export interface CancelQuantumTaskResponse {
875
975
  */
876
976
  export interface CreateQuantumTaskRequest {
877
977
  /**
978
+ * @public
878
979
  * <p>The client token associated with the request.</p>
879
980
  */
880
981
  clientToken?: string;
881
982
  /**
983
+ * @public
882
984
  * <p>The ARN of the device to run the task on.</p>
883
985
  */
884
986
  deviceArn: string | undefined;
885
987
  /**
988
+ * @public
886
989
  * <p>The parameters for the device to run the task on.</p>
887
990
  */
888
991
  deviceParameters?: __LazyJsonString | string;
889
992
  /**
993
+ * @public
890
994
  * <p>The number of shots to use for the task.</p>
891
995
  */
892
996
  shots: number | undefined;
893
997
  /**
998
+ * @public
894
999
  * <p>The S3 bucket to store task result files in.</p>
895
1000
  */
896
1001
  outputS3Bucket: string | undefined;
897
1002
  /**
1003
+ * @public
898
1004
  * <p>The key prefix for the location in the S3 bucket to store task results in.</p>
899
1005
  */
900
1006
  outputS3KeyPrefix: string | undefined;
901
1007
  /**
1008
+ * @public
902
1009
  * <p>The action associated with the task.</p>
903
1010
  */
904
1011
  action: __LazyJsonString | string | undefined;
905
1012
  /**
1013
+ * @public
906
1014
  * <p>Tags to be added to the quantum task you're creating.</p>
907
1015
  */
908
1016
  tags?: Record<string, string>;
909
1017
  /**
1018
+ * @public
910
1019
  * <p>The token for an Amazon Braket job that associates it with the quantum task.</p>
911
1020
  */
912
1021
  jobToken?: string;
@@ -916,6 +1025,7 @@ export interface CreateQuantumTaskRequest {
916
1025
  */
917
1026
  export interface CreateQuantumTaskResponse {
918
1027
  /**
1028
+ * @public
919
1029
  * <p>The ARN of the task created by the request.</p>
920
1030
  */
921
1031
  quantumTaskArn: string | undefined;
@@ -937,6 +1047,7 @@ export declare class DeviceOfflineException extends __BaseException {
937
1047
  */
938
1048
  export interface GetQuantumTaskRequest {
939
1049
  /**
1050
+ * @public
940
1051
  * <p>the ARN of the task to retrieve.</p>
941
1052
  */
942
1053
  quantumTaskArn: string | undefined;
@@ -963,50 +1074,62 @@ export type QuantumTaskStatus = (typeof QuantumTaskStatus)[keyof typeof QuantumT
963
1074
  */
964
1075
  export interface GetQuantumTaskResponse {
965
1076
  /**
1077
+ * @public
966
1078
  * <p>The ARN of the task.</p>
967
1079
  */
968
1080
  quantumTaskArn: string | undefined;
969
1081
  /**
1082
+ * @public
970
1083
  * <p>The status of the task.</p>
971
1084
  */
972
1085
  status: QuantumTaskStatus | string | undefined;
973
1086
  /**
1087
+ * @public
974
1088
  * <p>The reason that a task failed.</p>
975
1089
  */
976
1090
  failureReason?: string;
977
1091
  /**
1092
+ * @public
978
1093
  * <p>The ARN of the device the task was run on.</p>
979
1094
  */
980
1095
  deviceArn: string | undefined;
981
1096
  /**
1097
+ * @public
982
1098
  * <p>The parameters for the device on which the task ran.</p>
983
1099
  */
984
1100
  deviceParameters: __LazyJsonString | string | undefined;
985
1101
  /**
1102
+ * @public
986
1103
  * <p>The number of shots used in the task.</p>
987
1104
  */
988
1105
  shots: number | undefined;
989
1106
  /**
1107
+ * @public
990
1108
  * <p>The S3 bucket where task results are stored.</p>
991
1109
  */
992
1110
  outputS3Bucket: string | undefined;
993
1111
  /**
1112
+ * @public
994
1113
  * <p>The folder in the S3 bucket where task results are stored.</p>
995
1114
  */
996
1115
  outputS3Directory: string | undefined;
997
1116
  /**
1117
+ * @public
998
1118
  * <p>The time at which the task was created.</p>
999
1119
  */
1000
1120
  createdAt: Date | undefined;
1001
1121
  /**
1122
+ * @public
1002
1123
  * <p>The time at which the task ended.</p>
1003
1124
  */
1004
1125
  endedAt?: Date;
1005
1126
  /**
1127
+ * @public
1006
1128
  * <p>The tags that belong to this task.</p>
1007
1129
  */
1008
1130
  tags?: Record<string, string>;
1009
1131
  /**
1132
+ * @public
1010
1133
  * <p>The ARN of the Amazon Braket job associated with the quantum task.</p>
1011
1134
  */
1012
1135
  jobArn?: string;
@@ -1033,14 +1156,17 @@ export type SearchQuantumTasksFilterOperator = (typeof SearchQuantumTasksFilterO
1033
1156
  */
1034
1157
  export interface SearchQuantumTasksFilter {
1035
1158
  /**
1159
+ * @public
1036
1160
  * <p>The name of the device used for the task.</p>
1037
1161
  */
1038
1162
  name: string | undefined;
1039
1163
  /**
1164
+ * @public
1040
1165
  * <p>The values to use for the filter.</p>
1041
1166
  */
1042
1167
  values: string[] | undefined;
1043
1168
  /**
1169
+ * @public
1044
1170
  * <p>An operator to use in the filter.</p>
1045
1171
  */
1046
1172
  operator: SearchQuantumTasksFilterOperator | string | undefined;
@@ -1050,15 +1176,18 @@ export interface SearchQuantumTasksFilter {
1050
1176
  */
1051
1177
  export interface SearchQuantumTasksRequest {
1052
1178
  /**
1179
+ * @public
1053
1180
  * <p>A token used for pagination of results returned in the response. Use the token returned
1054
1181
  * from the previous request continue results where the previous request ended.</p>
1055
1182
  */
1056
1183
  nextToken?: string;
1057
1184
  /**
1185
+ * @public
1058
1186
  * <p>Maximum number of results to return in the response.</p>
1059
1187
  */
1060
1188
  maxResults?: number;
1061
1189
  /**
1190
+ * @public
1062
1191
  * <p>Array of <code>SearchQuantumTasksFilter</code> objects.</p>
1063
1192
  */
1064
1193
  filters: SearchQuantumTasksFilter[] | undefined;
@@ -1069,38 +1198,47 @@ export interface SearchQuantumTasksRequest {
1069
1198
  */
1070
1199
  export interface QuantumTaskSummary {
1071
1200
  /**
1201
+ * @public
1072
1202
  * <p>The ARN of the task.</p>
1073
1203
  */
1074
1204
  quantumTaskArn: string | undefined;
1075
1205
  /**
1206
+ * @public
1076
1207
  * <p>The status of the task.</p>
1077
1208
  */
1078
1209
  status: QuantumTaskStatus | string | undefined;
1079
1210
  /**
1211
+ * @public
1080
1212
  * <p>The ARN of the device the task ran on.</p>
1081
1213
  */
1082
1214
  deviceArn: string | undefined;
1083
1215
  /**
1216
+ * @public
1084
1217
  * <p>The shots used for the task.</p>
1085
1218
  */
1086
1219
  shots: number | undefined;
1087
1220
  /**
1221
+ * @public
1088
1222
  * <p>The S3 bucket where the task result file is stored..</p>
1089
1223
  */
1090
1224
  outputS3Bucket: string | undefined;
1091
1225
  /**
1226
+ * @public
1092
1227
  * <p>The folder in the S3 bucket where the task result file is stored.</p>
1093
1228
  */
1094
1229
  outputS3Directory: string | undefined;
1095
1230
  /**
1231
+ * @public
1096
1232
  * <p>The time at which the task was created.</p>
1097
1233
  */
1098
1234
  createdAt: Date | undefined;
1099
1235
  /**
1236
+ * @public
1100
1237
  * <p>The time at which the task finished.</p>
1101
1238
  */
1102
1239
  endedAt?: Date;
1103
1240
  /**
1241
+ * @public
1104
1242
  * <p>Displays the key, value pairs of tags associated with this quantum task.</p>
1105
1243
  */
1106
1244
  tags?: Record<string, string>;
@@ -1110,11 +1248,13 @@ export interface QuantumTaskSummary {
1110
1248
  */
1111
1249
  export interface SearchQuantumTasksResponse {
1112
1250
  /**
1251
+ * @public
1113
1252
  * <p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified
1114
1253
  * filters.</p>
1115
1254
  */
1116
1255
  quantumTasks: QuantumTaskSummary[] | undefined;
1117
1256
  /**
1257
+ * @public
1118
1258
  * <p>A token used for pagination of results, or null if there are no additional results. Use
1119
1259
  * the token value in a subsequent request to continue results where the previous request
1120
1260
  * ended.</p>
@@ -1126,11 +1266,13 @@ export interface SearchQuantumTasksResponse {
1126
1266
  */
1127
1267
  export interface TagResourceRequest {
1128
1268
  /**
1269
+ * @public
1129
1270
  * <p>Specify the <code>resourceArn</code> of the resource to which a tag will be
1130
1271
  * added.</p>
1131
1272
  */
1132
1273
  resourceArn: string | undefined;
1133
1274
  /**
1275
+ * @public
1134
1276
  * <p>Specify the tags to add to the resource.</p>
1135
1277
  */
1136
1278
  tags: Record<string, string> | undefined;
@@ -1145,11 +1287,13 @@ export interface TagResourceResponse {
1145
1287
  */
1146
1288
  export interface UntagResourceRequest {
1147
1289
  /**
1290
+ * @public
1148
1291
  * <p>Specify the <code>resourceArn</code> for the resource from which to remove the
1149
1292
  * tags.</p>
1150
1293
  */
1151
1294
  resourceArn: string | undefined;
1152
1295
  /**
1296
+ * @public
1153
1297
  * <p>Specify the keys for the tags to remove from the resource.</p>
1154
1298
  */
1155
1299
  tagKeys: string[] | undefined;
@@ -1,5 +1,6 @@
1
1
  export * from "./BraketClient";
2
2
  export * from "./Braket";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
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.378.0",
4
+ "version": "3.382.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,15 +21,15 @@
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",