@aws-sdk/client-braket 3.529.1 → 3.535.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 (38) hide show
  1. package/dist-types/Braket.d.ts +1 -1
  2. package/dist-types/BraketClient.d.ts +1 -1
  3. package/dist-types/commands/CancelJobCommand.d.ts +2 -1
  4. package/dist-types/commands/CancelQuantumTaskCommand.d.ts +2 -1
  5. package/dist-types/commands/CreateJobCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateQuantumTaskCommand.d.ts +2 -1
  7. package/dist-types/commands/GetDeviceCommand.d.ts +2 -1
  8. package/dist-types/commands/GetJobCommand.d.ts +2 -1
  9. package/dist-types/commands/GetQuantumTaskCommand.d.ts +2 -1
  10. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  11. package/dist-types/commands/SearchDevicesCommand.d.ts +2 -1
  12. package/dist-types/commands/SearchJobsCommand.d.ts +2 -1
  13. package/dist-types/commands/SearchQuantumTasksCommand.d.ts +2 -1
  14. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  15. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  16. package/dist-types/models/models_0.d.ts +196 -196
  17. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  18. package/dist-types/runtimeConfig.d.ts +2 -2
  19. package/dist-types/runtimeConfig.native.d.ts +2 -2
  20. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  21. package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/CancelQuantumTaskCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/CreateJobCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/CreateQuantumTaskCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/GetDeviceCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +7 -0
  27. package/dist-types/ts3.4/commands/GetQuantumTaskCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/SearchDevicesCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/SearchJobsCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/SearchQuantumTasksCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  35. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  36. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  37. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  38. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
2
2
  import { BraketServiceException as __BaseException } from "./BraketServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,13 +13,13 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>The container image used to create an Amazon Braket job.</p>
17
+ * @public
18
18
  */
19
19
  export interface ContainerImage {
20
20
  /**
21
- * @public
22
21
  * <p>The URI locating the container image.</p>
22
+ * @public
23
23
  */
24
24
  uri: string | undefined;
25
25
  }
@@ -36,43 +36,43 @@ export declare const CompressionType: {
36
36
  */
37
37
  export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType];
38
38
  /**
39
- * @public
40
39
  * <p>Contains information about the Python scripts used for entry and by an Amazon Braket
41
40
  * job.</p>
41
+ * @public
42
42
  */
43
43
  export interface ScriptModeConfig {
44
44
  /**
45
- * @public
46
45
  * <p>The path to the Python script that serves as the entry point for an Amazon Braket
47
46
  * job.</p>
47
+ * @public
48
48
  */
49
49
  entryPoint: string | undefined;
50
50
  /**
51
- * @public
52
51
  * <p>The URI that specifies the S3 path to the Python script module that contains the
53
52
  * training script used by an Amazon Braket job.</p>
53
+ * @public
54
54
  */
55
55
  s3Uri: string | undefined;
56
56
  /**
57
- * @public
58
57
  * <p>The type of compression used by the Python scripts for an Amazon Braket job.</p>
58
+ * @public
59
59
  */
60
60
  compressionType?: CompressionType;
61
61
  }
62
62
  /**
63
- * @public
64
63
  * <p>Defines the Amazon Braket job to be created. Specifies the container image the job uses
65
64
  * and the paths to the Python scripts used for entry and training.</p>
65
+ * @public
66
66
  */
67
67
  export interface AlgorithmSpecification {
68
68
  /**
69
- * @public
70
69
  * <p>Configures the paths to the Python scripts used for entry and training.</p>
70
+ * @public
71
71
  */
72
72
  scriptModeConfig?: ScriptModeConfig;
73
73
  /**
74
- * @public
75
74
  * <p>The container image used to create an Amazon Braket job.</p>
75
+ * @public
76
76
  */
77
77
  containerImage?: ContainerImage;
78
78
  }
@@ -88,18 +88,18 @@ export declare const AssociationType: {
88
88
  */
89
89
  export type AssociationType = (typeof AssociationType)[keyof typeof AssociationType];
90
90
  /**
91
- * @public
92
91
  * <p>The Amazon Braket resource and the association type.</p>
92
+ * @public
93
93
  */
94
94
  export interface Association {
95
95
  /**
96
- * @public
97
96
  * <p>The Amazon Braket resource arn.</p>
97
+ * @public
98
98
  */
99
99
  arn: string | undefined;
100
100
  /**
101
- * @public
102
101
  * <p>The association type for the specified Amazon Braket resource arn.</p>
102
+ * @public
103
103
  */
104
104
  type: AssociationType | undefined;
105
105
  }
@@ -108,8 +108,8 @@ export interface Association {
108
108
  */
109
109
  export interface GetDeviceRequest {
110
110
  /**
111
- * @public
112
111
  * <p>The ARN of the device to retrieve.</p>
112
+ * @public
113
113
  */
114
114
  deviceArn: string | undefined;
115
115
  }
@@ -138,24 +138,24 @@ export declare const QueuePriority: {
138
138
  */
139
139
  export type QueuePriority = (typeof QueuePriority)[keyof typeof QueuePriority];
140
140
  /**
141
- * @public
142
141
  * <p>Information about tasks and jobs queued on a device.</p>
142
+ * @public
143
143
  */
144
144
  export interface DeviceQueueInfo {
145
145
  /**
146
- * @public
147
146
  * <p>The name of the queue. </p>
147
+ * @public
148
148
  */
149
149
  queue: QueueName | undefined;
150
150
  /**
151
- * @public
152
151
  * <p>The number of jobs or tasks in the queue for a given device. </p>
152
+ * @public
153
153
  */
154
154
  queueSize: string | undefined;
155
155
  /**
156
- * @public
157
156
  * <p>Optional. Specifies the priority of the queue. Tasks in a priority queue
158
157
  * are processed before the tasks in a normal queue.</p>
158
+ * @public
159
159
  */
160
160
  queuePriority?: QueuePriority;
161
161
  }
@@ -189,45 +189,45 @@ export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType];
189
189
  */
190
190
  export interface GetDeviceResponse {
191
191
  /**
192
- * @public
193
192
  * <p>The ARN of the device.</p>
193
+ * @public
194
194
  */
195
195
  deviceArn: string | undefined;
196
196
  /**
197
- * @public
198
197
  * <p>The name of the device.</p>
198
+ * @public
199
199
  */
200
200
  deviceName: string | undefined;
201
201
  /**
202
- * @public
203
202
  * <p>The name of the partner company for the device.</p>
203
+ * @public
204
204
  */
205
205
  providerName: string | undefined;
206
206
  /**
207
- * @public
208
207
  * <p>The type of the device.</p>
208
+ * @public
209
209
  */
210
210
  deviceType: DeviceType | undefined;
211
211
  /**
212
- * @public
213
212
  * <p>The status of the device.</p>
213
+ * @public
214
214
  */
215
215
  deviceStatus: DeviceStatus | undefined;
216
216
  /**
217
- * @public
218
217
  * <p>Details about the capabilities of the device.</p>
218
+ * @public
219
219
  */
220
220
  deviceCapabilities: __LazyJsonString | string | undefined;
221
221
  /**
222
- * @public
223
222
  * <p>List of information about tasks and jobs queued on a device.</p>
223
+ * @public
224
224
  */
225
225
  deviceQueueInfo?: DeviceQueueInfo[];
226
226
  }
227
227
  /**
228
- * @public
229
228
  * <p>The request processing has failed because of an unknown error, exception, or
230
229
  * failure.</p>
230
+ * @public
231
231
  */
232
232
  export declare class InternalServiceException extends __BaseException {
233
233
  readonly name: "InternalServiceException";
@@ -238,8 +238,8 @@ export declare class InternalServiceException extends __BaseException {
238
238
  constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
239
239
  }
240
240
  /**
241
- * @public
242
241
  * <p>The specified resource was not found.</p>
242
+ * @public
243
243
  */
244
244
  export declare class ResourceNotFoundException extends __BaseException {
245
245
  readonly name: "ResourceNotFoundException";
@@ -250,8 +250,8 @@ export declare class ResourceNotFoundException extends __BaseException {
250
250
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
251
251
  }
252
252
  /**
253
- * @public
254
253
  * <p>The throttling rate limit is met.</p>
254
+ * @public
255
255
  */
256
256
  export declare class ThrottlingException extends __BaseException {
257
257
  readonly name: "ThrottlingException";
@@ -262,8 +262,8 @@ export declare class ThrottlingException extends __BaseException {
262
262
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
263
263
  }
264
264
  /**
265
- * @public
266
265
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
266
+ * @public
267
267
  */
268
268
  export declare class ValidationException extends __BaseException {
269
269
  readonly name: "ValidationException";
@@ -274,18 +274,18 @@ export declare class ValidationException extends __BaseException {
274
274
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
275
275
  }
276
276
  /**
277
- * @public
278
277
  * <p>The filter to use for searching devices.</p>
278
+ * @public
279
279
  */
280
280
  export interface SearchDevicesFilter {
281
281
  /**
282
- * @public
283
282
  * <p>The name to use to filter results.</p>
283
+ * @public
284
284
  */
285
285
  name: string | undefined;
286
286
  /**
287
- * @public
288
287
  * <p>The values to use to filter results.</p>
288
+ * @public
289
289
  */
290
290
  values: string[] | undefined;
291
291
  }
@@ -294,50 +294,50 @@ export interface SearchDevicesFilter {
294
294
  */
295
295
  export interface SearchDevicesRequest {
296
296
  /**
297
- * @public
298
297
  * <p>A token used for pagination of results returned in the response. Use the token returned
299
298
  * from the previous request continue results where the previous request ended.</p>
299
+ * @public
300
300
  */
301
301
  nextToken?: string;
302
302
  /**
303
- * @public
304
303
  * <p>The maximum number of results to return in the response.</p>
304
+ * @public
305
305
  */
306
306
  maxResults?: number;
307
307
  /**
308
- * @public
309
308
  * <p>The filter values to use to search for a device.</p>
309
+ * @public
310
310
  */
311
311
  filters: SearchDevicesFilter[] | undefined;
312
312
  }
313
313
  /**
314
- * @public
315
314
  * <p>Includes information about the device.</p>
315
+ * @public
316
316
  */
317
317
  export interface DeviceSummary {
318
318
  /**
319
- * @public
320
319
  * <p>The ARN of the device.</p>
320
+ * @public
321
321
  */
322
322
  deviceArn: string | undefined;
323
323
  /**
324
- * @public
325
324
  * <p>The name of the device.</p>
325
+ * @public
326
326
  */
327
327
  deviceName: string | undefined;
328
328
  /**
329
- * @public
330
329
  * <p>The provider of the device.</p>
330
+ * @public
331
331
  */
332
332
  providerName: string | undefined;
333
333
  /**
334
- * @public
335
334
  * <p>The type of the device.</p>
335
+ * @public
336
336
  */
337
337
  deviceType: DeviceType | undefined;
338
338
  /**
339
- * @public
340
339
  * <p>The status of the device.</p>
340
+ * @public
341
341
  */
342
342
  deviceStatus: DeviceStatus | undefined;
343
343
  }
@@ -346,16 +346,16 @@ export interface DeviceSummary {
346
346
  */
347
347
  export interface SearchDevicesResponse {
348
348
  /**
349
- * @public
350
349
  * <p>An array of <code>DeviceSummary</code> objects for devices that match the specified
351
350
  * filter values.</p>
351
+ * @public
352
352
  */
353
353
  devices: DeviceSummary[] | undefined;
354
354
  /**
355
- * @public
356
355
  * <p>A token used for pagination of results, or null if there are no additional results. Use
357
356
  * the token value in a subsequent request to continue results where the previous request
358
357
  * ended.</p>
358
+ * @public
359
359
  */
360
360
  nextToken?: string;
361
361
  }
@@ -364,8 +364,8 @@ export interface SearchDevicesResponse {
364
364
  */
365
365
  export interface CancelJobRequest {
366
366
  /**
367
- * @public
368
367
  * <p>The ARN of the Amazon Braket job to cancel.</p>
368
+ * @public
369
369
  */
370
370
  jobArn: string | undefined;
371
371
  }
@@ -386,19 +386,19 @@ export type CancellationStatus = (typeof CancellationStatus)[keyof typeof Cancel
386
386
  */
387
387
  export interface CancelJobResponse {
388
388
  /**
389
- * @public
390
389
  * <p>The ARN of the Amazon Braket job.</p>
390
+ * @public
391
391
  */
392
392
  jobArn: string | undefined;
393
393
  /**
394
- * @public
395
394
  * <p>The status of the job cancellation request.</p>
395
+ * @public
396
396
  */
397
397
  cancellationStatus: CancellationStatus | undefined;
398
398
  }
399
399
  /**
400
- * @public
401
400
  * <p>An error occurred due to a conflict.</p>
401
+ * @public
402
402
  */
403
403
  export declare class ConflictException extends __BaseException {
404
404
  readonly name: "ConflictException";
@@ -409,78 +409,78 @@ export declare class ConflictException extends __BaseException {
409
409
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
410
410
  }
411
411
  /**
412
- * @public
413
412
  * <p>Contains information about the output locations for job checkpoint data.</p>
413
+ * @public
414
414
  */
415
415
  export interface JobCheckpointConfig {
416
416
  /**
417
- * @public
418
417
  * <p>(Optional) The local directory where checkpoints are written. The default directory is
419
418
  * <code>/opt/braket/checkpoints/</code>.</p>
419
+ * @public
420
420
  */
421
421
  localPath?: string;
422
422
  /**
423
- * @public
424
423
  * <p>Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,
425
424
  * <code>s3://bucket-name/key-name-prefix</code>.</p>
425
+ * @public
426
426
  */
427
427
  s3Uri: string | undefined;
428
428
  }
429
429
  /**
430
- * @public
431
430
  * <p>Configures the quantum processing units (QPUs) or simulator used to create and run an
432
431
  * Amazon Braket job.</p>
432
+ * @public
433
433
  */
434
434
  export interface DeviceConfig {
435
435
  /**
436
- * @public
437
436
  * <p>The primary quantum processing unit (QPU) or simulator used to create and run an Amazon
438
437
  * Braket job.</p>
438
+ * @public
439
439
  */
440
440
  device: string | undefined;
441
441
  }
442
442
  /**
443
- * @public
444
443
  * <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
444
+ * @public
445
445
  */
446
446
  export interface S3DataSource {
447
447
  /**
448
- * @public
449
448
  * <p>Depending on the value specified for the <code>S3DataType</code>, identifies either a
450
449
  * key name prefix or a manifest that locates the S3 data source.</p>
450
+ * @public
451
451
  */
452
452
  s3Uri: string | undefined;
453
453
  }
454
454
  /**
455
- * @public
456
455
  * <p>Information about the source of the data used by the Amazon Braket job.</p>
456
+ * @public
457
457
  */
458
458
  export interface DataSource {
459
459
  /**
460
- * @public
461
460
  * <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
461
+ * @public
462
462
  */
463
463
  s3DataSource: S3DataSource | undefined;
464
464
  }
465
465
  /**
466
- * @public
467
466
  * <p>A list of parameters that specify the input channels, type of input data, and where it
468
467
  * is located.</p>
468
+ * @public
469
469
  */
470
470
  export interface InputFileConfig {
471
471
  /**
472
- * @public
473
472
  * <p>A named input source that an Amazon Braket job can consume.</p>
473
+ * @public
474
474
  */
475
475
  channelName: string | undefined;
476
476
  /**
477
- * @public
478
477
  * <p>The MIME type of the data.</p>
478
+ * @public
479
479
  */
480
480
  contentType?: string;
481
481
  /**
482
- * @public
483
482
  * <p>The location of the channel data.</p>
483
+ * @public
484
484
  */
485
485
  dataSource: DataSource | undefined;
486
486
  }
@@ -534,56 +534,56 @@ export declare const _InstanceType: {
534
534
  */
535
535
  export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
536
536
  /**
537
- * @public
538
537
  * <p>Configures the resource instances to use while running the Amazon Braket hybrid job on
539
538
  * Amazon Braket.</p>
539
+ * @public
540
540
  */
541
541
  export interface InstanceConfig {
542
542
  /**
543
- * @public
544
543
  * <p>Configures the type resource instances to use while running an Amazon Braket hybrid
545
544
  * job.</p>
545
+ * @public
546
546
  */
547
547
  instanceType: _InstanceType | undefined;
548
548
  /**
549
- * @public
550
549
  * <p>The size of the storage volume, in GB, that user wants to provision.</p>
550
+ * @public
551
551
  */
552
552
  volumeSizeInGb: number | undefined;
553
553
  /**
554
- * @public
555
554
  * <p>Configures the number of resource instances to use while running an Amazon Braket job on
556
555
  * Amazon Braket. The default value is 1.</p>
556
+ * @public
557
557
  */
558
558
  instanceCount?: number;
559
559
  }
560
560
  /**
561
- * @public
562
561
  * <p>Specifies the path to the S3 location where you want to store job artifacts and the
563
562
  * encryption key used to store them.</p>
563
+ * @public
564
564
  */
565
565
  export interface JobOutputDataConfig {
566
566
  /**
567
- * @public
568
567
  * <p>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job
569
568
  * training artifacts at rest using Amazon S3 server-side encryption.</p>
569
+ * @public
570
570
  */
571
571
  kmsKeyId?: string;
572
572
  /**
573
- * @public
574
573
  * <p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts.
575
574
  * For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
575
+ * @public
576
576
  */
577
577
  s3Path: string | undefined;
578
578
  }
579
579
  /**
580
- * @public
581
580
  * <p>Specifies limits for how long an Amazon Braket job can run. </p>
581
+ * @public
582
582
  */
583
583
  export interface JobStoppingCondition {
584
584
  /**
585
- * @public
586
585
  * <p>The maximum length of time, in seconds, that an Amazon Braket job can run.</p>
586
+ * @public
587
587
  */
588
588
  maxRuntimeInSeconds?: number;
589
589
  }
@@ -592,78 +592,78 @@ export interface JobStoppingCondition {
592
592
  */
593
593
  export interface CreateJobRequest {
594
594
  /**
595
- * @public
596
595
  * <p>A unique token that guarantees that the call to this API is idempotent.</p>
596
+ * @public
597
597
  */
598
598
  clientToken?: string;
599
599
  /**
600
- * @public
601
600
  * <p>Definition of the Amazon Braket job to be created. Specifies the container image the job
602
601
  * uses and information about the Python scripts used for entry and training.</p>
602
+ * @public
603
603
  */
604
604
  algorithmSpecification: AlgorithmSpecification | undefined;
605
605
  /**
606
- * @public
607
606
  * <p>A list of parameters that specify the name and type of input data and where it is
608
607
  * located.</p>
608
+ * @public
609
609
  */
610
610
  inputDataConfig?: InputFileConfig[];
611
611
  /**
612
- * @public
613
612
  * <p>The path to the S3 location where you want to store job artifacts and the encryption key
614
613
  * used to store them.</p>
614
+ * @public
615
615
  */
616
616
  outputDataConfig: JobOutputDataConfig | undefined;
617
617
  /**
618
- * @public
619
618
  * <p>Information about the output locations for job checkpoint data.</p>
619
+ * @public
620
620
  */
621
621
  checkpointConfig?: JobCheckpointConfig;
622
622
  /**
623
- * @public
624
623
  * <p>The name of the Amazon Braket job.</p>
624
+ * @public
625
625
  */
626
626
  jobName: string | undefined;
627
627
  /**
628
- * @public
629
628
  * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
630
629
  * tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
631
630
  * on behalf of user, and output resources to the users' s3 buckets.</p>
631
+ * @public
632
632
  */
633
633
  roleArn: string | undefined;
634
634
  /**
635
- * @public
636
635
  * <p> The user-defined criteria that specifies when a job stops running.</p>
636
+ * @public
637
637
  */
638
638
  stoppingCondition?: JobStoppingCondition;
639
639
  /**
640
- * @public
641
640
  * <p>Configuration of the resource instances to use while running the hybrid job on Amazon
642
641
  * Braket.</p>
642
+ * @public
643
643
  */
644
644
  instanceConfig: InstanceConfig | undefined;
645
645
  /**
646
- * @public
647
646
  * <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
648
647
  * the training job. The values are set with a string of JSON key:value pairs, where the key
649
648
  * is the name of the hyperparameter and the value is the value of th hyperparameter.</p>
649
+ * @public
650
650
  */
651
651
  hyperParameters?: Record<string, string>;
652
652
  /**
653
- * @public
654
653
  * <p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket
655
654
  * job.</p>
655
+ * @public
656
656
  */
657
657
  deviceConfig: DeviceConfig | undefined;
658
658
  /**
659
- * @public
660
659
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
661
660
  * Amazon Braket resources.</p>
661
+ * @public
662
662
  */
663
663
  tags?: Record<string, string>;
664
664
  /**
665
- * @public
666
665
  * <p>The list of Amazon Braket resources associated with the hybrid job.</p>
666
+ * @public
667
667
  */
668
668
  associations?: Association[];
669
669
  }
@@ -672,14 +672,14 @@ export interface CreateJobRequest {
672
672
  */
673
673
  export interface CreateJobResponse {
674
674
  /**
675
- * @public
676
675
  * <p>The ARN of the Amazon Braket job created.</p>
676
+ * @public
677
677
  */
678
678
  jobArn: string | undefined;
679
679
  }
680
680
  /**
681
- * @public
682
681
  * <p>The specified device is currently offline.</p>
682
+ * @public
683
683
  */
684
684
  export declare class DeviceOfflineException extends __BaseException {
685
685
  readonly name: "DeviceOfflineException";
@@ -690,8 +690,8 @@ export declare class DeviceOfflineException extends __BaseException {
690
690
  constructor(opts: __ExceptionOptionType<DeviceOfflineException, __BaseException>);
691
691
  }
692
692
  /**
693
- * @public
694
693
  * <p>The specified device has been retired.</p>
694
+ * @public
695
695
  */
696
696
  export declare class DeviceRetiredException extends __BaseException {
697
697
  readonly name: "DeviceRetiredException";
@@ -702,8 +702,8 @@ export declare class DeviceRetiredException extends __BaseException {
702
702
  constructor(opts: __ExceptionOptionType<DeviceRetiredException, __BaseException>);
703
703
  }
704
704
  /**
705
- * @public
706
705
  * <p>The request failed because a service quota is exceeded.</p>
706
+ * @public
707
707
  */
708
708
  export declare class ServiceQuotaExceededException extends __BaseException {
709
709
  readonly name: "ServiceQuotaExceededException";
@@ -729,13 +729,13 @@ export type HybridJobAdditionalAttributeName = (typeof HybridJobAdditionalAttrib
729
729
  */
730
730
  export interface GetJobRequest {
731
731
  /**
732
- * @public
733
732
  * <p>The ARN of the job to retrieve.</p>
733
+ * @public
734
734
  */
735
735
  jobArn: string | undefined;
736
736
  /**
737
- * @public
738
737
  * <p>A list of attributes to return information for.</p>
738
+ * @public
739
739
  */
740
740
  additionalAttributeNames?: HybridJobAdditionalAttributeName[];
741
741
  }
@@ -761,46 +761,46 @@ export declare const JobEventType: {
761
761
  */
762
762
  export type JobEventType = (typeof JobEventType)[keyof typeof JobEventType];
763
763
  /**
764
- * @public
765
764
  * <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
765
+ * @public
766
766
  */
767
767
  export interface JobEventDetails {
768
768
  /**
769
- * @public
770
769
  * <p>The type of event that occurred related to the Amazon Braket job.</p>
770
+ * @public
771
771
  */
772
772
  eventType?: JobEventType;
773
773
  /**
774
- * @public
775
774
  * <p>The type of event that occurred related to the Amazon Braket job.</p>
775
+ * @public
776
776
  */
777
777
  timeOfEvent?: Date;
778
778
  /**
779
- * @public
780
779
  * <p>A message describing the event that occurred related to the Amazon Braket job.</p>
780
+ * @public
781
781
  */
782
782
  message?: string;
783
783
  }
784
784
  /**
785
- * @public
786
785
  * <p>Information about the queue for a specified job.</p>
786
+ * @public
787
787
  */
788
788
  export interface HybridJobQueueInfo {
789
789
  /**
790
- * @public
791
790
  * <p>The name of the queue.</p>
791
+ * @public
792
792
  */
793
793
  queue: QueueName | undefined;
794
794
  /**
795
- * @public
796
795
  * <p>Current position of the job in the jobs queue.</p>
796
+ * @public
797
797
  */
798
798
  position: string | undefined;
799
799
  /**
800
- * @public
801
800
  * <p>Optional. Provides more information about the queue position. For example,
802
801
  * if the job is complete and no longer in the queue, the message field contains
803
802
  * that information.</p>
803
+ * @public
804
804
  */
805
805
  message?: string;
806
806
  }
@@ -825,119 +825,119 @@ export type JobPrimaryStatus = (typeof JobPrimaryStatus)[keyof typeof JobPrimary
825
825
  */
826
826
  export interface GetJobResponse {
827
827
  /**
828
- * @public
829
828
  * <p>The status of the Amazon Braket job.</p>
829
+ * @public
830
830
  */
831
831
  status: JobPrimaryStatus | undefined;
832
832
  /**
833
- * @public
834
833
  * <p>The ARN of the Amazon Braket job.</p>
834
+ * @public
835
835
  */
836
836
  jobArn: string | undefined;
837
837
  /**
838
- * @public
839
838
  * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
840
839
  * tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
841
840
  * on behalf of user, and output resources to the s3 buckets of a user.</p>
841
+ * @public
842
842
  */
843
843
  roleArn: string | undefined;
844
844
  /**
845
- * @public
846
845
  * <p>A description of the reason why an Amazon Braket job failed, if it failed.</p>
846
+ * @public
847
847
  */
848
848
  failureReason?: string;
849
849
  /**
850
- * @public
851
850
  * <p>The name of the Amazon Braket job.</p>
851
+ * @public
852
852
  */
853
853
  jobName: string | undefined;
854
854
  /**
855
- * @public
856
855
  * <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
857
856
  * the traiing job. The values are set with a string of JSON key:value pairs, where the key is
858
857
  * the name of the hyperparameter and the value is the value of th hyperparameter.</p>
858
+ * @public
859
859
  */
860
860
  hyperParameters?: Record<string, string>;
861
861
  /**
862
- * @public
863
862
  * <p>A list of parameters that specify the name and type of input data and where it is
864
863
  * located.</p>
864
+ * @public
865
865
  */
866
866
  inputDataConfig?: InputFileConfig[];
867
867
  /**
868
- * @public
869
868
  * <p>The path to the S3 location where job artifacts are stored and the encryption key used
870
869
  * to store them there.</p>
870
+ * @public
871
871
  */
872
872
  outputDataConfig: JobOutputDataConfig | undefined;
873
873
  /**
874
- * @public
875
874
  * <p>The user-defined criteria that specifies when to stop a job running.</p>
875
+ * @public
876
876
  */
877
877
  stoppingCondition?: JobStoppingCondition;
878
878
  /**
879
- * @public
880
879
  * <p>Information about the output locations for job checkpoint data.</p>
880
+ * @public
881
881
  */
882
882
  checkpointConfig?: JobCheckpointConfig;
883
883
  /**
884
- * @public
885
884
  * <p>Definition of the Amazon Braket job created. Specifies the container image the job uses,
886
885
  * information about the Python scripts used for entry and training, and the user-defined
887
886
  * metrics used to evaluation the job.</p>
887
+ * @public
888
888
  */
889
889
  algorithmSpecification: AlgorithmSpecification | undefined;
890
890
  /**
891
- * @public
892
891
  * <p>The resource instances to use while running the hybrid job on Amazon Braket.</p>
892
+ * @public
893
893
  */
894
894
  instanceConfig: InstanceConfig | undefined;
895
895
  /**
896
- * @public
897
896
  * <p>The date and time that the Amazon Braket job was created.</p>
897
+ * @public
898
898
  */
899
899
  createdAt: Date | undefined;
900
900
  /**
901
- * @public
902
901
  * <p>The date and time that the Amazon Braket job was started.</p>
902
+ * @public
903
903
  */
904
904
  startedAt?: Date;
905
905
  /**
906
- * @public
907
906
  * <p>The date and time that the Amazon Braket job ended.</p>
907
+ * @public
908
908
  */
909
909
  endedAt?: Date;
910
910
  /**
911
- * @public
912
911
  * <p>The billable time the Amazon Braket job used to complete.</p>
912
+ * @public
913
913
  */
914
914
  billableDuration?: number;
915
915
  /**
916
- * @public
917
916
  * <p>The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.</p>
917
+ * @public
918
918
  */
919
919
  deviceConfig?: DeviceConfig;
920
920
  /**
921
- * @public
922
921
  * <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
922
+ * @public
923
923
  */
924
924
  events?: JobEventDetails[];
925
925
  /**
926
- * @public
927
926
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
928
927
  * Amazon Braket resources.</p>
928
+ * @public
929
929
  */
930
930
  tags?: Record<string, string>;
931
931
  /**
932
- * @public
933
932
  * <p>Queue information for the requested job. Only returned if
934
933
  * <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code>
935
934
  * field in the <code>GetJob</code> API request.</p>
935
+ * @public
936
936
  */
937
937
  queueInfo?: HybridJobQueueInfo;
938
938
  /**
939
- * @public
940
939
  * <p>The list of Amazon Braket resources associated with the hybrid job.</p>
940
+ * @public
941
941
  */
942
942
  associations?: Association[];
943
943
  }
@@ -959,23 +959,23 @@ export declare const SearchJobsFilterOperator: {
959
959
  */
960
960
  export type SearchJobsFilterOperator = (typeof SearchJobsFilterOperator)[keyof typeof SearchJobsFilterOperator];
961
961
  /**
962
- * @public
963
962
  * <p>A filter used to search for Amazon Braket jobs.</p>
963
+ * @public
964
964
  */
965
965
  export interface SearchJobsFilter {
966
966
  /**
967
- * @public
968
967
  * <p>The name to use for the jobs filter.</p>
968
+ * @public
969
969
  */
970
970
  name: string | undefined;
971
971
  /**
972
- * @public
973
972
  * <p>The values to use for the jobs filter.</p>
973
+ * @public
974
974
  */
975
975
  values: string[] | undefined;
976
976
  /**
977
- * @public
978
977
  * <p>An operator to use for the jobs filter.</p>
978
+ * @public
979
979
  */
980
980
  operator: SearchJobsFilterOperator | undefined;
981
981
  }
@@ -984,67 +984,67 @@ export interface SearchJobsFilter {
984
984
  */
985
985
  export interface SearchJobsRequest {
986
986
  /**
987
- * @public
988
987
  * <p>A token used for pagination of results returned in the response. Use the token returned
989
988
  * from the previous request to continue results where the previous request ended.</p>
989
+ * @public
990
990
  */
991
991
  nextToken?: string;
992
992
  /**
993
- * @public
994
993
  * <p>The maximum number of results to return in the response.</p>
994
+ * @public
995
995
  */
996
996
  maxResults?: number;
997
997
  /**
998
- * @public
999
998
  * <p>The filter values to use when searching for a job.</p>
999
+ * @public
1000
1000
  */
1001
1001
  filters: SearchJobsFilter[] | undefined;
1002
1002
  }
1003
1003
  /**
1004
- * @public
1005
1004
  * <p>Provides summary information about an Amazon Braket job.</p>
1005
+ * @public
1006
1006
  */
1007
1007
  export interface JobSummary {
1008
1008
  /**
1009
- * @public
1010
1009
  * <p>The status of the Amazon Braket job.</p>
1010
+ * @public
1011
1011
  */
1012
1012
  status: JobPrimaryStatus | undefined;
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The ARN of the Amazon Braket job.</p>
1015
+ * @public
1016
1016
  */
1017
1017
  jobArn: string | undefined;
1018
1018
  /**
1019
- * @public
1020
1019
  * <p>The name of the Amazon Braket job.</p>
1020
+ * @public
1021
1021
  */
1022
1022
  jobName: string | undefined;
1023
1023
  /**
1024
- * @public
1025
1024
  * <p>Provides summary information about the primary device used by an Amazon Braket
1026
1025
  * job.</p>
1026
+ * @public
1027
1027
  */
1028
1028
  device: string | undefined;
1029
1029
  /**
1030
- * @public
1031
1030
  * <p>The date and time that the Amazon Braket job was created.</p>
1031
+ * @public
1032
1032
  */
1033
1033
  createdAt: Date | undefined;
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The date and time that the Amazon Braket job was started.</p>
1036
+ * @public
1037
1037
  */
1038
1038
  startedAt?: Date;
1039
1039
  /**
1040
- * @public
1041
1040
  * <p>The date and time that the Amazon Braket job ended.</p>
1041
+ * @public
1042
1042
  */
1043
1043
  endedAt?: Date;
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>A tag object that consists of a key and an optional value, used to manage metadata for
1047
1046
  * Amazon Braket resources.</p>
1047
+ * @public
1048
1048
  */
1049
1049
  tags?: Record<string, string>;
1050
1050
  }
@@ -1053,16 +1053,16 @@ export interface JobSummary {
1053
1053
  */
1054
1054
  export interface SearchJobsResponse {
1055
1055
  /**
1056
- * @public
1057
1056
  * <p>An array of <code>JobSummary</code> objects for devices that match the specified filter
1058
1057
  * values.</p>
1058
+ * @public
1059
1059
  */
1060
1060
  jobs: JobSummary[] | undefined;
1061
1061
  /**
1062
- * @public
1063
1062
  * <p>A token used for pagination of results, or <code>null</code> if there are no additional
1064
1063
  * results. Use the token value in a subsequent request to continue results where the previous
1065
1064
  * request ended.</p>
1065
+ * @public
1066
1066
  */
1067
1067
  nextToken?: string;
1068
1068
  }
@@ -1071,8 +1071,8 @@ export interface SearchJobsResponse {
1071
1071
  */
1072
1072
  export interface ListTagsForResourceRequest {
1073
1073
  /**
1074
- * @public
1075
1074
  * <p>Specify the <code>resourceArn</code> for the resource whose tags to display.</p>
1075
+ * @public
1076
1076
  */
1077
1077
  resourceArn: string | undefined;
1078
1078
  }
@@ -1081,8 +1081,8 @@ export interface ListTagsForResourceRequest {
1081
1081
  */
1082
1082
  export interface ListTagsForResourceResponse {
1083
1083
  /**
1084
- * @public
1085
1084
  * <p>Displays the key, value pairs of tags associated with this resource.</p>
1085
+ * @public
1086
1086
  */
1087
1087
  tags?: Record<string, string>;
1088
1088
  }
@@ -1091,13 +1091,13 @@ export interface ListTagsForResourceResponse {
1091
1091
  */
1092
1092
  export interface CancelQuantumTaskRequest {
1093
1093
  /**
1094
- * @public
1095
1094
  * <p>The ARN of the task to cancel.</p>
1095
+ * @public
1096
1096
  */
1097
1097
  quantumTaskArn: string | undefined;
1098
1098
  /**
1099
- * @public
1100
1099
  * <p>The client token associated with the request.</p>
1100
+ * @public
1101
1101
  */
1102
1102
  clientToken?: string;
1103
1103
  }
@@ -1106,13 +1106,13 @@ export interface CancelQuantumTaskRequest {
1106
1106
  */
1107
1107
  export interface CancelQuantumTaskResponse {
1108
1108
  /**
1109
- * @public
1110
1109
  * <p>The ARN of the task.</p>
1110
+ * @public
1111
1111
  */
1112
1112
  quantumTaskArn: string | undefined;
1113
1113
  /**
1114
- * @public
1115
1114
  * <p>The status of the cancellation request.</p>
1115
+ * @public
1116
1116
  */
1117
1117
  cancellationStatus: CancellationStatus | undefined;
1118
1118
  }
@@ -1121,53 +1121,53 @@ export interface CancelQuantumTaskResponse {
1121
1121
  */
1122
1122
  export interface CreateQuantumTaskRequest {
1123
1123
  /**
1124
- * @public
1125
1124
  * <p>The client token associated with the request.</p>
1125
+ * @public
1126
1126
  */
1127
1127
  clientToken?: string;
1128
1128
  /**
1129
- * @public
1130
1129
  * <p>The ARN of the device to run the task on.</p>
1130
+ * @public
1131
1131
  */
1132
1132
  deviceArn: string | undefined;
1133
1133
  /**
1134
- * @public
1135
1134
  * <p>The parameters for the device to run the task on.</p>
1135
+ * @public
1136
1136
  */
1137
1137
  deviceParameters?: __LazyJsonString | string;
1138
1138
  /**
1139
- * @public
1140
1139
  * <p>The number of shots to use for the task.</p>
1140
+ * @public
1141
1141
  */
1142
1142
  shots: number | undefined;
1143
1143
  /**
1144
- * @public
1145
1144
  * <p>The S3 bucket to store task result files in.</p>
1145
+ * @public
1146
1146
  */
1147
1147
  outputS3Bucket: string | undefined;
1148
1148
  /**
1149
- * @public
1150
1149
  * <p>The key prefix for the location in the S3 bucket to store task results in.</p>
1150
+ * @public
1151
1151
  */
1152
1152
  outputS3KeyPrefix: string | undefined;
1153
1153
  /**
1154
- * @public
1155
1154
  * <p>The action associated with the task.</p>
1155
+ * @public
1156
1156
  */
1157
1157
  action: __LazyJsonString | string | undefined;
1158
1158
  /**
1159
- * @public
1160
1159
  * <p>Tags to be added to the quantum task you're creating.</p>
1160
+ * @public
1161
1161
  */
1162
1162
  tags?: Record<string, string>;
1163
1163
  /**
1164
- * @public
1165
1164
  * <p>The token for an Amazon Braket job that associates it with the quantum task.</p>
1165
+ * @public
1166
1166
  */
1167
1167
  jobToken?: string;
1168
1168
  /**
1169
- * @public
1170
1169
  * <p>The list of Amazon Braket resources associated with the quantum task.</p>
1170
+ * @public
1171
1171
  */
1172
1172
  associations?: Association[];
1173
1173
  }
@@ -1176,8 +1176,8 @@ export interface CreateQuantumTaskRequest {
1176
1176
  */
1177
1177
  export interface CreateQuantumTaskResponse {
1178
1178
  /**
1179
- * @public
1180
1179
  * <p>The ARN of the task created by the request.</p>
1180
+ * @public
1181
1181
  */
1182
1182
  quantumTaskArn: string | undefined;
1183
1183
  }
@@ -1197,42 +1197,42 @@ export type QuantumTaskAdditionalAttributeName = (typeof QuantumTaskAdditionalAt
1197
1197
  */
1198
1198
  export interface GetQuantumTaskRequest {
1199
1199
  /**
1200
- * @public
1201
1200
  * <p>The ARN of the task to retrieve.</p>
1201
+ * @public
1202
1202
  */
1203
1203
  quantumTaskArn: string | undefined;
1204
1204
  /**
1205
- * @public
1206
1205
  * <p>A list of attributes to return information for.</p>
1206
+ * @public
1207
1207
  */
1208
1208
  additionalAttributeNames?: QuantumTaskAdditionalAttributeName[];
1209
1209
  }
1210
1210
  /**
1211
- * @public
1212
1211
  * <p>Information about the queue for the specified quantum task.</p>
1212
+ * @public
1213
1213
  */
1214
1214
  export interface QuantumTaskQueueInfo {
1215
1215
  /**
1216
- * @public
1217
1216
  * <p>The name of the queue. </p>
1217
+ * @public
1218
1218
  */
1219
1219
  queue: QueueName | undefined;
1220
1220
  /**
1221
- * @public
1222
1221
  * <p>Current position of the task in the quantum tasks queue.</p>
1222
+ * @public
1223
1223
  */
1224
1224
  position: string | undefined;
1225
1225
  /**
1226
- * @public
1227
1226
  * <p>Optional. Specifies the priority of the queue. Quantum tasks in a priority queue
1228
1227
  * are processed before the tasks in a normal queue.</p>
1228
+ * @public
1229
1229
  */
1230
1230
  queuePriority?: QueuePriority;
1231
1231
  /**
1232
- * @public
1233
1232
  * <p>Optional. Provides more information about the queue position. For example,
1234
1233
  * if the task is complete and no longer in the queue, the message field contains
1235
1234
  * that information.</p>
1235
+ * @public
1236
1236
  */
1237
1237
  message?: string;
1238
1238
  }
@@ -1258,75 +1258,75 @@ export type QuantumTaskStatus = (typeof QuantumTaskStatus)[keyof typeof QuantumT
1258
1258
  */
1259
1259
  export interface GetQuantumTaskResponse {
1260
1260
  /**
1261
- * @public
1262
1261
  * <p>The ARN of the task.</p>
1262
+ * @public
1263
1263
  */
1264
1264
  quantumTaskArn: string | undefined;
1265
1265
  /**
1266
- * @public
1267
1266
  * <p>The status of the task.</p>
1267
+ * @public
1268
1268
  */
1269
1269
  status: QuantumTaskStatus | undefined;
1270
1270
  /**
1271
- * @public
1272
1271
  * <p>The reason that a task failed.</p>
1272
+ * @public
1273
1273
  */
1274
1274
  failureReason?: string;
1275
1275
  /**
1276
- * @public
1277
1276
  * <p>The ARN of the device the task was run on.</p>
1277
+ * @public
1278
1278
  */
1279
1279
  deviceArn: string | undefined;
1280
1280
  /**
1281
- * @public
1282
1281
  * <p>The parameters for the device on which the task ran.</p>
1282
+ * @public
1283
1283
  */
1284
1284
  deviceParameters: __LazyJsonString | string | undefined;
1285
1285
  /**
1286
- * @public
1287
1286
  * <p>The number of shots used in the task.</p>
1287
+ * @public
1288
1288
  */
1289
1289
  shots: number | undefined;
1290
1290
  /**
1291
- * @public
1292
1291
  * <p>The S3 bucket where task results are stored.</p>
1292
+ * @public
1293
1293
  */
1294
1294
  outputS3Bucket: string | undefined;
1295
1295
  /**
1296
- * @public
1297
1296
  * <p>The folder in the S3 bucket where task results are stored.</p>
1297
+ * @public
1298
1298
  */
1299
1299
  outputS3Directory: string | undefined;
1300
1300
  /**
1301
- * @public
1302
1301
  * <p>The time at which the task was created.</p>
1302
+ * @public
1303
1303
  */
1304
1304
  createdAt: Date | undefined;
1305
1305
  /**
1306
- * @public
1307
1306
  * <p>The time at which the task ended.</p>
1307
+ * @public
1308
1308
  */
1309
1309
  endedAt?: Date;
1310
1310
  /**
1311
- * @public
1312
1311
  * <p>The tags that belong to this task.</p>
1312
+ * @public
1313
1313
  */
1314
1314
  tags?: Record<string, string>;
1315
1315
  /**
1316
- * @public
1317
1316
  * <p>The ARN of the Amazon Braket job associated with the quantum task.</p>
1317
+ * @public
1318
1318
  */
1319
1319
  jobArn?: string;
1320
1320
  /**
1321
- * @public
1322
1321
  * <p>Queue information for the requested quantum task. Only returned if
1323
1322
  * <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code>
1324
1323
  * field in the <code>GetQuantumTask</code> API request.</p>
1324
+ * @public
1325
1325
  */
1326
1326
  queueInfo?: QuantumTaskQueueInfo;
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>The list of Amazon Braket resources associated with the quantum task.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  associations?: Association[];
1332
1332
  }
@@ -1347,23 +1347,23 @@ export declare const SearchQuantumTasksFilterOperator: {
1347
1347
  */
1348
1348
  export type SearchQuantumTasksFilterOperator = (typeof SearchQuantumTasksFilterOperator)[keyof typeof SearchQuantumTasksFilterOperator];
1349
1349
  /**
1350
- * @public
1351
1350
  * <p>A filter to use to search for tasks.</p>
1351
+ * @public
1352
1352
  */
1353
1353
  export interface SearchQuantumTasksFilter {
1354
1354
  /**
1355
- * @public
1356
1355
  * <p>The name of the device used for the task.</p>
1356
+ * @public
1357
1357
  */
1358
1358
  name: string | undefined;
1359
1359
  /**
1360
- * @public
1361
1360
  * <p>The values to use for the filter.</p>
1361
+ * @public
1362
1362
  */
1363
1363
  values: string[] | undefined;
1364
1364
  /**
1365
- * @public
1366
1365
  * <p>An operator to use in the filter.</p>
1366
+ * @public
1367
1367
  */
1368
1368
  operator: SearchQuantumTasksFilterOperator | undefined;
1369
1369
  }
@@ -1372,70 +1372,70 @@ export interface SearchQuantumTasksFilter {
1372
1372
  */
1373
1373
  export interface SearchQuantumTasksRequest {
1374
1374
  /**
1375
- * @public
1376
1375
  * <p>A token used for pagination of results returned in the response. Use the token returned
1377
1376
  * from the previous request continue results where the previous request ended.</p>
1377
+ * @public
1378
1378
  */
1379
1379
  nextToken?: string;
1380
1380
  /**
1381
- * @public
1382
1381
  * <p>Maximum number of results to return in the response.</p>
1382
+ * @public
1383
1383
  */
1384
1384
  maxResults?: number;
1385
1385
  /**
1386
- * @public
1387
1386
  * <p>Array of <code>SearchQuantumTasksFilter</code> objects.</p>
1387
+ * @public
1388
1388
  */
1389
1389
  filters: SearchQuantumTasksFilter[] | undefined;
1390
1390
  }
1391
1391
  /**
1392
- * @public
1393
1392
  * <p>Includes information about a quantum task.</p>
1393
+ * @public
1394
1394
  */
1395
1395
  export interface QuantumTaskSummary {
1396
1396
  /**
1397
- * @public
1398
1397
  * <p>The ARN of the task.</p>
1398
+ * @public
1399
1399
  */
1400
1400
  quantumTaskArn: string | undefined;
1401
1401
  /**
1402
- * @public
1403
1402
  * <p>The status of the task.</p>
1403
+ * @public
1404
1404
  */
1405
1405
  status: QuantumTaskStatus | undefined;
1406
1406
  /**
1407
- * @public
1408
1407
  * <p>The ARN of the device the task ran on.</p>
1408
+ * @public
1409
1409
  */
1410
1410
  deviceArn: string | undefined;
1411
1411
  /**
1412
- * @public
1413
1412
  * <p>The shots used for the task.</p>
1413
+ * @public
1414
1414
  */
1415
1415
  shots: number | undefined;
1416
1416
  /**
1417
- * @public
1418
1417
  * <p>The S3 bucket where the task result file is stored..</p>
1418
+ * @public
1419
1419
  */
1420
1420
  outputS3Bucket: string | undefined;
1421
1421
  /**
1422
- * @public
1423
1422
  * <p>The folder in the S3 bucket where the task result file is stored.</p>
1423
+ * @public
1424
1424
  */
1425
1425
  outputS3Directory: string | undefined;
1426
1426
  /**
1427
- * @public
1428
1427
  * <p>The time at which the task was created.</p>
1428
+ * @public
1429
1429
  */
1430
1430
  createdAt: Date | undefined;
1431
1431
  /**
1432
- * @public
1433
1432
  * <p>The time at which the task finished.</p>
1433
+ * @public
1434
1434
  */
1435
1435
  endedAt?: Date;
1436
1436
  /**
1437
- * @public
1438
1437
  * <p>Displays the key, value pairs of tags associated with this quantum task.</p>
1438
+ * @public
1439
1439
  */
1440
1440
  tags?: Record<string, string>;
1441
1441
  }
@@ -1444,16 +1444,16 @@ export interface QuantumTaskSummary {
1444
1444
  */
1445
1445
  export interface SearchQuantumTasksResponse {
1446
1446
  /**
1447
- * @public
1448
1447
  * <p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified
1449
1448
  * filters.</p>
1449
+ * @public
1450
1450
  */
1451
1451
  quantumTasks: QuantumTaskSummary[] | undefined;
1452
1452
  /**
1453
- * @public
1454
1453
  * <p>A token used for pagination of results, or null if there are no additional results. Use
1455
1454
  * the token value in a subsequent request to continue results where the previous request
1456
1455
  * ended.</p>
1456
+ * @public
1457
1457
  */
1458
1458
  nextToken?: string;
1459
1459
  }
@@ -1462,14 +1462,14 @@ export interface SearchQuantumTasksResponse {
1462
1462
  */
1463
1463
  export interface TagResourceRequest {
1464
1464
  /**
1465
- * @public
1466
1465
  * <p>Specify the <code>resourceArn</code> of the resource to which a tag will be
1467
1466
  * added.</p>
1467
+ * @public
1468
1468
  */
1469
1469
  resourceArn: string | undefined;
1470
1470
  /**
1471
- * @public
1472
1471
  * <p>Specify the tags to add to the resource.</p>
1472
+ * @public
1473
1473
  */
1474
1474
  tags: Record<string, string> | undefined;
1475
1475
  }
@@ -1483,14 +1483,14 @@ export interface TagResourceResponse {
1483
1483
  */
1484
1484
  export interface UntagResourceRequest {
1485
1485
  /**
1486
- * @public
1487
1486
  * <p>Specify the <code>resourceArn</code> for the resource from which to remove the
1488
1487
  * tags.</p>
1488
+ * @public
1489
1489
  */
1490
1490
  resourceArn: string | undefined;
1491
1491
  /**
1492
- * @public
1493
1492
  * <p>Specify the keys for the tags to remove from the resource.</p>
1493
+ * @public
1494
1494
  */
1495
1495
  tagKeys: string[] | undefined;
1496
1496
  }