@aws-sdk/client-braket 3.864.0 → 3.867.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.
- package/README.md +1 -10
- package/dist-cjs/index.js +22 -1
- package/dist-es/models/models_0.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +4 -0
- package/dist-types/Braket.d.ts +1 -10
- package/dist-types/BraketClient.d.ts +1 -10
- package/dist-types/commands/CancelJobCommand.d.ts +5 -6
- package/dist-types/commands/CancelQuantumTaskCommand.d.ts +4 -5
- package/dist-types/commands/CreateJobCommand.d.ts +5 -6
- package/dist-types/commands/CreateQuantumTaskCommand.d.ts +4 -5
- package/dist-types/commands/GetDeviceCommand.d.ts +5 -15
- package/dist-types/commands/GetJobCommand.d.ts +5 -6
- package/dist-types/commands/GetQuantumTaskCommand.d.ts +10 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -3
- package/dist-types/commands/SearchDevicesCommand.d.ts +4 -5
- package/dist-types/commands/SearchJobsCommand.d.ts +5 -6
- package/dist-types/commands/SearchQuantumTasksCommand.d.ts +4 -5
- package/dist-types/commands/TagResourceCommand.d.ts +2 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -3
- package/dist-types/index.d.ts +1 -10
- package/dist-types/models/models_0.d.ts +225 -214
- package/dist-types/ts3.4/models/models_0.d.ts +19 -0
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion, ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { BraketServiceException as __BaseException } from "./BraketServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>You do not have sufficient
|
|
4
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
5
5
|
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -13,7 +13,28 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* <p>
|
|
16
|
+
* <p>Contains metadata about the quantum task action, including the action type and program statistics.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface ActionMetadata {
|
|
20
|
+
/**
|
|
21
|
+
* <p>The type of action associated with the quantum task.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
actionType: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The number of programs in a program set. This is only available for a Program Set.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
programCount?: number | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The number of executables in a program set. This is only available for a Program Set.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
executableCount?: number | undefined;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* <p>The container image used to create an Amazon Braket hybrid job.</p>
|
|
17
38
|
* @public
|
|
18
39
|
*/
|
|
19
40
|
export interface ContainerImage {
|
|
@@ -36,32 +57,28 @@ export declare const CompressionType: {
|
|
|
36
57
|
*/
|
|
37
58
|
export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType];
|
|
38
59
|
/**
|
|
39
|
-
* <p>Contains information about
|
|
40
|
-
* job.</p>
|
|
60
|
+
* <p>Contains information about algorithm scripts used for the Amazon Braket hybrid job.</p>
|
|
41
61
|
* @public
|
|
42
62
|
*/
|
|
43
63
|
export interface ScriptModeConfig {
|
|
44
64
|
/**
|
|
45
|
-
* <p>The
|
|
46
|
-
* job.</p>
|
|
65
|
+
* <p>The entry point in the algorithm scripts from where the execution begins in the hybrid job.</p>
|
|
47
66
|
* @public
|
|
48
67
|
*/
|
|
49
68
|
entryPoint: string | undefined;
|
|
50
69
|
/**
|
|
51
|
-
* <p>The URI that specifies the S3 path to the
|
|
52
|
-
* training script used by an Amazon Braket job.</p>
|
|
70
|
+
* <p>The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.</p>
|
|
53
71
|
* @public
|
|
54
72
|
*/
|
|
55
73
|
s3Uri: string | undefined;
|
|
56
74
|
/**
|
|
57
|
-
* <p>The type of compression used
|
|
75
|
+
* <p>The type of compression used to store the algorithm scripts in Amazon S3 storage.</p>
|
|
58
76
|
* @public
|
|
59
77
|
*/
|
|
60
78
|
compressionType?: CompressionType | undefined;
|
|
61
79
|
}
|
|
62
80
|
/**
|
|
63
|
-
* <p>Defines the Amazon Braket job to be created. Specifies the container image the job uses
|
|
64
|
-
* and the paths to the Python scripts used for entry and training.</p>
|
|
81
|
+
* <p>Defines the Amazon Braket hybrid job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.</p>
|
|
65
82
|
* @public
|
|
66
83
|
*/
|
|
67
84
|
export interface AlgorithmSpecification {
|
|
@@ -71,7 +88,7 @@ export interface AlgorithmSpecification {
|
|
|
71
88
|
*/
|
|
72
89
|
scriptModeConfig?: ScriptModeConfig | undefined;
|
|
73
90
|
/**
|
|
74
|
-
* <p>The container image used to create an Amazon Braket job.</p>
|
|
91
|
+
* <p>The container image used to create an Amazon Braket hybrid job.</p>
|
|
75
92
|
* @public
|
|
76
93
|
*/
|
|
77
94
|
containerImage?: ContainerImage | undefined;
|
|
@@ -138,7 +155,7 @@ export declare const QueuePriority: {
|
|
|
138
155
|
*/
|
|
139
156
|
export type QueuePriority = (typeof QueuePriority)[keyof typeof QueuePriority];
|
|
140
157
|
/**
|
|
141
|
-
* <p>Information about tasks and jobs queued on a device.</p>
|
|
158
|
+
* <p>Information about quantum tasks and hybrid jobs queued on a device.</p>
|
|
142
159
|
* @public
|
|
143
160
|
*/
|
|
144
161
|
export interface DeviceQueueInfo {
|
|
@@ -148,13 +165,12 @@ export interface DeviceQueueInfo {
|
|
|
148
165
|
*/
|
|
149
166
|
queue: QueueName | undefined;
|
|
150
167
|
/**
|
|
151
|
-
* <p>The number of jobs or tasks in the queue for a given device. </p>
|
|
168
|
+
* <p>The number of hybrid jobs or quantum tasks in the queue for a given device. </p>
|
|
152
169
|
* @public
|
|
153
170
|
*/
|
|
154
171
|
queueSize: string | undefined;
|
|
155
172
|
/**
|
|
156
|
-
* <p>Optional. Specifies the priority of the queue.
|
|
157
|
-
* are processed before the tasks in a normal queue.</p>
|
|
173
|
+
* <p>Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.</p>
|
|
158
174
|
* @public
|
|
159
175
|
*/
|
|
160
176
|
queuePriority?: QueuePriority | undefined;
|
|
@@ -219,14 +235,13 @@ export interface GetDeviceResponse {
|
|
|
219
235
|
*/
|
|
220
236
|
deviceCapabilities: __AutomaticJsonStringConversion | string | undefined;
|
|
221
237
|
/**
|
|
222
|
-
* <p>
|
|
238
|
+
* <p>The number of quantum tasks and hybrid jobs currently queued on the device.</p>
|
|
223
239
|
* @public
|
|
224
240
|
*/
|
|
225
241
|
deviceQueueInfo?: DeviceQueueInfo[] | undefined;
|
|
226
242
|
}
|
|
227
243
|
/**
|
|
228
|
-
* <p>The request
|
|
229
|
-
* failure.</p>
|
|
244
|
+
* <p>The request failed because of an unknown error.</p>
|
|
230
245
|
* @public
|
|
231
246
|
*/
|
|
232
247
|
export declare class InternalServiceException extends __BaseException {
|
|
@@ -250,7 +265,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
250
265
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
251
266
|
}
|
|
252
267
|
/**
|
|
253
|
-
* <p>The throttling rate limit is
|
|
268
|
+
* <p>The API throttling rate limit is exceeded.</p>
|
|
254
269
|
* @public
|
|
255
270
|
*/
|
|
256
271
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -262,29 +277,71 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
262
277
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
263
278
|
}
|
|
264
279
|
/**
|
|
265
|
-
* <p>
|
|
280
|
+
* <p>Contains information about validation failures that occurred during the processing of a program set in a quantum task.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export interface ProgramSetValidationFailure {
|
|
284
|
+
/**
|
|
285
|
+
* <p>The index of the program within the program set that failed validation.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
programIndex: number | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The index of the input within the program set that failed validation.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
inputsIndex?: number | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* <p>A list of error messages describing the validation failures that occurred.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
errors?: string[] | undefined;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* @public
|
|
302
|
+
* @enum
|
|
303
|
+
*/
|
|
304
|
+
export declare const ValidationExceptionReason: {
|
|
305
|
+
readonly PROGRAM_SET_VALIDATION_FAILED: "ProgramSetValidationFailed";
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
311
|
+
/**
|
|
312
|
+
* <p>The input request failed to satisfy constraints expected by Amazon Braket.</p>
|
|
266
313
|
* @public
|
|
267
314
|
*/
|
|
268
315
|
export declare class ValidationException extends __BaseException {
|
|
269
316
|
readonly name: "ValidationException";
|
|
270
317
|
readonly $fault: "client";
|
|
318
|
+
/**
|
|
319
|
+
* <p>The reason for validation failure.</p>
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
reason?: ValidationExceptionReason | undefined;
|
|
323
|
+
/**
|
|
324
|
+
* <p>The validation failures in the program set submitted in the request.</p>
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
programSetValidationFailures?: ProgramSetValidationFailure[] | undefined;
|
|
271
328
|
/**
|
|
272
329
|
* @internal
|
|
273
330
|
*/
|
|
274
331
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
275
332
|
}
|
|
276
333
|
/**
|
|
277
|
-
* <p>The filter to
|
|
334
|
+
* <p>The filter used to search for devices.</p>
|
|
278
335
|
* @public
|
|
279
336
|
*/
|
|
280
337
|
export interface SearchDevicesFilter {
|
|
281
338
|
/**
|
|
282
|
-
* <p>The name
|
|
339
|
+
* <p>The name of the device parameter to filter based on. Only <code>deviceArn</code> filter name is currently supported.</p>
|
|
283
340
|
* @public
|
|
284
341
|
*/
|
|
285
342
|
name: string | undefined;
|
|
286
343
|
/**
|
|
287
|
-
* <p>The values to
|
|
344
|
+
* <p>The values used to filter devices based on the filter name.</p>
|
|
288
345
|
* @public
|
|
289
346
|
*/
|
|
290
347
|
values: string[] | undefined;
|
|
@@ -294,8 +351,7 @@ export interface SearchDevicesFilter {
|
|
|
294
351
|
*/
|
|
295
352
|
export interface SearchDevicesRequest {
|
|
296
353
|
/**
|
|
297
|
-
* <p>A token used for pagination of results returned in the response. Use the token returned
|
|
298
|
-
* from the previous request continue results where the previous request ended.</p>
|
|
354
|
+
* <p>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</p>
|
|
299
355
|
* @public
|
|
300
356
|
*/
|
|
301
357
|
nextToken?: string | undefined;
|
|
@@ -305,7 +361,7 @@ export interface SearchDevicesRequest {
|
|
|
305
361
|
*/
|
|
306
362
|
maxResults?: number | undefined;
|
|
307
363
|
/**
|
|
308
|
-
* <p>
|
|
364
|
+
* <p>Array of SearchDevicesFilter objects to use when searching for devices.</p>
|
|
309
365
|
* @public
|
|
310
366
|
*/
|
|
311
367
|
filters: SearchDevicesFilter[] | undefined;
|
|
@@ -346,15 +402,12 @@ export interface DeviceSummary {
|
|
|
346
402
|
*/
|
|
347
403
|
export interface SearchDevicesResponse {
|
|
348
404
|
/**
|
|
349
|
-
* <p>An array of <code>DeviceSummary</code> objects for devices that match the specified
|
|
350
|
-
* filter values.</p>
|
|
405
|
+
* <p>An array of <code>DeviceSummary</code> objects for devices that match the specified filter values.</p>
|
|
351
406
|
* @public
|
|
352
407
|
*/
|
|
353
408
|
devices: DeviceSummary[] | undefined;
|
|
354
409
|
/**
|
|
355
|
-
* <p>A token used for pagination of results, or null if there are no additional results. Use
|
|
356
|
-
* the token value in a subsequent request to continue results where the previous request
|
|
357
|
-
* ended.</p>
|
|
410
|
+
* <p>A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.</p>
|
|
358
411
|
* @public
|
|
359
412
|
*/
|
|
360
413
|
nextToken?: string | undefined;
|
|
@@ -364,7 +417,7 @@ export interface SearchDevicesResponse {
|
|
|
364
417
|
*/
|
|
365
418
|
export interface CancelJobRequest {
|
|
366
419
|
/**
|
|
367
|
-
* <p>The ARN of the Amazon Braket job to cancel.</p>
|
|
420
|
+
* <p>The ARN of the Amazon Braket hybrid job to cancel.</p>
|
|
368
421
|
* @public
|
|
369
422
|
*/
|
|
370
423
|
jobArn: string | undefined;
|
|
@@ -391,7 +444,7 @@ export interface CancelJobResponse {
|
|
|
391
444
|
*/
|
|
392
445
|
jobArn: string | undefined;
|
|
393
446
|
/**
|
|
394
|
-
* <p>The status of the job
|
|
447
|
+
* <p>The status of the hybrid job.</p>
|
|
395
448
|
* @public
|
|
396
449
|
*/
|
|
397
450
|
cancellationStatus: CancellationStatus | undefined;
|
|
@@ -409,67 +462,61 @@ export declare class ConflictException extends __BaseException {
|
|
|
409
462
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
410
463
|
}
|
|
411
464
|
/**
|
|
412
|
-
* <p>Contains information about the output locations for job checkpoint data.</p>
|
|
465
|
+
* <p>Contains information about the output locations for hybrid job checkpoint data.</p>
|
|
413
466
|
* @public
|
|
414
467
|
*/
|
|
415
468
|
export interface JobCheckpointConfig {
|
|
416
469
|
/**
|
|
417
|
-
* <p>(Optional) The local directory where
|
|
418
|
-
* <code>/opt/braket/checkpoints/</code>.</p>
|
|
470
|
+
* <p>(Optional) The local directory where checkpoint data is stored. The default directory is <code>/opt/braket/checkpoints/</code>.</p>
|
|
419
471
|
* @public
|
|
420
472
|
*/
|
|
421
473
|
localPath?: string | undefined;
|
|
422
474
|
/**
|
|
423
|
-
* <p>Identifies the S3 path where you want Amazon Braket to store
|
|
424
|
-
* <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
475
|
+
* <p>Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
425
476
|
* @public
|
|
426
477
|
*/
|
|
427
478
|
s3Uri: string | undefined;
|
|
428
479
|
}
|
|
429
480
|
/**
|
|
430
|
-
* <p>Configures the
|
|
431
|
-
* Amazon Braket job.</p>
|
|
481
|
+
* <p>Configures the primary device used to create and run an Amazon Braket hybrid job.</p>
|
|
432
482
|
* @public
|
|
433
483
|
*/
|
|
434
484
|
export interface DeviceConfig {
|
|
435
485
|
/**
|
|
436
|
-
* <p>The primary
|
|
437
|
-
* Braket job.</p>
|
|
486
|
+
* <p>The primary device ARN used to create and run an Amazon Braket hybrid job.</p>
|
|
438
487
|
* @public
|
|
439
488
|
*/
|
|
440
489
|
device: string | undefined;
|
|
441
490
|
}
|
|
442
491
|
/**
|
|
443
|
-
* <p>Information about the
|
|
492
|
+
* <p>Information about the Amazon S3 storage used by the Amazon Braket hybrid job.</p>
|
|
444
493
|
* @public
|
|
445
494
|
*/
|
|
446
495
|
export interface S3DataSource {
|
|
447
496
|
/**
|
|
448
|
-
* <p>Depending on the value specified for the <code>S3DataType</code>, identifies either a
|
|
449
|
-
* key name prefix or a manifest that locates the S3 data source.</p>
|
|
497
|
+
* <p>Depending on the value specified for the <code>S3DataType</code>, identifies either a key name prefix or a manifest that locates the S3 data source.</p>
|
|
450
498
|
* @public
|
|
451
499
|
*/
|
|
452
500
|
s3Uri: string | undefined;
|
|
453
501
|
}
|
|
454
502
|
/**
|
|
455
|
-
* <p>Information about the source of the data used by the Amazon Braket job.</p>
|
|
503
|
+
* <p>Information about the source of the input data used by the Amazon Braket hybrid job.</p>
|
|
456
504
|
* @public
|
|
457
505
|
*/
|
|
458
506
|
export interface DataSource {
|
|
459
507
|
/**
|
|
460
|
-
* <p>
|
|
508
|
+
* <p>Amazon S3 path of the input data used by the hybrid job.</p>
|
|
461
509
|
* @public
|
|
462
510
|
*/
|
|
463
511
|
s3DataSource: S3DataSource | undefined;
|
|
464
512
|
}
|
|
465
513
|
/**
|
|
466
|
-
* <p>A list of parameters that specify the input channels, type of input data, and where it
|
|
467
|
-
* is located.</p>
|
|
514
|
+
* <p>A list of parameters that specify the input channels, type of input data, and where it is located.</p>
|
|
468
515
|
* @public
|
|
469
516
|
*/
|
|
470
517
|
export interface InputFileConfig {
|
|
471
518
|
/**
|
|
472
|
-
* <p>A named input source that an Amazon Braket job can consume.</p>
|
|
519
|
+
* <p>A named input source that an Amazon Braket hybrid job can consume.</p>
|
|
473
520
|
* @public
|
|
474
521
|
*/
|
|
475
522
|
channelName: string | undefined;
|
|
@@ -479,7 +526,7 @@ export interface InputFileConfig {
|
|
|
479
526
|
*/
|
|
480
527
|
contentType?: string | undefined;
|
|
481
528
|
/**
|
|
482
|
-
* <p>The location of the
|
|
529
|
+
* <p>The location of the input data.</p>
|
|
483
530
|
* @public
|
|
484
531
|
*/
|
|
485
532
|
dataSource: DataSource | undefined;
|
|
@@ -534,55 +581,49 @@ export declare const _InstanceType: {
|
|
|
534
581
|
*/
|
|
535
582
|
export type _InstanceType = (typeof _InstanceType)[keyof typeof _InstanceType];
|
|
536
583
|
/**
|
|
537
|
-
* <p>Configures the resource instances to use while running the Amazon Braket hybrid job on
|
|
538
|
-
* Amazon Braket.</p>
|
|
584
|
+
* <p>Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.</p>
|
|
539
585
|
* @public
|
|
540
586
|
*/
|
|
541
587
|
export interface InstanceConfig {
|
|
542
588
|
/**
|
|
543
|
-
* <p>Configures the type resource instances to use while running an Amazon Braket hybrid
|
|
544
|
-
* job.</p>
|
|
589
|
+
* <p>Configures the type of resource instances to use while running an Amazon Braket hybrid job.</p>
|
|
545
590
|
* @public
|
|
546
591
|
*/
|
|
547
592
|
instanceType: _InstanceType | undefined;
|
|
548
593
|
/**
|
|
549
|
-
* <p>The size of the storage volume, in GB,
|
|
594
|
+
* <p>The size of the storage volume, in GB, to provision.</p>
|
|
550
595
|
* @public
|
|
551
596
|
*/
|
|
552
597
|
volumeSizeInGb: number | undefined;
|
|
553
598
|
/**
|
|
554
|
-
* <p>Configures the number of resource instances to use while running an Amazon Braket job on
|
|
555
|
-
* Amazon Braket. The default value is 1.</p>
|
|
599
|
+
* <p>Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.</p>
|
|
556
600
|
* @public
|
|
557
601
|
*/
|
|
558
602
|
instanceCount?: number | undefined;
|
|
559
603
|
}
|
|
560
604
|
/**
|
|
561
|
-
* <p>Specifies the path to the S3 location where you want to store job artifacts and the
|
|
562
|
-
* encryption key used to store them.</p>
|
|
605
|
+
* <p>Specifies the path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.</p>
|
|
563
606
|
* @public
|
|
564
607
|
*/
|
|
565
608
|
export interface JobOutputDataConfig {
|
|
566
609
|
/**
|
|
567
|
-
* <p>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job
|
|
568
|
-
* training artifacts at rest using Amazon S3 server-side encryption.</p>
|
|
610
|
+
* <p>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.</p>
|
|
569
611
|
* @public
|
|
570
612
|
*/
|
|
571
613
|
kmsKeyId?: string | undefined;
|
|
572
614
|
/**
|
|
573
|
-
* <p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts.
|
|
574
|
-
* For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
615
|
+
* <p>Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
575
616
|
* @public
|
|
576
617
|
*/
|
|
577
618
|
s3Path: string | undefined;
|
|
578
619
|
}
|
|
579
620
|
/**
|
|
580
|
-
* <p>Specifies limits for how long an Amazon Braket job can run. </p>
|
|
621
|
+
* <p>Specifies limits for how long an Amazon Braket hybrid job can run. </p>
|
|
581
622
|
* @public
|
|
582
623
|
*/
|
|
583
624
|
export interface JobStoppingCondition {
|
|
584
625
|
/**
|
|
585
|
-
* <p>The maximum length of time, in seconds, that an Amazon Braket job can run.</p>
|
|
626
|
+
* <p>The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.</p>
|
|
586
627
|
* @public
|
|
587
628
|
*/
|
|
588
629
|
maxRuntimeInSeconds?: number | undefined;
|
|
@@ -592,72 +633,62 @@ export interface JobStoppingCondition {
|
|
|
592
633
|
*/
|
|
593
634
|
export interface CreateJobRequest {
|
|
594
635
|
/**
|
|
595
|
-
* <p>
|
|
636
|
+
* <p>The client token associated with this request that guarantees that the request is idempotent.</p>
|
|
596
637
|
* @public
|
|
597
638
|
*/
|
|
598
639
|
clientToken?: string | undefined;
|
|
599
640
|
/**
|
|
600
|
-
* <p>Definition of the Amazon Braket job to be created. Specifies the container image the job
|
|
601
|
-
* uses and information about the Python scripts used for entry and training.</p>
|
|
641
|
+
* <p>Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.</p>
|
|
602
642
|
* @public
|
|
603
643
|
*/
|
|
604
644
|
algorithmSpecification: AlgorithmSpecification | undefined;
|
|
605
645
|
/**
|
|
606
|
-
* <p>A list of parameters that specify the name and type of input data and where it is
|
|
607
|
-
* located.</p>
|
|
646
|
+
* <p>A list of parameters that specify the name and type of input data and where it is located.</p>
|
|
608
647
|
* @public
|
|
609
648
|
*/
|
|
610
649
|
inputDataConfig?: InputFileConfig[] | undefined;
|
|
611
650
|
/**
|
|
612
|
-
* <p>The path to the S3 location where you want to store job artifacts and the encryption key
|
|
613
|
-
* used to store them.</p>
|
|
651
|
+
* <p>The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.</p>
|
|
614
652
|
* @public
|
|
615
653
|
*/
|
|
616
654
|
outputDataConfig: JobOutputDataConfig | undefined;
|
|
617
655
|
/**
|
|
618
|
-
* <p>Information about the output locations for job checkpoint data.</p>
|
|
656
|
+
* <p>Information about the output locations for hybrid job checkpoint data.</p>
|
|
619
657
|
* @public
|
|
620
658
|
*/
|
|
621
659
|
checkpointConfig?: JobCheckpointConfig | undefined;
|
|
622
660
|
/**
|
|
623
|
-
* <p>The name of the Amazon Braket job.</p>
|
|
661
|
+
* <p>The name of the Amazon Braket hybrid job.</p>
|
|
624
662
|
* @public
|
|
625
663
|
*/
|
|
626
664
|
jobName: string | undefined;
|
|
627
665
|
/**
|
|
628
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
|
|
629
|
-
* tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
|
|
630
|
-
* on behalf of user, and output resources to the users' s3 buckets.</p>
|
|
666
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users' s3 buckets.</p>
|
|
631
667
|
* @public
|
|
632
668
|
*/
|
|
633
669
|
roleArn: string | undefined;
|
|
634
670
|
/**
|
|
635
|
-
* <p> The user-defined criteria that specifies when a job stops running.</p>
|
|
671
|
+
* <p> The user-defined criteria that specifies when a hybrid job stops running.</p>
|
|
636
672
|
* @public
|
|
637
673
|
*/
|
|
638
674
|
stoppingCondition?: JobStoppingCondition | undefined;
|
|
639
675
|
/**
|
|
640
|
-
* <p>Configuration of the resource instances to use while running the hybrid job on Amazon
|
|
641
|
-
* Braket.</p>
|
|
676
|
+
* <p>Configuration of the resource instances to use while running the hybrid job on Amazon Braket.</p>
|
|
642
677
|
* @public
|
|
643
678
|
*/
|
|
644
679
|
instanceConfig: InstanceConfig | undefined;
|
|
645
680
|
/**
|
|
646
|
-
* <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
|
|
647
|
-
* the training job. The values are set with a string of JSON key:value pairs, where the key
|
|
648
|
-
* is the name of the hyperparameter and the value is the value of th hyperparameter.</p>
|
|
681
|
+
* <p>Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.</p> <important> <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.</p> </important>
|
|
649
682
|
* @public
|
|
650
683
|
*/
|
|
651
684
|
hyperParameters?: Record<string, string> | undefined;
|
|
652
685
|
/**
|
|
653
|
-
* <p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket
|
|
654
|
-
* job.</p>
|
|
686
|
+
* <p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.</p>
|
|
655
687
|
* @public
|
|
656
688
|
*/
|
|
657
689
|
deviceConfig: DeviceConfig | undefined;
|
|
658
690
|
/**
|
|
659
|
-
* <p>
|
|
660
|
-
* Amazon Braket resources.</p>
|
|
691
|
+
* <p>Tags to be added to the hybrid job you're creating.</p>
|
|
661
692
|
* @public
|
|
662
693
|
*/
|
|
663
694
|
tags?: Record<string, string> | undefined;
|
|
@@ -672,7 +703,7 @@ export interface CreateJobRequest {
|
|
|
672
703
|
*/
|
|
673
704
|
export interface CreateJobResponse {
|
|
674
705
|
/**
|
|
675
|
-
* <p>The ARN of the Amazon Braket job created.</p>
|
|
706
|
+
* <p>The ARN of the Amazon Braket hybrid job created.</p>
|
|
676
707
|
* @public
|
|
677
708
|
*/
|
|
678
709
|
jobArn: string | undefined;
|
|
@@ -729,12 +760,12 @@ export type HybridJobAdditionalAttributeName = (typeof HybridJobAdditionalAttrib
|
|
|
729
760
|
*/
|
|
730
761
|
export interface GetJobRequest {
|
|
731
762
|
/**
|
|
732
|
-
* <p>The ARN of the job to retrieve.</p>
|
|
763
|
+
* <p>The ARN of the hybrid job to retrieve.</p>
|
|
733
764
|
* @public
|
|
734
765
|
*/
|
|
735
766
|
jobArn: string | undefined;
|
|
736
767
|
/**
|
|
737
|
-
* <p>A list of attributes to return information for
|
|
768
|
+
* <p>A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported. </p>
|
|
738
769
|
* @public
|
|
739
770
|
*/
|
|
740
771
|
additionalAttributeNames?: HybridJobAdditionalAttributeName[] | undefined;
|
|
@@ -761,28 +792,28 @@ export declare const JobEventType: {
|
|
|
761
792
|
*/
|
|
762
793
|
export type JobEventType = (typeof JobEventType)[keyof typeof JobEventType];
|
|
763
794
|
/**
|
|
764
|
-
* <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
|
|
795
|
+
* <p>Details about the type and time events that occurred related to the Amazon Braket hybrid job.</p>
|
|
765
796
|
* @public
|
|
766
797
|
*/
|
|
767
798
|
export interface JobEventDetails {
|
|
768
799
|
/**
|
|
769
|
-
* <p>The type of event that occurred related to the Amazon Braket job.</p>
|
|
800
|
+
* <p>The type of event that occurred related to the Amazon Braket hybrid job.</p>
|
|
770
801
|
* @public
|
|
771
802
|
*/
|
|
772
803
|
eventType?: JobEventType | undefined;
|
|
773
804
|
/**
|
|
774
|
-
* <p>The
|
|
805
|
+
* <p>The time of the event that occurred related to the Amazon Braket hybrid job.</p>
|
|
775
806
|
* @public
|
|
776
807
|
*/
|
|
777
808
|
timeOfEvent?: Date | undefined;
|
|
778
809
|
/**
|
|
779
|
-
* <p>A message describing the event that occurred related to the Amazon Braket job.</p>
|
|
810
|
+
* <p>A message describing the event that occurred related to the Amazon Braket hybrid job.</p>
|
|
780
811
|
* @public
|
|
781
812
|
*/
|
|
782
813
|
message?: string | undefined;
|
|
783
814
|
}
|
|
784
815
|
/**
|
|
785
|
-
* <p>Information about the queue for a specified job.</p>
|
|
816
|
+
* <p>Information about the queue for a specified hybrid job.</p>
|
|
786
817
|
* @public
|
|
787
818
|
*/
|
|
788
819
|
export interface HybridJobQueueInfo {
|
|
@@ -792,14 +823,12 @@ export interface HybridJobQueueInfo {
|
|
|
792
823
|
*/
|
|
793
824
|
queue: QueueName | undefined;
|
|
794
825
|
/**
|
|
795
|
-
* <p>Current position of the job in the jobs queue.</p>
|
|
826
|
+
* <p>Current position of the hybrid job in the jobs queue.</p>
|
|
796
827
|
* @public
|
|
797
828
|
*/
|
|
798
829
|
position: string | undefined;
|
|
799
830
|
/**
|
|
800
|
-
* <p>Optional. Provides more information about the queue position. For example,
|
|
801
|
-
* if the job is complete and no longer in the queue, the message field contains
|
|
802
|
-
* that information.</p>
|
|
831
|
+
* <p>Optional. Provides more information about the queue position. For example, if the hybrid job is complete and no longer in the queue, the message field contains that information.</p>
|
|
803
832
|
* @public
|
|
804
833
|
*/
|
|
805
834
|
message?: string | undefined;
|
|
@@ -825,65 +854,57 @@ export type JobPrimaryStatus = (typeof JobPrimaryStatus)[keyof typeof JobPrimary
|
|
|
825
854
|
*/
|
|
826
855
|
export interface GetJobResponse {
|
|
827
856
|
/**
|
|
828
|
-
* <p>The status of the Amazon Braket job.</p>
|
|
857
|
+
* <p>The status of the Amazon Braket hybrid job.</p>
|
|
829
858
|
* @public
|
|
830
859
|
*/
|
|
831
860
|
status: JobPrimaryStatus | undefined;
|
|
832
861
|
/**
|
|
833
|
-
* <p>The ARN of the Amazon Braket job.</p>
|
|
862
|
+
* <p>The ARN of the Amazon Braket hybrid job.</p>
|
|
834
863
|
* @public
|
|
835
864
|
*/
|
|
836
865
|
jobArn: string | undefined;
|
|
837
866
|
/**
|
|
838
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
|
|
839
|
-
* tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
|
|
840
|
-
* on behalf of user, and output resources to the s3 buckets of a user.</p>
|
|
867
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user.</p>
|
|
841
868
|
* @public
|
|
842
869
|
*/
|
|
843
870
|
roleArn: string | undefined;
|
|
844
871
|
/**
|
|
845
|
-
* <p>A description of the reason why an Amazon Braket job failed, if it failed.</p>
|
|
872
|
+
* <p>A description of the reason why an Amazon Braket hybrid job failed, if it failed.</p>
|
|
846
873
|
* @public
|
|
847
874
|
*/
|
|
848
875
|
failureReason?: string | undefined;
|
|
849
876
|
/**
|
|
850
|
-
* <p>The name of the Amazon Braket job.</p>
|
|
877
|
+
* <p>The name of the Amazon Braket hybrid job.</p>
|
|
851
878
|
* @public
|
|
852
879
|
*/
|
|
853
880
|
jobName: string | undefined;
|
|
854
881
|
/**
|
|
855
|
-
* <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
|
|
856
|
-
* the traiing job. The values are set with a string of JSON key:value pairs, where the key is
|
|
857
|
-
* the name of the hyperparameter and the value is the value of th hyperparameter.</p>
|
|
882
|
+
* <p>Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.</p>
|
|
858
883
|
* @public
|
|
859
884
|
*/
|
|
860
885
|
hyperParameters?: Record<string, string> | undefined;
|
|
861
886
|
/**
|
|
862
|
-
* <p>A list of parameters that specify the name and type of input data and where it is
|
|
863
|
-
* located.</p>
|
|
887
|
+
* <p>A list of parameters that specify the name and type of input data and where it is located.</p>
|
|
864
888
|
* @public
|
|
865
889
|
*/
|
|
866
890
|
inputDataConfig?: InputFileConfig[] | undefined;
|
|
867
891
|
/**
|
|
868
|
-
* <p>The path to the S3 location where job artifacts are stored and the encryption key used
|
|
869
|
-
* to store them there.</p>
|
|
892
|
+
* <p>The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.</p>
|
|
870
893
|
* @public
|
|
871
894
|
*/
|
|
872
895
|
outputDataConfig: JobOutputDataConfig | undefined;
|
|
873
896
|
/**
|
|
874
|
-
* <p>The user-defined criteria that specifies when to stop a job
|
|
897
|
+
* <p>The user-defined criteria that specifies when to stop a running hybrid job.</p>
|
|
875
898
|
* @public
|
|
876
899
|
*/
|
|
877
900
|
stoppingCondition?: JobStoppingCondition | undefined;
|
|
878
901
|
/**
|
|
879
|
-
* <p>Information about the output locations for job checkpoint data.</p>
|
|
902
|
+
* <p>Information about the output locations for hybrid job checkpoint data.</p>
|
|
880
903
|
* @public
|
|
881
904
|
*/
|
|
882
905
|
checkpointConfig?: JobCheckpointConfig | undefined;
|
|
883
906
|
/**
|
|
884
|
-
* <p>Definition of the Amazon Braket job created.
|
|
885
|
-
* information about the Python scripts used for entry and training, and the user-defined
|
|
886
|
-
* metrics used to evaluation the job.</p>
|
|
907
|
+
* <p>Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.</p>
|
|
887
908
|
* @public
|
|
888
909
|
*/
|
|
889
910
|
algorithmSpecification: AlgorithmSpecification | undefined;
|
|
@@ -893,45 +914,42 @@ export interface GetJobResponse {
|
|
|
893
914
|
*/
|
|
894
915
|
instanceConfig: InstanceConfig | undefined;
|
|
895
916
|
/**
|
|
896
|
-
* <p>The
|
|
917
|
+
* <p>The time at which the Amazon Braket hybrid job was created.</p>
|
|
897
918
|
* @public
|
|
898
919
|
*/
|
|
899
920
|
createdAt: Date | undefined;
|
|
900
921
|
/**
|
|
901
|
-
* <p>The
|
|
922
|
+
* <p>The time at which the Amazon Braket hybrid job was started.</p>
|
|
902
923
|
* @public
|
|
903
924
|
*/
|
|
904
925
|
startedAt?: Date | undefined;
|
|
905
926
|
/**
|
|
906
|
-
* <p>The
|
|
927
|
+
* <p>The time at which the Amazon Braket hybrid job ended.</p>
|
|
907
928
|
* @public
|
|
908
929
|
*/
|
|
909
930
|
endedAt?: Date | undefined;
|
|
910
931
|
/**
|
|
911
|
-
* <p>The billable time the Amazon Braket job used to complete.</p>
|
|
932
|
+
* <p>The billable time for which the Amazon Braket hybrid job used to complete.</p>
|
|
912
933
|
* @public
|
|
913
934
|
*/
|
|
914
935
|
billableDuration?: number | undefined;
|
|
915
936
|
/**
|
|
916
|
-
* <p>The
|
|
937
|
+
* <p>The primary device used by the Amazon Braket hybrid job.</p>
|
|
917
938
|
* @public
|
|
918
939
|
*/
|
|
919
940
|
deviceConfig?: DeviceConfig | undefined;
|
|
920
941
|
/**
|
|
921
|
-
* <p>Details about the
|
|
942
|
+
* <p>Details about the time and type of events occurred related to the Amazon Braket hybrid job.</p>
|
|
922
943
|
* @public
|
|
923
944
|
*/
|
|
924
945
|
events?: JobEventDetails[] | undefined;
|
|
925
946
|
/**
|
|
926
|
-
* <p>
|
|
927
|
-
* Amazon Braket resources.</p>
|
|
947
|
+
* <p>The tags associated with this hybrid job.</p>
|
|
928
948
|
* @public
|
|
929
949
|
*/
|
|
930
950
|
tags?: Record<string, string> | undefined;
|
|
931
951
|
/**
|
|
932
|
-
* <p>Queue information for the requested job. Only returned if
|
|
933
|
-
* <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code>
|
|
934
|
-
* field in the <code>GetJob</code> API request.</p>
|
|
952
|
+
* <p>Queue information for the requested hybrid job. Only returned if <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code> field in the <code>GetJob</code> API request.</p>
|
|
935
953
|
* @public
|
|
936
954
|
*/
|
|
937
955
|
queueInfo?: HybridJobQueueInfo | undefined;
|
|
@@ -959,22 +977,22 @@ export declare const SearchJobsFilterOperator: {
|
|
|
959
977
|
*/
|
|
960
978
|
export type SearchJobsFilterOperator = (typeof SearchJobsFilterOperator)[keyof typeof SearchJobsFilterOperator];
|
|
961
979
|
/**
|
|
962
|
-
* <p>A filter used to search for Amazon Braket jobs.</p>
|
|
980
|
+
* <p>A filter used to search for Amazon Braket hybrid jobs.</p>
|
|
963
981
|
* @public
|
|
964
982
|
*/
|
|
965
983
|
export interface SearchJobsFilter {
|
|
966
984
|
/**
|
|
967
|
-
* <p>The name to
|
|
985
|
+
* <p>The name of the hybrid job parameter to filter based on. Filter name can be either <code>jobArn</code> or <code>createdAt</code>. </p>
|
|
968
986
|
* @public
|
|
969
987
|
*/
|
|
970
988
|
name: string | undefined;
|
|
971
989
|
/**
|
|
972
|
-
* <p>The values to
|
|
990
|
+
* <p>The values used to filter hybrid jobs based on the filter name and operator.</p>
|
|
973
991
|
* @public
|
|
974
992
|
*/
|
|
975
993
|
values: string[] | undefined;
|
|
976
994
|
/**
|
|
977
|
-
* <p>An operator to use for the
|
|
995
|
+
* <p>An operator to use for the filter.</p>
|
|
978
996
|
* @public
|
|
979
997
|
*/
|
|
980
998
|
operator: SearchJobsFilterOperator | undefined;
|
|
@@ -984,8 +1002,7 @@ export interface SearchJobsFilter {
|
|
|
984
1002
|
*/
|
|
985
1003
|
export interface SearchJobsRequest {
|
|
986
1004
|
/**
|
|
987
|
-
* <p>A token used for pagination of results returned in the response. Use the token returned
|
|
988
|
-
* from the previous request to continue results where the previous request ended.</p>
|
|
1005
|
+
* <p>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</p>
|
|
989
1006
|
* @public
|
|
990
1007
|
*/
|
|
991
1008
|
nextToken?: string | undefined;
|
|
@@ -995,55 +1012,53 @@ export interface SearchJobsRequest {
|
|
|
995
1012
|
*/
|
|
996
1013
|
maxResults?: number | undefined;
|
|
997
1014
|
/**
|
|
998
|
-
* <p>
|
|
1015
|
+
* <p>Array of SearchJobsFilter objects to use when searching for hybrid jobs.</p>
|
|
999
1016
|
* @public
|
|
1000
1017
|
*/
|
|
1001
1018
|
filters: SearchJobsFilter[] | undefined;
|
|
1002
1019
|
}
|
|
1003
1020
|
/**
|
|
1004
|
-
* <p>Provides summary information about an Amazon Braket job.</p>
|
|
1021
|
+
* <p>Provides summary information about an Amazon Braket hybrid job.</p>
|
|
1005
1022
|
* @public
|
|
1006
1023
|
*/
|
|
1007
1024
|
export interface JobSummary {
|
|
1008
1025
|
/**
|
|
1009
|
-
* <p>The status of the Amazon Braket job.</p>
|
|
1026
|
+
* <p>The status of the Amazon Braket hybrid job.</p>
|
|
1010
1027
|
* @public
|
|
1011
1028
|
*/
|
|
1012
1029
|
status: JobPrimaryStatus | undefined;
|
|
1013
1030
|
/**
|
|
1014
|
-
* <p>The ARN of the Amazon Braket job.</p>
|
|
1031
|
+
* <p>The ARN of the Amazon Braket hybrid job.</p>
|
|
1015
1032
|
* @public
|
|
1016
1033
|
*/
|
|
1017
1034
|
jobArn: string | undefined;
|
|
1018
1035
|
/**
|
|
1019
|
-
* <p>The name of the Amazon Braket job.</p>
|
|
1036
|
+
* <p>The name of the Amazon Braket hybrid job.</p>
|
|
1020
1037
|
* @public
|
|
1021
1038
|
*/
|
|
1022
1039
|
jobName: string | undefined;
|
|
1023
1040
|
/**
|
|
1024
|
-
* <p>
|
|
1025
|
-
* job.</p>
|
|
1041
|
+
* <p>The primary device used by an Amazon Braket hybrid job.</p>
|
|
1026
1042
|
* @public
|
|
1027
1043
|
*/
|
|
1028
1044
|
device: string | undefined;
|
|
1029
1045
|
/**
|
|
1030
|
-
* <p>The
|
|
1046
|
+
* <p>The time at which the Amazon Braket hybrid job was created.</p>
|
|
1031
1047
|
* @public
|
|
1032
1048
|
*/
|
|
1033
1049
|
createdAt: Date | undefined;
|
|
1034
1050
|
/**
|
|
1035
|
-
* <p>The
|
|
1051
|
+
* <p>The time at which the Amazon Braket hybrid job was started.</p>
|
|
1036
1052
|
* @public
|
|
1037
1053
|
*/
|
|
1038
1054
|
startedAt?: Date | undefined;
|
|
1039
1055
|
/**
|
|
1040
|
-
* <p>The
|
|
1056
|
+
* <p>The time at which the Amazon Braket hybrid job ended.</p>
|
|
1041
1057
|
* @public
|
|
1042
1058
|
*/
|
|
1043
1059
|
endedAt?: Date | undefined;
|
|
1044
1060
|
/**
|
|
1045
|
-
* <p>
|
|
1046
|
-
* Amazon Braket resources.</p>
|
|
1061
|
+
* <p>Displays the key, value pairs of tags associated with this hybrid job.</p>
|
|
1047
1062
|
* @public
|
|
1048
1063
|
*/
|
|
1049
1064
|
tags?: Record<string, string> | undefined;
|
|
@@ -1053,15 +1068,12 @@ export interface JobSummary {
|
|
|
1053
1068
|
*/
|
|
1054
1069
|
export interface SearchJobsResponse {
|
|
1055
1070
|
/**
|
|
1056
|
-
* <p>An array of <code>JobSummary</code> objects for devices that match the specified filter
|
|
1057
|
-
* values.</p>
|
|
1071
|
+
* <p>An array of <code>JobSummary</code> objects for devices that match the specified filter values.</p>
|
|
1058
1072
|
* @public
|
|
1059
1073
|
*/
|
|
1060
1074
|
jobs: JobSummary[] | undefined;
|
|
1061
1075
|
/**
|
|
1062
|
-
* <p>A token used for pagination of results, or <code>null</code> if there are no additional
|
|
1063
|
-
* results. Use the token value in a subsequent request to continue results where the previous
|
|
1064
|
-
* request ended.</p>
|
|
1076
|
+
* <p>A token used for pagination of results, or <code>null</code> if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.</p>
|
|
1065
1077
|
* @public
|
|
1066
1078
|
*/
|
|
1067
1079
|
nextToken?: string | undefined;
|
|
@@ -1091,12 +1103,12 @@ export interface ListTagsForResourceResponse {
|
|
|
1091
1103
|
*/
|
|
1092
1104
|
export interface CancelQuantumTaskRequest {
|
|
1093
1105
|
/**
|
|
1094
|
-
* <p>The ARN of the task to cancel.</p>
|
|
1106
|
+
* <p>The ARN of the quantum task to cancel.</p>
|
|
1095
1107
|
* @public
|
|
1096
1108
|
*/
|
|
1097
1109
|
quantumTaskArn: string | undefined;
|
|
1098
1110
|
/**
|
|
1099
|
-
* <p>The client token associated with the request.</p>
|
|
1111
|
+
* <p>The client token associated with the cancellation request.</p>
|
|
1100
1112
|
* @public
|
|
1101
1113
|
*/
|
|
1102
1114
|
clientToken?: string | undefined;
|
|
@@ -1106,12 +1118,12 @@ export interface CancelQuantumTaskRequest {
|
|
|
1106
1118
|
*/
|
|
1107
1119
|
export interface CancelQuantumTaskResponse {
|
|
1108
1120
|
/**
|
|
1109
|
-
* <p>The ARN of the task.</p>
|
|
1121
|
+
* <p>The ARN of the quantum task.</p>
|
|
1110
1122
|
* @public
|
|
1111
1123
|
*/
|
|
1112
1124
|
quantumTaskArn: string | undefined;
|
|
1113
1125
|
/**
|
|
1114
|
-
* <p>The status of the
|
|
1126
|
+
* <p>The status of the quantum task.</p>
|
|
1115
1127
|
* @public
|
|
1116
1128
|
*/
|
|
1117
1129
|
cancellationStatus: CancellationStatus | undefined;
|
|
@@ -1126,32 +1138,32 @@ export interface CreateQuantumTaskRequest {
|
|
|
1126
1138
|
*/
|
|
1127
1139
|
clientToken?: string | undefined;
|
|
1128
1140
|
/**
|
|
1129
|
-
* <p>The ARN of the device to run the task on.</p>
|
|
1141
|
+
* <p>The ARN of the device to run the quantum task on.</p>
|
|
1130
1142
|
* @public
|
|
1131
1143
|
*/
|
|
1132
1144
|
deviceArn: string | undefined;
|
|
1133
1145
|
/**
|
|
1134
|
-
* <p>The parameters for the device to run the task on.</p>
|
|
1146
|
+
* <p>The parameters for the device to run the quantum task on.</p>
|
|
1135
1147
|
* @public
|
|
1136
1148
|
*/
|
|
1137
1149
|
deviceParameters?: __AutomaticJsonStringConversion | string | undefined;
|
|
1138
1150
|
/**
|
|
1139
|
-
* <p>The number of shots to use for the task.</p>
|
|
1151
|
+
* <p>The number of shots to use for the quantum task.</p>
|
|
1140
1152
|
* @public
|
|
1141
1153
|
*/
|
|
1142
1154
|
shots: number | undefined;
|
|
1143
1155
|
/**
|
|
1144
|
-
* <p>The S3 bucket to store task result files in.</p>
|
|
1156
|
+
* <p>The S3 bucket to store quantum task result files in.</p>
|
|
1145
1157
|
* @public
|
|
1146
1158
|
*/
|
|
1147
1159
|
outputS3Bucket: string | undefined;
|
|
1148
1160
|
/**
|
|
1149
|
-
* <p>The key prefix for the location in the S3 bucket to store task results in.</p>
|
|
1161
|
+
* <p>The key prefix for the location in the S3 bucket to store quantum task results in.</p>
|
|
1150
1162
|
* @public
|
|
1151
1163
|
*/
|
|
1152
1164
|
outputS3KeyPrefix: string | undefined;
|
|
1153
1165
|
/**
|
|
1154
|
-
* <p>The action associated with the task.</p>
|
|
1166
|
+
* <p>The action associated with the quantum task.</p>
|
|
1155
1167
|
* @public
|
|
1156
1168
|
*/
|
|
1157
1169
|
action: __AutomaticJsonStringConversion | string | undefined;
|
|
@@ -1161,7 +1173,7 @@ export interface CreateQuantumTaskRequest {
|
|
|
1161
1173
|
*/
|
|
1162
1174
|
tags?: Record<string, string> | undefined;
|
|
1163
1175
|
/**
|
|
1164
|
-
* <p>The token for an Amazon Braket job that associates it with the quantum task.</p>
|
|
1176
|
+
* <p>The token for an Amazon Braket hybrid job that associates it with the quantum task.</p>
|
|
1165
1177
|
* @public
|
|
1166
1178
|
*/
|
|
1167
1179
|
jobToken?: string | undefined;
|
|
@@ -1176,7 +1188,7 @@ export interface CreateQuantumTaskRequest {
|
|
|
1176
1188
|
*/
|
|
1177
1189
|
export interface CreateQuantumTaskResponse {
|
|
1178
1190
|
/**
|
|
1179
|
-
* <p>The ARN of the task created by the request.</p>
|
|
1191
|
+
* <p>The ARN of the quantum task created by the request.</p>
|
|
1180
1192
|
* @public
|
|
1181
1193
|
*/
|
|
1182
1194
|
quantumTaskArn: string | undefined;
|
|
@@ -1197,18 +1209,18 @@ export type QuantumTaskAdditionalAttributeName = (typeof QuantumTaskAdditionalAt
|
|
|
1197
1209
|
*/
|
|
1198
1210
|
export interface GetQuantumTaskRequest {
|
|
1199
1211
|
/**
|
|
1200
|
-
* <p>The ARN of the task to retrieve.</p>
|
|
1212
|
+
* <p>The ARN of the quantum task to retrieve.</p>
|
|
1201
1213
|
* @public
|
|
1202
1214
|
*/
|
|
1203
1215
|
quantumTaskArn: string | undefined;
|
|
1204
1216
|
/**
|
|
1205
|
-
* <p>A list of attributes to return information for.</p>
|
|
1217
|
+
* <p>A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.</p>
|
|
1206
1218
|
* @public
|
|
1207
1219
|
*/
|
|
1208
1220
|
additionalAttributeNames?: QuantumTaskAdditionalAttributeName[] | undefined;
|
|
1209
1221
|
}
|
|
1210
1222
|
/**
|
|
1211
|
-
* <p>
|
|
1223
|
+
* <p>The queue information for the specified quantum task.</p>
|
|
1212
1224
|
* @public
|
|
1213
1225
|
*/
|
|
1214
1226
|
export interface QuantumTaskQueueInfo {
|
|
@@ -1218,20 +1230,17 @@ export interface QuantumTaskQueueInfo {
|
|
|
1218
1230
|
*/
|
|
1219
1231
|
queue: QueueName | undefined;
|
|
1220
1232
|
/**
|
|
1221
|
-
* <p>Current position of the task in the quantum tasks queue.</p>
|
|
1233
|
+
* <p>Current position of the quantum task in the quantum tasks queue.</p>
|
|
1222
1234
|
* @public
|
|
1223
1235
|
*/
|
|
1224
1236
|
position: string | undefined;
|
|
1225
1237
|
/**
|
|
1226
|
-
* <p>Optional. Specifies the priority of the queue. Quantum tasks in a priority queue
|
|
1227
|
-
* are processed before the tasks in a normal queue.</p>
|
|
1238
|
+
* <p>Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.</p>
|
|
1228
1239
|
* @public
|
|
1229
1240
|
*/
|
|
1230
1241
|
queuePriority?: QueuePriority | undefined;
|
|
1231
1242
|
/**
|
|
1232
|
-
* <p>Optional. Provides more information about the queue position. For example,
|
|
1233
|
-
* if the task is complete and no longer in the queue, the message field contains
|
|
1234
|
-
* that information.</p>
|
|
1243
|
+
* <p>Optional. Provides more information about the queue position. For example, if the quantum task is complete and no longer in the queue, the message field contains that information.</p>
|
|
1235
1244
|
* @public
|
|
1236
1245
|
*/
|
|
1237
1246
|
message?: string | undefined;
|
|
@@ -1258,57 +1267,57 @@ export type QuantumTaskStatus = (typeof QuantumTaskStatus)[keyof typeof QuantumT
|
|
|
1258
1267
|
*/
|
|
1259
1268
|
export interface GetQuantumTaskResponse {
|
|
1260
1269
|
/**
|
|
1261
|
-
* <p>The ARN of the task.</p>
|
|
1270
|
+
* <p>The ARN of the quantum task.</p>
|
|
1262
1271
|
* @public
|
|
1263
1272
|
*/
|
|
1264
1273
|
quantumTaskArn: string | undefined;
|
|
1265
1274
|
/**
|
|
1266
|
-
* <p>The status of the task.</p>
|
|
1275
|
+
* <p>The status of the quantum task.</p>
|
|
1267
1276
|
* @public
|
|
1268
1277
|
*/
|
|
1269
1278
|
status: QuantumTaskStatus | undefined;
|
|
1270
1279
|
/**
|
|
1271
|
-
* <p>The reason that a task failed.</p>
|
|
1280
|
+
* <p>The reason that a quantum task failed.</p>
|
|
1272
1281
|
* @public
|
|
1273
1282
|
*/
|
|
1274
1283
|
failureReason?: string | undefined;
|
|
1275
1284
|
/**
|
|
1276
|
-
* <p>The ARN of the device the task was run on.</p>
|
|
1285
|
+
* <p>The ARN of the device the quantum task was run on.</p>
|
|
1277
1286
|
* @public
|
|
1278
1287
|
*/
|
|
1279
1288
|
deviceArn: string | undefined;
|
|
1280
1289
|
/**
|
|
1281
|
-
* <p>The parameters for the device on which the task ran.</p>
|
|
1290
|
+
* <p>The parameters for the device on which the quantum task ran.</p>
|
|
1282
1291
|
* @public
|
|
1283
1292
|
*/
|
|
1284
1293
|
deviceParameters: __AutomaticJsonStringConversion | string | undefined;
|
|
1285
1294
|
/**
|
|
1286
|
-
* <p>The number of shots used in the task.</p>
|
|
1295
|
+
* <p>The number of shots used in the quantum task.</p>
|
|
1287
1296
|
* @public
|
|
1288
1297
|
*/
|
|
1289
1298
|
shots: number | undefined;
|
|
1290
1299
|
/**
|
|
1291
|
-
* <p>The S3 bucket where task results are stored.</p>
|
|
1300
|
+
* <p>The S3 bucket where quantum task results are stored.</p>
|
|
1292
1301
|
* @public
|
|
1293
1302
|
*/
|
|
1294
1303
|
outputS3Bucket: string | undefined;
|
|
1295
1304
|
/**
|
|
1296
|
-
* <p>The folder in the S3 bucket where task results are stored.</p>
|
|
1305
|
+
* <p>The folder in the S3 bucket where quantum task results are stored.</p>
|
|
1297
1306
|
* @public
|
|
1298
1307
|
*/
|
|
1299
1308
|
outputS3Directory: string | undefined;
|
|
1300
1309
|
/**
|
|
1301
|
-
* <p>The time at which the task was created.</p>
|
|
1310
|
+
* <p>The time at which the quantum task was created.</p>
|
|
1302
1311
|
* @public
|
|
1303
1312
|
*/
|
|
1304
1313
|
createdAt: Date | undefined;
|
|
1305
1314
|
/**
|
|
1306
|
-
* <p>The time at which the task ended.</p>
|
|
1315
|
+
* <p>The time at which the quantum task ended.</p>
|
|
1307
1316
|
* @public
|
|
1308
1317
|
*/
|
|
1309
1318
|
endedAt?: Date | undefined;
|
|
1310
1319
|
/**
|
|
1311
|
-
* <p>The tags that belong to this task.</p>
|
|
1320
|
+
* <p>The tags that belong to this quantum task.</p>
|
|
1312
1321
|
* @public
|
|
1313
1322
|
*/
|
|
1314
1323
|
tags?: Record<string, string> | undefined;
|
|
@@ -1318,9 +1327,7 @@ export interface GetQuantumTaskResponse {
|
|
|
1318
1327
|
*/
|
|
1319
1328
|
jobArn?: string | undefined;
|
|
1320
1329
|
/**
|
|
1321
|
-
* <p>Queue information for the requested quantum task. Only returned if
|
|
1322
|
-
* <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code>
|
|
1323
|
-
* field in the <code>GetQuantumTask</code> API request.</p>
|
|
1330
|
+
* <p>Queue information for the requested quantum task. Only returned if <code>QueueInfo</code> is specified in the <code>additionalAttributeNames"</code> field in the <code>GetQuantumTask</code> API request.</p>
|
|
1324
1331
|
* @public
|
|
1325
1332
|
*/
|
|
1326
1333
|
queueInfo?: QuantumTaskQueueInfo | undefined;
|
|
@@ -1329,6 +1336,16 @@ export interface GetQuantumTaskResponse {
|
|
|
1329
1336
|
* @public
|
|
1330
1337
|
*/
|
|
1331
1338
|
associations?: Association[] | undefined;
|
|
1339
|
+
/**
|
|
1340
|
+
* <p>The number of successful shots for the quantum task. This is available after a successfully completed quantum task.</p>
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
numSuccessfulShots?: number | undefined;
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>Metadata about the action performed by the quantum task, including information about the type of action and program counts.</p>
|
|
1346
|
+
* @public
|
|
1347
|
+
*/
|
|
1348
|
+
actionMetadata?: ActionMetadata | undefined;
|
|
1332
1349
|
}
|
|
1333
1350
|
/**
|
|
1334
1351
|
* @public
|
|
@@ -1347,22 +1364,22 @@ export declare const SearchQuantumTasksFilterOperator: {
|
|
|
1347
1364
|
*/
|
|
1348
1365
|
export type SearchQuantumTasksFilterOperator = (typeof SearchQuantumTasksFilterOperator)[keyof typeof SearchQuantumTasksFilterOperator];
|
|
1349
1366
|
/**
|
|
1350
|
-
* <p>A filter
|
|
1367
|
+
* <p>A filter used to search for quantum tasks.</p>
|
|
1351
1368
|
* @public
|
|
1352
1369
|
*/
|
|
1353
1370
|
export interface SearchQuantumTasksFilter {
|
|
1354
1371
|
/**
|
|
1355
|
-
* <p>The name of the
|
|
1372
|
+
* <p>The name of the quantum task parameter to filter based on. Filter name can be either <code>quantumTaskArn</code>, <code>deviceArn</code>, <code>jobArn</code>, <code>status</code> or <code>createdAt</code>.</p>
|
|
1356
1373
|
* @public
|
|
1357
1374
|
*/
|
|
1358
1375
|
name: string | undefined;
|
|
1359
1376
|
/**
|
|
1360
|
-
* <p>The values to
|
|
1377
|
+
* <p>The values used to filter quantum tasks based on the filter name and operator.</p>
|
|
1361
1378
|
* @public
|
|
1362
1379
|
*/
|
|
1363
1380
|
values: string[] | undefined;
|
|
1364
1381
|
/**
|
|
1365
|
-
* <p>An operator to use
|
|
1382
|
+
* <p>An operator to use for the filter.</p>
|
|
1366
1383
|
* @public
|
|
1367
1384
|
*/
|
|
1368
1385
|
operator: SearchQuantumTasksFilterOperator | undefined;
|
|
@@ -1372,8 +1389,7 @@ export interface SearchQuantumTasksFilter {
|
|
|
1372
1389
|
*/
|
|
1373
1390
|
export interface SearchQuantumTasksRequest {
|
|
1374
1391
|
/**
|
|
1375
|
-
* <p>A token used for pagination of results returned in the response. Use the token returned
|
|
1376
|
-
* from the previous request continue results where the previous request ended.</p>
|
|
1392
|
+
* <p>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</p>
|
|
1377
1393
|
* @public
|
|
1378
1394
|
*/
|
|
1379
1395
|
nextToken?: string | undefined;
|
|
@@ -1383,7 +1399,7 @@ export interface SearchQuantumTasksRequest {
|
|
|
1383
1399
|
*/
|
|
1384
1400
|
maxResults?: number | undefined;
|
|
1385
1401
|
/**
|
|
1386
|
-
* <p>Array of <code>SearchQuantumTasksFilter</code> objects.</p>
|
|
1402
|
+
* <p>Array of <code>SearchQuantumTasksFilter</code> objects to use when searching for quantum tasks.</p>
|
|
1387
1403
|
* @public
|
|
1388
1404
|
*/
|
|
1389
1405
|
filters: SearchQuantumTasksFilter[] | undefined;
|
|
@@ -1394,42 +1410,42 @@ export interface SearchQuantumTasksRequest {
|
|
|
1394
1410
|
*/
|
|
1395
1411
|
export interface QuantumTaskSummary {
|
|
1396
1412
|
/**
|
|
1397
|
-
* <p>The ARN of the task.</p>
|
|
1413
|
+
* <p>The ARN of the quantum task.</p>
|
|
1398
1414
|
* @public
|
|
1399
1415
|
*/
|
|
1400
1416
|
quantumTaskArn: string | undefined;
|
|
1401
1417
|
/**
|
|
1402
|
-
* <p>The status of the task.</p>
|
|
1418
|
+
* <p>The status of the quantum task.</p>
|
|
1403
1419
|
* @public
|
|
1404
1420
|
*/
|
|
1405
1421
|
status: QuantumTaskStatus | undefined;
|
|
1406
1422
|
/**
|
|
1407
|
-
* <p>The ARN of the device the task ran on.</p>
|
|
1423
|
+
* <p>The ARN of the device the quantum task ran on.</p>
|
|
1408
1424
|
* @public
|
|
1409
1425
|
*/
|
|
1410
1426
|
deviceArn: string | undefined;
|
|
1411
1427
|
/**
|
|
1412
|
-
* <p>The shots used for the task.</p>
|
|
1428
|
+
* <p>The shots used for the quantum task.</p>
|
|
1413
1429
|
* @public
|
|
1414
1430
|
*/
|
|
1415
1431
|
shots: number | undefined;
|
|
1416
1432
|
/**
|
|
1417
|
-
* <p>The S3 bucket where the task result file is stored
|
|
1433
|
+
* <p>The S3 bucket where the quantum task result file is stored.</p>
|
|
1418
1434
|
* @public
|
|
1419
1435
|
*/
|
|
1420
1436
|
outputS3Bucket: string | undefined;
|
|
1421
1437
|
/**
|
|
1422
|
-
* <p>The folder in the S3 bucket where the task result file is stored.</p>
|
|
1438
|
+
* <p>The folder in the S3 bucket where the quantum task result file is stored.</p>
|
|
1423
1439
|
* @public
|
|
1424
1440
|
*/
|
|
1425
1441
|
outputS3Directory: string | undefined;
|
|
1426
1442
|
/**
|
|
1427
|
-
* <p>The time at which the task was created.</p>
|
|
1443
|
+
* <p>The time at which the quantum task was created.</p>
|
|
1428
1444
|
* @public
|
|
1429
1445
|
*/
|
|
1430
1446
|
createdAt: Date | undefined;
|
|
1431
1447
|
/**
|
|
1432
|
-
* <p>The time at which the task finished.</p>
|
|
1448
|
+
* <p>The time at which the quantum task finished.</p>
|
|
1433
1449
|
* @public
|
|
1434
1450
|
*/
|
|
1435
1451
|
endedAt?: Date | undefined;
|
|
@@ -1444,15 +1460,12 @@ export interface QuantumTaskSummary {
|
|
|
1444
1460
|
*/
|
|
1445
1461
|
export interface SearchQuantumTasksResponse {
|
|
1446
1462
|
/**
|
|
1447
|
-
* <p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified
|
|
1448
|
-
* filters.</p>
|
|
1463
|
+
* <p>An array of <code>QuantumTaskSummary</code> objects for quantum tasks that match the specified filters.</p>
|
|
1449
1464
|
* @public
|
|
1450
1465
|
*/
|
|
1451
1466
|
quantumTasks: QuantumTaskSummary[] | undefined;
|
|
1452
1467
|
/**
|
|
1453
|
-
* <p>A token used for pagination of results, or null if there are no additional results. Use
|
|
1454
|
-
* the token value in a subsequent request to continue results where the previous request
|
|
1455
|
-
* ended.</p>
|
|
1468
|
+
* <p>A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.</p>
|
|
1456
1469
|
* @public
|
|
1457
1470
|
*/
|
|
1458
1471
|
nextToken?: string | undefined;
|
|
@@ -1462,13 +1475,12 @@ export interface SearchQuantumTasksResponse {
|
|
|
1462
1475
|
*/
|
|
1463
1476
|
export interface TagResourceRequest {
|
|
1464
1477
|
/**
|
|
1465
|
-
* <p>Specify the <code>resourceArn</code> of the resource to which a tag will be
|
|
1466
|
-
* added.</p>
|
|
1478
|
+
* <p>Specify the <code>resourceArn</code> of the resource to which a tag will be added.</p>
|
|
1467
1479
|
* @public
|
|
1468
1480
|
*/
|
|
1469
1481
|
resourceArn: string | undefined;
|
|
1470
1482
|
/**
|
|
1471
|
-
* <p>Specify the tags to add to the resource.</p>
|
|
1483
|
+
* <p>Specify the tags to add to the resource. Tags can be specified as a key-value map.</p>
|
|
1472
1484
|
* @public
|
|
1473
1485
|
*/
|
|
1474
1486
|
tags: Record<string, string> | undefined;
|
|
@@ -1483,8 +1495,7 @@ export interface TagResourceResponse {
|
|
|
1483
1495
|
*/
|
|
1484
1496
|
export interface UntagResourceRequest {
|
|
1485
1497
|
/**
|
|
1486
|
-
* <p>Specify the <code>resourceArn</code> for the resource from which to remove the
|
|
1487
|
-
* tags.</p>
|
|
1498
|
+
* <p>Specify the <code>resourceArn</code> for the resource from which to remove the tags.</p>
|
|
1488
1499
|
* @public
|
|
1489
1500
|
*/
|
|
1490
1501
|
resourceArn: string | undefined;
|