@aws-sdk/client-braket 3.42.0 → 3.43.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/CHANGELOG.md +11 -0
- package/README.md +7 -7
- package/dist-cjs/Braket.js +60 -0
- package/dist-cjs/commands/CancelJobCommand.js +36 -0
- package/dist-cjs/commands/CreateJobCommand.js +36 -0
- package/dist-cjs/commands/GetJobCommand.js +36 -0
- package/dist-cjs/commands/SearchJobsCommand.js +36 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/models/models_0.js +237 -24
- package/dist-cjs/pagination/SearchJobsPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +824 -25
- package/dist-es/Braket.js +60 -0
- package/dist-es/commands/CancelJobCommand.js +39 -0
- package/dist-es/commands/CreateJobCommand.js +39 -0
- package/dist-es/commands/GetJobCommand.js +39 -0
- package/dist-es/commands/SearchJobsCommand.js +39 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +189 -21
- package/dist-es/pagination/SearchJobsPaginator.js +74 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +887 -66
- package/dist-types/Braket.d.ts +28 -0
- package/dist-types/BraketClient.d.ts +6 -2
- package/dist-types/commands/CancelJobCommand.d.ts +35 -0
- package/dist-types/commands/CreateJobCommand.d.ts +35 -0
- package/dist-types/commands/GetJobCommand.d.ts +35 -0
- package/dist-types/commands/SearchJobsCommand.d.ts +35 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +674 -37
- package/dist-types/pagination/SearchJobsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +12 -0
- package/dist-types/ts3.4/Braket.d.ts +20 -0
- package/dist-types/ts3.4/BraketClient.d.ts +6 -2
- package/dist-types/ts3.4/commands/CancelJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetJobCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SearchJobsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +413 -30
- package/dist-types/ts3.4/pagination/SearchJobsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +2 -2
|
@@ -15,32 +15,68 @@ export declare namespace AccessDeniedException {
|
|
|
15
15
|
const filterSensitiveLog: (obj: AccessDeniedException) => any;
|
|
16
16
|
}
|
|
17
17
|
/**
|
|
18
|
-
* <p>The
|
|
18
|
+
* <p>The container image used to create an Amazon Braket job.</p>
|
|
19
19
|
*/
|
|
20
|
-
export interface
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
export interface ContainerImage {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The URI locating the container image.</p>
|
|
23
|
+
*/
|
|
24
|
+
uri: string | undefined;
|
|
24
25
|
}
|
|
25
|
-
export declare namespace
|
|
26
|
+
export declare namespace ContainerImage {
|
|
26
27
|
/**
|
|
27
28
|
* @internal
|
|
28
29
|
*/
|
|
29
|
-
const filterSensitiveLog: (obj:
|
|
30
|
+
const filterSensitiveLog: (obj: ContainerImage) => any;
|
|
31
|
+
}
|
|
32
|
+
export declare enum CompressionType {
|
|
33
|
+
GZIP = "GZIP",
|
|
34
|
+
NONE = "NONE"
|
|
30
35
|
}
|
|
31
36
|
/**
|
|
32
|
-
* <p>
|
|
37
|
+
* <p>Contains information about the Python scripts used for entry and by an Amazon Braket job.</p>
|
|
33
38
|
*/
|
|
34
|
-
export interface
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
39
|
+
export interface ScriptModeConfig {
|
|
40
|
+
/**
|
|
41
|
+
* <p>The path to the Python script that serves as the entry point for an Amazon Braket
|
|
42
|
+
* job.</p>
|
|
43
|
+
*/
|
|
44
|
+
entryPoint: string | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The URI that specifies the S3 path to the Python script module that contains the
|
|
47
|
+
* training script used by an Amazon Braket job.</p>
|
|
48
|
+
*/
|
|
49
|
+
s3Uri: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The type of compression used by the Python scripts for an Amazon Braket job.</p>
|
|
52
|
+
*/
|
|
53
|
+
compressionType?: CompressionType | string;
|
|
38
54
|
}
|
|
39
|
-
export declare namespace
|
|
55
|
+
export declare namespace ScriptModeConfig {
|
|
40
56
|
/**
|
|
41
57
|
* @internal
|
|
42
58
|
*/
|
|
43
|
-
const filterSensitiveLog: (obj:
|
|
59
|
+
const filterSensitiveLog: (obj: ScriptModeConfig) => any;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* <p>Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to
|
|
63
|
+
* the Python scripts used for entry and training.</p>
|
|
64
|
+
*/
|
|
65
|
+
export interface AlgorithmSpecification {
|
|
66
|
+
/**
|
|
67
|
+
* <p>Configures the paths to the Python scripts used for entry and training.</p>
|
|
68
|
+
*/
|
|
69
|
+
scriptModeConfig?: ScriptModeConfig;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The container image used to create an Amazon Braket job.</p>
|
|
72
|
+
*/
|
|
73
|
+
containerImage?: ContainerImage;
|
|
74
|
+
}
|
|
75
|
+
export declare namespace AlgorithmSpecification {
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
79
|
+
const filterSensitiveLog: (obj: AlgorithmSpecification) => any;
|
|
44
80
|
}
|
|
45
81
|
export interface GetDeviceRequest {
|
|
46
82
|
/**
|
|
@@ -237,6 +273,617 @@ export declare namespace SearchDevicesResponse {
|
|
|
237
273
|
*/
|
|
238
274
|
const filterSensitiveLog: (obj: SearchDevicesResponse) => any;
|
|
239
275
|
}
|
|
276
|
+
export interface CancelJobRequest {
|
|
277
|
+
/**
|
|
278
|
+
* <p>The ARN of the Amazon Braket job to cancel.</p>
|
|
279
|
+
*/
|
|
280
|
+
jobArn: string | undefined;
|
|
281
|
+
}
|
|
282
|
+
export declare namespace CancelJobRequest {
|
|
283
|
+
/**
|
|
284
|
+
* @internal
|
|
285
|
+
*/
|
|
286
|
+
const filterSensitiveLog: (obj: CancelJobRequest) => any;
|
|
287
|
+
}
|
|
288
|
+
export declare enum CancellationStatus {
|
|
289
|
+
CANCELLED = "CANCELLED",
|
|
290
|
+
CANCELLING = "CANCELLING"
|
|
291
|
+
}
|
|
292
|
+
export interface CancelJobResponse {
|
|
293
|
+
/**
|
|
294
|
+
* <p>The ARN of the Amazon Braket job.</p>
|
|
295
|
+
*/
|
|
296
|
+
jobArn: string | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* <p>The status of the job cancellation request.</p>
|
|
299
|
+
*/
|
|
300
|
+
cancellationStatus: CancellationStatus | string | undefined;
|
|
301
|
+
}
|
|
302
|
+
export declare namespace CancelJobResponse {
|
|
303
|
+
/**
|
|
304
|
+
* @internal
|
|
305
|
+
*/
|
|
306
|
+
const filterSensitiveLog: (obj: CancelJobResponse) => any;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* <p>An error occurred due to a conflict.</p>
|
|
310
|
+
*/
|
|
311
|
+
export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
312
|
+
name: "ConflictException";
|
|
313
|
+
$fault: "client";
|
|
314
|
+
message?: string;
|
|
315
|
+
}
|
|
316
|
+
export declare namespace ConflictException {
|
|
317
|
+
/**
|
|
318
|
+
* @internal
|
|
319
|
+
*/
|
|
320
|
+
const filterSensitiveLog: (obj: ConflictException) => any;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* <p>Contains information about the output locations for job checkpoint data.</p>
|
|
324
|
+
*/
|
|
325
|
+
export interface JobCheckpointConfig {
|
|
326
|
+
/**
|
|
327
|
+
* <p>(Optional) The local directory where checkpoints are written. The default directory is <code>/opt/braket/checkpoints/</code>.</p>
|
|
328
|
+
*/
|
|
329
|
+
localPath?: string;
|
|
330
|
+
/**
|
|
331
|
+
* <p>Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
332
|
+
*/
|
|
333
|
+
s3Uri: string | undefined;
|
|
334
|
+
}
|
|
335
|
+
export declare namespace JobCheckpointConfig {
|
|
336
|
+
/**
|
|
337
|
+
* @internal
|
|
338
|
+
*/
|
|
339
|
+
const filterSensitiveLog: (obj: JobCheckpointConfig) => any;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* <p>Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.</p>
|
|
343
|
+
*/
|
|
344
|
+
export interface DeviceConfig {
|
|
345
|
+
/**
|
|
346
|
+
* <p>The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.</p>
|
|
347
|
+
*/
|
|
348
|
+
device: string | undefined;
|
|
349
|
+
}
|
|
350
|
+
export declare namespace DeviceConfig {
|
|
351
|
+
/**
|
|
352
|
+
* @internal
|
|
353
|
+
*/
|
|
354
|
+
const filterSensitiveLog: (obj: DeviceConfig) => any;
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
|
|
358
|
+
*/
|
|
359
|
+
export interface S3DataSource {
|
|
360
|
+
/**
|
|
361
|
+
* <p>Depending on the value specified for the <code>S3DataType</code>, identifies either a
|
|
362
|
+
* key name prefix or a manifest that locates the S3 data source.</p>
|
|
363
|
+
*/
|
|
364
|
+
s3Uri: string | undefined;
|
|
365
|
+
}
|
|
366
|
+
export declare namespace S3DataSource {
|
|
367
|
+
/**
|
|
368
|
+
* @internal
|
|
369
|
+
*/
|
|
370
|
+
const filterSensitiveLog: (obj: S3DataSource) => any;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* <p>Information about the source of the data used by the Amazon Braket job.</p>
|
|
374
|
+
*/
|
|
375
|
+
export interface DataSource {
|
|
376
|
+
/**
|
|
377
|
+
* <p>Information about the data stored in Amazon S3 used by the Amazon Braket job.</p>
|
|
378
|
+
*/
|
|
379
|
+
s3DataSource: S3DataSource | undefined;
|
|
380
|
+
}
|
|
381
|
+
export declare namespace DataSource {
|
|
382
|
+
/**
|
|
383
|
+
* @internal
|
|
384
|
+
*/
|
|
385
|
+
const filterSensitiveLog: (obj: DataSource) => any;
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* <p>A list of parameters that specify the input channels, type of input data, and where it
|
|
389
|
+
* is located.</p>
|
|
390
|
+
*/
|
|
391
|
+
export interface InputFileConfig {
|
|
392
|
+
/**
|
|
393
|
+
* <p>A named input source that an Amazon Braket job can consume.</p>
|
|
394
|
+
*/
|
|
395
|
+
channelName: string | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>The MIME type of the data.</p>
|
|
398
|
+
*/
|
|
399
|
+
contentType?: string;
|
|
400
|
+
/**
|
|
401
|
+
* <p>The location of the channel data.</p>
|
|
402
|
+
*/
|
|
403
|
+
dataSource: DataSource | undefined;
|
|
404
|
+
}
|
|
405
|
+
export declare namespace InputFileConfig {
|
|
406
|
+
/**
|
|
407
|
+
* @internal
|
|
408
|
+
*/
|
|
409
|
+
const filterSensitiveLog: (obj: InputFileConfig) => any;
|
|
410
|
+
}
|
|
411
|
+
export declare enum _InstanceType {
|
|
412
|
+
ML_C4_2XLARGE = "ml.c4.2xlarge",
|
|
413
|
+
ML_C4_4XLARGE = "ml.c4.4xlarge",
|
|
414
|
+
ML_C4_8XLARGE = "ml.c4.8xlarge",
|
|
415
|
+
ML_C4_XLARGE = "ml.c4.xlarge",
|
|
416
|
+
ML_C5N_18XLARGE = "ml.c5n.18xlarge",
|
|
417
|
+
ML_C5N_2XLARGE = "ml.c5n.2xlarge",
|
|
418
|
+
ML_C5N_4XLARGE = "ml.c5n.4xlarge",
|
|
419
|
+
ML_C5N_9XLARGE = "ml.c5n.9xlarge",
|
|
420
|
+
ML_C5N_XLARGE = "ml.c5n.xlarge",
|
|
421
|
+
ML_C5_18XLARGE = "ml.c5.18xlarge",
|
|
422
|
+
ML_C5_2XLARGE = "ml.c5.2xlarge",
|
|
423
|
+
ML_C5_4XLARGE = "ml.c5.4xlarge",
|
|
424
|
+
ML_C5_9XLARGE = "ml.c5.9xlarge",
|
|
425
|
+
ML_C5_XLARGE = "ml.c5.xlarge",
|
|
426
|
+
ML_G4DN_12XLARGE = "ml.g4dn.12xlarge",
|
|
427
|
+
ML_G4DN_16XLARGE = "ml.g4dn.16xlarge",
|
|
428
|
+
ML_G4DN_2XLARGE = "ml.g4dn.2xlarge",
|
|
429
|
+
ML_G4DN_4XLARGE = "ml.g4dn.4xlarge",
|
|
430
|
+
ML_G4DN_8XLARGE = "ml.g4dn.8xlarge",
|
|
431
|
+
ML_G4DN_XLARGE = "ml.g4dn.xlarge",
|
|
432
|
+
ML_M4_10XLARGE = "ml.m4.10xlarge",
|
|
433
|
+
ML_M4_16XLARGE = "ml.m4.16xlarge",
|
|
434
|
+
ML_M4_2XLARGE = "ml.m4.2xlarge",
|
|
435
|
+
ML_M4_4XLARGE = "ml.m4.4xlarge",
|
|
436
|
+
ML_M4_XLARGE = "ml.m4.xlarge",
|
|
437
|
+
ML_M5_12XLARGE = "ml.m5.12xlarge",
|
|
438
|
+
ML_M5_24XLARGE = "ml.m5.24xlarge",
|
|
439
|
+
ML_M5_2XLARGE = "ml.m5.2xlarge",
|
|
440
|
+
ML_M5_4XLARGE = "ml.m5.4xlarge",
|
|
441
|
+
ML_M5_LARGE = "ml.m5.large",
|
|
442
|
+
ML_M5_XLARGE = "ml.m5.xlarge",
|
|
443
|
+
ML_P2_16XLARGE = "ml.p2.16xlarge",
|
|
444
|
+
ML_P2_8XLARGE = "ml.p2.8xlarge",
|
|
445
|
+
ML_P2_XLARGE = "ml.p2.xlarge",
|
|
446
|
+
ML_P3DN_24XLARGE = "ml.p3dn.24xlarge",
|
|
447
|
+
ML_P3_16XLARGE = "ml.p3.16xlarge",
|
|
448
|
+
ML_P3_2XLARGE = "ml.p3.2xlarge",
|
|
449
|
+
ML_P3_8XLARGE = "ml.p3.8xlarge",
|
|
450
|
+
ML_P4D_24XLARGE = "ml.p4d.24xlarge"
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* <p>Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon
|
|
454
|
+
* Braket.</p>
|
|
455
|
+
*/
|
|
456
|
+
export interface InstanceConfig {
|
|
457
|
+
/**
|
|
458
|
+
* <p>Configures the type resource instances to use while running an Amazon Braket hybrid job.</p>
|
|
459
|
+
*/
|
|
460
|
+
instanceType: _InstanceType | string | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* <p>The size of the storage volume, in GB, that user wants to provision.</p>
|
|
463
|
+
*/
|
|
464
|
+
volumeSizeInGb: number | undefined;
|
|
465
|
+
}
|
|
466
|
+
export declare namespace InstanceConfig {
|
|
467
|
+
/**
|
|
468
|
+
* @internal
|
|
469
|
+
*/
|
|
470
|
+
const filterSensitiveLog: (obj: InstanceConfig) => any;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* <p>Specifies the path to the S3 location where you want to store job artifacts and the
|
|
474
|
+
* encryption key used to store them.</p>
|
|
475
|
+
*/
|
|
476
|
+
export interface JobOutputDataConfig {
|
|
477
|
+
/**
|
|
478
|
+
* <p>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the
|
|
479
|
+
* job training artifacts at rest using Amazon S3 server-side encryption.</p>
|
|
480
|
+
*/
|
|
481
|
+
kmsKeyId?: string;
|
|
482
|
+
/**
|
|
483
|
+
* <p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For
|
|
484
|
+
* example, <code>s3://bucket-name/key-name-prefix</code>.</p>
|
|
485
|
+
*/
|
|
486
|
+
s3Path: string | undefined;
|
|
487
|
+
}
|
|
488
|
+
export declare namespace JobOutputDataConfig {
|
|
489
|
+
/**
|
|
490
|
+
* @internal
|
|
491
|
+
*/
|
|
492
|
+
const filterSensitiveLog: (obj: JobOutputDataConfig) => any;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* <p>Specifies limits for how long an Amazon Braket job can run. </p>
|
|
496
|
+
*/
|
|
497
|
+
export interface JobStoppingCondition {
|
|
498
|
+
/**
|
|
499
|
+
* <p>The maximum length of time, in seconds, that an Amazon Braket job can run.</p>
|
|
500
|
+
*/
|
|
501
|
+
maxRuntimeInSeconds?: number;
|
|
502
|
+
}
|
|
503
|
+
export declare namespace JobStoppingCondition {
|
|
504
|
+
/**
|
|
505
|
+
* @internal
|
|
506
|
+
*/
|
|
507
|
+
const filterSensitiveLog: (obj: JobStoppingCondition) => any;
|
|
508
|
+
}
|
|
509
|
+
export interface CreateJobRequest {
|
|
510
|
+
/**
|
|
511
|
+
* <p>A unique token that guarantees that the call to this API is idempotent.</p>
|
|
512
|
+
*/
|
|
513
|
+
clientToken?: string;
|
|
514
|
+
/**
|
|
515
|
+
* <p>Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information
|
|
516
|
+
* about the Python scripts used for entry and training.</p>
|
|
517
|
+
*/
|
|
518
|
+
algorithmSpecification: AlgorithmSpecification | undefined;
|
|
519
|
+
/**
|
|
520
|
+
* <p>A list of parameters that specify the name and type of input data and where it is
|
|
521
|
+
* located.</p>
|
|
522
|
+
*/
|
|
523
|
+
inputDataConfig?: InputFileConfig[];
|
|
524
|
+
/**
|
|
525
|
+
* <p>The path to the S3 location where you want to store job artifacts and the
|
|
526
|
+
* encryption key used to store them.</p>
|
|
527
|
+
*/
|
|
528
|
+
outputDataConfig: JobOutputDataConfig | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* <p>Information about the output locations for job checkpoint data.</p>
|
|
531
|
+
*/
|
|
532
|
+
checkpointConfig?: JobCheckpointConfig;
|
|
533
|
+
/**
|
|
534
|
+
* <p>The name of the Amazon Braket job.</p>
|
|
535
|
+
*/
|
|
536
|
+
jobName: string | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
|
|
539
|
+
* tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
|
|
540
|
+
* on behalf of user, and output resources to the users' s3 buckets.</p>
|
|
541
|
+
*/
|
|
542
|
+
roleArn: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p> The user-defined criteria that specifies when a job stops running.</p>
|
|
545
|
+
*/
|
|
546
|
+
stoppingCondition?: JobStoppingCondition;
|
|
547
|
+
/**
|
|
548
|
+
* <p>Configuration of the resource instances to use while running the hybrid job on Amazon
|
|
549
|
+
* Braket.</p>
|
|
550
|
+
*/
|
|
551
|
+
instanceConfig: InstanceConfig | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
|
|
554
|
+
* the training job. The values are set with a string of JSON key:value pairs, where the key is the
|
|
555
|
+
* name of the hyperparameter and the value is the value of th hyperparameter.</p>
|
|
556
|
+
*/
|
|
557
|
+
hyperParameters?: {
|
|
558
|
+
[key: string]: string;
|
|
559
|
+
};
|
|
560
|
+
/**
|
|
561
|
+
* <p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.</p>
|
|
562
|
+
*/
|
|
563
|
+
deviceConfig: DeviceConfig | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* <p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>
|
|
566
|
+
*/
|
|
567
|
+
tags?: {
|
|
568
|
+
[key: string]: string;
|
|
569
|
+
};
|
|
570
|
+
}
|
|
571
|
+
export declare namespace CreateJobRequest {
|
|
572
|
+
/**
|
|
573
|
+
* @internal
|
|
574
|
+
*/
|
|
575
|
+
const filterSensitiveLog: (obj: CreateJobRequest) => any;
|
|
576
|
+
}
|
|
577
|
+
export interface CreateJobResponse {
|
|
578
|
+
/**
|
|
579
|
+
* <p>The ARN of the Amazon Braket job created.</p>
|
|
580
|
+
*/
|
|
581
|
+
jobArn: string | undefined;
|
|
582
|
+
}
|
|
583
|
+
export declare namespace CreateJobResponse {
|
|
584
|
+
/**
|
|
585
|
+
* @internal
|
|
586
|
+
*/
|
|
587
|
+
const filterSensitiveLog: (obj: CreateJobResponse) => any;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* <p>The specified device has been retired.</p>
|
|
591
|
+
*/
|
|
592
|
+
export interface DeviceRetiredException extends __SmithyException, $MetadataBearer {
|
|
593
|
+
name: "DeviceRetiredException";
|
|
594
|
+
$fault: "client";
|
|
595
|
+
message?: string;
|
|
596
|
+
}
|
|
597
|
+
export declare namespace DeviceRetiredException {
|
|
598
|
+
/**
|
|
599
|
+
* @internal
|
|
600
|
+
*/
|
|
601
|
+
const filterSensitiveLog: (obj: DeviceRetiredException) => any;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* <p>The request failed because a service quota is exceeded.</p>
|
|
605
|
+
*/
|
|
606
|
+
export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
|
|
607
|
+
name: "ServiceQuotaExceededException";
|
|
608
|
+
$fault: "client";
|
|
609
|
+
message?: string;
|
|
610
|
+
}
|
|
611
|
+
export declare namespace ServiceQuotaExceededException {
|
|
612
|
+
/**
|
|
613
|
+
* @internal
|
|
614
|
+
*/
|
|
615
|
+
const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
|
|
616
|
+
}
|
|
617
|
+
export interface GetJobRequest {
|
|
618
|
+
/**
|
|
619
|
+
* <p>The ARN of the job to retrieve.</p>
|
|
620
|
+
*/
|
|
621
|
+
jobArn: string | undefined;
|
|
622
|
+
}
|
|
623
|
+
export declare namespace GetJobRequest {
|
|
624
|
+
/**
|
|
625
|
+
* @internal
|
|
626
|
+
*/
|
|
627
|
+
const filterSensitiveLog: (obj: GetJobRequest) => any;
|
|
628
|
+
}
|
|
629
|
+
export declare enum JobEventType {
|
|
630
|
+
CANCELLED = "CANCELLED",
|
|
631
|
+
COMPLETED = "COMPLETED",
|
|
632
|
+
DEPRIORITIZED_DUE_TO_INACTIVITY = "DEPRIORITIZED_DUE_TO_INACTIVITY",
|
|
633
|
+
DOWNLOADING_DATA = "DOWNLOADING_DATA",
|
|
634
|
+
FAILED = "FAILED",
|
|
635
|
+
MAX_RUNTIME_EXCEEDED = "MAX_RUNTIME_EXCEEDED",
|
|
636
|
+
QUEUED_FOR_EXECUTION = "QUEUED_FOR_EXECUTION",
|
|
637
|
+
RUNNING = "RUNNING",
|
|
638
|
+
STARTING_INSTANCE = "STARTING_INSTANCE",
|
|
639
|
+
UPLOADING_RESULTS = "UPLOADING_RESULTS",
|
|
640
|
+
WAITING_FOR_PRIORITY = "WAITING_FOR_PRIORITY"
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
|
|
644
|
+
*/
|
|
645
|
+
export interface JobEventDetails {
|
|
646
|
+
/**
|
|
647
|
+
* <p>The type of event that occurred related to the Amazon Braket job.</p>
|
|
648
|
+
*/
|
|
649
|
+
eventType?: JobEventType | string;
|
|
650
|
+
/**
|
|
651
|
+
* <p>TThe type of event that occurred related to the Amazon Braket job.</p>
|
|
652
|
+
*/
|
|
653
|
+
timeOfEvent?: Date;
|
|
654
|
+
/**
|
|
655
|
+
* <p>A message describing the event that occurred related to the Amazon Braket job.</p>
|
|
656
|
+
*/
|
|
657
|
+
message?: string;
|
|
658
|
+
}
|
|
659
|
+
export declare namespace JobEventDetails {
|
|
660
|
+
/**
|
|
661
|
+
* @internal
|
|
662
|
+
*/
|
|
663
|
+
const filterSensitiveLog: (obj: JobEventDetails) => any;
|
|
664
|
+
}
|
|
665
|
+
export declare enum JobPrimaryStatus {
|
|
666
|
+
CANCELLED = "CANCELLED",
|
|
667
|
+
CANCELLING = "CANCELLING",
|
|
668
|
+
COMPLETED = "COMPLETED",
|
|
669
|
+
FAILED = "FAILED",
|
|
670
|
+
QUEUED = "QUEUED",
|
|
671
|
+
RUNNING = "RUNNING"
|
|
672
|
+
}
|
|
673
|
+
export interface GetJobResponse {
|
|
674
|
+
/**
|
|
675
|
+
* <p>The status of the Amazon Braket job.</p>
|
|
676
|
+
*/
|
|
677
|
+
status: JobPrimaryStatus | string | undefined;
|
|
678
|
+
/**
|
|
679
|
+
* <p>The ARN of the Amazon Braket job.</p>
|
|
680
|
+
*/
|
|
681
|
+
jobArn: string | undefined;
|
|
682
|
+
/**
|
|
683
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform
|
|
684
|
+
* tasks on behalf of a user. It can access user resources, run an Amazon Braket job container
|
|
685
|
+
* on behalf of user, and output resources to the s3 buckets of a user.</p>
|
|
686
|
+
*/
|
|
687
|
+
roleArn: string | undefined;
|
|
688
|
+
/**
|
|
689
|
+
* <p>A description of the reason why an Amazon Braket job failed, if it failed.</p>
|
|
690
|
+
*/
|
|
691
|
+
failureReason?: string;
|
|
692
|
+
/**
|
|
693
|
+
* <p>The name of the Amazon Braket job.</p>
|
|
694
|
+
*/
|
|
695
|
+
jobName: string | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>Algorithm-specific parameters used by an Amazon Braket job that influence the quality of
|
|
698
|
+
* the traiing job. The values are set with a string of JSON key:value pairs, where the key is the
|
|
699
|
+
* name of the hyperparameter and the value is the value of th hyperparameter.</p>
|
|
700
|
+
*/
|
|
701
|
+
hyperParameters?: {
|
|
702
|
+
[key: string]: string;
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* <p>A list of parameters that specify the name and type of input data and where it is
|
|
706
|
+
* located.</p>
|
|
707
|
+
*/
|
|
708
|
+
inputDataConfig?: InputFileConfig[];
|
|
709
|
+
/**
|
|
710
|
+
* <p>The path to the S3 location where job artifacts are stored and the encryption
|
|
711
|
+
* key used to store them there.</p>
|
|
712
|
+
*/
|
|
713
|
+
outputDataConfig: JobOutputDataConfig | undefined;
|
|
714
|
+
/**
|
|
715
|
+
* <p>The user-defined criteria that specifies when to stop a job running.</p>
|
|
716
|
+
*/
|
|
717
|
+
stoppingCondition?: JobStoppingCondition;
|
|
718
|
+
/**
|
|
719
|
+
* <p>Information about the output locations for job checkpoint data.</p>
|
|
720
|
+
*/
|
|
721
|
+
checkpointConfig?: JobCheckpointConfig;
|
|
722
|
+
/**
|
|
723
|
+
* <p>Definition of the Amazon Braket job created. Specifies the container image the job uses, information about
|
|
724
|
+
* the Python scripts used for entry and training, and the user-defined metrics used to
|
|
725
|
+
* evaluation the job.</p>
|
|
726
|
+
*/
|
|
727
|
+
algorithmSpecification: AlgorithmSpecification | undefined;
|
|
728
|
+
/**
|
|
729
|
+
* <p>The resource instances to use while running the hybrid job on Amazon
|
|
730
|
+
* Braket.</p>
|
|
731
|
+
*/
|
|
732
|
+
instanceConfig: InstanceConfig | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* <p>The date and time that the Amazon Braket job was created.</p>
|
|
735
|
+
*/
|
|
736
|
+
createdAt: Date | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The date and time that the Amazon Braket job was started.</p>
|
|
739
|
+
*/
|
|
740
|
+
startedAt?: Date;
|
|
741
|
+
/**
|
|
742
|
+
* <p>The date and time that the Amazon Braket job ended.</p>
|
|
743
|
+
*/
|
|
744
|
+
endedAt?: Date;
|
|
745
|
+
/**
|
|
746
|
+
* <p>The billable time the Amazon Braket job used to complete.</p>
|
|
747
|
+
*/
|
|
748
|
+
billableDuration?: number;
|
|
749
|
+
/**
|
|
750
|
+
* <p>The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.</p>
|
|
751
|
+
*/
|
|
752
|
+
deviceConfig?: DeviceConfig;
|
|
753
|
+
/**
|
|
754
|
+
* <p>Details about the type and time events occurred related to the Amazon Braket job.</p>
|
|
755
|
+
*/
|
|
756
|
+
events?: JobEventDetails[];
|
|
757
|
+
/**
|
|
758
|
+
* <p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>
|
|
759
|
+
*/
|
|
760
|
+
tags?: {
|
|
761
|
+
[key: string]: string;
|
|
762
|
+
};
|
|
763
|
+
}
|
|
764
|
+
export declare namespace GetJobResponse {
|
|
765
|
+
/**
|
|
766
|
+
* @internal
|
|
767
|
+
*/
|
|
768
|
+
const filterSensitiveLog: (obj: GetJobResponse) => any;
|
|
769
|
+
}
|
|
770
|
+
export declare enum SearchJobsFilterOperator {
|
|
771
|
+
BETWEEN = "BETWEEN",
|
|
772
|
+
CONTAINS = "CONTAINS",
|
|
773
|
+
EQUAL = "EQUAL",
|
|
774
|
+
GT = "GT",
|
|
775
|
+
GTE = "GTE",
|
|
776
|
+
LT = "LT",
|
|
777
|
+
LTE = "LTE"
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* <p>A filter used to search for Amazon Braket jobs.</p>
|
|
781
|
+
*/
|
|
782
|
+
export interface SearchJobsFilter {
|
|
783
|
+
/**
|
|
784
|
+
* <p>The name to use for the jobs filter.</p>
|
|
785
|
+
*/
|
|
786
|
+
name: string | undefined;
|
|
787
|
+
/**
|
|
788
|
+
* <p>The values to use for the jobs filter.</p>
|
|
789
|
+
*/
|
|
790
|
+
values: string[] | undefined;
|
|
791
|
+
/**
|
|
792
|
+
* <p>An operator to use for the jobs filter.</p>
|
|
793
|
+
*/
|
|
794
|
+
operator: SearchJobsFilterOperator | string | undefined;
|
|
795
|
+
}
|
|
796
|
+
export declare namespace SearchJobsFilter {
|
|
797
|
+
/**
|
|
798
|
+
* @internal
|
|
799
|
+
*/
|
|
800
|
+
const filterSensitiveLog: (obj: SearchJobsFilter) => any;
|
|
801
|
+
}
|
|
802
|
+
export interface SearchJobsRequest {
|
|
803
|
+
/**
|
|
804
|
+
* <p>A token used for pagination of results returned in the response. Use the token returned
|
|
805
|
+
* from the previous request to continue results where the previous request ended.</p>
|
|
806
|
+
*/
|
|
807
|
+
nextToken?: string;
|
|
808
|
+
/**
|
|
809
|
+
* <p>The maximum number of results to return in the response.</p>
|
|
810
|
+
*/
|
|
811
|
+
maxResults?: number;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The filter values to use when searching for a job.</p>
|
|
814
|
+
*/
|
|
815
|
+
filters: SearchJobsFilter[] | undefined;
|
|
816
|
+
}
|
|
817
|
+
export declare namespace SearchJobsRequest {
|
|
818
|
+
/**
|
|
819
|
+
* @internal
|
|
820
|
+
*/
|
|
821
|
+
const filterSensitiveLog: (obj: SearchJobsRequest) => any;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* <p>Provides summary information about an Amazon Braket job.</p>
|
|
825
|
+
*/
|
|
826
|
+
export interface JobSummary {
|
|
827
|
+
/**
|
|
828
|
+
* <p>The status of the Amazon Braket job.</p>
|
|
829
|
+
*/
|
|
830
|
+
status: JobPrimaryStatus | string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The ARN of the Amazon Braket job.</p>
|
|
833
|
+
*/
|
|
834
|
+
jobArn: string | undefined;
|
|
835
|
+
/**
|
|
836
|
+
* <p>The name of the Amazon Braket job.</p>
|
|
837
|
+
*/
|
|
838
|
+
jobName: string | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* <p>Provides summary information about the primary device used by an Amazon Braket job.</p>
|
|
841
|
+
*/
|
|
842
|
+
device: string | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>The date and time that the Amazon Braket job was created.</p>
|
|
845
|
+
*/
|
|
846
|
+
createdAt: Date | undefined;
|
|
847
|
+
/**
|
|
848
|
+
* <p>The date and time that the Amazon Braket job was started.</p>
|
|
849
|
+
*/
|
|
850
|
+
startedAt?: Date;
|
|
851
|
+
/**
|
|
852
|
+
* <p>The date and time that the Amazon Braket job ended.</p>
|
|
853
|
+
*/
|
|
854
|
+
endedAt?: Date;
|
|
855
|
+
/**
|
|
856
|
+
* <p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>
|
|
857
|
+
*/
|
|
858
|
+
tags?: {
|
|
859
|
+
[key: string]: string;
|
|
860
|
+
};
|
|
861
|
+
}
|
|
862
|
+
export declare namespace JobSummary {
|
|
863
|
+
/**
|
|
864
|
+
* @internal
|
|
865
|
+
*/
|
|
866
|
+
const filterSensitiveLog: (obj: JobSummary) => any;
|
|
867
|
+
}
|
|
868
|
+
export interface SearchJobsResponse {
|
|
869
|
+
/**
|
|
870
|
+
* <p>An array of <code>JobSummary</code> objects for devices that match the specified filter
|
|
871
|
+
* values.</p>
|
|
872
|
+
*/
|
|
873
|
+
jobs: JobSummary[] | undefined;
|
|
874
|
+
/**
|
|
875
|
+
* <p>A token used for pagination of results, or <code>null</code> if there are no additional results. Use
|
|
876
|
+
* the token value in a subsequent request to continue results where the previous request
|
|
877
|
+
* ended.</p>
|
|
878
|
+
*/
|
|
879
|
+
nextToken?: string;
|
|
880
|
+
}
|
|
881
|
+
export declare namespace SearchJobsResponse {
|
|
882
|
+
/**
|
|
883
|
+
* @internal
|
|
884
|
+
*/
|
|
885
|
+
const filterSensitiveLog: (obj: SearchJobsResponse) => any;
|
|
886
|
+
}
|
|
240
887
|
export interface ListTagsForResourceRequest {
|
|
241
888
|
/**
|
|
242
889
|
* <p>Specify the <code>resourceArn</code> for the resource whose tags to display.</p>
|
|
@@ -279,10 +926,6 @@ export declare namespace CancelQuantumTaskRequest {
|
|
|
279
926
|
*/
|
|
280
927
|
const filterSensitiveLog: (obj: CancelQuantumTaskRequest) => any;
|
|
281
928
|
}
|
|
282
|
-
export declare enum CancellationStatus {
|
|
283
|
-
CANCELLED = "CANCELLED",
|
|
284
|
-
CANCELLING = "CANCELLING"
|
|
285
|
-
}
|
|
286
929
|
export interface CancelQuantumTaskResponse {
|
|
287
930
|
/**
|
|
288
931
|
* <p>The ARN of the task.</p>
|
|
@@ -299,20 +942,6 @@ export declare namespace CancelQuantumTaskResponse {
|
|
|
299
942
|
*/
|
|
300
943
|
const filterSensitiveLog: (obj: CancelQuantumTaskResponse) => any;
|
|
301
944
|
}
|
|
302
|
-
/**
|
|
303
|
-
* <p>An error occurred due to a conflict.</p>
|
|
304
|
-
*/
|
|
305
|
-
export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
306
|
-
name: "ConflictException";
|
|
307
|
-
$fault: "client";
|
|
308
|
-
message?: string;
|
|
309
|
-
}
|
|
310
|
-
export declare namespace ConflictException {
|
|
311
|
-
/**
|
|
312
|
-
* @internal
|
|
313
|
-
*/
|
|
314
|
-
const filterSensitiveLog: (obj: ConflictException) => any;
|
|
315
|
-
}
|
|
316
945
|
export interface CreateQuantumTaskRequest {
|
|
317
946
|
/**
|
|
318
947
|
* <p>The client token associated with the request.</p>
|
|
@@ -348,6 +977,10 @@ export interface CreateQuantumTaskRequest {
|
|
|
348
977
|
tags?: {
|
|
349
978
|
[key: string]: string;
|
|
350
979
|
};
|
|
980
|
+
/**
|
|
981
|
+
* <p>The token for an Amazon Braket job that associates it with the quantum task.</p>
|
|
982
|
+
*/
|
|
983
|
+
jobToken?: string;
|
|
351
984
|
}
|
|
352
985
|
export declare namespace CreateQuantumTaskRequest {
|
|
353
986
|
/**
|
|
@@ -368,18 +1001,18 @@ export declare namespace CreateQuantumTaskResponse {
|
|
|
368
1001
|
const filterSensitiveLog: (obj: CreateQuantumTaskResponse) => any;
|
|
369
1002
|
}
|
|
370
1003
|
/**
|
|
371
|
-
* <p>The
|
|
1004
|
+
* <p>The specified device is currently offline.</p>
|
|
372
1005
|
*/
|
|
373
|
-
export interface
|
|
374
|
-
name: "
|
|
1006
|
+
export interface DeviceOfflineException extends __SmithyException, $MetadataBearer {
|
|
1007
|
+
name: "DeviceOfflineException";
|
|
375
1008
|
$fault: "client";
|
|
376
1009
|
message?: string;
|
|
377
1010
|
}
|
|
378
|
-
export declare namespace
|
|
1011
|
+
export declare namespace DeviceOfflineException {
|
|
379
1012
|
/**
|
|
380
1013
|
* @internal
|
|
381
1014
|
*/
|
|
382
|
-
const filterSensitiveLog: (obj:
|
|
1015
|
+
const filterSensitiveLog: (obj: DeviceOfflineException) => any;
|
|
383
1016
|
}
|
|
384
1017
|
export interface GetQuantumTaskRequest {
|
|
385
1018
|
/**
|
|
@@ -449,6 +1082,10 @@ export interface GetQuantumTaskResponse {
|
|
|
449
1082
|
tags?: {
|
|
450
1083
|
[key: string]: string;
|
|
451
1084
|
};
|
|
1085
|
+
/**
|
|
1086
|
+
* <p>The ARN of the Amazon Braket job associated with the quantum task.</p>
|
|
1087
|
+
*/
|
|
1088
|
+
jobArn?: string;
|
|
452
1089
|
}
|
|
453
1090
|
export declare namespace GetQuantumTaskResponse {
|
|
454
1091
|
/**
|