@aws-sdk/client-lookoutequipment 3.381.0 → 3.382.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +456 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -34,6 +34,7 @@ export declare class ConflictException extends __BaseException {
34
34
  */
35
35
  export interface DatasetSchema {
36
36
  /**
37
+ * @public
37
38
  * <p>
38
39
  * </p>
39
40
  */
@@ -45,10 +46,12 @@ export interface DatasetSchema {
45
46
  */
46
47
  export interface Tag {
47
48
  /**
49
+ * @public
48
50
  * <p>The key for the specified tag. </p>
49
51
  */
50
52
  Key: string | undefined;
51
53
  /**
54
+ * @public
52
55
  * <p>The value for the specified tag. </p>
53
56
  */
54
57
  Value: string | undefined;
@@ -58,25 +61,30 @@ export interface Tag {
58
61
  */
59
62
  export interface CreateDatasetRequest {
60
63
  /**
64
+ * @public
61
65
  * <p>The name of the dataset being created. </p>
62
66
  */
63
67
  DatasetName: string | undefined;
64
68
  /**
69
+ * @public
65
70
  * <p>A JSON description of the data that is in each time series dataset, including names,
66
71
  * column names, and data types. </p>
67
72
  */
68
73
  DatasetSchema?: DatasetSchema;
69
74
  /**
75
+ * @public
70
76
  * <p>Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout
71
77
  * for Equipment. </p>
72
78
  */
73
79
  ServerSideKmsKeyId?: string;
74
80
  /**
81
+ * @public
75
82
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
76
83
  * Lookout for Equipment generates one. </p>
77
84
  */
78
85
  ClientToken?: string;
79
86
  /**
87
+ * @public
80
88
  * <p>Any tags associated with the ingested data described in the dataset. </p>
81
89
  */
82
90
  Tags?: Tag[];
@@ -100,14 +108,17 @@ export type DatasetStatus = (typeof DatasetStatus)[keyof typeof DatasetStatus];
100
108
  */
101
109
  export interface CreateDatasetResponse {
102
110
  /**
111
+ * @public
103
112
  * <p>The name of the dataset being created. </p>
104
113
  */
105
114
  DatasetName?: string;
106
115
  /**
116
+ * @public
107
117
  * <p> The Amazon Resource Name (ARN) of the dataset being created. </p>
108
118
  */
109
119
  DatasetArn?: string;
110
120
  /**
121
+ * @public
111
122
  * <p>Indicates the status of the <code>CreateDataset</code> operation. </p>
112
123
  */
113
124
  Status?: DatasetStatus | string;
@@ -173,11 +184,13 @@ export declare class ValidationException extends __BaseException {
173
184
  */
174
185
  export interface InferenceInputNameConfiguration {
175
186
  /**
187
+ * @public
176
188
  * <p>The format of the timestamp, whether Epoch time, or standard, with or without hyphens
177
189
  * (-). </p>
178
190
  */
179
191
  TimestampFormat?: string;
180
192
  /**
193
+ * @public
181
194
  * <p>Indicates the delimiter character used between items in the data. </p>
182
195
  */
183
196
  ComponentTimestampDelimiter?: string;
@@ -189,10 +202,12 @@ export interface InferenceInputNameConfiguration {
189
202
  */
190
203
  export interface InferenceS3InputConfiguration {
191
204
  /**
205
+ * @public
192
206
  * <p>The bucket containing the input dataset for the inference. </p>
193
207
  */
194
208
  Bucket: string | undefined;
195
209
  /**
210
+ * @public
196
211
  * <p>The prefix for the S3 bucket used for the input data for the inference. </p>
197
212
  */
198
213
  Prefix?: string;
@@ -204,16 +219,19 @@ export interface InferenceS3InputConfiguration {
204
219
  */
205
220
  export interface InferenceInputConfiguration {
206
221
  /**
222
+ * @public
207
223
  * <p> Specifies configuration information for the input data for the inference, including
208
224
  * Amazon S3 location of input data.</p>
209
225
  */
210
226
  S3InputConfiguration?: InferenceS3InputConfiguration;
211
227
  /**
228
+ * @public
212
229
  * <p>Indicates the difference between your time zone and Coordinated Universal Time
213
230
  * (UTC).</p>
214
231
  */
215
232
  InputTimeZoneOffset?: string;
216
233
  /**
234
+ * @public
217
235
  * <p>Specifies configuration information for the input data for the inference, including
218
236
  * timestamp format and delimiter. </p>
219
237
  */
@@ -226,10 +244,12 @@ export interface InferenceInputConfiguration {
226
244
  */
227
245
  export interface InferenceS3OutputConfiguration {
228
246
  /**
247
+ * @public
229
248
  * <p> The bucket containing the output results from the inference </p>
230
249
  */
231
250
  Bucket: string | undefined;
232
251
  /**
252
+ * @public
233
253
  * <p> The prefix for the S3 bucket used for the output results from the inference. </p>
234
254
  */
235
255
  Prefix?: string;
@@ -241,11 +261,13 @@ export interface InferenceS3OutputConfiguration {
241
261
  */
242
262
  export interface InferenceOutputConfiguration {
243
263
  /**
264
+ * @public
244
265
  * <p> Specifies configuration information for the output results from for the inference,
245
266
  * output S3 location. </p>
246
267
  */
247
268
  S3OutputConfiguration: InferenceS3OutputConfiguration | undefined;
248
269
  /**
270
+ * @public
249
271
  * <p>The ID number for the KMS key key used to encrypt the inference output. </p>
250
272
  */
251
273
  KmsKeyId?: string;
@@ -270,15 +292,18 @@ export type DataUploadFrequency = (typeof DataUploadFrequency)[keyof typeof Data
270
292
  */
271
293
  export interface CreateInferenceSchedulerRequest {
272
294
  /**
295
+ * @public
273
296
  * <p>The name of the previously trained ML model being used to create the inference
274
297
  * scheduler. </p>
275
298
  */
276
299
  ModelName: string | undefined;
277
300
  /**
301
+ * @public
278
302
  * <p>The name of the inference scheduler being created. </p>
279
303
  */
280
304
  InferenceSchedulerName: string | undefined;
281
305
  /**
306
+ * @public
282
307
  * <p>The interval (in minutes) of planned delay at the start of each inference segment. For
283
308
  * example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the
284
309
  * configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3
@@ -288,6 +313,7 @@ export interface CreateInferenceSchedulerRequest {
288
313
  */
289
314
  DataDelayOffsetInMinutes?: number;
290
315
  /**
316
+ * @public
291
317
  * <p> How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen
292
318
  * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5
293
319
  * minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.</p>
@@ -295,31 +321,37 @@ export interface CreateInferenceSchedulerRequest {
295
321
  */
296
322
  DataUploadFrequency: DataUploadFrequency | string | undefined;
297
323
  /**
324
+ * @public
298
325
  * <p>Specifies configuration information for the input data for the inference scheduler,
299
326
  * including delimiter, format, and dataset location. </p>
300
327
  */
301
328
  DataInputConfiguration: InferenceInputConfiguration | undefined;
302
329
  /**
330
+ * @public
303
331
  * <p>Specifies configuration information for the output results for the inference scheduler,
304
332
  * including the S3 location for the output. </p>
305
333
  */
306
334
  DataOutputConfiguration: InferenceOutputConfiguration | undefined;
307
335
  /**
336
+ * @public
308
337
  * <p>The Amazon Resource Name (ARN) of a role with permission to access the data source being
309
338
  * used for the inference. </p>
310
339
  */
311
340
  RoleArn: string | undefined;
312
341
  /**
342
+ * @public
313
343
  * <p>Provides the identifier of the KMS key used to encrypt inference scheduler data by
314
344
  * Amazon Lookout for Equipment. </p>
315
345
  */
316
346
  ServerSideKmsKeyId?: string;
317
347
  /**
348
+ * @public
318
349
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
319
350
  * Lookout for Equipment generates one. </p>
320
351
  */
321
352
  ClientToken?: string;
322
353
  /**
354
+ * @public
323
355
  * <p>Any tags associated with the inference scheduler. </p>
324
356
  */
325
357
  Tags?: Tag[];
@@ -343,14 +375,17 @@ export type InferenceSchedulerStatus = (typeof InferenceSchedulerStatus)[keyof t
343
375
  */
344
376
  export interface CreateInferenceSchedulerResponse {
345
377
  /**
378
+ * @public
346
379
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being created. </p>
347
380
  */
348
381
  InferenceSchedulerArn?: string;
349
382
  /**
383
+ * @public
350
384
  * <p>The name of inference scheduler being created. </p>
351
385
  */
352
386
  InferenceSchedulerName?: string;
353
387
  /**
388
+ * @public
354
389
  * <p>Indicates the status of the <code>CreateInferenceScheduler</code> operation. </p>
355
390
  */
356
391
  Status?: InferenceSchedulerStatus | string;
@@ -387,6 +422,7 @@ export type LabelRating = (typeof LabelRating)[keyof typeof LabelRating];
387
422
  */
388
423
  export interface CreateLabelRequest {
389
424
  /**
425
+ * @public
390
426
  * <p>
391
427
  * The name of a group of labels. </p>
392
428
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
@@ -394,24 +430,28 @@ export interface CreateLabelRequest {
394
430
  */
395
431
  LabelGroupName: string | undefined;
396
432
  /**
433
+ * @public
397
434
  * <p>
398
435
  * The start time of the labeled event.
399
436
  * </p>
400
437
  */
401
438
  StartTime: Date | undefined;
402
439
  /**
440
+ * @public
403
441
  * <p>
404
442
  * The end time of the labeled event.
405
443
  * </p>
406
444
  */
407
445
  EndTime: Date | undefined;
408
446
  /**
447
+ * @public
409
448
  * <p>
410
449
  * Indicates whether a labeled event represents an anomaly.
411
450
  * </p>
412
451
  */
413
452
  Rating: LabelRating | string | undefined;
414
453
  /**
454
+ * @public
415
455
  * <p>
416
456
  * Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.</p>
417
457
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
@@ -419,6 +459,7 @@ export interface CreateLabelRequest {
419
459
  */
420
460
  FaultCode?: string;
421
461
  /**
462
+ * @public
422
463
  * <p>
423
464
  * Metadata providing additional information about the label.
424
465
  * </p>
@@ -426,6 +467,7 @@ export interface CreateLabelRequest {
426
467
  */
427
468
  Notes?: string;
428
469
  /**
470
+ * @public
429
471
  * <p>
430
472
  * Indicates that a label pertains to a particular piece of equipment.
431
473
  * </p>
@@ -433,6 +475,7 @@ export interface CreateLabelRequest {
433
475
  */
434
476
  Equipment?: string;
435
477
  /**
478
+ * @public
436
479
  * <p>
437
480
  * A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.
438
481
  * </p>
@@ -444,6 +487,7 @@ export interface CreateLabelRequest {
444
487
  */
445
488
  export interface CreateLabelResponse {
446
489
  /**
490
+ * @public
447
491
  * <p>
448
492
  * The ID of the label that you have created.
449
493
  * </p>
@@ -455,6 +499,7 @@ export interface CreateLabelResponse {
455
499
  */
456
500
  export interface CreateLabelGroupRequest {
457
501
  /**
502
+ * @public
458
503
  * <p>
459
504
  * Names a group of labels.</p>
460
505
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.
@@ -462,18 +507,21 @@ export interface CreateLabelGroupRequest {
462
507
  */
463
508
  LabelGroupName: string | undefined;
464
509
  /**
510
+ * @public
465
511
  * <p>
466
512
  * The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.</p>
467
513
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
468
514
  */
469
515
  FaultCodes?: string[];
470
516
  /**
517
+ * @public
471
518
  * <p>
472
519
  * A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.
473
520
  * </p>
474
521
  */
475
522
  ClientToken?: string;
476
523
  /**
524
+ * @public
477
525
  * <p>
478
526
  * Tags that provide metadata about the label group you are creating.
479
527
  * </p>
@@ -486,12 +534,14 @@ export interface CreateLabelGroupRequest {
486
534
  */
487
535
  export interface CreateLabelGroupResponse {
488
536
  /**
537
+ * @public
489
538
  * <p>
490
539
  * The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.
491
540
  * </p>
492
541
  */
493
542
  LabelGroupName?: string;
494
543
  /**
544
+ * @public
495
545
  * <p>
496
546
  * The Amazon Resource Name (ARN) of the label group that you have created.
497
547
  * </p>
@@ -534,6 +584,7 @@ export type TargetSamplingRate = (typeof TargetSamplingRate)[keyof typeof Target
534
584
  */
535
585
  export interface DataPreProcessingConfiguration {
536
586
  /**
587
+ * @public
537
588
  * <p>The sampling rate of the data after post processing by Amazon Lookout for Equipment. For
538
589
  * example, if you provide data that has been collected at a 1 second level and you want the
539
590
  * system to resample the data at a 1 minute rate before training, the
@@ -553,10 +604,12 @@ export interface DataPreProcessingConfiguration {
553
604
  */
554
605
  export interface LabelsS3InputConfiguration {
555
606
  /**
607
+ * @public
556
608
  * <p>The name of the S3 bucket holding the label data. </p>
557
609
  */
558
610
  Bucket: string | undefined;
559
611
  /**
612
+ * @public
560
613
  * <p> The prefix for the S3 bucket used for the label data. </p>
561
614
  */
562
615
  Prefix?: string;
@@ -568,10 +621,12 @@ export interface LabelsS3InputConfiguration {
568
621
  */
569
622
  export interface LabelsInputConfiguration {
570
623
  /**
624
+ * @public
571
625
  * <p>Contains location information for the S3 location being used for label data. </p>
572
626
  */
573
627
  S3InputConfiguration?: LabelsS3InputConfiguration;
574
628
  /**
629
+ * @public
575
630
  * <p>
576
631
  * The name of the label group to be used for label data.
577
632
  * </p>
@@ -583,53 +638,64 @@ export interface LabelsInputConfiguration {
583
638
  */
584
639
  export interface CreateModelRequest {
585
640
  /**
641
+ * @public
586
642
  * <p>The name for the ML model to be created.</p>
587
643
  */
588
644
  ModelName: string | undefined;
589
645
  /**
646
+ * @public
590
647
  * <p>The name of the dataset for the ML model being created. </p>
591
648
  */
592
649
  DatasetName: string | undefined;
593
650
  /**
651
+ * @public
594
652
  * <p>The data schema for the ML model being created. </p>
595
653
  */
596
654
  DatasetSchema?: DatasetSchema;
597
655
  /**
656
+ * @public
598
657
  * <p>The input configuration for the labels being used for the ML model that's being created.
599
658
  * </p>
600
659
  */
601
660
  LabelsInputConfiguration?: LabelsInputConfiguration;
602
661
  /**
662
+ * @public
603
663
  * <p>A unique identifier for the request. If you do not set the client request token, Amazon
604
664
  * Lookout for Equipment generates one. </p>
605
665
  */
606
666
  ClientToken?: string;
607
667
  /**
668
+ * @public
608
669
  * <p>Indicates the time reference in the dataset that should be used to begin the subset of
609
670
  * training data for the ML model. </p>
610
671
  */
611
672
  TrainingDataStartTime?: Date;
612
673
  /**
674
+ * @public
613
675
  * <p>Indicates the time reference in the dataset that should be used to end the subset of
614
676
  * training data for the ML model. </p>
615
677
  */
616
678
  TrainingDataEndTime?: Date;
617
679
  /**
680
+ * @public
618
681
  * <p>Indicates the time reference in the dataset that should be used to begin the subset of
619
682
  * evaluation data for the ML model. </p>
620
683
  */
621
684
  EvaluationDataStartTime?: Date;
622
685
  /**
686
+ * @public
623
687
  * <p> Indicates the time reference in the dataset that should be used to end the subset of
624
688
  * evaluation data for the ML model. </p>
625
689
  */
626
690
  EvaluationDataEndTime?: Date;
627
691
  /**
692
+ * @public
628
693
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source
629
694
  * being used to create the ML model. </p>
630
695
  */
631
696
  RoleArn?: string;
632
697
  /**
698
+ * @public
633
699
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
634
700
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
635
701
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -643,15 +709,18 @@ export interface CreateModelRequest {
643
709
  */
644
710
  DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
645
711
  /**
712
+ * @public
646
713
  * <p>Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout
647
714
  * for Equipment. </p>
648
715
  */
649
716
  ServerSideKmsKeyId?: string;
650
717
  /**
718
+ * @public
651
719
  * <p> Any tags associated with the ML model being created. </p>
652
720
  */
653
721
  Tags?: Tag[];
654
722
  /**
723
+ * @public
655
724
  * <p>Indicates that the asset associated with this sensor has been shut off. As long as this
656
725
  * condition is met, Lookout for Equipment will not use data from this asset for training,
657
726
  * evaluation, or inference.</p>
@@ -677,10 +746,12 @@ export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
677
746
  */
678
747
  export interface CreateModelResponse {
679
748
  /**
749
+ * @public
680
750
  * <p>The Amazon Resource Name (ARN) of the model being created. </p>
681
751
  */
682
752
  ModelArn?: string;
683
753
  /**
754
+ * @public
684
755
  * <p>Indicates the status of the <code>CreateModel</code> operation. </p>
685
756
  */
686
757
  Status?: ModelStatus | string;
@@ -690,6 +761,7 @@ export interface CreateModelResponse {
690
761
  */
691
762
  export interface DeleteDatasetRequest {
692
763
  /**
764
+ * @public
693
765
  * <p>The name of the dataset to be deleted. </p>
694
766
  */
695
767
  DatasetName: string | undefined;
@@ -699,6 +771,7 @@ export interface DeleteDatasetRequest {
699
771
  */
700
772
  export interface DeleteInferenceSchedulerRequest {
701
773
  /**
774
+ * @public
702
775
  * <p>The name of the inference scheduler to be deleted. </p>
703
776
  */
704
777
  InferenceSchedulerName: string | undefined;
@@ -708,12 +781,14 @@ export interface DeleteInferenceSchedulerRequest {
708
781
  */
709
782
  export interface DeleteLabelRequest {
710
783
  /**
784
+ * @public
711
785
  * <p>
712
786
  * The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
713
787
  * </p>
714
788
  */
715
789
  LabelGroupName: string | undefined;
716
790
  /**
791
+ * @public
717
792
  * <p>
718
793
  * The ID of the label that you want to delete.
719
794
  * </p>
@@ -725,6 +800,7 @@ export interface DeleteLabelRequest {
725
800
  */
726
801
  export interface DeleteLabelGroupRequest {
727
802
  /**
803
+ * @public
728
804
  * <p>
729
805
  * The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.
730
806
  * </p>
@@ -736,6 +812,7 @@ export interface DeleteLabelGroupRequest {
736
812
  */
737
813
  export interface DeleteModelRequest {
738
814
  /**
815
+ * @public
739
816
  * <p>The name of the ML model to be deleted. </p>
740
817
  */
741
818
  ModelName: string | undefined;
@@ -745,6 +822,7 @@ export interface DeleteModelRequest {
745
822
  */
746
823
  export interface DeleteResourcePolicyRequest {
747
824
  /**
825
+ * @public
748
826
  * <p>The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.</p>
749
827
  */
750
828
  ResourceArn: string | undefined;
@@ -754,6 +832,7 @@ export interface DeleteResourcePolicyRequest {
754
832
  */
755
833
  export interface DescribeDataIngestionJobRequest {
756
834
  /**
835
+ * @public
757
836
  * <p>The job ID of the data ingestion job. </p>
758
837
  */
759
838
  JobId: string | undefined;
@@ -764,6 +843,7 @@ export interface DescribeDataIngestionJobRequest {
764
843
  */
765
844
  export interface DuplicateTimestamps {
766
845
  /**
846
+ * @public
767
847
  * <p> Indicates the total number of duplicate timestamps. </p>
768
848
  */
769
849
  TotalNumberOfDuplicateTimestamps: number | undefined;
@@ -775,6 +855,7 @@ export interface DuplicateTimestamps {
775
855
  */
776
856
  export interface MissingCompleteSensorData {
777
857
  /**
858
+ * @public
778
859
  * <p> Indicates the number of sensors that have data missing completely. </p>
779
860
  */
780
861
  AffectedSensorCount: number | undefined;
@@ -785,6 +866,7 @@ export interface MissingCompleteSensorData {
785
866
  */
786
867
  export interface SensorsWithShortDateRange {
787
868
  /**
869
+ * @public
788
870
  * <p> Indicates the number of sensors that have less than 90 days of data. </p>
789
871
  */
790
872
  AffectedSensorCount: number | undefined;
@@ -796,11 +878,13 @@ export interface SensorsWithShortDateRange {
796
878
  */
797
879
  export interface InsufficientSensorData {
798
880
  /**
881
+ * @public
799
882
  * <p> Parameter that describes the total number of sensors that have data completely missing
800
883
  * for it. </p>
801
884
  */
802
885
  MissingCompleteSensorData: MissingCompleteSensorData | undefined;
803
886
  /**
887
+ * @public
804
888
  * <p> Parameter that describes the total number of sensors that have a short date range of
805
889
  * less than 90 days of data overall. </p>
806
890
  */
@@ -813,10 +897,12 @@ export interface InsufficientSensorData {
813
897
  */
814
898
  export interface InvalidSensorData {
815
899
  /**
900
+ * @public
816
901
  * <p> Indicates the number of sensors that have at least some invalid values. </p>
817
902
  */
818
903
  AffectedSensorCount: number | undefined;
819
904
  /**
905
+ * @public
820
906
  * <p> Indicates the total number of invalid values across all the sensors. </p>
821
907
  */
822
908
  TotalNumberOfInvalidValues: number | undefined;
@@ -827,10 +913,12 @@ export interface InvalidSensorData {
827
913
  */
828
914
  export interface MissingSensorData {
829
915
  /**
916
+ * @public
830
917
  * <p> Indicates the number of sensors that have atleast some data missing. </p>
831
918
  */
832
919
  AffectedSensorCount: number | undefined;
833
920
  /**
921
+ * @public
834
922
  * <p> Indicates the total number of missing values across all the sensors. </p>
835
923
  */
836
924
  TotalNumberOfMissingValues: number | undefined;
@@ -841,6 +929,7 @@ export interface MissingSensorData {
841
929
  */
842
930
  export interface UnsupportedTimestamps {
843
931
  /**
932
+ * @public
844
933
  * <p> Indicates the total number of unsupported timestamps across the ingested data. </p>
845
934
  */
846
935
  TotalNumberOfUnsupportedTimestamps: number | undefined;
@@ -854,27 +943,32 @@ export interface UnsupportedTimestamps {
854
943
  */
855
944
  export interface DataQualitySummary {
856
945
  /**
946
+ * @public
857
947
  * <p> Parameter that gives information about insufficient data for sensors in the dataset.
858
948
  * This includes information about those sensors that have complete data missing and those
859
949
  * with a short date range. </p>
860
950
  */
861
951
  InsufficientSensorData: InsufficientSensorData | undefined;
862
952
  /**
953
+ * @public
863
954
  * <p> Parameter that gives information about data that is missing over all the sensors in the
864
955
  * input data. </p>
865
956
  */
866
957
  MissingSensorData: MissingSensorData | undefined;
867
958
  /**
959
+ * @public
868
960
  * <p> Parameter that gives information about data that is invalid over all the sensors in the
869
961
  * input data. </p>
870
962
  */
871
963
  InvalidSensorData: InvalidSensorData | undefined;
872
964
  /**
965
+ * @public
873
966
  * <p> Parameter that gives information about unsupported timestamps in the input data.
874
967
  * </p>
875
968
  */
876
969
  UnsupportedTimestamps: UnsupportedTimestamps | undefined;
877
970
  /**
971
+ * @public
878
972
  * <p> Parameter that gives information about duplicate timestamps in the input data. </p>
879
973
  */
880
974
  DuplicateTimestamps: DuplicateTimestamps | undefined;
@@ -885,10 +979,12 @@ export interface DataQualitySummary {
885
979
  */
886
980
  export interface S3Object {
887
981
  /**
982
+ * @public
888
983
  * <p>The name of the specific S3 bucket. </p>
889
984
  */
890
985
  Bucket: string | undefined;
891
986
  /**
987
+ * @public
892
988
  * <p>The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.
893
989
  * Without this key, data in the bucket is not accessible. </p>
894
990
  */
@@ -901,14 +997,17 @@ export interface S3Object {
901
997
  */
902
998
  export interface IngestedFilesSummary {
903
999
  /**
1000
+ * @public
904
1001
  * <p>Indicates the total number of files that were submitted for ingestion.</p>
905
1002
  */
906
1003
  TotalNumberOfFiles: number | undefined;
907
1004
  /**
1005
+ * @public
908
1006
  * <p>Indicates the number of files that were successfully ingested.</p>
909
1007
  */
910
1008
  IngestedNumberOfFiles: number | undefined;
911
1009
  /**
1010
+ * @public
912
1011
  * <p>Indicates the number of files that were discarded. A file could be discarded because its
913
1012
  * format is invalid (for example, a jpg or pdf) or not readable.</p>
914
1013
  */
@@ -921,15 +1020,18 @@ export interface IngestedFilesSummary {
921
1020
  */
922
1021
  export interface IngestionS3InputConfiguration {
923
1022
  /**
1023
+ * @public
924
1024
  * <p>The name of the S3 bucket used for the input data for the data ingestion. </p>
925
1025
  */
926
1026
  Bucket: string | undefined;
927
1027
  /**
1028
+ * @public
928
1029
  * <p>The prefix for the S3 location being used for the input data for the data ingestion.
929
1030
  * </p>
930
1031
  */
931
1032
  Prefix?: string;
932
1033
  /**
1034
+ * @public
933
1035
  * <p>
934
1036
  * The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern \{prefix\}/\{component_name\}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.</p>
935
1037
  * <p>Valid Values: \{prefix\}/\{component_name\}_* | \{prefix\}/\{component_name\}/* | \{prefix\}/\{component_name\}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)</p>
@@ -943,6 +1045,7 @@ export interface IngestionS3InputConfiguration {
943
1045
  */
944
1046
  export interface IngestionInputConfiguration {
945
1047
  /**
1048
+ * @public
946
1049
  * <p>The location information for the S3 bucket used for input data for the data ingestion.
947
1050
  * </p>
948
1051
  */
@@ -967,67 +1070,81 @@ export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof Ingest
967
1070
  */
968
1071
  export interface DescribeDataIngestionJobResponse {
969
1072
  /**
1073
+ * @public
970
1074
  * <p>Indicates the job ID of the data ingestion job. </p>
971
1075
  */
972
1076
  JobId?: string;
973
1077
  /**
1078
+ * @public
974
1079
  * <p>The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
975
1080
  * </p>
976
1081
  */
977
1082
  DatasetArn?: string;
978
1083
  /**
1084
+ * @public
979
1085
  * <p>Specifies the S3 location configuration for the data input for the data ingestion job.
980
1086
  * </p>
981
1087
  */
982
1088
  IngestionInputConfiguration?: IngestionInputConfiguration;
983
1089
  /**
1090
+ * @public
984
1091
  * <p>The Amazon Resource Name (ARN) of an IAM role with permission to access the data source
985
1092
  * being ingested. </p>
986
1093
  */
987
1094
  RoleArn?: string;
988
1095
  /**
1096
+ * @public
989
1097
  * <p>The time at which the data ingestion job was created. </p>
990
1098
  */
991
1099
  CreatedAt?: Date;
992
1100
  /**
1101
+ * @public
993
1102
  * <p>Indicates the status of the <code>DataIngestionJob</code> operation. </p>
994
1103
  */
995
1104
  Status?: IngestionJobStatus | string;
996
1105
  /**
1106
+ * @public
997
1107
  * <p>Specifies the reason for failure when a data ingestion job has failed. </p>
998
1108
  */
999
1109
  FailedReason?: string;
1000
1110
  /**
1111
+ * @public
1001
1112
  * <p> Gives statistics about a completed ingestion job. These statistics primarily relate to
1002
1113
  * quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData,
1003
1114
  * UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps. </p>
1004
1115
  */
1005
1116
  DataQualitySummary?: DataQualitySummary;
1006
1117
  /**
1118
+ * @public
1007
1119
  * <p>Gives statistics about how many files have been ingested, and which files have not been
1008
1120
  * ingested, for a particular ingestion job.</p>
1009
1121
  */
1010
1122
  IngestedFilesSummary?: IngestedFilesSummary;
1011
1123
  /**
1124
+ * @public
1012
1125
  * <p> Provides details about status of the ingestion job that is currently in progress.
1013
1126
  * </p>
1014
1127
  */
1015
1128
  StatusDetail?: string;
1016
1129
  /**
1130
+ * @public
1017
1131
  * <p> Indicates the size of the ingested dataset. </p>
1018
1132
  */
1019
1133
  IngestedDataSize?: number;
1020
1134
  /**
1135
+ * @public
1021
1136
  * <p> Indicates the earliest timestamp corresponding to data that was successfully ingested
1022
1137
  * during this specific ingestion job. </p>
1023
1138
  */
1024
1139
  DataStartTime?: Date;
1025
1140
  /**
1141
+ * @public
1026
1142
  * <p> Indicates the latest timestamp corresponding to data that was successfully ingested
1027
1143
  * during this specific ingestion job. </p>
1028
1144
  */
1029
1145
  DataEndTime?: Date;
1030
1146
  /**
1147
+ * @public
1031
1148
  * <p>The Amazon Resource Name (ARN) of the source dataset from which the data
1032
1149
  * used for the data ingestion job was imported from.</p>
1033
1150
  */
@@ -1038,6 +1155,7 @@ export interface DescribeDataIngestionJobResponse {
1038
1155
  */
1039
1156
  export interface DescribeDatasetRequest {
1040
1157
  /**
1158
+ * @public
1041
1159
  * <p>The name of the dataset to be described. </p>
1042
1160
  */
1043
1161
  DatasetName: string | undefined;
@@ -1047,41 +1165,50 @@ export interface DescribeDatasetRequest {
1047
1165
  */
1048
1166
  export interface DescribeDatasetResponse {
1049
1167
  /**
1168
+ * @public
1050
1169
  * <p>The name of the dataset being described. </p>
1051
1170
  */
1052
1171
  DatasetName?: string;
1053
1172
  /**
1173
+ * @public
1054
1174
  * <p>The Amazon Resource Name (ARN) of the dataset being described. </p>
1055
1175
  */
1056
1176
  DatasetArn?: string;
1057
1177
  /**
1178
+ * @public
1058
1179
  * <p>Specifies the time the dataset was created in Lookout for Equipment. </p>
1059
1180
  */
1060
1181
  CreatedAt?: Date;
1061
1182
  /**
1183
+ * @public
1062
1184
  * <p>Specifies the time the dataset was last updated, if it was. </p>
1063
1185
  */
1064
1186
  LastUpdatedAt?: Date;
1065
1187
  /**
1188
+ * @public
1066
1189
  * <p>Indicates the status of the dataset. </p>
1067
1190
  */
1068
1191
  Status?: DatasetStatus | string;
1069
1192
  /**
1193
+ * @public
1070
1194
  * <p>A JSON description of the data that is in each time series dataset, including names,
1071
1195
  * column names, and data types. </p>
1072
1196
  */
1073
1197
  Schema?: __LazyJsonString | string;
1074
1198
  /**
1199
+ * @public
1075
1200
  * <p>Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout
1076
1201
  * for Equipment. </p>
1077
1202
  */
1078
1203
  ServerSideKmsKeyId?: string;
1079
1204
  /**
1205
+ * @public
1080
1206
  * <p>Specifies the S3 location configuration for the data input for the data ingestion job.
1081
1207
  * </p>
1082
1208
  */
1083
1209
  IngestionInputConfiguration?: IngestionInputConfiguration;
1084
1210
  /**
1211
+ * @public
1085
1212
  * <p> Gives statistics associated with the given dataset for the latest successful associated
1086
1213
  * ingestion job id. These statistics primarily relate to quantifying incorrect data such as
1087
1214
  * MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,
@@ -1089,26 +1216,31 @@ export interface DescribeDatasetResponse {
1089
1216
  */
1090
1217
  DataQualitySummary?: DataQualitySummary;
1091
1218
  /**
1219
+ * @public
1092
1220
  * <p> IngestedFilesSummary associated with the given dataset for the latest successful
1093
1221
  * associated ingestion job id. </p>
1094
1222
  */
1095
1223
  IngestedFilesSummary?: IngestedFilesSummary;
1096
1224
  /**
1225
+ * @public
1097
1226
  * <p> The Amazon Resource Name (ARN) of the IAM role that you are using for this the data
1098
1227
  * ingestion job. </p>
1099
1228
  */
1100
1229
  RoleArn?: string;
1101
1230
  /**
1231
+ * @public
1102
1232
  * <p> Indicates the earliest timestamp corresponding to data that was successfully ingested
1103
1233
  * during the most recent ingestion of this particular dataset. </p>
1104
1234
  */
1105
1235
  DataStartTime?: Date;
1106
1236
  /**
1237
+ * @public
1107
1238
  * <p> Indicates the latest timestamp corresponding to data that was successfully ingested
1108
1239
  * during the most recent ingestion of this particular dataset. </p>
1109
1240
  */
1110
1241
  DataEndTime?: Date;
1111
1242
  /**
1243
+ * @public
1112
1244
  * <p>The Amazon Resource Name (ARN) of the source dataset from which the
1113
1245
  * current data being described was imported from.</p>
1114
1246
  */
@@ -1119,6 +1251,7 @@ export interface DescribeDatasetResponse {
1119
1251
  */
1120
1252
  export interface DescribeInferenceSchedulerRequest {
1121
1253
  /**
1254
+ * @public
1122
1255
  * <p>The name of the inference scheduler being described. </p>
1123
1256
  */
1124
1257
  InferenceSchedulerName: string | undefined;
@@ -1140,27 +1273,33 @@ export type LatestInferenceResult = (typeof LatestInferenceResult)[keyof typeof
1140
1273
  */
1141
1274
  export interface DescribeInferenceSchedulerResponse {
1142
1275
  /**
1276
+ * @public
1143
1277
  * <p>The Amazon Resource Name (ARN) of the ML model of the inference scheduler being
1144
1278
  * described. </p>
1145
1279
  */
1146
1280
  ModelArn?: string;
1147
1281
  /**
1282
+ * @public
1148
1283
  * <p>The name of the ML model of the inference scheduler being described. </p>
1149
1284
  */
1150
1285
  ModelName?: string;
1151
1286
  /**
1287
+ * @public
1152
1288
  * <p>The name of the inference scheduler being described. </p>
1153
1289
  */
1154
1290
  InferenceSchedulerName?: string;
1155
1291
  /**
1292
+ * @public
1156
1293
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being described. </p>
1157
1294
  */
1158
1295
  InferenceSchedulerArn?: string;
1159
1296
  /**
1297
+ * @public
1160
1298
  * <p>Indicates the status of the inference scheduler. </p>
1161
1299
  */
1162
1300
  Status?: InferenceSchedulerStatus | string;
1163
1301
  /**
1302
+ * @public
1164
1303
  * <p> A period of time (in minutes) by which inference on the data is delayed after the data
1165
1304
  * starts. For instance, if you select an offset delay time of five minutes, inference will
1166
1305
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -1171,6 +1310,7 @@ export interface DescribeInferenceSchedulerResponse {
1171
1310
  */
1172
1311
  DataDelayOffsetInMinutes?: number;
1173
1312
  /**
1313
+ * @public
1174
1314
  * <p>Specifies how often data is uploaded to the source S3 bucket for the input data. This
1175
1315
  * value is the length of time between data uploads. For instance, if you select 5 minutes,
1176
1316
  * Amazon Lookout for Equipment will upload the real-time data to the source bucket once every
@@ -1179,34 +1319,41 @@ export interface DescribeInferenceSchedulerResponse {
1179
1319
  */
1180
1320
  DataUploadFrequency?: DataUploadFrequency | string;
1181
1321
  /**
1322
+ * @public
1182
1323
  * <p>Specifies the time at which the inference scheduler was created. </p>
1183
1324
  */
1184
1325
  CreatedAt?: Date;
1185
1326
  /**
1327
+ * @public
1186
1328
  * <p>Specifies the time at which the inference scheduler was last updated, if it was. </p>
1187
1329
  */
1188
1330
  UpdatedAt?: Date;
1189
1331
  /**
1332
+ * @public
1190
1333
  * <p> Specifies configuration information for the input data for the inference scheduler,
1191
1334
  * including delimiter, format, and dataset location. </p>
1192
1335
  */
1193
1336
  DataInputConfiguration?: InferenceInputConfiguration;
1194
1337
  /**
1338
+ * @public
1195
1339
  * <p> Specifies information for the output results for the inference scheduler, including
1196
1340
  * the output S3 location. </p>
1197
1341
  */
1198
1342
  DataOutputConfiguration?: InferenceOutputConfiguration;
1199
1343
  /**
1344
+ * @public
1200
1345
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
1201
1346
  * the inference scheduler being described. </p>
1202
1347
  */
1203
1348
  RoleArn?: string;
1204
1349
  /**
1350
+ * @public
1205
1351
  * <p>Provides the identifier of the KMS key used to encrypt inference scheduler data by
1206
1352
  * Amazon Lookout for Equipment. </p>
1207
1353
  */
1208
1354
  ServerSideKmsKeyId?: string;
1209
1355
  /**
1356
+ * @public
1210
1357
  * <p>Indicates whether the latest execution for the inference scheduler was Anomalous
1211
1358
  * (anomalous events found) or Normal (no anomalous events found).</p>
1212
1359
  */
@@ -1217,12 +1364,14 @@ export interface DescribeInferenceSchedulerResponse {
1217
1364
  */
1218
1365
  export interface DescribeLabelRequest {
1219
1366
  /**
1367
+ * @public
1220
1368
  * <p>
1221
1369
  * Returns the name of the group containing the label.
1222
1370
  * </p>
1223
1371
  */
1224
1372
  LabelGroupName: string | undefined;
1225
1373
  /**
1374
+ * @public
1226
1375
  * <p>
1227
1376
  * Returns the ID of the label.
1228
1377
  * </p>
@@ -1234,42 +1383,49 @@ export interface DescribeLabelRequest {
1234
1383
  */
1235
1384
  export interface DescribeLabelResponse {
1236
1385
  /**
1386
+ * @public
1237
1387
  * <p>
1238
1388
  * The name of the requested label group.
1239
1389
  * </p>
1240
1390
  */
1241
1391
  LabelGroupName?: string;
1242
1392
  /**
1393
+ * @public
1243
1394
  * <p>
1244
1395
  * The Amazon Resource Name (ARN) of the requested label group.
1245
1396
  * </p>
1246
1397
  */
1247
1398
  LabelGroupArn?: string;
1248
1399
  /**
1400
+ * @public
1249
1401
  * <p>
1250
1402
  * The ID of the requested label.
1251
1403
  * </p>
1252
1404
  */
1253
1405
  LabelId?: string;
1254
1406
  /**
1407
+ * @public
1255
1408
  * <p>
1256
1409
  * The start time of the requested label.
1257
1410
  * </p>
1258
1411
  */
1259
1412
  StartTime?: Date;
1260
1413
  /**
1414
+ * @public
1261
1415
  * <p>
1262
1416
  * The end time of the requested label.
1263
1417
  * </p>
1264
1418
  */
1265
1419
  EndTime?: Date;
1266
1420
  /**
1421
+ * @public
1267
1422
  * <p>
1268
1423
  * Indicates whether a labeled event represents an anomaly.
1269
1424
  * </p>
1270
1425
  */
1271
1426
  Rating?: LabelRating | string;
1272
1427
  /**
1428
+ * @public
1273
1429
  * <p>
1274
1430
  * Indicates the type of anomaly associated with the label.
1275
1431
  * </p>
@@ -1277,17 +1433,20 @@ export interface DescribeLabelResponse {
1277
1433
  */
1278
1434
  FaultCode?: string;
1279
1435
  /**
1436
+ * @public
1280
1437
  * <p>Metadata providing additional information about the label.</p>
1281
1438
  * <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
1282
1439
  */
1283
1440
  Notes?: string;
1284
1441
  /**
1442
+ * @public
1285
1443
  * <p>
1286
1444
  * Indicates that a label pertains to a particular piece of equipment.
1287
1445
  * </p>
1288
1446
  */
1289
1447
  Equipment?: string;
1290
1448
  /**
1449
+ * @public
1291
1450
  * <p>
1292
1451
  * The time at which the label was created.
1293
1452
  * </p>
@@ -1299,6 +1458,7 @@ export interface DescribeLabelResponse {
1299
1458
  */
1300
1459
  export interface DescribeLabelGroupRequest {
1301
1460
  /**
1461
+ * @public
1302
1462
  * <p>
1303
1463
  * Returns the name of the label group.
1304
1464
  * </p>
@@ -1310,30 +1470,35 @@ export interface DescribeLabelGroupRequest {
1310
1470
  */
1311
1471
  export interface DescribeLabelGroupResponse {
1312
1472
  /**
1473
+ * @public
1313
1474
  * <p>
1314
1475
  * The name of the label group.
1315
1476
  * </p>
1316
1477
  */
1317
1478
  LabelGroupName?: string;
1318
1479
  /**
1480
+ * @public
1319
1481
  * <p>
1320
1482
  * The Amazon Resource Name (ARN) of the label group.
1321
1483
  * </p>
1322
1484
  */
1323
1485
  LabelGroupArn?: string;
1324
1486
  /**
1487
+ * @public
1325
1488
  * <p>
1326
1489
  * Codes indicating the type of anomaly associated with the labels in the lagbel group.
1327
1490
  * </p>
1328
1491
  */
1329
1492
  FaultCodes?: string[];
1330
1493
  /**
1494
+ * @public
1331
1495
  * <p>
1332
1496
  * The time at which the label group was created.
1333
1497
  * </p>
1334
1498
  */
1335
1499
  CreatedAt?: Date;
1336
1500
  /**
1501
+ * @public
1337
1502
  * <p>
1338
1503
  * The time at which the label group was updated.
1339
1504
  * </p>
@@ -1345,6 +1510,7 @@ export interface DescribeLabelGroupResponse {
1345
1510
  */
1346
1511
  export interface DescribeModelRequest {
1347
1512
  /**
1513
+ * @public
1348
1514
  * <p>The name of the ML model to be described. </p>
1349
1515
  */
1350
1516
  ModelName: string | undefined;
@@ -1354,58 +1520,70 @@ export interface DescribeModelRequest {
1354
1520
  */
1355
1521
  export interface DescribeModelResponse {
1356
1522
  /**
1523
+ * @public
1357
1524
  * <p>The name of the ML model being described. </p>
1358
1525
  */
1359
1526
  ModelName?: string;
1360
1527
  /**
1528
+ * @public
1361
1529
  * <p>The Amazon Resource Name (ARN) of the ML model being described. </p>
1362
1530
  */
1363
1531
  ModelArn?: string;
1364
1532
  /**
1533
+ * @public
1365
1534
  * <p>The name of the dataset being used by the ML being described. </p>
1366
1535
  */
1367
1536
  DatasetName?: string;
1368
1537
  /**
1538
+ * @public
1369
1539
  * <p>The Amazon Resouce Name (ARN) of the dataset used to create the ML model being
1370
1540
  * described. </p>
1371
1541
  */
1372
1542
  DatasetArn?: string;
1373
1543
  /**
1544
+ * @public
1374
1545
  * <p>A JSON description of the data that is in each time series dataset, including names,
1375
1546
  * column names, and data types. </p>
1376
1547
  */
1377
1548
  Schema?: __LazyJsonString | string;
1378
1549
  /**
1550
+ * @public
1379
1551
  * <p>Specifies configuration information about the labels input, including its S3 location.
1380
1552
  * </p>
1381
1553
  */
1382
1554
  LabelsInputConfiguration?: LabelsInputConfiguration;
1383
1555
  /**
1556
+ * @public
1384
1557
  * <p> Indicates the time reference in the dataset that was used to begin the subset of
1385
1558
  * training data for the ML model. </p>
1386
1559
  */
1387
1560
  TrainingDataStartTime?: Date;
1388
1561
  /**
1562
+ * @public
1389
1563
  * <p> Indicates the time reference in the dataset that was used to end the subset of training
1390
1564
  * data for the ML model. </p>
1391
1565
  */
1392
1566
  TrainingDataEndTime?: Date;
1393
1567
  /**
1568
+ * @public
1394
1569
  * <p> Indicates the time reference in the dataset that was used to begin the subset of
1395
1570
  * evaluation data for the ML model. </p>
1396
1571
  */
1397
1572
  EvaluationDataStartTime?: Date;
1398
1573
  /**
1574
+ * @public
1399
1575
  * <p> Indicates the time reference in the dataset that was used to end the subset of
1400
1576
  * evaluation data for the ML model. </p>
1401
1577
  */
1402
1578
  EvaluationDataEndTime?: Date;
1403
1579
  /**
1580
+ * @public
1404
1581
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
1405
1582
  * the ML model being described. </p>
1406
1583
  */
1407
1584
  RoleArn?: string;
1408
1585
  /**
1586
+ * @public
1409
1587
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
1410
1588
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
1411
1589
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -1419,89 +1597,107 @@ export interface DescribeModelResponse {
1419
1597
  */
1420
1598
  DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
1421
1599
  /**
1600
+ * @public
1422
1601
  * <p>Specifies the current status of the model being described. Status describes the status
1423
1602
  * of the most recent action of the model. </p>
1424
1603
  */
1425
1604
  Status?: ModelStatus | string;
1426
1605
  /**
1606
+ * @public
1427
1607
  * <p>Indicates the time at which the training of the ML model began. </p>
1428
1608
  */
1429
1609
  TrainingExecutionStartTime?: Date;
1430
1610
  /**
1611
+ * @public
1431
1612
  * <p>Indicates the time at which the training of the ML model was completed. </p>
1432
1613
  */
1433
1614
  TrainingExecutionEndTime?: Date;
1434
1615
  /**
1616
+ * @public
1435
1617
  * <p>If the training of the ML model failed, this indicates the reason for that failure.
1436
1618
  * </p>
1437
1619
  */
1438
1620
  FailedReason?: string;
1439
1621
  /**
1622
+ * @public
1440
1623
  * <p>The Model Metrics show an aggregated summary of the model's performance within the
1441
1624
  * evaluation time range. This is the JSON content of the metrics created when evaluating the
1442
1625
  * model. </p>
1443
1626
  */
1444
1627
  ModelMetrics?: __LazyJsonString | string;
1445
1628
  /**
1629
+ * @public
1446
1630
  * <p>Indicates the last time the ML model was updated. The type of update is not specified.
1447
1631
  * </p>
1448
1632
  */
1449
1633
  LastUpdatedTime?: Date;
1450
1634
  /**
1635
+ * @public
1451
1636
  * <p>Indicates the time and date at which the ML model was created. </p>
1452
1637
  */
1453
1638
  CreatedAt?: Date;
1454
1639
  /**
1640
+ * @public
1455
1641
  * <p>Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout
1456
1642
  * for Equipment. </p>
1457
1643
  */
1458
1644
  ServerSideKmsKeyId?: string;
1459
1645
  /**
1646
+ * @public
1460
1647
  * <p>Indicates that the asset associated with this sensor has been shut off. As long as this
1461
1648
  * condition is met, Lookout for Equipment will not use data from this asset for training,
1462
1649
  * evaluation, or inference.</p>
1463
1650
  */
1464
1651
  OffCondition?: string;
1465
1652
  /**
1653
+ * @public
1466
1654
  * <p>The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version
1467
1655
  * was imported.</p>
1468
1656
  */
1469
1657
  SourceModelVersionArn?: string;
1470
1658
  /**
1659
+ * @public
1471
1660
  * <p>The date and time when the import job was started.
1472
1661
  * This field appears if the active model version was imported.</p>
1473
1662
  */
1474
1663
  ImportJobStartTime?: Date;
1475
1664
  /**
1665
+ * @public
1476
1666
  * <p>The date and time when the import job was completed.
1477
1667
  * This field appears if the active model version was imported.</p>
1478
1668
  */
1479
1669
  ImportJobEndTime?: Date;
1480
1670
  /**
1671
+ * @public
1481
1672
  * <p>The name of the model version used by the inference schedular when running a
1482
1673
  * scheduled inference execution.</p>
1483
1674
  */
1484
1675
  ActiveModelVersion?: number;
1485
1676
  /**
1677
+ * @public
1486
1678
  * <p>The Amazon Resource Name (ARN) of the model version used by the
1487
1679
  * inference scheduler when running a scheduled inference execution.</p>
1488
1680
  */
1489
1681
  ActiveModelVersionArn?: string;
1490
1682
  /**
1683
+ * @public
1491
1684
  * <p>The date the active model version was activated.</p>
1492
1685
  */
1493
1686
  ModelVersionActivatedAt?: Date;
1494
1687
  /**
1688
+ * @public
1495
1689
  * <p>The model version that was set as the active model version prior to the
1496
1690
  * current active model version.</p>
1497
1691
  */
1498
1692
  PreviousActiveModelVersion?: number;
1499
1693
  /**
1694
+ * @public
1500
1695
  * <p>The ARN of the model version that was set as the active model version prior to the
1501
1696
  * current active model version.</p>
1502
1697
  */
1503
1698
  PreviousActiveModelVersionArn?: string;
1504
1699
  /**
1700
+ * @public
1505
1701
  * <p>The date and time when the previous active model version was activated.</p>
1506
1702
  */
1507
1703
  PreviousModelVersionActivatedAt?: Date;
@@ -1511,10 +1707,12 @@ export interface DescribeModelResponse {
1511
1707
  */
1512
1708
  export interface DescribeModelVersionRequest {
1513
1709
  /**
1710
+ * @public
1514
1711
  * <p>The name of the machine learning model that this version belongs to.</p>
1515
1712
  */
1516
1713
  ModelName: string | undefined;
1517
1714
  /**
1715
+ * @public
1518
1716
  * <p>The version of the machine learning model.</p>
1519
1717
  */
1520
1718
  ModelVersion: number | undefined;
@@ -1552,75 +1750,91 @@ export type ModelVersionStatus = (typeof ModelVersionStatus)[keyof typeof ModelV
1552
1750
  */
1553
1751
  export interface DescribeModelVersionResponse {
1554
1752
  /**
1753
+ * @public
1555
1754
  * <p>The name of the machine learning model that this version belongs to.</p>
1556
1755
  */
1557
1756
  ModelName?: string;
1558
1757
  /**
1758
+ * @public
1559
1759
  * <p>The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.</p>
1560
1760
  */
1561
1761
  ModelArn?: string;
1562
1762
  /**
1763
+ * @public
1563
1764
  * <p>The version of the machine learning model.</p>
1564
1765
  */
1565
1766
  ModelVersion?: number;
1566
1767
  /**
1768
+ * @public
1567
1769
  * <p>The Amazon Resource Name (ARN) of the model version.</p>
1568
1770
  */
1569
1771
  ModelVersionArn?: string;
1570
1772
  /**
1773
+ * @public
1571
1774
  * <p>The current status of the model version.</p>
1572
1775
  */
1573
1776
  Status?: ModelVersionStatus | string;
1574
1777
  /**
1778
+ * @public
1575
1779
  * <p>Indicates whether this model version was created by training or by importing.</p>
1576
1780
  */
1577
1781
  SourceType?: ModelVersionSourceType | string;
1578
1782
  /**
1783
+ * @public
1579
1784
  * <p>The name of the dataset used to train the model version.</p>
1580
1785
  */
1581
1786
  DatasetName?: string;
1582
1787
  /**
1788
+ * @public
1583
1789
  * <p>The Amazon Resource Name (ARN) of the dataset used to train the model version.</p>
1584
1790
  */
1585
1791
  DatasetArn?: string;
1586
1792
  /**
1793
+ * @public
1587
1794
  * <p>The schema of the data used to train the model version.</p>
1588
1795
  */
1589
1796
  Schema?: string;
1590
1797
  /**
1798
+ * @public
1591
1799
  * <p>Contains the configuration information for the S3 location being used to hold label
1592
1800
  * data. </p>
1593
1801
  */
1594
1802
  LabelsInputConfiguration?: LabelsInputConfiguration;
1595
1803
  /**
1804
+ * @public
1596
1805
  * <p>The date on which the training data began being gathered. If you imported
1597
1806
  * the version, this is the date that the training data in the source
1598
1807
  * version began being gathered.</p>
1599
1808
  */
1600
1809
  TrainingDataStartTime?: Date;
1601
1810
  /**
1811
+ * @public
1602
1812
  * <p>The date on which the training data finished being gathered.
1603
1813
  * If you imported the version, this is the date that the training data in the
1604
1814
  * source version finished being gathered.</p>
1605
1815
  */
1606
1816
  TrainingDataEndTime?: Date;
1607
1817
  /**
1818
+ * @public
1608
1819
  * <p>The date on which the data in the evaluation set began being gathered.
1609
1820
  * If you imported the version, this is the date that the evaluation set data in
1610
1821
  * the source version began being gathered.</p>
1611
1822
  */
1612
1823
  EvaluationDataStartTime?: Date;
1613
1824
  /**
1825
+ * @public
1614
1826
  * <p>The date on which the data in the evaluation set began being gathered.
1615
1827
  * If you imported the version, this is the date that the evaluation set data in the
1616
1828
  * source version finished being gathered.</p>
1617
1829
  */
1618
1830
  EvaluationDataEndTime?: Date;
1619
1831
  /**
1832
+ * @public
1620
1833
  * <p>The Amazon Resource Name (ARN) of the role that was used to train the model version.</p>
1621
1834
  */
1622
1835
  RoleArn?: string;
1623
1836
  /**
1837
+ * @public
1624
1838
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
1625
1839
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
1626
1840
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -1634,58 +1848,70 @@ export interface DescribeModelVersionResponse {
1634
1848
  */
1635
1849
  DataPreProcessingConfiguration?: DataPreProcessingConfiguration;
1636
1850
  /**
1851
+ * @public
1637
1852
  * <p>The time when the training of the version began.</p>
1638
1853
  */
1639
1854
  TrainingExecutionStartTime?: Date;
1640
1855
  /**
1856
+ * @public
1641
1857
  * <p>The time when the training of the version completed.</p>
1642
1858
  */
1643
1859
  TrainingExecutionEndTime?: Date;
1644
1860
  /**
1861
+ * @public
1645
1862
  * <p>The failure message if the training of the model version failed.</p>
1646
1863
  */
1647
1864
  FailedReason?: string;
1648
1865
  /**
1866
+ * @public
1649
1867
  * <p>Shows an aggregated summary, in JSON format, of the model's
1650
1868
  * performance within the evaluation time range. These metrics
1651
1869
  * are created when evaluating the model.</p>
1652
1870
  */
1653
1871
  ModelMetrics?: string;
1654
1872
  /**
1873
+ * @public
1655
1874
  * <p>Indicates the last time the machine learning model version was updated.</p>
1656
1875
  */
1657
1876
  LastUpdatedTime?: Date;
1658
1877
  /**
1878
+ * @public
1659
1879
  * <p>Indicates the time and date at which the machine learning model version was created.</p>
1660
1880
  */
1661
1881
  CreatedAt?: Date;
1662
1882
  /**
1883
+ * @public
1663
1884
  * <p>The identifier of the KMS key key used to encrypt model version data by
1664
1885
  * Amazon Lookout for Equipment.</p>
1665
1886
  */
1666
1887
  ServerSideKmsKeyId?: string;
1667
1888
  /**
1889
+ * @public
1668
1890
  * <p>Indicates that the asset associated with this sensor has been
1669
1891
  * shut off. As long as this condition is met, Lookout for Equipment
1670
1892
  * will not use data from this asset for training, evaluation, or inference.</p>
1671
1893
  */
1672
1894
  OffCondition?: string;
1673
1895
  /**
1896
+ * @public
1674
1897
  * <p>If model version was imported, then this field is the arn
1675
1898
  * of the source model version.</p>
1676
1899
  */
1677
1900
  SourceModelVersionArn?: string;
1678
1901
  /**
1902
+ * @public
1679
1903
  * <p>The date and time when the import job began.
1680
1904
  * This field appears if the model version was imported.</p>
1681
1905
  */
1682
1906
  ImportJobStartTime?: Date;
1683
1907
  /**
1908
+ * @public
1684
1909
  * <p>The date and time when the import job completed.
1685
1910
  * This field appears if the model version was imported.</p>
1686
1911
  */
1687
1912
  ImportJobEndTime?: Date;
1688
1913
  /**
1914
+ * @public
1689
1915
  * <p>The size in bytes of the imported data.
1690
1916
  * This field appears if the model version was imported.</p>
1691
1917
  */
@@ -1696,6 +1922,7 @@ export interface DescribeModelVersionResponse {
1696
1922
  */
1697
1923
  export interface DescribeResourcePolicyRequest {
1698
1924
  /**
1925
+ * @public
1699
1926
  * <p>The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.</p>
1700
1927
  */
1701
1928
  ResourceArn: string | undefined;
@@ -1705,18 +1932,22 @@ export interface DescribeResourcePolicyRequest {
1705
1932
  */
1706
1933
  export interface DescribeResourcePolicyResponse {
1707
1934
  /**
1935
+ * @public
1708
1936
  * <p>A unique identifier for a revision of the resource policy.</p>
1709
1937
  */
1710
1938
  PolicyRevisionId?: string;
1711
1939
  /**
1940
+ * @public
1712
1941
  * <p>The resource policy in a JSON-formatted string.</p>
1713
1942
  */
1714
1943
  ResourcePolicy?: string;
1715
1944
  /**
1945
+ * @public
1716
1946
  * <p>The time when the resource policy was created.</p>
1717
1947
  */
1718
1948
  CreationTime?: Date;
1719
1949
  /**
1950
+ * @public
1720
1951
  * <p>The time when the resource policy was last modified.</p>
1721
1952
  */
1722
1953
  LastModifiedTime?: Date;
@@ -1726,25 +1957,30 @@ export interface DescribeResourcePolicyResponse {
1726
1957
  */
1727
1958
  export interface ImportDatasetRequest {
1728
1959
  /**
1960
+ * @public
1729
1961
  * <p>The Amazon Resource Name (ARN) of the dataset to import.</p>
1730
1962
  */
1731
1963
  SourceDatasetArn: string | undefined;
1732
1964
  /**
1965
+ * @public
1733
1966
  * <p>The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.</p>
1734
1967
  */
1735
1968
  DatasetName?: string;
1736
1969
  /**
1970
+ * @public
1737
1971
  * <p>A unique identifier for the request.
1738
1972
  * If you do not set the client request token,
1739
1973
  * Amazon Lookout for Equipment generates one. </p>
1740
1974
  */
1741
1975
  ClientToken?: string;
1742
1976
  /**
1977
+ * @public
1743
1978
  * <p>Provides the identifier of the KMS key key used to
1744
1979
  * encrypt model data by Amazon Lookout for Equipment. </p>
1745
1980
  */
1746
1981
  ServerSideKmsKeyId?: string;
1747
1982
  /**
1983
+ * @public
1748
1984
  * <p>Any tags associated with the dataset to be created.</p>
1749
1985
  */
1750
1986
  Tags?: Tag[];
@@ -1754,18 +1990,22 @@ export interface ImportDatasetRequest {
1754
1990
  */
1755
1991
  export interface ImportDatasetResponse {
1756
1992
  /**
1993
+ * @public
1757
1994
  * <p>The name of the created machine learning dataset.</p>
1758
1995
  */
1759
1996
  DatasetName?: string;
1760
1997
  /**
1998
+ * @public
1761
1999
  * <p>The Amazon Resource Name (ARN) of the dataset that was imported.</p>
1762
2000
  */
1763
2001
  DatasetArn?: string;
1764
2002
  /**
2003
+ * @public
1765
2004
  * <p>The status of the <code>ImportDataset</code> operation.</p>
1766
2005
  */
1767
2006
  Status?: DatasetStatus | string;
1768
2007
  /**
2008
+ * @public
1769
2009
  * <p>A unique identifier for the job of importing the dataset.</p>
1770
2010
  */
1771
2011
  JobId?: string;
@@ -1775,40 +2015,48 @@ export interface ImportDatasetResponse {
1775
2015
  */
1776
2016
  export interface ImportModelVersionRequest {
1777
2017
  /**
2018
+ * @public
1778
2019
  * <p>The Amazon Resource Name (ARN) of the model version to import.</p>
1779
2020
  */
1780
2021
  SourceModelVersionArn: string | undefined;
1781
2022
  /**
2023
+ * @public
1782
2024
  * <p>The name for the machine learning model to be created.
1783
2025
  * If the model already exists, Amazon Lookout for Equipment creates a new version.
1784
2026
  * If you do not specify this field, it is filled with the name of the source model.</p>
1785
2027
  */
1786
2028
  ModelName?: string;
1787
2029
  /**
2030
+ * @public
1788
2031
  * <p>The name of the dataset for the machine learning model being imported. </p>
1789
2032
  */
1790
2033
  DatasetName: string | undefined;
1791
2034
  /**
2035
+ * @public
1792
2036
  * <p>Contains the configuration information for the S3 location being used to hold label
1793
2037
  * data. </p>
1794
2038
  */
1795
2039
  LabelsInputConfiguration?: LabelsInputConfiguration;
1796
2040
  /**
2041
+ * @public
1797
2042
  * <p>A unique identifier for the request. If you do not set the client request
1798
2043
  * token, Amazon Lookout for Equipment generates one. </p>
1799
2044
  */
1800
2045
  ClientToken?: string;
1801
2046
  /**
2047
+ * @public
1802
2048
  * <p>The Amazon Resource Name (ARN) of a role with permission to
1803
2049
  * access the data source being used to create the machine learning model. </p>
1804
2050
  */
1805
2051
  RoleArn?: string;
1806
2052
  /**
2053
+ * @public
1807
2054
  * <p>Provides the identifier of the KMS key key used to encrypt
1808
2055
  * model data by Amazon Lookout for Equipment. </p>
1809
2056
  */
1810
2057
  ServerSideKmsKeyId?: string;
1811
2058
  /**
2059
+ * @public
1812
2060
  * <p>The tags associated with the machine learning model to be created. </p>
1813
2061
  */
1814
2062
  Tags?: Tag[];
@@ -1818,22 +2066,27 @@ export interface ImportModelVersionRequest {
1818
2066
  */
1819
2067
  export interface ImportModelVersionResponse {
1820
2068
  /**
2069
+ * @public
1821
2070
  * <p>The name for the machine learning model.</p>
1822
2071
  */
1823
2072
  ModelName?: string;
1824
2073
  /**
2074
+ * @public
1825
2075
  * <p>The Amazon Resource Name (ARN) of the model being created. </p>
1826
2076
  */
1827
2077
  ModelArn?: string;
1828
2078
  /**
2079
+ * @public
1829
2080
  * <p>The Amazon Resource Name (ARN) of the model version being created. </p>
1830
2081
  */
1831
2082
  ModelVersionArn?: string;
1832
2083
  /**
2084
+ * @public
1833
2085
  * <p>The version of the model being created.</p>
1834
2086
  */
1835
2087
  ModelVersion?: number;
1836
2088
  /**
2089
+ * @public
1837
2090
  * <p>The status of the <code>ImportModelVersion</code> operation. </p>
1838
2091
  */
1839
2092
  Status?: ModelVersionStatus | string;
@@ -1843,19 +2096,23 @@ export interface ImportModelVersionResponse {
1843
2096
  */
1844
2097
  export interface ListDataIngestionJobsRequest {
1845
2098
  /**
2099
+ * @public
1846
2100
  * <p>The name of the dataset being used for the data ingestion job. </p>
1847
2101
  */
1848
2102
  DatasetName?: string;
1849
2103
  /**
2104
+ * @public
1850
2105
  * <p>An opaque pagination token indicating where to continue the listing of data ingestion
1851
2106
  * jobs. </p>
1852
2107
  */
1853
2108
  NextToken?: string;
1854
2109
  /**
2110
+ * @public
1855
2111
  * <p> Specifies the maximum number of data ingestion jobs to list. </p>
1856
2112
  */
1857
2113
  MaxResults?: number;
1858
2114
  /**
2115
+ * @public
1859
2116
  * <p>Indicates the status of the data ingestion job. </p>
1860
2117
  */
1861
2118
  Status?: IngestionJobStatus | string;
@@ -1867,23 +2124,28 @@ export interface ListDataIngestionJobsRequest {
1867
2124
  */
1868
2125
  export interface DataIngestionJobSummary {
1869
2126
  /**
2127
+ * @public
1870
2128
  * <p>Indicates the job ID of the data ingestion job. </p>
1871
2129
  */
1872
2130
  JobId?: string;
1873
2131
  /**
2132
+ * @public
1874
2133
  * <p>The name of the dataset used for the data ingestion job. </p>
1875
2134
  */
1876
2135
  DatasetName?: string;
1877
2136
  /**
2137
+ * @public
1878
2138
  * <p>The Amazon Resource Name (ARN) of the dataset used in the data ingestion job. </p>
1879
2139
  */
1880
2140
  DatasetArn?: string;
1881
2141
  /**
2142
+ * @public
1882
2143
  * <p> Specifies information for the input data for the data inference job, including data
1883
2144
  * Amazon S3 location parameters. </p>
1884
2145
  */
1885
2146
  IngestionInputConfiguration?: IngestionInputConfiguration;
1886
2147
  /**
2148
+ * @public
1887
2149
  * <p>Indicates the status of the data ingestion job. </p>
1888
2150
  */
1889
2151
  Status?: IngestionJobStatus | string;
@@ -1893,11 +2155,13 @@ export interface DataIngestionJobSummary {
1893
2155
  */
1894
2156
  export interface ListDataIngestionJobsResponse {
1895
2157
  /**
2158
+ * @public
1896
2159
  * <p> An opaque pagination token indicating where to continue the listing of data ingestion
1897
2160
  * jobs. </p>
1898
2161
  */
1899
2162
  NextToken?: string;
1900
2163
  /**
2164
+ * @public
1901
2165
  * <p>Specifies information about the specific data ingestion job, including dataset name and
1902
2166
  * status. </p>
1903
2167
  */
@@ -1908,15 +2172,18 @@ export interface ListDataIngestionJobsResponse {
1908
2172
  */
1909
2173
  export interface ListDatasetsRequest {
1910
2174
  /**
2175
+ * @public
1911
2176
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
1912
2177
  * </p>
1913
2178
  */
1914
2179
  NextToken?: string;
1915
2180
  /**
2181
+ * @public
1916
2182
  * <p> Specifies the maximum number of datasets to list. </p>
1917
2183
  */
1918
2184
  MaxResults?: number;
1919
2185
  /**
2186
+ * @public
1920
2187
  * <p>The beginning of the name of the datasets to be listed. </p>
1921
2188
  */
1922
2189
  DatasetNameBeginsWith?: string;
@@ -1928,18 +2195,22 @@ export interface ListDatasetsRequest {
1928
2195
  */
1929
2196
  export interface DatasetSummary {
1930
2197
  /**
2198
+ * @public
1931
2199
  * <p>The name of the dataset. </p>
1932
2200
  */
1933
2201
  DatasetName?: string;
1934
2202
  /**
2203
+ * @public
1935
2204
  * <p>The Amazon Resource Name (ARN) of the specified dataset. </p>
1936
2205
  */
1937
2206
  DatasetArn?: string;
1938
2207
  /**
2208
+ * @public
1939
2209
  * <p>Indicates the status of the dataset. </p>
1940
2210
  */
1941
2211
  Status?: DatasetStatus | string;
1942
2212
  /**
2213
+ * @public
1943
2214
  * <p>The time at which the dataset was created in Amazon Lookout for Equipment. </p>
1944
2215
  */
1945
2216
  CreatedAt?: Date;
@@ -1949,11 +2220,13 @@ export interface DatasetSummary {
1949
2220
  */
1950
2221
  export interface ListDatasetsResponse {
1951
2222
  /**
2223
+ * @public
1952
2224
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
1953
2225
  * </p>
1954
2226
  */
1955
2227
  NextToken?: string;
1956
2228
  /**
2229
+ * @public
1957
2230
  * <p>Provides information about the specified dataset, including creation time, dataset ARN,
1958
2231
  * and status. </p>
1959
2232
  */
@@ -1964,24 +2237,29 @@ export interface ListDatasetsResponse {
1964
2237
  */
1965
2238
  export interface ListInferenceEventsRequest {
1966
2239
  /**
2240
+ * @public
1967
2241
  * <p>An opaque pagination token indicating where to continue the listing of inference
1968
2242
  * events.</p>
1969
2243
  */
1970
2244
  NextToken?: string;
1971
2245
  /**
2246
+ * @public
1972
2247
  * <p>Specifies the maximum number of inference events to list. </p>
1973
2248
  */
1974
2249
  MaxResults?: number;
1975
2250
  /**
2251
+ * @public
1976
2252
  * <p>The name of the inference scheduler for the inference events listed. </p>
1977
2253
  */
1978
2254
  InferenceSchedulerName: string | undefined;
1979
2255
  /**
2256
+ * @public
1980
2257
  * <p> Lookout for Equipment will return all the inference events with an end time equal to or greater than the
1981
2258
  * start time given.</p>
1982
2259
  */
1983
2260
  IntervalStartTime: Date | undefined;
1984
2261
  /**
2262
+ * @public
1985
2263
  * <p>Returns all the inference events with an end start time equal to or greater than less than the end time given.</p>
1986
2264
  */
1987
2265
  IntervalEndTime: Date | undefined;
@@ -1993,28 +2271,34 @@ export interface ListInferenceEventsRequest {
1993
2271
  */
1994
2272
  export interface InferenceEventSummary {
1995
2273
  /**
2274
+ * @public
1996
2275
  * <p> The Amazon Resource Name (ARN) of the inference scheduler being used for the inference
1997
2276
  * event. </p>
1998
2277
  */
1999
2278
  InferenceSchedulerArn?: string;
2000
2279
  /**
2280
+ * @public
2001
2281
  * <p>The name of the inference scheduler being used for the inference events. </p>
2002
2282
  */
2003
2283
  InferenceSchedulerName?: string;
2004
2284
  /**
2285
+ * @public
2005
2286
  * <p>Indicates the starting time of an inference event. </p>
2006
2287
  */
2007
2288
  EventStartTime?: Date;
2008
2289
  /**
2290
+ * @public
2009
2291
  * <p>Indicates the ending time of an inference event. </p>
2010
2292
  */
2011
2293
  EventEndTime?: Date;
2012
2294
  /**
2295
+ * @public
2013
2296
  * <p> An array which specifies the names and values of all sensors contributing to an
2014
2297
  * inference event.</p>
2015
2298
  */
2016
2299
  Diagnostics?: string;
2017
2300
  /**
2301
+ * @public
2018
2302
  * <p> Indicates the size of an inference event in seconds. </p>
2019
2303
  */
2020
2304
  EventDurationInSeconds?: number;
@@ -2024,11 +2308,13 @@ export interface InferenceEventSummary {
2024
2308
  */
2025
2309
  export interface ListInferenceEventsResponse {
2026
2310
  /**
2311
+ * @public
2027
2312
  * <p>An opaque pagination token indicating where to continue the listing of inference
2028
2313
  * executions. </p>
2029
2314
  */
2030
2315
  NextToken?: string;
2031
2316
  /**
2317
+ * @public
2032
2318
  * <p>Provides an array of information about the individual inference events returned from the
2033
2319
  * <code>ListInferenceEvents</code> operation, including scheduler used, event start time,
2034
2320
  * event end time, diagnostics, and so on. </p>
@@ -2053,29 +2339,35 @@ export type InferenceExecutionStatus = (typeof InferenceExecutionStatus)[keyof t
2053
2339
  */
2054
2340
  export interface ListInferenceExecutionsRequest {
2055
2341
  /**
2342
+ * @public
2056
2343
  * <p>An opaque pagination token indicating where to continue the listing of inference
2057
2344
  * executions.</p>
2058
2345
  */
2059
2346
  NextToken?: string;
2060
2347
  /**
2348
+ * @public
2061
2349
  * <p>Specifies the maximum number of inference executions to list. </p>
2062
2350
  */
2063
2351
  MaxResults?: number;
2064
2352
  /**
2353
+ * @public
2065
2354
  * <p>The name of the inference scheduler for the inference execution listed. </p>
2066
2355
  */
2067
2356
  InferenceSchedulerName: string | undefined;
2068
2357
  /**
2358
+ * @public
2069
2359
  * <p>The time reference in the inferenced dataset after which Amazon Lookout for Equipment
2070
2360
  * started the inference execution. </p>
2071
2361
  */
2072
2362
  DataStartTimeAfter?: Date;
2073
2363
  /**
2364
+ * @public
2074
2365
  * <p>The time reference in the inferenced dataset before which Amazon Lookout for Equipment
2075
2366
  * stopped the inference execution. </p>
2076
2367
  */
2077
2368
  DataEndTimeBefore?: Date;
2078
2369
  /**
2370
+ * @public
2079
2371
  * <p>The status of the inference execution. </p>
2080
2372
  */
2081
2373
  Status?: InferenceExecutionStatus | string;
@@ -2087,58 +2379,70 @@ export interface ListInferenceExecutionsRequest {
2087
2379
  */
2088
2380
  export interface InferenceExecutionSummary {
2089
2381
  /**
2382
+ * @public
2090
2383
  * <p>The name of the ML model being used for the inference execution. </p>
2091
2384
  */
2092
2385
  ModelName?: string;
2093
2386
  /**
2387
+ * @public
2094
2388
  * <p>The Amazon Resource Name (ARN) of the ML model used for the inference execution. </p>
2095
2389
  */
2096
2390
  ModelArn?: string;
2097
2391
  /**
2392
+ * @public
2098
2393
  * <p>The name of the inference scheduler being used for the inference execution. </p>
2099
2394
  */
2100
2395
  InferenceSchedulerName?: string;
2101
2396
  /**
2397
+ * @public
2102
2398
  * <p> The Amazon Resource Name (ARN) of the inference scheduler being used for the inference
2103
2399
  * execution. </p>
2104
2400
  */
2105
2401
  InferenceSchedulerArn?: string;
2106
2402
  /**
2403
+ * @public
2107
2404
  * <p>Indicates the start time at which the inference scheduler began the specific inference
2108
2405
  * execution. </p>
2109
2406
  */
2110
2407
  ScheduledStartTime?: Date;
2111
2408
  /**
2409
+ * @public
2112
2410
  * <p>Indicates the time reference in the dataset at which the inference execution began.
2113
2411
  * </p>
2114
2412
  */
2115
2413
  DataStartTime?: Date;
2116
2414
  /**
2415
+ * @public
2117
2416
  * <p>Indicates the time reference in the dataset at which the inference execution stopped.
2118
2417
  * </p>
2119
2418
  */
2120
2419
  DataEndTime?: Date;
2121
2420
  /**
2421
+ * @public
2122
2422
  * <p> Specifies configuration information for the input data for the inference scheduler,
2123
2423
  * including delimiter, format, and dataset location. </p>
2124
2424
  */
2125
2425
  DataInputConfiguration?: InferenceInputConfiguration;
2126
2426
  /**
2427
+ * @public
2127
2428
  * <p> Specifies configuration information for the output results from for the inference
2128
2429
  * execution, including the output Amazon S3 location.
2129
2430
  * </p>
2130
2431
  */
2131
2432
  DataOutputConfiguration?: InferenceOutputConfiguration;
2132
2433
  /**
2434
+ * @public
2133
2435
  * <p>
2134
2436
  * </p>
2135
2437
  */
2136
2438
  CustomerResultObject?: S3Object;
2137
2439
  /**
2440
+ * @public
2138
2441
  * <p>Indicates the status of the inference execution. </p>
2139
2442
  */
2140
2443
  Status?: InferenceExecutionStatus | string;
2141
2444
  /**
2445
+ * @public
2142
2446
  * <p> Specifies the reason for failure when an inference execution has failed. </p>
2143
2447
  */
2144
2448
  FailedReason?: string;
@@ -2148,11 +2452,13 @@ export interface InferenceExecutionSummary {
2148
2452
  */
2149
2453
  export interface ListInferenceExecutionsResponse {
2150
2454
  /**
2455
+ * @public
2151
2456
  * <p> An opaque pagination token indicating where to continue the listing of inference
2152
2457
  * executions. </p>
2153
2458
  */
2154
2459
  NextToken?: string;
2155
2460
  /**
2461
+ * @public
2156
2462
  * <p>Provides an array of information about the individual inference executions returned from
2157
2463
  * the <code>ListInferenceExecutions</code> operation, including model used, inference
2158
2464
  * scheduler, data configuration, and so on. </p>
@@ -2164,23 +2470,28 @@ export interface ListInferenceExecutionsResponse {
2164
2470
  */
2165
2471
  export interface ListInferenceSchedulersRequest {
2166
2472
  /**
2473
+ * @public
2167
2474
  * <p> An opaque pagination token indicating where to continue the listing of inference
2168
2475
  * schedulers. </p>
2169
2476
  */
2170
2477
  NextToken?: string;
2171
2478
  /**
2479
+ * @public
2172
2480
  * <p> Specifies the maximum number of inference schedulers to list. </p>
2173
2481
  */
2174
2482
  MaxResults?: number;
2175
2483
  /**
2484
+ * @public
2176
2485
  * <p>The beginning of the name of the inference schedulers to be listed. </p>
2177
2486
  */
2178
2487
  InferenceSchedulerNameBeginsWith?: string;
2179
2488
  /**
2489
+ * @public
2180
2490
  * <p>The name of the ML model used by the inference scheduler to be listed. </p>
2181
2491
  */
2182
2492
  ModelName?: string;
2183
2493
  /**
2494
+ * @public
2184
2495
  * <p>Specifies the current status of the inference schedulers.</p>
2185
2496
  */
2186
2497
  Status?: InferenceSchedulerStatus | string;
@@ -2192,26 +2503,32 @@ export interface ListInferenceSchedulersRequest {
2192
2503
  */
2193
2504
  export interface InferenceSchedulerSummary {
2194
2505
  /**
2506
+ * @public
2195
2507
  * <p>The name of the ML model used for the inference scheduler. </p>
2196
2508
  */
2197
2509
  ModelName?: string;
2198
2510
  /**
2511
+ * @public
2199
2512
  * <p> The Amazon Resource Name (ARN) of the ML model used by the inference scheduler. </p>
2200
2513
  */
2201
2514
  ModelArn?: string;
2202
2515
  /**
2516
+ * @public
2203
2517
  * <p>The name of the inference scheduler. </p>
2204
2518
  */
2205
2519
  InferenceSchedulerName?: string;
2206
2520
  /**
2521
+ * @public
2207
2522
  * <p> The Amazon Resource Name (ARN) of the inference scheduler. </p>
2208
2523
  */
2209
2524
  InferenceSchedulerArn?: string;
2210
2525
  /**
2526
+ * @public
2211
2527
  * <p>Indicates the status of the inference scheduler. </p>
2212
2528
  */
2213
2529
  Status?: InferenceSchedulerStatus | string;
2214
2530
  /**
2531
+ * @public
2215
2532
  * <p>A period of time (in minutes) by which inference on the data is delayed after the data
2216
2533
  * starts. For instance, if an offset delay time of five minutes was selected, inference will
2217
2534
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -2222,6 +2539,7 @@ export interface InferenceSchedulerSummary {
2222
2539
  */
2223
2540
  DataDelayOffsetInMinutes?: number;
2224
2541
  /**
2542
+ * @public
2225
2543
  * <p>How often data is uploaded to the source S3 bucket for the input data. This value is the
2226
2544
  * length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout
2227
2545
  * for Equipment will upload the real-time data to the source bucket once every 5 minutes.
@@ -2230,6 +2548,7 @@ export interface InferenceSchedulerSummary {
2230
2548
  */
2231
2549
  DataUploadFrequency?: DataUploadFrequency | string;
2232
2550
  /**
2551
+ * @public
2233
2552
  * <p>Indicates whether the latest execution for the inference scheduler was Anomalous
2234
2553
  * (anomalous events found) or Normal (no anomalous events found).</p>
2235
2554
  */
@@ -2240,11 +2559,13 @@ export interface InferenceSchedulerSummary {
2240
2559
  */
2241
2560
  export interface ListInferenceSchedulersResponse {
2242
2561
  /**
2562
+ * @public
2243
2563
  * <p> An opaque pagination token indicating where to continue the listing of inference
2244
2564
  * schedulers. </p>
2245
2565
  */
2246
2566
  NextToken?: string;
2247
2567
  /**
2568
+ * @public
2248
2569
  * <p>Provides information about the specified inference scheduler, including data upload
2249
2570
  * frequency, model name and ARN, and status. </p>
2250
2571
  */
@@ -2255,18 +2576,21 @@ export interface ListInferenceSchedulersResponse {
2255
2576
  */
2256
2577
  export interface ListLabelGroupsRequest {
2257
2578
  /**
2579
+ * @public
2258
2580
  * <p>
2259
2581
  * The beginning of the name of the label groups to be listed.
2260
2582
  * </p>
2261
2583
  */
2262
2584
  LabelGroupNameBeginsWith?: string;
2263
2585
  /**
2586
+ * @public
2264
2587
  * <p>
2265
2588
  * An opaque pagination token indicating where to continue the listing of label groups.
2266
2589
  * </p>
2267
2590
  */
2268
2591
  NextToken?: string;
2269
2592
  /**
2593
+ * @public
2270
2594
  * <p>
2271
2595
  * Specifies the maximum number of label groups to list.
2272
2596
  * </p>
@@ -2281,24 +2605,28 @@ export interface ListLabelGroupsRequest {
2281
2605
  */
2282
2606
  export interface LabelGroupSummary {
2283
2607
  /**
2608
+ * @public
2284
2609
  * <p>
2285
2610
  * The name of the label group.
2286
2611
  * </p>
2287
2612
  */
2288
2613
  LabelGroupName?: string;
2289
2614
  /**
2615
+ * @public
2290
2616
  * <p>
2291
2617
  * The Amazon Resource Name (ARN) of the label group.
2292
2618
  * </p>
2293
2619
  */
2294
2620
  LabelGroupArn?: string;
2295
2621
  /**
2622
+ * @public
2296
2623
  * <p>
2297
2624
  * The time at which the label group was created.
2298
2625
  * </p>
2299
2626
  */
2300
2627
  CreatedAt?: Date;
2301
2628
  /**
2629
+ * @public
2302
2630
  * <p>
2303
2631
  * The time at which the label group was updated.
2304
2632
  * </p>
@@ -2310,12 +2638,14 @@ export interface LabelGroupSummary {
2310
2638
  */
2311
2639
  export interface ListLabelGroupsResponse {
2312
2640
  /**
2641
+ * @public
2313
2642
  * <p>
2314
2643
  * An opaque pagination token indicating where to continue the listing of label groups.
2315
2644
  * </p>
2316
2645
  */
2317
2646
  NextToken?: string;
2318
2647
  /**
2648
+ * @public
2319
2649
  * <p>
2320
2650
  * A summary of the label groups.
2321
2651
  * </p>
@@ -2327,42 +2657,49 @@ export interface ListLabelGroupsResponse {
2327
2657
  */
2328
2658
  export interface ListLabelsRequest {
2329
2659
  /**
2660
+ * @public
2330
2661
  * <p>
2331
2662
  * Retruns the name of the label group.
2332
2663
  * </p>
2333
2664
  */
2334
2665
  LabelGroupName: string | undefined;
2335
2666
  /**
2667
+ * @public
2336
2668
  * <p>
2337
2669
  * Returns all the labels with a end time equal to or later than the start time given.
2338
2670
  * </p>
2339
2671
  */
2340
2672
  IntervalStartTime?: Date;
2341
2673
  /**
2674
+ * @public
2342
2675
  * <p>
2343
2676
  * Returns all labels with a start time earlier than the end time given.
2344
2677
  * </p>
2345
2678
  */
2346
2679
  IntervalEndTime?: Date;
2347
2680
  /**
2681
+ * @public
2348
2682
  * <p>
2349
2683
  * Returns labels with a particular fault code.
2350
2684
  * </p>
2351
2685
  */
2352
2686
  FaultCode?: string;
2353
2687
  /**
2688
+ * @public
2354
2689
  * <p>
2355
2690
  * Lists the labels that pertain to a particular piece of equipment.
2356
2691
  * </p>
2357
2692
  */
2358
2693
  Equipment?: string;
2359
2694
  /**
2695
+ * @public
2360
2696
  * <p>
2361
2697
  * An opaque pagination token indicating where to continue the listing of label groups.
2362
2698
  * </p>
2363
2699
  */
2364
2700
  NextToken?: string;
2365
2701
  /**
2702
+ * @public
2366
2703
  * <p>
2367
2704
  * Specifies the maximum number of labels to list.
2368
2705
  * </p>
@@ -2377,42 +2714,49 @@ export interface ListLabelsRequest {
2377
2714
  */
2378
2715
  export interface LabelSummary {
2379
2716
  /**
2717
+ * @public
2380
2718
  * <p>
2381
2719
  * The name of the label group.
2382
2720
  * </p>
2383
2721
  */
2384
2722
  LabelGroupName?: string;
2385
2723
  /**
2724
+ * @public
2386
2725
  * <p>
2387
2726
  * The ID of the label.
2388
2727
  * </p>
2389
2728
  */
2390
2729
  LabelId?: string;
2391
2730
  /**
2731
+ * @public
2392
2732
  * <p>
2393
2733
  * The Amazon Resource Name (ARN) of the label group.
2394
2734
  * </p>
2395
2735
  */
2396
2736
  LabelGroupArn?: string;
2397
2737
  /**
2738
+ * @public
2398
2739
  * <p>
2399
2740
  * The timestamp indicating the start of the label.
2400
2741
  * </p>
2401
2742
  */
2402
2743
  StartTime?: Date;
2403
2744
  /**
2745
+ * @public
2404
2746
  * <p>
2405
2747
  * The timestamp indicating the end of the label.
2406
2748
  * </p>
2407
2749
  */
2408
2750
  EndTime?: Date;
2409
2751
  /**
2752
+ * @public
2410
2753
  * <p>
2411
2754
  * Indicates whether a labeled event represents an anomaly.
2412
2755
  * </p>
2413
2756
  */
2414
2757
  Rating?: LabelRating | string;
2415
2758
  /**
2759
+ * @public
2416
2760
  * <p>
2417
2761
  * Indicates the type of anomaly associated with the label.
2418
2762
  * </p>
@@ -2420,12 +2764,14 @@ export interface LabelSummary {
2420
2764
  */
2421
2765
  FaultCode?: string;
2422
2766
  /**
2767
+ * @public
2423
2768
  * <p>
2424
2769
  * Indicates that a label pertains to a particular piece of equipment.
2425
2770
  * </p>
2426
2771
  */
2427
2772
  Equipment?: string;
2428
2773
  /**
2774
+ * @public
2429
2775
  * <p>
2430
2776
  * The time at which the label was created.
2431
2777
  * </p>
@@ -2437,12 +2783,14 @@ export interface LabelSummary {
2437
2783
  */
2438
2784
  export interface ListLabelsResponse {
2439
2785
  /**
2786
+ * @public
2440
2787
  * <p>
2441
2788
  * An opaque pagination token indicating where to continue the listing of datasets.
2442
2789
  * </p>
2443
2790
  */
2444
2791
  NextToken?: string;
2445
2792
  /**
2793
+ * @public
2446
2794
  * <p>
2447
2795
  * A summary of the items in the label group.
2448
2796
  * </p>
@@ -2454,23 +2802,28 @@ export interface ListLabelsResponse {
2454
2802
  */
2455
2803
  export interface ListModelsRequest {
2456
2804
  /**
2805
+ * @public
2457
2806
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
2458
2807
  * </p>
2459
2808
  */
2460
2809
  NextToken?: string;
2461
2810
  /**
2811
+ * @public
2462
2812
  * <p> Specifies the maximum number of ML models to list. </p>
2463
2813
  */
2464
2814
  MaxResults?: number;
2465
2815
  /**
2816
+ * @public
2466
2817
  * <p>The status of the ML model. </p>
2467
2818
  */
2468
2819
  Status?: ModelStatus | string;
2469
2820
  /**
2821
+ * @public
2470
2822
  * <p>The beginning of the name of the ML models being listed. </p>
2471
2823
  */
2472
2824
  ModelNameBeginsWith?: string;
2473
2825
  /**
2826
+ * @public
2474
2827
  * <p>The beginning of the name of the dataset of the ML models to be listed. </p>
2475
2828
  */
2476
2829
  DatasetNameBeginsWith?: string;
@@ -2482,35 +2835,43 @@ export interface ListModelsRequest {
2482
2835
  */
2483
2836
  export interface ModelSummary {
2484
2837
  /**
2838
+ * @public
2485
2839
  * <p>The name of the ML model. </p>
2486
2840
  */
2487
2841
  ModelName?: string;
2488
2842
  /**
2843
+ * @public
2489
2844
  * <p> The Amazon Resource Name (ARN) of the ML model. </p>
2490
2845
  */
2491
2846
  ModelArn?: string;
2492
2847
  /**
2848
+ * @public
2493
2849
  * <p>The name of the dataset being used for the ML model. </p>
2494
2850
  */
2495
2851
  DatasetName?: string;
2496
2852
  /**
2853
+ * @public
2497
2854
  * <p> The Amazon Resource Name (ARN) of the dataset used to create the model. </p>
2498
2855
  */
2499
2856
  DatasetArn?: string;
2500
2857
  /**
2858
+ * @public
2501
2859
  * <p>Indicates the status of the ML model. </p>
2502
2860
  */
2503
2861
  Status?: ModelStatus | string;
2504
2862
  /**
2863
+ * @public
2505
2864
  * <p>The time at which the specific model was created. </p>
2506
2865
  */
2507
2866
  CreatedAt?: Date;
2508
2867
  /**
2868
+ * @public
2509
2869
  * <p>The model version that the inference scheduler uses to run an inference
2510
2870
  * execution.</p>
2511
2871
  */
2512
2872
  ActiveModelVersion?: number;
2513
2873
  /**
2874
+ * @public
2514
2875
  * <p>The Amazon Resource Name (ARN) of the model version that is set as active. The active model version
2515
2876
  * is the model version that the inference scheduler uses to run an inference
2516
2877
  * execution.</p>
@@ -2522,11 +2883,13 @@ export interface ModelSummary {
2522
2883
  */
2523
2884
  export interface ListModelsResponse {
2524
2885
  /**
2886
+ * @public
2525
2887
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
2526
2888
  * </p>
2527
2889
  */
2528
2890
  NextToken?: string;
2529
2891
  /**
2892
+ * @public
2530
2893
  * <p>Provides information on the specified model, including created time, model and dataset
2531
2894
  * ARNs, and status. </p>
2532
2895
  */
@@ -2537,11 +2900,13 @@ export interface ListModelsResponse {
2537
2900
  */
2538
2901
  export interface ListModelVersionsRequest {
2539
2902
  /**
2903
+ * @public
2540
2904
  * <p>Then name of the machine learning model for which the
2541
2905
  * model versions are to be listed.</p>
2542
2906
  */
2543
2907
  ModelName: string | undefined;
2544
2908
  /**
2909
+ * @public
2545
2910
  * <p>If the total number of results exceeds the limit that the response can
2546
2911
  * display, the response returns an opaque pagination token indicating where to
2547
2912
  * continue the listing of machine learning model versions. Use this token in the <code>NextToken</code>
@@ -2549,30 +2914,37 @@ export interface ListModelVersionsRequest {
2549
2914
  */
2550
2915
  NextToken?: string;
2551
2916
  /**
2917
+ * @public
2552
2918
  * <p>Specifies the maximum number of machine learning model versions to list.</p>
2553
2919
  */
2554
2920
  MaxResults?: number;
2555
2921
  /**
2922
+ * @public
2556
2923
  * <p>Filter the results based on the current status of the model version.</p>
2557
2924
  */
2558
2925
  Status?: ModelVersionStatus | string;
2559
2926
  /**
2927
+ * @public
2560
2928
  * <p>Filter the results based on the way the model version was generated.</p>
2561
2929
  */
2562
2930
  SourceType?: ModelVersionSourceType | string;
2563
2931
  /**
2932
+ * @public
2564
2933
  * <p>Filter results to return all the model versions created before this time.</p>
2565
2934
  */
2566
2935
  CreatedAtEndTime?: Date;
2567
2936
  /**
2937
+ * @public
2568
2938
  * <p>Filter results to return all the model versions created after this time.</p>
2569
2939
  */
2570
2940
  CreatedAtStartTime?: Date;
2571
2941
  /**
2942
+ * @public
2572
2943
  * <p>Specifies the highest version of the model to return in the list.</p>
2573
2944
  */
2574
2945
  MaxModelVersion?: number;
2575
2946
  /**
2947
+ * @public
2576
2948
  * <p>Specifies the lowest version of the model to return in the list.</p>
2577
2949
  */
2578
2950
  MinModelVersion?: number;
@@ -2583,30 +2955,37 @@ export interface ListModelVersionsRequest {
2583
2955
  */
2584
2956
  export interface ModelVersionSummary {
2585
2957
  /**
2958
+ * @public
2586
2959
  * <p>The name of the model that this model version is a version of.</p>
2587
2960
  */
2588
2961
  ModelName?: string;
2589
2962
  /**
2963
+ * @public
2590
2964
  * <p>The Amazon Resource Name (ARN) of the model that this model version is a version of.</p>
2591
2965
  */
2592
2966
  ModelArn?: string;
2593
2967
  /**
2968
+ * @public
2594
2969
  * <p>The version of the model.</p>
2595
2970
  */
2596
2971
  ModelVersion?: number;
2597
2972
  /**
2973
+ * @public
2598
2974
  * <p>The Amazon Resource Name (ARN) of the model version.</p>
2599
2975
  */
2600
2976
  ModelVersionArn?: string;
2601
2977
  /**
2978
+ * @public
2602
2979
  * <p>The time when this model version was created.</p>
2603
2980
  */
2604
2981
  CreatedAt?: Date;
2605
2982
  /**
2983
+ * @public
2606
2984
  * <p>The current status of the model version.</p>
2607
2985
  */
2608
2986
  Status?: ModelVersionStatus | string;
2609
2987
  /**
2988
+ * @public
2610
2989
  * <p>Indicates how this model version was generated.</p>
2611
2990
  */
2612
2991
  SourceType?: ModelVersionSourceType | string;
@@ -2616,6 +2995,7 @@ export interface ModelVersionSummary {
2616
2995
  */
2617
2996
  export interface ListModelVersionsResponse {
2618
2997
  /**
2998
+ * @public
2619
2999
  * <p>If the total number of results exceeds the limit that the response can
2620
3000
  * display, the response returns an opaque pagination token indicating where to
2621
3001
  * continue the listing of machine learning model versions. Use this token in the <code>NextToken</code>
@@ -2623,6 +3003,7 @@ export interface ListModelVersionsResponse {
2623
3003
  */
2624
3004
  NextToken?: string;
2625
3005
  /**
3006
+ * @public
2626
3007
  * <p>Provides information on the specified model version,
2627
3008
  * including the created time, model and dataset ARNs, and status.</p>
2628
3009
  */
@@ -2633,20 +3014,24 @@ export interface ListModelVersionsResponse {
2633
3014
  */
2634
3015
  export interface ListSensorStatisticsRequest {
2635
3016
  /**
3017
+ * @public
2636
3018
  * <p> The name of the dataset associated with the list of Sensor Statistics. </p>
2637
3019
  */
2638
3020
  DatasetName: string | undefined;
2639
3021
  /**
3022
+ * @public
2640
3023
  * <p> The ingestion job id associated with the list of Sensor Statistics. To get sensor
2641
3024
  * statistics for a particular ingestion job id, both dataset name and ingestion job id must
2642
3025
  * be submitted as inputs. </p>
2643
3026
  */
2644
3027
  IngestionJobId?: string;
2645
3028
  /**
3029
+ * @public
2646
3030
  * <p>Specifies the maximum number of sensors for which to retrieve statistics. </p>
2647
3031
  */
2648
3032
  MaxResults?: number;
2649
3033
  /**
3034
+ * @public
2650
3035
  * <p>An opaque pagination token indicating where to continue the listing of sensor
2651
3036
  * statistics. </p>
2652
3037
  */
@@ -2670,11 +3055,13 @@ export type StatisticalIssueStatus = (typeof StatisticalIssueStatus)[keyof typeo
2670
3055
  */
2671
3056
  export interface CategoricalValues {
2672
3057
  /**
3058
+ * @public
2673
3059
  * <p> Indicates whether there is a potential data issue related to categorical values.
2674
3060
  * </p>
2675
3061
  */
2676
3062
  Status: StatisticalIssueStatus | string | undefined;
2677
3063
  /**
3064
+ * @public
2678
3065
  * <p> Indicates the number of categories in the data. </p>
2679
3066
  */
2680
3067
  NumberOfCategory?: number;
@@ -2685,10 +3072,12 @@ export interface CategoricalValues {
2685
3072
  */
2686
3073
  export interface CountPercent {
2687
3074
  /**
3075
+ * @public
2688
3076
  * <p> Indicates the count of occurences of the given statistic. </p>
2689
3077
  */
2690
3078
  Count: number | undefined;
2691
3079
  /**
3080
+ * @public
2692
3081
  * <p> Indicates the percentage of occurances of the given statistic. </p>
2693
3082
  */
2694
3083
  Percentage: number | undefined;
@@ -2700,15 +3089,18 @@ export interface CountPercent {
2700
3089
  */
2701
3090
  export interface LargeTimestampGaps {
2702
3091
  /**
3092
+ * @public
2703
3093
  * <p> Indicates whether there is a potential data issue related to large gaps in timestamps.
2704
3094
  * </p>
2705
3095
  */
2706
3096
  Status: StatisticalIssueStatus | string | undefined;
2707
3097
  /**
3098
+ * @public
2708
3099
  * <p> Indicates the number of large timestamp gaps, if there are any. </p>
2709
3100
  */
2710
3101
  NumberOfLargeTimestampGaps?: number;
2711
3102
  /**
3103
+ * @public
2712
3104
  * <p> Indicates the size of the largest timestamp gap, in days. </p>
2713
3105
  */
2714
3106
  MaxTimestampGapInDays?: number;
@@ -2732,11 +3124,13 @@ export type Monotonicity = (typeof Monotonicity)[keyof typeof Monotonicity];
2732
3124
  */
2733
3125
  export interface MonotonicValues {
2734
3126
  /**
3127
+ * @public
2735
3128
  * <p> Indicates whether there is a potential data issue related to having monotonic values.
2736
3129
  * </p>
2737
3130
  */
2738
3131
  Status: StatisticalIssueStatus | string | undefined;
2739
3132
  /**
3133
+ * @public
2740
3134
  * <p> Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC. </p>
2741
3135
  */
2742
3136
  Monotonicity?: Monotonicity | string;
@@ -2747,6 +3141,7 @@ export interface MonotonicValues {
2747
3141
  */
2748
3142
  export interface MultipleOperatingModes {
2749
3143
  /**
3144
+ * @public
2750
3145
  * <p> Indicates whether there is a potential data issue related to having multiple operating
2751
3146
  * modes. </p>
2752
3147
  */
@@ -2759,65 +3154,78 @@ export interface MultipleOperatingModes {
2759
3154
  */
2760
3155
  export interface SensorStatisticsSummary {
2761
3156
  /**
3157
+ * @public
2762
3158
  * <p> Name of the component to which the particular sensor belongs for which the statistics
2763
3159
  * belong to. </p>
2764
3160
  */
2765
3161
  ComponentName?: string;
2766
3162
  /**
3163
+ * @public
2767
3164
  * <p> Name of the sensor that the statistics belong to. </p>
2768
3165
  */
2769
3166
  SensorName?: string;
2770
3167
  /**
3168
+ * @public
2771
3169
  * <p> Parameter that indicates whether data exists for the sensor that the statistics belong
2772
3170
  * to. </p>
2773
3171
  */
2774
3172
  DataExists?: boolean;
2775
3173
  /**
3174
+ * @public
2776
3175
  * <p> Parameter that describes the total number of, and percentage of, values that are
2777
3176
  * missing for the sensor that the statistics belong to. </p>
2778
3177
  */
2779
3178
  MissingValues?: CountPercent;
2780
3179
  /**
3180
+ * @public
2781
3181
  * <p> Parameter that describes the total number of, and percentage of, values that are
2782
3182
  * invalid for the sensor that the statistics belong to. </p>
2783
3183
  */
2784
3184
  InvalidValues?: CountPercent;
2785
3185
  /**
3186
+ * @public
2786
3187
  * <p> Parameter that describes the total number of invalid date entries associated with the
2787
3188
  * sensor that the statistics belong to. </p>
2788
3189
  */
2789
3190
  InvalidDateEntries?: CountPercent;
2790
3191
  /**
3192
+ * @public
2791
3193
  * <p> Parameter that describes the total number of duplicate timestamp records associated
2792
3194
  * with the sensor that the statistics belong to. </p>
2793
3195
  */
2794
3196
  DuplicateTimestamps?: CountPercent;
2795
3197
  /**
3198
+ * @public
2796
3199
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2797
3200
  * is categorical. </p>
2798
3201
  */
2799
3202
  CategoricalValues?: CategoricalValues;
2800
3203
  /**
3204
+ * @public
2801
3205
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2802
3206
  * has more than one operating mode. </p>
2803
3207
  */
2804
3208
  MultipleOperatingModes?: MultipleOperatingModes;
2805
3209
  /**
3210
+ * @public
2806
3211
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2807
3212
  * contains one or more large gaps between consecutive timestamps. </p>
2808
3213
  */
2809
3214
  LargeTimestampGaps?: LargeTimestampGaps;
2810
3215
  /**
3216
+ * @public
2811
3217
  * <p> Parameter that describes potential risk about whether data associated with the sensor
2812
3218
  * is mostly monotonic. </p>
2813
3219
  */
2814
3220
  MonotonicValues?: MonotonicValues;
2815
3221
  /**
3222
+ * @public
2816
3223
  * <p> Indicates the time reference to indicate the beginning of valid data associated with
2817
3224
  * the sensor that the statistics belong to. </p>
2818
3225
  */
2819
3226
  DataStartTime?: Date;
2820
3227
  /**
3228
+ * @public
2821
3229
  * <p> Indicates the time reference to indicate the end of valid data associated with the
2822
3230
  * sensor that the statistics belong to. </p>
2823
3231
  */
@@ -2828,12 +3236,14 @@ export interface SensorStatisticsSummary {
2828
3236
  */
2829
3237
  export interface ListSensorStatisticsResponse {
2830
3238
  /**
3239
+ * @public
2831
3240
  * <p>Provides ingestion-based statistics regarding the specified sensor with respect to
2832
3241
  * various validation types, such as whether data exists, the number and percentage of missing
2833
3242
  * values, and the number and percentage of duplicate timestamps. </p>
2834
3243
  */
2835
3244
  SensorStatisticsSummaries?: SensorStatisticsSummary[];
2836
3245
  /**
3246
+ * @public
2837
3247
  * <p>An opaque pagination token indicating where to continue the listing of sensor
2838
3248
  * statistics. </p>
2839
3249
  */
@@ -2844,6 +3254,7 @@ export interface ListSensorStatisticsResponse {
2844
3254
  */
2845
3255
  export interface ListTagsForResourceRequest {
2846
3256
  /**
3257
+ * @public
2847
3258
  * <p>The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is
2848
3259
  * the focus of the <code>ListTagsForResource</code> operation. </p>
2849
3260
  */
@@ -2854,6 +3265,7 @@ export interface ListTagsForResourceRequest {
2854
3265
  */
2855
3266
  export interface ListTagsForResourceResponse {
2856
3267
  /**
3268
+ * @public
2857
3269
  * <p> Any tags associated with the resource. </p>
2858
3270
  */
2859
3271
  Tags?: Tag[];
@@ -2863,19 +3275,23 @@ export interface ListTagsForResourceResponse {
2863
3275
  */
2864
3276
  export interface PutResourcePolicyRequest {
2865
3277
  /**
3278
+ * @public
2866
3279
  * <p>The Amazon Resource Name (ARN) of the resource for which the
2867
3280
  * policy is being created.</p>
2868
3281
  */
2869
3282
  ResourceArn: string | undefined;
2870
3283
  /**
3284
+ * @public
2871
3285
  * <p>The JSON-formatted resource policy to create.</p>
2872
3286
  */
2873
3287
  ResourcePolicy: string | undefined;
2874
3288
  /**
3289
+ * @public
2875
3290
  * <p>A unique identifier for a revision of the resource policy.</p>
2876
3291
  */
2877
3292
  PolicyRevisionId?: string;
2878
3293
  /**
3294
+ * @public
2879
3295
  * <p>A unique identifier for the request.
2880
3296
  * If you do not set the client request token, Amazon Lookout for Equipment
2881
3297
  * generates one. </p>
@@ -2887,11 +3303,13 @@ export interface PutResourcePolicyRequest {
2887
3303
  */
2888
3304
  export interface PutResourcePolicyResponse {
2889
3305
  /**
3306
+ * @public
2890
3307
  * <p>The Amazon Resource Name (ARN) of the resource for which the
2891
3308
  * policy was created.</p>
2892
3309
  */
2893
3310
  ResourceArn?: string;
2894
3311
  /**
3312
+ * @public
2895
3313
  * <p>A unique identifier for a revision of the resource policy.</p>
2896
3314
  */
2897
3315
  PolicyRevisionId?: string;
@@ -2901,20 +3319,24 @@ export interface PutResourcePolicyResponse {
2901
3319
  */
2902
3320
  export interface StartDataIngestionJobRequest {
2903
3321
  /**
3322
+ * @public
2904
3323
  * <p>The name of the dataset being used by the data ingestion job. </p>
2905
3324
  */
2906
3325
  DatasetName: string | undefined;
2907
3326
  /**
3327
+ * @public
2908
3328
  * <p> Specifies information for the input data for the data ingestion job, including dataset
2909
3329
  * S3 location. </p>
2910
3330
  */
2911
3331
  IngestionInputConfiguration: IngestionInputConfiguration | undefined;
2912
3332
  /**
3333
+ * @public
2913
3334
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
2914
3335
  * the data ingestion job. </p>
2915
3336
  */
2916
3337
  RoleArn: string | undefined;
2917
3338
  /**
3339
+ * @public
2918
3340
  * <p> A unique identifier for the request. If you do not set the client request token, Amazon
2919
3341
  * Lookout for Equipment generates one. </p>
2920
3342
  */
@@ -2925,10 +3347,12 @@ export interface StartDataIngestionJobRequest {
2925
3347
  */
2926
3348
  export interface StartDataIngestionJobResponse {
2927
3349
  /**
3350
+ * @public
2928
3351
  * <p>Indicates the job ID of the data ingestion job. </p>
2929
3352
  */
2930
3353
  JobId?: string;
2931
3354
  /**
3355
+ * @public
2932
3356
  * <p>Indicates the status of the <code>StartDataIngestionJob</code> operation. </p>
2933
3357
  */
2934
3358
  Status?: IngestionJobStatus | string;
@@ -2938,6 +3362,7 @@ export interface StartDataIngestionJobResponse {
2938
3362
  */
2939
3363
  export interface StartInferenceSchedulerRequest {
2940
3364
  /**
3365
+ * @public
2941
3366
  * <p>The name of the inference scheduler to be started. </p>
2942
3367
  */
2943
3368
  InferenceSchedulerName: string | undefined;
@@ -2947,23 +3372,28 @@ export interface StartInferenceSchedulerRequest {
2947
3372
  */
2948
3373
  export interface StartInferenceSchedulerResponse {
2949
3374
  /**
3375
+ * @public
2950
3376
  * <p>The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.
2951
3377
  * </p>
2952
3378
  */
2953
3379
  ModelArn?: string;
2954
3380
  /**
3381
+ * @public
2955
3382
  * <p>The name of the ML model being used by the inference scheduler. </p>
2956
3383
  */
2957
3384
  ModelName?: string;
2958
3385
  /**
3386
+ * @public
2959
3387
  * <p>The name of the inference scheduler being started. </p>
2960
3388
  */
2961
3389
  InferenceSchedulerName?: string;
2962
3390
  /**
3391
+ * @public
2963
3392
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being started. </p>
2964
3393
  */
2965
3394
  InferenceSchedulerArn?: string;
2966
3395
  /**
3396
+ * @public
2967
3397
  * <p>Indicates the status of the inference scheduler. </p>
2968
3398
  */
2969
3399
  Status?: InferenceSchedulerStatus | string;
@@ -2973,6 +3403,7 @@ export interface StartInferenceSchedulerResponse {
2973
3403
  */
2974
3404
  export interface StopInferenceSchedulerRequest {
2975
3405
  /**
3406
+ * @public
2976
3407
  * <p>The name of the inference scheduler to be stopped. </p>
2977
3408
  */
2978
3409
  InferenceSchedulerName: string | undefined;
@@ -2982,23 +3413,28 @@ export interface StopInferenceSchedulerRequest {
2982
3413
  */
2983
3414
  export interface StopInferenceSchedulerResponse {
2984
3415
  /**
3416
+ * @public
2985
3417
  * <p>The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being
2986
3418
  * stopped. </p>
2987
3419
  */
2988
3420
  ModelArn?: string;
2989
3421
  /**
3422
+ * @public
2990
3423
  * <p>The name of the ML model used by the inference scheduler being stopped. </p>
2991
3424
  */
2992
3425
  ModelName?: string;
2993
3426
  /**
3427
+ * @public
2994
3428
  * <p>The name of the inference scheduler being stopped. </p>
2995
3429
  */
2996
3430
  InferenceSchedulerName?: string;
2997
3431
  /**
3432
+ * @public
2998
3433
  * <p>The Amazon Resource Name (ARN) of the inference schedule being stopped. </p>
2999
3434
  */
3000
3435
  InferenceSchedulerArn?: string;
3001
3436
  /**
3437
+ * @public
3002
3438
  * <p>Indicates the status of the inference scheduler. </p>
3003
3439
  */
3004
3440
  Status?: InferenceSchedulerStatus | string;
@@ -3008,11 +3444,13 @@ export interface StopInferenceSchedulerResponse {
3008
3444
  */
3009
3445
  export interface TagResourceRequest {
3010
3446
  /**
3447
+ * @public
3011
3448
  * <p>The Amazon Resource Name (ARN) of the specific resource to which the tag should be
3012
3449
  * associated. </p>
3013
3450
  */
3014
3451
  ResourceArn: string | undefined;
3015
3452
  /**
3453
+ * @public
3016
3454
  * <p>The tag or tags to be associated with a specific resource. Both the tag key and value
3017
3455
  * are specified. </p>
3018
3456
  */
@@ -3028,11 +3466,13 @@ export interface TagResourceResponse {
3028
3466
  */
3029
3467
  export interface UntagResourceRequest {
3030
3468
  /**
3469
+ * @public
3031
3470
  * <p>The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.
3032
3471
  * </p>
3033
3472
  */
3034
3473
  ResourceArn: string | undefined;
3035
3474
  /**
3475
+ * @public
3036
3476
  * <p>Specifies the key of the tag to be removed from a specified resource. </p>
3037
3477
  */
3038
3478
  TagKeys: string[] | undefined;
@@ -3047,11 +3487,13 @@ export interface UntagResourceResponse {
3047
3487
  */
3048
3488
  export interface UpdateActiveModelVersionRequest {
3049
3489
  /**
3490
+ * @public
3050
3491
  * <p>The name of the machine learning model for which the active model version
3051
3492
  * is being set.</p>
3052
3493
  */
3053
3494
  ModelName: string | undefined;
3054
3495
  /**
3496
+ * @public
3055
3497
  * <p>The version of the machine learning model for which the active model version
3056
3498
  * is being set.</p>
3057
3499
  */
@@ -3062,30 +3504,36 @@ export interface UpdateActiveModelVersionRequest {
3062
3504
  */
3063
3505
  export interface UpdateActiveModelVersionResponse {
3064
3506
  /**
3507
+ * @public
3065
3508
  * <p>The name of the machine learning model for which the active model version was set.</p>
3066
3509
  */
3067
3510
  ModelName?: string;
3068
3511
  /**
3512
+ * @public
3069
3513
  * <p>The Amazon Resource Name (ARN) of the machine learning model for which
3070
3514
  * the active model version was set.</p>
3071
3515
  */
3072
3516
  ModelArn?: string;
3073
3517
  /**
3518
+ * @public
3074
3519
  * <p>The version that is currently active of the machine learning model
3075
3520
  * for which the active model version was set.</p>
3076
3521
  */
3077
3522
  CurrentActiveVersion?: number;
3078
3523
  /**
3524
+ * @public
3079
3525
  * <p>The previous version that was active of the machine learning model
3080
3526
  * for which the active model version was set.</p>
3081
3527
  */
3082
3528
  PreviousActiveVersion?: number;
3083
3529
  /**
3530
+ * @public
3084
3531
  * <p>The Amazon Resource Name (ARN) of the machine learning model version that is the
3085
3532
  * current active model version.</p>
3086
3533
  */
3087
3534
  CurrentActiveVersionArn?: string;
3088
3535
  /**
3536
+ * @public
3089
3537
  * <p>The Amazon Resource Name (ARN) of the machine learning model version that was the
3090
3538
  * previous active model version.</p>
3091
3539
  */
@@ -3096,10 +3544,12 @@ export interface UpdateActiveModelVersionResponse {
3096
3544
  */
3097
3545
  export interface UpdateInferenceSchedulerRequest {
3098
3546
  /**
3547
+ * @public
3099
3548
  * <p>The name of the inference scheduler to be updated. </p>
3100
3549
  */
3101
3550
  InferenceSchedulerName: string | undefined;
3102
3551
  /**
3552
+ * @public
3103
3553
  * <p> A period of time (in minutes) by which inference on the data is delayed after the data
3104
3554
  * starts. For instance, if you select an offset delay time of five minutes, inference will
3105
3555
  * not begin on the data until the first data measurement after the five minute mark. For
@@ -3110,6 +3560,7 @@ export interface UpdateInferenceSchedulerRequest {
3110
3560
  */
3111
3561
  DataDelayOffsetInMinutes?: number;
3112
3562
  /**
3563
+ * @public
3113
3564
  * <p>How often data is uploaded to the source S3 bucket for the input data. The value chosen
3114
3565
  * is the length of time between data uploads. For instance, if you select 5 minutes, Amazon
3115
3566
  * Lookout for Equipment will upload the real-time data to the source bucket once every 5
@@ -3118,16 +3569,19 @@ export interface UpdateInferenceSchedulerRequest {
3118
3569
  */
3119
3570
  DataUploadFrequency?: DataUploadFrequency | string;
3120
3571
  /**
3572
+ * @public
3121
3573
  * <p> Specifies information for the input data for the inference scheduler, including
3122
3574
  * delimiter, format, and dataset location. </p>
3123
3575
  */
3124
3576
  DataInputConfiguration?: InferenceInputConfiguration;
3125
3577
  /**
3578
+ * @public
3126
3579
  * <p> Specifies information for the output results from the inference scheduler, including
3127
3580
  * the output S3 location. </p>
3128
3581
  */
3129
3582
  DataOutputConfiguration?: InferenceOutputConfiguration;
3130
3583
  /**
3584
+ * @public
3131
3585
  * <p> The Amazon Resource Name (ARN) of a role with permission to access the data source for
3132
3586
  * the inference scheduler. </p>
3133
3587
  */
@@ -3138,12 +3592,14 @@ export interface UpdateInferenceSchedulerRequest {
3138
3592
  */
3139
3593
  export interface UpdateLabelGroupRequest {
3140
3594
  /**
3595
+ * @public
3141
3596
  * <p>
3142
3597
  * The name of the label group to be updated.
3143
3598
  * </p>
3144
3599
  */
3145
3600
  LabelGroupName: string | undefined;
3146
3601
  /**
3602
+ * @public
3147
3603
  * <p>
3148
3604
  * Updates the code indicating the type of anomaly associated with the label.
3149
3605
  * </p>