/
models_0.ts
2302 lines (2007 loc) · 63.4 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { Readable } from "stream";
import { LookoutVisionServiceException as __BaseException } from "./LookoutVisionServiceException";
/**
* <p>You are not authorized to perform the action.</p>
*/
export class AccessDeniedException extends __BaseException {
readonly name: "AccessDeniedException" = "AccessDeniedException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>) {
super({
name: "AccessDeniedException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, AccessDeniedException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>Information about the pixels in an anomaly mask. For more information, see <a>Anomaly</a>.
* <code>PixelAnomaly</code> is only returned by image segmentation models.</p>
*/
export interface PixelAnomaly {
/**
* <p>The percentage area of the image that the anomaly type covers.</p>
*/
TotalPercentageArea?: number;
/**
* <p>A hex color value for the mask that covers an anomaly type. Each anomaly type has
* a different mask color. The color maps to the color of the anomaly type used in the
* training dataset. </p>
*/
Color?: string;
}
/**
* <p>Information about an anomaly type found on an image by an image segmentation model.
* For more information, see <a>DetectAnomalies</a>.</p>
*/
export interface Anomaly {
/**
* <p>The name of an anomaly type found in an image.
* <code>Name</code> maps to an anomaly type in the training dataset, apart from the anomaly type <code>background</code>.
* The service automatically inserts the <code>background</code> anomaly type into the response from <code>DetectAnomalies</code>. </p>
*/
Name?: string;
/**
* <p>Information about the pixel mask that covers an anomaly type.</p>
*/
PixelAnomaly?: PixelAnomaly;
}
export enum ResourceType {
DATASET = "DATASET",
MODEL = "MODEL",
MODEL_PACKAGE_JOB = "MODEL_PACKAGE_JOB",
PROJECT = "PROJECT",
TRIAL = "TRIAL",
}
/**
* <p>The update or deletion of a resource caused an inconsistent state.</p>
*/
export class ConflictException extends __BaseException {
readonly name: "ConflictException" = "ConflictException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p>The ID of the resource.</p>
*/
ResourceId: string | undefined;
/**
* <p>The type of the resource.</p>
*/
ResourceType: ResourceType | string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>) {
super({
name: "ConflictException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ConflictException.prototype);
this.Message = opts.Message;
this.ResourceId = opts.ResourceId;
this.ResourceType = opts.ResourceType;
}
}
/**
* <p>Amazon S3 Location information for an input manifest file. </p>
*/
export interface InputS3Object {
/**
* <p>The Amazon S3 bucket that contains the manifest.</p>
*/
Bucket: string | undefined;
/**
* <p>The name and location of the manifest file withiin the bucket.</p>
*/
Key: string | undefined;
/**
* <p>The version ID of the bucket.</p>
*/
VersionId?: string;
}
/**
* <p>Location information about a manifest file. You can use a manifest file to
* create a dataset.</p>
*/
export interface DatasetGroundTruthManifest {
/**
* <p>The S3 bucket location for the manifest file.</p>
*/
S3Object?: InputS3Object;
}
/**
* <p>Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.</p>
*/
export interface DatasetSource {
/**
* <p>Location information for the manifest file.</p>
*/
GroundTruthManifest?: DatasetGroundTruthManifest;
}
export interface CreateDatasetRequest {
/**
* <p>The name of the project in which you want to create a dataset.</p>
*/
ProjectName: string | undefined;
/**
* <p>The type of the dataset. Specify <code>train</code> for a training dataset.
* Specify <code>test</code> for a test dataset.</p>
*/
DatasetType: string | undefined;
/**
* <p>The location of the manifest file that Amazon Lookout for Vision uses to create the dataset.</p>
* <p>If you don't specify <code>DatasetSource</code>, an empty dataset is created and the operation
* synchronously returns. Later, you can add JSON Lines by calling <a>UpdateDatasetEntries</a>.
* </p>
* <p>If you specify a value for <code>DataSource</code>, the manifest at the S3 location
* is validated and used to create the dataset. The call to <code>CreateDataset</code> is asynchronous
* and might take a while to complete. To find out the current status, Check the value of <code>Status</code>
* returned in a call to <a>DescribeDataset</a>.</p>
*/
DatasetSource?: DatasetSource;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>CreateDataset</code>
* completes only once. You choose the value to pass. For example, An issue might prevent you
* from getting a response from <code>CreateDataset</code>.
* In this case, safely retry your call
* to <code>CreateDataset</code> by using the same <code>ClientToken</code> parameter value.</p>
* <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from making multiple dataset creation requests. You'll need to
* provide your own value for other use cases. </p>
* <p>An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>CreateDataset</code>. An idempotency
* token is active for 8 hours.
* </p>
*/
ClientToken?: string;
}
export enum DatasetStatus {
CREATE_COMPLETE = "CREATE_COMPLETE",
CREATE_FAILED = "CREATE_FAILED",
CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
DELETE_COMPLETE = "DELETE_COMPLETE",
DELETE_FAILED = "DELETE_FAILED",
DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS",
UPDATE_COMPLETE = "UPDATE_COMPLETE",
UPDATE_FAILED_ROLLBACK_COMPLETE = "UPDATE_FAILED_ROLLBACK_COMPLETE",
UPDATE_FAILED_ROLLBACK_IN_PROGRESS = "UPDATE_FAILED_ROLLBACK_IN_PROGRESS",
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS",
}
/**
* <p>Summary information for an Amazon Lookout for Vision dataset. For more information,
* see <a>DescribeDataset</a> and <a>ProjectDescription</a>.</p>
*/
export interface DatasetMetadata {
/**
* <p>The type of the dataset.</p>
*/
DatasetType?: string;
/**
* <p>The Unix timestamp for the date and time that the dataset was created. </p>
*/
CreationTimestamp?: Date;
/**
* <p>The status for the dataset.</p>
*/
Status?: DatasetStatus | string;
/**
* <p>The status message for the dataset.</p>
*/
StatusMessage?: string;
}
export interface CreateDatasetResponse {
/**
* <p>Information about the dataset.</p>
*/
DatasetMetadata?: DatasetMetadata;
}
/**
* <p>Amazon Lookout for Vision experienced a service issue. Try your call again.</p>
*/
export class InternalServerException extends __BaseException {
readonly name: "InternalServerException" = "InternalServerException";
readonly $fault: "server" = "server";
Message: string | undefined;
/**
* <p>The period of time, in seconds, before the operation can be retried.</p>
*/
RetryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>) {
super({
name: "InternalServerException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, InternalServerException.prototype);
this.Message = opts.Message;
this.RetryAfterSeconds = opts.RetryAfterSeconds;
}
}
/**
* <p>The resource could not be found.</p>
*/
export class ResourceNotFoundException extends __BaseException {
readonly name: "ResourceNotFoundException" = "ResourceNotFoundException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p>The ID of the resource.</p>
*/
ResourceId: string | undefined;
/**
* <p>The type of the resource.</p>
*/
ResourceType: ResourceType | string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>) {
super({
name: "ResourceNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
this.Message = opts.Message;
this.ResourceId = opts.ResourceId;
this.ResourceType = opts.ResourceType;
}
}
/**
* <p>A service quota was exceeded the allowed limit. For more information, see
* Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide. </p>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p>The ID of the resource.</p>
*/
ResourceId?: string;
/**
* <p>The type of the resource.</p>
*/
ResourceType?: ResourceType | string;
/**
* <p>The quota code. </p>
*/
QuotaCode: string | undefined;
/**
* <p>The service code. </p>
*/
ServiceCode: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.Message = opts.Message;
this.ResourceId = opts.ResourceId;
this.ResourceType = opts.ResourceType;
this.QuotaCode = opts.QuotaCode;
this.ServiceCode = opts.ServiceCode;
}
}
/**
* <p>Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.</p>
*/
export class ThrottlingException extends __BaseException {
readonly name: "ThrottlingException" = "ThrottlingException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* <p>The quota code. </p>
*/
QuotaCode?: string;
/**
* <p>The service code. </p>
*/
ServiceCode?: string;
/**
* <p>The period of time, in seconds, before the operation can be retried. </p>
*/
RetryAfterSeconds?: number;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>) {
super({
name: "ThrottlingException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ThrottlingException.prototype);
this.Message = opts.Message;
this.QuotaCode = opts.QuotaCode;
this.ServiceCode = opts.ServiceCode;
this.RetryAfterSeconds = opts.RetryAfterSeconds;
}
}
/**
* <p>An input validation error occured. For example, invalid characters in a project name,
* or if a pagination token is invalid.</p>
*/
export class ValidationException extends __BaseException {
readonly name: "ValidationException" = "ValidationException";
readonly $fault: "client" = "client";
Message: string | undefined;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) {
super({
name: "ValidationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ValidationException.prototype);
this.Message = opts.Message;
}
}
/**
* <p>Information about the location of training output or the output of a model packaging job.</p>
*/
export interface S3Location {
/**
* <p>The S3 bucket that contains the training or model packaging job output. If you are training a model,
* the bucket must in your AWS account. If you use an S3 bucket for a model packaging job,
* the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.</p>
*/
Bucket: string | undefined;
/**
* <p>The path of the folder, within the S3 bucket, that contains the output.</p>
*/
Prefix?: string;
}
/**
* <p>The S3 location where Amazon Lookout for Vision saves model training files.</p>
*/
export interface OutputConfig {
/**
* <p>The S3 location for the output.</p>
*/
S3Location: S3Location | undefined;
}
/**
* <p>A key and value pair that is attached to the specified Amazon Lookout for Vision model.</p>
*/
export interface Tag {
/**
* <p>The key of the tag that is attached to the specified model.</p>
*/
Key: string | undefined;
/**
* <p>The value of the tag that is attached to the specified model.</p>
*/
Value: string | undefined;
}
export interface CreateModelRequest {
/**
* <p>The name of the project in which you want to create a model version.</p>
*/
ProjectName: string | undefined;
/**
* <p>A description for the version of the model.</p>
*/
Description?: string;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>CreateModel</code>
* completes only once. You choose the value to pass. For example, An issue
* might prevent you from getting a response from <code>CreateModel</code>.
* In this case, safely retry your call
* to <code>CreateModel</code> by using the same <code>ClientToken</code> parameter value. </p>
* <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from starting multiple training jobs. You'll need to
* provide your own value for other use cases. </p>
* <p>An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>CreateModel</code>. An idempotency
* token is active for 8 hours.</p>
*/
ClientToken?: string;
/**
* <p>The location where Amazon Lookout for Vision saves the training results.</p>
*/
OutputConfig: OutputConfig | undefined;
/**
* <p>The identifier for your AWS KMS key.
* The key is used to encrypt training and test images copied into the service for model training. Your
* source images are unaffected.
* If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.</p>
*/
KmsKeyId?: string;
/**
* <p>A set of tags (key-value pairs) that you want to attach to the model.</p>
*/
Tags?: Tag[];
}
/**
* <p>Information about the evaluation performance of a trained model. </p>
*/
export interface ModelPerformance {
/**
* <p>The overall F1 score metric for the trained model.</p>
*/
F1Score?: number;
/**
* <p>The overall recall metric value for the trained model. </p>
*/
Recall?: number;
/**
* <p>The overall precision metric value for the trained model.</p>
*/
Precision?: number;
}
export enum ModelStatus {
DELETING = "DELETING",
HOSTED = "HOSTED",
HOSTING_FAILED = "HOSTING_FAILED",
STARTING_HOSTING = "STARTING_HOSTING",
STOPPING_HOSTING = "STOPPING_HOSTING",
SYSTEM_UPDATING = "SYSTEM_UPDATING",
TRAINED = "TRAINED",
TRAINING = "TRAINING",
TRAINING_FAILED = "TRAINING_FAILED",
}
/**
* <p>Describes an Amazon Lookout for Vision model.</p>
*/
export interface ModelMetadata {
/**
* <p>The unix timestamp for the date and time that the model was created. </p>
*/
CreationTimestamp?: Date;
/**
* <p>The version of the model.</p>
*/
ModelVersion?: string;
/**
* <p>The Amazon Resource Name (ARN) of the model.</p>
*/
ModelArn?: string;
/**
* <p>The description for the model.</p>
*/
Description?: string;
/**
* <p>The status of the model.</p>
*/
Status?: ModelStatus | string;
/**
* <p>The status message for the model.</p>
*/
StatusMessage?: string;
/**
* <p>Performance metrics for the model. Not available until training has successfully completed.</p>
*/
Performance?: ModelPerformance;
}
export interface CreateModelResponse {
/**
* <p>The response from a call to <code>CreateModel</code>.</p>
*/
ModelMetadata?: ModelMetadata;
}
export interface CreateProjectRequest {
/**
* <p>The name for the project.</p>
*/
ProjectName: string | undefined;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>CreateProject</code>
* completes only once. You choose the value to pass. For example, An issue might prevent you from
* getting a response from <code>CreateProject</code>.
* In this case, safely retry your call
* to <code>CreateProject</code> by using the same <code>ClientToken</code> parameter value. </p>
* <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from making multiple project creation requests. You'll need to
* provide your own value for other use cases. </p>
* <p>An error occurs
* if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>CreateProject</code>. An idempotency
* token is active for 8 hours.</p>
*/
ClientToken?: string;
}
/**
* <p>Metadata about an Amazon Lookout for Vision project.</p>
*/
export interface ProjectMetadata {
/**
* <p>The Amazon Resource Name (ARN) of the project.</p>
*/
ProjectArn?: string;
/**
* <p>The name of the project.</p>
*/
ProjectName?: string;
/**
* <p>The unix timestamp for the date and time that the project was created. </p>
*/
CreationTimestamp?: Date;
}
export interface CreateProjectResponse {
/**
* <p>Information about the project.</p>
*/
ProjectMetadata?: ProjectMetadata;
}
/**
* <p>Statistics about the images in a dataset.</p>
*/
export interface DatasetImageStats {
/**
* <p>The total number of images in the dataset.</p>
*/
Total?: number;
/**
* <p>The total number of labeled images.</p>
*/
Labeled?: number;
/**
* <p>The total number of images labeled as normal.</p>
*/
Normal?: number;
/**
* <p>the total number of images labeled as an anomaly.</p>
*/
Anomaly?: number;
}
/**
* <p>The description for a dataset. For more information, see <a>DescribeDataset</a>.</p>
*/
export interface DatasetDescription {
/**
* <p>The name of the project that contains the dataset.</p>
*/
ProjectName?: string;
/**
* <p>The type of the dataset. The value <code>train</code> represents a training dataset or single dataset project.
* The value <code>test</code> represents a test dataset.</p>
*/
DatasetType?: string;
/**
* <p>The Unix timestamp for the time and date that the dataset was created.</p>
*/
CreationTimestamp?: Date;
/**
* <p>The Unix timestamp for the date and time that the dataset was last updated.</p>
*/
LastUpdatedTimestamp?: Date;
/**
* <p>The status of the dataset.</p>
*/
Status?: DatasetStatus | string;
/**
* <p>The status message for the dataset. </p>
*/
StatusMessage?: string;
/**
* <p>Statistics about the images in a dataset.</p>
*/
ImageStats?: DatasetImageStats;
}
export interface DeleteDatasetRequest {
/**
* <p>The name of the project that contains the dataset that you want to delete.</p>
*/
ProjectName: string | undefined;
/**
* <p>The type of the dataset to delete. Specify <code>train</code> to delete the training dataset.
* Specify <code>test</code> to delete the test dataset. To delete the dataset in a single dataset project,
* specify <code>train</code>.</p>
*/
DatasetType: string | undefined;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>DeleteDataset</code>
* completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from <code>DeleteDataset</code>.
* In this case, safely retry your call
* to <code>DeleteDataset</code> by using the same <code>ClientToken</code> parameter value. </p>
* <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from making multiple deletetion requests. You'll need to
* provide your own value for other use cases. </p>
* <p>An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>DeleteDataset</code>. An idempotency
* token is active for 8 hours.</p>
*/
ClientToken?: string;
}
export interface DeleteDatasetResponse {}
export interface DeleteModelRequest {
/**
* <p>The name of the project that contains the model that you want to delete.</p>
*/
ProjectName: string | undefined;
/**
* <p>The version of the model that you want to delete.</p>
*/
ModelVersion: string | undefined;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>DeleteModel</code>
* completes only once. You choose the value to pass. For example, an issue might prevent
* you from getting a response from <code>DeleteModel</code>.
* In this case, safely retry your call
* to <code>DeleteModel</code> by using the same <code>ClientToken</code> parameter value.</p>
* <p>If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from making multiple model deletion requests. You'll need to
* provide your own value for other use cases. </p>
*
* <p>An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>DeleteModel</code>. An idempotency
* token is active for 8 hours.</p>
*/
ClientToken?: string;
}
export interface DeleteModelResponse {
/**
* <p>The Amazon Resource Name (ARN) of the model that was deleted.</p>
*/
ModelArn?: string;
}
export interface DeleteProjectRequest {
/**
* <p>The name of the project to delete.</p>
*/
ProjectName: string | undefined;
/**
* <p>ClientToken is an idempotency token that ensures a call to <code>DeleteProject</code>
* completes only once. You choose the value to pass. For example, An issue
* might prevent you from getting a response from <code>DeleteProject</code>.
* In this case, safely retry your call
* to <code>DeleteProject</code> by using the same <code>ClientToken</code> parameter value. </p>
* <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you.
* This prevents retries after a network error from making multiple project deletion requests. You'll need to
* provide your own value for other use cases. </p>
* <p>An error occurs if the other input parameters are not the same as in the first request. Using a different
* value for <code>ClientToken</code> is considered a new call to <code>DeleteProject</code>. An idempotency
* token is active for 8 hours.</p>
*/
ClientToken?: string;
}
export interface DeleteProjectResponse {
/**
* <p>The Amazon Resource Name (ARN) of the project that was deleted.</p>
*/
ProjectArn?: string;
}
export interface DescribeDatasetRequest {
/**
* <p>The name of the project that contains the dataset that you want to describe.</p>
*/
ProjectName: string | undefined;
/**
* <p>The type of the dataset to describe. Specify <code>train</code> to describe the
* training dataset. Specify <code>test</code> to describe the test dataset.
* If you have a single dataset project, specify <code>train</code>
* </p>
*/
DatasetType: string | undefined;
}
export interface DescribeDatasetResponse {
/**
* <p>The description of the requested dataset. </p>
*/
DatasetDescription?: DatasetDescription;
}
export interface DescribeModelRequest {
/**
* <p>The project that contains the version of a model that you want to describe.</p>
*/
ProjectName: string | undefined;
/**
* <p>The version of the model that you want to describe.</p>
*/
ModelVersion: string | undefined;
}
/**
* <p>The S3 location where Amazon Lookout for Vision saves training output.</p>
*/
export interface OutputS3Object {
/**
* <p>The bucket that contains the training output.</p>
*/
Bucket: string | undefined;
/**
* <p>The location of the training output in the bucket.</p>
*/
Key: string | undefined;
}
/**
* <p>Describes an Amazon Lookout for Vision model.</p>
*/
export interface ModelDescription {
/**
* <p>The version of the model</p>
*/
ModelVersion?: string;
/**
* <p>The Amazon Resource Name (ARN) of the model.</p>
*/
ModelArn?: string;
/**
* <p>The unix timestamp for the date and time that the model was created. </p>
*/
CreationTimestamp?: Date;
/**
* <p>The description for the model.</p>
*/
Description?: string;
/**
* <p>The status of the model.</p>
*/
Status?: ModelStatus | string;
/**
* <p>The status message for the model.</p>
*/
StatusMessage?: string;
/**
* <p>Performance metrics for the model. Created during training.</p>
*/
Performance?: ModelPerformance;
/**
* <p>The S3 location where Amazon Lookout for Vision saves model training files.</p>
*/
OutputConfig?: OutputConfig;
/**
* <p>The S3 location where Amazon Lookout for Vision saves the manifest file
* that was used to test the trained model and generate the performance scores.</p>
*/
EvaluationManifest?: OutputS3Object;
/**
* <p>The S3 location where Amazon Lookout for Vision saves the performance metrics.</p>
*/
EvaluationResult?: OutputS3Object;
/**
* <p>The unix timestamp for the date and time that the evaluation ended. </p>
*/
EvaluationEndTimestamp?: Date;
/**
* <p>The identifer for the AWS Key Management Service (AWS KMS) key that was used to encrypt the model
* during training.</p>
*/
KmsKeyId?: string;
/**
* <p>The minimum number of inference units used by the model. For more information,
* see <a>StartModel</a>
* </p>
*/
MinInferenceUnits?: number;
/**
* <p>The maximum number of inference units Amazon Lookout for Vision uses to auto-scale the model.
* For more information, see <a>StartModel</a>.</p>
*/
MaxInferenceUnits?: number;
}
export interface DescribeModelResponse {
/**
* <p>Contains the description of the model.</p>
*/
ModelDescription?: ModelDescription;
}
export interface DescribeModelPackagingJobRequest {
/**
* <p>The name of the project that contains the model packaging job that you want to describe.
* </p>
*/
ProjectName: string | undefined;
/**
* <p>The job name for the model packaging job.
*
* </p>
*/
JobName: string | undefined;
}
export enum TargetDevice {
JETSON_XAVIER = "jetson_xavier",
}
export enum TargetPlatformAccelerator {
NVIDIA = "NVIDIA",
}
export enum TargetPlatformArch {
ARM64 = "ARM64",
X86_64 = "X86_64",
}
export enum TargetPlatformOs {
LINUX = "LINUX",
}
/**
* <p>The platform on which a model runs on an AWS IoT Greengrass core device.</p>
*/
export interface TargetPlatform {
/**
* <p>The target operating system for the model. Linux is the only operating system
* that is currently supported.
* </p>
*/
Os: TargetPlatformOs | string | undefined;
/**
* <p>The target architecture for the model. The currently supported architectures are
* X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).
* </p>
*/
Arch: TargetPlatformArch | string | undefined;
/**
* <p>The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit)
* and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the <code>gpu-code</code>, <code>trt-ver</code>,
* and <code>cuda-ver</code> compiler options. If you don't specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the
* <a>GreengrassConfiguration$CompilerOptions</a> field. For example, you can use the following compiler options for CPU: </p>
* <ul>
* <li>
* <p>
* <code>mcpu</code>: CPU micro-architecture. For example, <code>{'mcpu': 'skylake-avx512'}</code>
* </p>
* </li>
* <li>
* <p>
* <code>mattr</code>: CPU flags. For example, <code>{'mattr': ['+neon', '+vfpv4']}</code>
* </p>
* </li>
* </ul>
*/
Accelerator?: TargetPlatformAccelerator | string;
}
/**
* <p>Configuration information for the AWS IoT Greengrass component created in a model packaging job.
* For more information, see <a>StartModelPackagingJob</a>.
* </p>
* <note>
* <p>You can't specify a component with the same <code>ComponentName</code> and <code>Componentversion</code> as
* an existing component with the same component name and component version.</p>
* </note>
*/
export interface GreengrassConfiguration {
/**
* <p>Additional compiler options for the Greengrass component. Currently,
* only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported.
* If you specify <code>TargetDevice</code>, don't specify <code>CompilerOptions</code>.</p>
*
*
* <p>For more information, see
* <i>Compiler options</i> in the Amazon Lookout for Vision Developer Guide. </p>
*/
CompilerOptions?: string;
/**
* <p>The target device for the model. Currently the only supported value is <code>jetson_xavier</code>.