@aws-sdk/client-lookoutequipment 3.296.0 → 3.297.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 (48) hide show
  1. package/dist-types/LookoutEquipment.d.ts +34 -0
  2. package/dist-types/LookoutEquipmentClient.d.ts +24 -4
  3. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateInferenceSchedulerCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateLabelCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateLabelGroupCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateModelCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteInferenceSchedulerCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteLabelCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteLabelGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteModelCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeDataIngestionJobCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeInferenceSchedulerCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeLabelCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeLabelGroupCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeModelCommand.d.ts +16 -0
  19. package/dist-types/commands/ListDataIngestionJobsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListInferenceEventsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListInferenceExecutionsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListInferenceSchedulersCommand.d.ts +16 -0
  24. package/dist-types/commands/ListLabelGroupsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListLabelsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListModelsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListSensorStatisticsCommand.d.ts +16 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  29. package/dist-types/commands/StartDataIngestionJobCommand.d.ts +16 -0
  30. package/dist-types/commands/StartInferenceSchedulerCommand.d.ts +16 -0
  31. package/dist-types/commands/StopInferenceSchedulerCommand.d.ts +16 -0
  32. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/UpdateInferenceSchedulerCommand.d.ts +16 -0
  35. package/dist-types/commands/UpdateLabelGroupCommand.d.ts +16 -0
  36. package/dist-types/models/LookoutEquipmentServiceException.d.ts +2 -0
  37. package/dist-types/models/models_0.d.ts +254 -1
  38. package/dist-types/pagination/Interfaces.d.ts +3 -0
  39. package/dist-types/pagination/ListDataIngestionJobsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListInferenceEventsPaginator.d.ts +3 -0
  42. package/dist-types/pagination/ListInferenceExecutionsPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListInferenceSchedulersPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListLabelGroupsPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListLabelsPaginator.d.ts +3 -0
  46. package/dist-types/pagination/ListModelsPaginator.d.ts +3 -0
  47. package/dist-types/pagination/ListSensorStatisticsPaginator.d.ts +3 -0
  48. package/package.json +3 -3
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { LookoutEquipmentServiceException as __BaseException } from "./LookoutEquipmentServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>The request could not be completed because you do not have access to the resource.
5
6
  * </p>
6
7
  */
@@ -14,6 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
14
15
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
16
  }
16
17
  /**
18
+ * @public
17
19
  * <p> The request could not be completed due to a conflict with the current state of the
18
20
  * target resource. </p>
19
21
  */
@@ -27,6 +29,7 @@ export declare class ConflictException extends __BaseException {
27
29
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
28
30
  }
29
31
  /**
32
+ * @public
30
33
  * <p>Provides information about the data schema used with the given dataset. </p>
31
34
  */
32
35
  export interface DatasetSchema {
@@ -37,6 +40,7 @@ export interface DatasetSchema {
37
40
  InlineDataSchema?: __LazyJsonString | string;
38
41
  }
39
42
  /**
43
+ * @public
40
44
  * <p>A tag is a key-value pair that can be added to a resource as metadata. </p>
41
45
  */
42
46
  export interface Tag {
@@ -49,6 +53,9 @@ export interface Tag {
49
53
  */
50
54
  Value: string | undefined;
51
55
  }
56
+ /**
57
+ * @public
58
+ */
52
59
  export interface CreateDatasetRequest {
53
60
  /**
54
61
  * <p>The name of the dataset being created. </p>
@@ -74,11 +81,17 @@ export interface CreateDatasetRequest {
74
81
  */
75
82
  Tags?: Tag[];
76
83
  }
84
+ /**
85
+ * @public
86
+ */
77
87
  export declare enum DatasetStatus {
78
88
  ACTIVE = "ACTIVE",
79
89
  CREATED = "CREATED",
80
90
  INGESTION_IN_PROGRESS = "INGESTION_IN_PROGRESS"
81
91
  }
92
+ /**
93
+ * @public
94
+ */
82
95
  export interface CreateDatasetResponse {
83
96
  /**
84
97
  * <p>The name of the dataset being created. </p>
@@ -94,6 +107,7 @@ export interface CreateDatasetResponse {
94
107
  Status?: DatasetStatus | string;
95
108
  }
96
109
  /**
110
+ * @public
97
111
  * <p> Processing of the request has failed because of an unknown error, exception or failure.
98
112
  * </p>
99
113
  */
@@ -107,6 +121,7 @@ export declare class InternalServerException extends __BaseException {
107
121
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
108
122
  }
109
123
  /**
124
+ * @public
110
125
  * <p> Resource limitations have been exceeded. </p>
111
126
  */
112
127
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -119,6 +134,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
119
134
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
120
135
  }
121
136
  /**
137
+ * @public
122
138
  * <p>The request was denied due to request throttling.</p>
123
139
  */
124
140
  export declare class ThrottlingException extends __BaseException {
@@ -131,6 +147,7 @@ export declare class ThrottlingException extends __BaseException {
131
147
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
132
148
  }
133
149
  /**
150
+ * @public
134
151
  * <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a
135
152
  * related AWS service that's being utilized. </p>
136
153
  */
@@ -144,6 +161,7 @@ export declare class ValidationException extends __BaseException {
144
161
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
145
162
  }
146
163
  /**
164
+ * @public
147
165
  * <p>Specifies configuration information for the input data for the inference, including
148
166
  * timestamp format and delimiter. </p>
149
167
  */
@@ -159,6 +177,7 @@ export interface InferenceInputNameConfiguration {
159
177
  ComponentTimestampDelimiter?: string;
160
178
  }
161
179
  /**
180
+ * @public
162
181
  * <p> Specifies configuration information for the input data for the inference, including
163
182
  * input data S3 location. </p>
164
183
  */
@@ -173,6 +192,7 @@ export interface InferenceS3InputConfiguration {
173
192
  Prefix?: string;
174
193
  }
175
194
  /**
195
+ * @public
176
196
  * <p>Specifies configuration information for the input data for the inference, including
177
197
  * Amazon S3 location of input data.. </p>
178
198
  */
@@ -194,6 +214,7 @@ export interface InferenceInputConfiguration {
194
214
  InferenceInputNameConfiguration?: InferenceInputNameConfiguration;
195
215
  }
196
216
  /**
217
+ * @public
197
218
  * <p> Specifies configuration information for the output results from the inference,
198
219
  * including output S3 location. </p>
199
220
  */
@@ -208,6 +229,7 @@ export interface InferenceS3OutputConfiguration {
208
229
  Prefix?: string;
209
230
  }
210
231
  /**
232
+ * @public
211
233
  * <p> Specifies configuration information for the output results from for the inference,
212
234
  * including KMS key ID and output S3 location. </p>
213
235
  */
@@ -222,6 +244,9 @@ export interface InferenceOutputConfiguration {
222
244
  */
223
245
  KmsKeyId?: string;
224
246
  }
247
+ /**
248
+ * @public
249
+ */
225
250
  export declare enum DataUploadFrequency {
226
251
  PT10M = "PT10M",
227
252
  PT15M = "PT15M",
@@ -229,6 +254,9 @@ export declare enum DataUploadFrequency {
229
254
  PT30M = "PT30M",
230
255
  PT5M = "PT5M"
231
256
  }
257
+ /**
258
+ * @public
259
+ */
232
260
  export interface CreateInferenceSchedulerRequest {
233
261
  /**
234
262
  * <p>The name of the previously trained ML model being used to create the inference
@@ -285,12 +313,18 @@ export interface CreateInferenceSchedulerRequest {
285
313
  */
286
314
  Tags?: Tag[];
287
315
  }
316
+ /**
317
+ * @public
318
+ */
288
319
  export declare enum InferenceSchedulerStatus {
289
320
  PENDING = "PENDING",
290
321
  RUNNING = "RUNNING",
291
322
  STOPPED = "STOPPED",
292
323
  STOPPING = "STOPPING"
293
324
  }
325
+ /**
326
+ * @public
327
+ */
294
328
  export interface CreateInferenceSchedulerResponse {
295
329
  /**
296
330
  * <p>The Amazon Resource Name (ARN) of the inference scheduler being created. </p>
@@ -306,6 +340,7 @@ export interface CreateInferenceSchedulerResponse {
306
340
  Status?: InferenceSchedulerStatus | string;
307
341
  }
308
342
  /**
343
+ * @public
309
344
  * <p> The resource requested could not be found. Verify the resource ID and retry your
310
345
  * request. </p>
311
346
  */
@@ -318,11 +353,17 @@ export declare class ResourceNotFoundException extends __BaseException {
318
353
  */
319
354
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
320
355
  }
356
+ /**
357
+ * @public
358
+ */
321
359
  export declare enum LabelRating {
322
360
  ANOMALY = "ANOMALY",
323
361
  NEUTRAL = "NEUTRAL",
324
362
  NO_ANOMALY = "NO_ANOMALY"
325
363
  }
364
+ /**
365
+ * @public
366
+ */
326
367
  export interface CreateLabelRequest {
327
368
  /**
328
369
  * <p>
@@ -377,6 +418,9 @@ export interface CreateLabelRequest {
377
418
  */
378
419
  ClientToken?: string;
379
420
  }
421
+ /**
422
+ * @public
423
+ */
380
424
  export interface CreateLabelResponse {
381
425
  /**
382
426
  * <p>
@@ -385,6 +429,9 @@ export interface CreateLabelResponse {
385
429
  */
386
430
  LabelId?: string;
387
431
  }
432
+ /**
433
+ * @public
434
+ */
388
435
  export interface CreateLabelGroupRequest {
389
436
  /**
390
437
  * <p>
@@ -413,6 +460,9 @@ export interface CreateLabelGroupRequest {
413
460
  */
414
461
  Tags?: Tag[];
415
462
  }
463
+ /**
464
+ * @public
465
+ */
416
466
  export interface CreateLabelGroupResponse {
417
467
  /**
418
468
  * <p>
@@ -427,6 +477,9 @@ export interface CreateLabelGroupResponse {
427
477
  */
428
478
  LabelGroupArn?: string;
429
479
  }
480
+ /**
481
+ * @public
482
+ */
430
483
  export declare enum TargetSamplingRate {
431
484
  PT10M = "PT10M",
432
485
  PT10S = "PT10S",
@@ -441,6 +494,7 @@ export declare enum TargetSamplingRate {
441
494
  PT5S = "PT5S"
442
495
  }
443
496
  /**
497
+ * @public
444
498
  * <p>The configuration is the <code>TargetSamplingRate</code>, which is the sampling rate of
445
499
  * the data after post processing by Amazon Lookout for Equipment. For example, if you provide
446
500
  * data that has been collected at a 1 second level and you want the system to resample the
@@ -467,6 +521,7 @@ export interface DataPreProcessingConfiguration {
467
521
  TargetSamplingRate?: TargetSamplingRate | string;
468
522
  }
469
523
  /**
524
+ * @public
470
525
  * <p>The location information (prefix and bucket name) for the s3 location being used for
471
526
  * label data. </p>
472
527
  */
@@ -481,6 +536,7 @@ export interface LabelsS3InputConfiguration {
481
536
  Prefix?: string;
482
537
  }
483
538
  /**
539
+ * @public
484
540
  * <p>Contains the configuration information for the S3 location being used to hold label
485
541
  * data. </p>
486
542
  */
@@ -496,6 +552,9 @@ export interface LabelsInputConfiguration {
496
552
  */
497
553
  LabelGroupName?: string;
498
554
  }
555
+ /**
556
+ * @public
557
+ */
499
558
  export interface CreateModelRequest {
500
559
  /**
501
560
  * <p>The name for the ML model to be created.</p>
@@ -573,11 +632,17 @@ export interface CreateModelRequest {
573
632
  */
574
633
  OffCondition?: string;
575
634
  }
635
+ /**
636
+ * @public
637
+ */
576
638
  export declare enum ModelStatus {
577
639
  FAILED = "FAILED",
578
640
  IN_PROGRESS = "IN_PROGRESS",
579
641
  SUCCESS = "SUCCESS"
580
642
  }
643
+ /**
644
+ * @public
645
+ */
581
646
  export interface CreateModelResponse {
582
647
  /**
583
648
  * <p>The Amazon Resource Name (ARN) of the model being created. </p>
@@ -588,18 +653,27 @@ export interface CreateModelResponse {
588
653
  */
589
654
  Status?: ModelStatus | string;
590
655
  }
656
+ /**
657
+ * @public
658
+ */
591
659
  export interface DeleteDatasetRequest {
592
660
  /**
593
661
  * <p>The name of the dataset to be deleted. </p>
594
662
  */
595
663
  DatasetName: string | undefined;
596
664
  }
665
+ /**
666
+ * @public
667
+ */
597
668
  export interface DeleteInferenceSchedulerRequest {
598
669
  /**
599
670
  * <p>The name of the inference scheduler to be deleted. </p>
600
671
  */
601
672
  InferenceSchedulerName: string | undefined;
602
673
  }
674
+ /**
675
+ * @public
676
+ */
603
677
  export interface DeleteLabelRequest {
604
678
  /**
605
679
  * <p>
@@ -614,6 +688,9 @@ export interface DeleteLabelRequest {
614
688
  */
615
689
  LabelId: string | undefined;
616
690
  }
691
+ /**
692
+ * @public
693
+ */
617
694
  export interface DeleteLabelGroupRequest {
618
695
  /**
619
696
  * <p>
@@ -622,12 +699,18 @@ export interface DeleteLabelGroupRequest {
622
699
  */
623
700
  LabelGroupName: string | undefined;
624
701
  }
702
+ /**
703
+ * @public
704
+ */
625
705
  export interface DeleteModelRequest {
626
706
  /**
627
707
  * <p>The name of the ML model to be deleted. </p>
628
708
  */
629
709
  ModelName: string | undefined;
630
710
  }
711
+ /**
712
+ * @public
713
+ */
631
714
  export interface DescribeDataIngestionJobRequest {
632
715
  /**
633
716
  * <p>The job ID of the data ingestion job. </p>
@@ -635,6 +718,7 @@ export interface DescribeDataIngestionJobRequest {
635
718
  JobId: string | undefined;
636
719
  }
637
720
  /**
721
+ * @public
638
722
  * <p> Entity that comprises information abount duplicate timestamps in the dataset. </p>
639
723
  */
640
724
  export interface DuplicateTimestamps {
@@ -644,6 +728,7 @@ export interface DuplicateTimestamps {
644
728
  TotalNumberOfDuplicateTimestamps: number | undefined;
645
729
  }
646
730
  /**
731
+ * @public
647
732
  * <p> Entity that comprises information on sensors that have sensor data completely missing.
648
733
  * </p>
649
734
  */
@@ -654,6 +739,7 @@ export interface MissingCompleteSensorData {
654
739
  AffectedSensorCount: number | undefined;
655
740
  }
656
741
  /**
742
+ * @public
657
743
  * <p> Entity that comprises information on sensors that have shorter date range. </p>
658
744
  */
659
745
  export interface SensorsWithShortDateRange {
@@ -663,6 +749,7 @@ export interface SensorsWithShortDateRange {
663
749
  AffectedSensorCount: number | undefined;
664
750
  }
665
751
  /**
752
+ * @public
666
753
  * <p> Entity that comprises aggregated information on sensors having insufficient data.
667
754
  * </p>
668
755
  */
@@ -679,6 +766,7 @@ export interface InsufficientSensorData {
679
766
  SensorsWithShortDateRange: SensorsWithShortDateRange | undefined;
680
767
  }
681
768
  /**
769
+ * @public
682
770
  * <p> Entity that comprises aggregated information on sensors having insufficient data.
683
771
  * </p>
684
772
  */
@@ -693,6 +781,7 @@ export interface InvalidSensorData {
693
781
  TotalNumberOfInvalidValues: number | undefined;
694
782
  }
695
783
  /**
784
+ * @public
696
785
  * <p> Entity that comprises aggregated information on sensors having missing data. </p>
697
786
  */
698
787
  export interface MissingSensorData {
@@ -706,6 +795,7 @@ export interface MissingSensorData {
706
795
  TotalNumberOfMissingValues: number | undefined;
707
796
  }
708
797
  /**
798
+ * @public
709
799
  * <p> Entity that comprises information abount unsupported timestamps in the dataset. </p>
710
800
  */
711
801
  export interface UnsupportedTimestamps {
@@ -715,6 +805,7 @@ export interface UnsupportedTimestamps {
715
805
  TotalNumberOfUnsupportedTimestamps: number | undefined;
716
806
  }
717
807
  /**
808
+ * @public
718
809
  * <p> DataQualitySummary gives aggregated statistics over all the sensors about a completed
719
810
  * ingestion job. It primarily gives more information about statistics over different
720
811
  * incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,
@@ -748,6 +839,7 @@ export interface DataQualitySummary {
748
839
  DuplicateTimestamps: DuplicateTimestamps | undefined;
749
840
  }
750
841
  /**
842
+ * @public
751
843
  * <p>Contains information about an S3 bucket. </p>
752
844
  */
753
845
  export interface S3Object {
@@ -762,6 +854,7 @@ export interface S3Object {
762
854
  Key: string | undefined;
763
855
  }
764
856
  /**
857
+ * @public
765
858
  * <p>Gives statistics about how many files have been ingested, and which files have not been
766
859
  * ingested, for a particular ingestion job.</p>
767
860
  */
@@ -781,6 +874,7 @@ export interface IngestedFilesSummary {
781
874
  DiscardedFiles?: S3Object[];
782
875
  }
783
876
  /**
877
+ * @public
784
878
  * <p> Specifies S3 configuration information for the input data for the data ingestion job.
785
879
  * </p>
786
880
  */
@@ -797,11 +891,12 @@ export interface IngestionS3InputConfiguration {
797
891
  /**
798
892
  * <p> Pattern for matching the Amazon S3 files which will be used for ingestion. If
799
893
  * no KeyPattern is provided, we will use the default hierarchy file structure, which is same
800
- * as KeyPattern {prefix}/{component_name}/* </p>
894
+ * as KeyPattern \{prefix\}/\{component_name\}/* </p>
801
895
  */
802
896
  KeyPattern?: string;
803
897
  }
804
898
  /**
899
+ * @public
805
900
  * <p> Specifies configuration information for the input data for the data ingestion job,
806
901
  * including input data S3 location. </p>
807
902
  */
@@ -812,11 +907,17 @@ export interface IngestionInputConfiguration {
812
907
  */
813
908
  S3InputConfiguration: IngestionS3InputConfiguration | undefined;
814
909
  }
910
+ /**
911
+ * @public
912
+ */
815
913
  export declare enum IngestionJobStatus {
816
914
  FAILED = "FAILED",
817
915
  IN_PROGRESS = "IN_PROGRESS",
818
916
  SUCCESS = "SUCCESS"
819
917
  }
918
+ /**
919
+ * @public
920
+ */
820
921
  export interface DescribeDataIngestionJobResponse {
821
922
  /**
822
923
  * <p>Indicates the job ID of the data ingestion job. </p>
@@ -880,12 +981,18 @@ export interface DescribeDataIngestionJobResponse {
880
981
  */
881
982
  DataEndTime?: Date;
882
983
  }
984
+ /**
985
+ * @public
986
+ */
883
987
  export interface DescribeDatasetRequest {
884
988
  /**
885
989
  * <p>The name of the dataset to be described. </p>
886
990
  */
887
991
  DatasetName: string | undefined;
888
992
  }
993
+ /**
994
+ * @public
995
+ */
889
996
  export interface DescribeDatasetResponse {
890
997
  /**
891
998
  * <p>The name of the dataset being described. </p>
@@ -950,16 +1057,25 @@ export interface DescribeDatasetResponse {
950
1057
  */
951
1058
  DataEndTime?: Date;
952
1059
  }
1060
+ /**
1061
+ * @public
1062
+ */
953
1063
  export interface DescribeInferenceSchedulerRequest {
954
1064
  /**
955
1065
  * <p>The name of the inference scheduler being described. </p>
956
1066
  */
957
1067
  InferenceSchedulerName: string | undefined;
958
1068
  }
1069
+ /**
1070
+ * @public
1071
+ */
959
1072
  export declare enum LatestInferenceResult {
960
1073
  ANOMALOUS = "ANOMALOUS",
961
1074
  NORMAL = "NORMAL"
962
1075
  }
1076
+ /**
1077
+ * @public
1078
+ */
963
1079
  export interface DescribeInferenceSchedulerResponse {
964
1080
  /**
965
1081
  * <p>The Amazon Resource Name (ARN) of the ML model of the inference scheduler being
@@ -1034,6 +1150,9 @@ export interface DescribeInferenceSchedulerResponse {
1034
1150
  */
1035
1151
  LatestInferenceResult?: LatestInferenceResult | string;
1036
1152
  }
1153
+ /**
1154
+ * @public
1155
+ */
1037
1156
  export interface DescribeLabelRequest {
1038
1157
  /**
1039
1158
  * <p>
@@ -1048,6 +1167,9 @@ export interface DescribeLabelRequest {
1048
1167
  */
1049
1168
  LabelId: string | undefined;
1050
1169
  }
1170
+ /**
1171
+ * @public
1172
+ */
1051
1173
  export interface DescribeLabelResponse {
1052
1174
  /**
1053
1175
  * <p>
@@ -1110,6 +1232,9 @@ export interface DescribeLabelResponse {
1110
1232
  */
1111
1233
  CreatedAt?: Date;
1112
1234
  }
1235
+ /**
1236
+ * @public
1237
+ */
1113
1238
  export interface DescribeLabelGroupRequest {
1114
1239
  /**
1115
1240
  * <p>
@@ -1118,6 +1243,9 @@ export interface DescribeLabelGroupRequest {
1118
1243
  */
1119
1244
  LabelGroupName: string | undefined;
1120
1245
  }
1246
+ /**
1247
+ * @public
1248
+ */
1121
1249
  export interface DescribeLabelGroupResponse {
1122
1250
  /**
1123
1251
  * <p>
@@ -1150,12 +1278,18 @@ export interface DescribeLabelGroupResponse {
1150
1278
  */
1151
1279
  UpdatedAt?: Date;
1152
1280
  }
1281
+ /**
1282
+ * @public
1283
+ */
1153
1284
  export interface DescribeModelRequest {
1154
1285
  /**
1155
1286
  * <p>The name of the ML model to be described. </p>
1156
1287
  */
1157
1288
  ModelName: string | undefined;
1158
1289
  }
1290
+ /**
1291
+ * @public
1292
+ */
1159
1293
  export interface DescribeModelResponse {
1160
1294
  /**
1161
1295
  * <p>The name of the ML model being described. </p>
@@ -1267,6 +1401,9 @@ export interface DescribeModelResponse {
1267
1401
  */
1268
1402
  OffCondition?: string;
1269
1403
  }
1404
+ /**
1405
+ * @public
1406
+ */
1270
1407
  export interface ListDataIngestionJobsRequest {
1271
1408
  /**
1272
1409
  * <p>The name of the dataset being used for the data ingestion job. </p>
@@ -1287,6 +1424,7 @@ export interface ListDataIngestionJobsRequest {
1287
1424
  Status?: IngestionJobStatus | string;
1288
1425
  }
1289
1426
  /**
1427
+ * @public
1290
1428
  * <p>Provides information about a specified data ingestion job, including dataset
1291
1429
  * information, data ingestion configuration, and status. </p>
1292
1430
  */
@@ -1313,6 +1451,9 @@ export interface DataIngestionJobSummary {
1313
1451
  */
1314
1452
  Status?: IngestionJobStatus | string;
1315
1453
  }
1454
+ /**
1455
+ * @public
1456
+ */
1316
1457
  export interface ListDataIngestionJobsResponse {
1317
1458
  /**
1318
1459
  * <p> An opaque pagination token indicating where to continue the listing of data ingestion
@@ -1325,6 +1466,9 @@ export interface ListDataIngestionJobsResponse {
1325
1466
  */
1326
1467
  DataIngestionJobSummaries?: DataIngestionJobSummary[];
1327
1468
  }
1469
+ /**
1470
+ * @public
1471
+ */
1328
1472
  export interface ListDatasetsRequest {
1329
1473
  /**
1330
1474
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
@@ -1341,6 +1485,7 @@ export interface ListDatasetsRequest {
1341
1485
  DatasetNameBeginsWith?: string;
1342
1486
  }
1343
1487
  /**
1488
+ * @public
1344
1489
  * <p>Contains information about the specific data set, including name, ARN, and status.
1345
1490
  * </p>
1346
1491
  */
@@ -1362,6 +1507,9 @@ export interface DatasetSummary {
1362
1507
  */
1363
1508
  CreatedAt?: Date;
1364
1509
  }
1510
+ /**
1511
+ * @public
1512
+ */
1365
1513
  export interface ListDatasetsResponse {
1366
1514
  /**
1367
1515
  * <p> An opaque pagination token indicating where to continue the listing of datasets.
@@ -1374,6 +1522,9 @@ export interface ListDatasetsResponse {
1374
1522
  */
1375
1523
  DatasetSummaries?: DatasetSummary[];
1376
1524
  }
1525
+ /**
1526
+ * @public
1527
+ */
1377
1528
  export interface ListInferenceEventsRequest {
1378
1529
  /**
1379
1530
  * <p>An opaque pagination token indicating where to continue the listing of inference
@@ -1399,6 +1550,7 @@ export interface ListInferenceEventsRequest {
1399
1550
  IntervalEndTime: Date | undefined;
1400
1551
  }
1401
1552
  /**
1553
+ * @public
1402
1554
  * <p>Contains information about the specific inference event, including start and end time,
1403
1555
  * diagnostics information, event duration and so on.</p>
1404
1556
  */
@@ -1430,6 +1582,9 @@ export interface InferenceEventSummary {
1430
1582
  */
1431
1583
  EventDurationInSeconds?: number;
1432
1584
  }
1585
+ /**
1586
+ * @public
1587
+ */
1433
1588
  export interface ListInferenceEventsResponse {
1434
1589
  /**
1435
1590
  * <p>An opaque pagination token indicating where to continue the listing of inference
@@ -1443,11 +1598,17 @@ export interface ListInferenceEventsResponse {
1443
1598
  */
1444
1599
  InferenceEventSummaries?: InferenceEventSummary[];
1445
1600
  }
1601
+ /**
1602
+ * @public
1603
+ */
1446
1604
  export declare enum InferenceExecutionStatus {
1447
1605
  FAILED = "FAILED",
1448
1606
  IN_PROGRESS = "IN_PROGRESS",
1449
1607
  SUCCESS = "SUCCESS"
1450
1608
  }
1609
+ /**
1610
+ * @public
1611
+ */
1451
1612
  export interface ListInferenceExecutionsRequest {
1452
1613
  /**
1453
1614
  * <p>An opaque pagination token indicating where to continue the listing of inference
@@ -1478,6 +1639,7 @@ export interface ListInferenceExecutionsRequest {
1478
1639
  Status?: InferenceExecutionStatus | string;
1479
1640
  }
1480
1641
  /**
1642
+ * @public
1481
1643
  * <p>Contains information about the specific inference execution, including input and output
1482
1644
  * data configuration, inference scheduling information, status, and so on. </p>
1483
1645
  */
@@ -1539,6 +1701,9 @@ export interface InferenceExecutionSummary {
1539
1701
  */
1540
1702
  FailedReason?: string;
1541
1703
  }
1704
+ /**
1705
+ * @public
1706
+ */
1542
1707
  export interface ListInferenceExecutionsResponse {
1543
1708
  /**
1544
1709
  * <p> An opaque pagination token indicating where to continue the listing of inference
@@ -1552,6 +1717,9 @@ export interface ListInferenceExecutionsResponse {
1552
1717
  */
1553
1718
  InferenceExecutionSummaries?: InferenceExecutionSummary[];
1554
1719
  }
1720
+ /**
1721
+ * @public
1722
+ */
1555
1723
  export interface ListInferenceSchedulersRequest {
1556
1724
  /**
1557
1725
  * <p> An opaque pagination token indicating where to continue the listing of inference
@@ -1576,6 +1744,7 @@ export interface ListInferenceSchedulersRequest {
1576
1744
  Status?: InferenceSchedulerStatus | string;
1577
1745
  }
1578
1746
  /**
1747
+ * @public
1579
1748
  * <p>Contains information about the specific inference scheduler, including data delay
1580
1749
  * offset, model name and ARN, status, and so on. </p>
1581
1750
  */
@@ -1624,6 +1793,9 @@ export interface InferenceSchedulerSummary {
1624
1793
  */
1625
1794
  LatestInferenceResult?: LatestInferenceResult | string;
1626
1795
  }
1796
+ /**
1797
+ * @public
1798
+ */
1627
1799
  export interface ListInferenceSchedulersResponse {
1628
1800
  /**
1629
1801
  * <p> An opaque pagination token indicating where to continue the listing of inference
@@ -1636,6 +1808,9 @@ export interface ListInferenceSchedulersResponse {
1636
1808
  */
1637
1809
  InferenceSchedulerSummaries?: InferenceSchedulerSummary[];
1638
1810
  }
1811
+ /**
1812
+ * @public
1813
+ */
1639
1814
  export interface ListLabelGroupsRequest {
1640
1815
  /**
1641
1816
  * <p>
@@ -1657,6 +1832,7 @@ export interface ListLabelGroupsRequest {
1657
1832
  MaxResults?: number;
1658
1833
  }
1659
1834
  /**
1835
+ * @public
1660
1836
  * <p>
1661
1837
  * Contains information about the label group.
1662
1838
  * </p>
@@ -1687,6 +1863,9 @@ export interface LabelGroupSummary {
1687
1863
  */
1688
1864
  UpdatedAt?: Date;
1689
1865
  }
1866
+ /**
1867
+ * @public
1868
+ */
1690
1869
  export interface ListLabelGroupsResponse {
1691
1870
  /**
1692
1871
  * <p>
@@ -1701,6 +1880,9 @@ export interface ListLabelGroupsResponse {
1701
1880
  */
1702
1881
  LabelGroupSummaries?: LabelGroupSummary[];
1703
1882
  }
1883
+ /**
1884
+ * @public
1885
+ */
1704
1886
  export interface ListLabelsRequest {
1705
1887
  /**
1706
1888
  * <p>
@@ -1746,6 +1928,7 @@ export interface ListLabelsRequest {
1746
1928
  MaxResults?: number;
1747
1929
  }
1748
1930
  /**
1931
+ * @public
1749
1932
  * <p>
1750
1933
  * Information about the label.
1751
1934
  * </p>
@@ -1807,6 +1990,9 @@ export interface LabelSummary {
1807
1990
  */
1808
1991
  CreatedAt?: Date;
1809
1992
  }
1993
+ /**
1994
+ * @public
1995
+ */
1810
1996
  export interface ListLabelsResponse {
1811
1997
  /**
1812
1998
  * <p>
@@ -1821,6 +2007,9 @@ export interface ListLabelsResponse {
1821
2007
  */
1822
2008
  LabelSummaries?: LabelSummary[];
1823
2009
  }
2010
+ /**
2011
+ * @public
2012
+ */
1824
2013
  export interface ListModelsRequest {
1825
2014
  /**
1826
2015
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
@@ -1845,6 +2034,7 @@ export interface ListModelsRequest {
1845
2034
  DatasetNameBeginsWith?: string;
1846
2035
  }
1847
2036
  /**
2037
+ * @public
1848
2038
  * <p>Provides information about the specified ML model, including dataset and model names and
1849
2039
  * ARNs, as well as status. </p>
1850
2040
  */
@@ -1874,6 +2064,9 @@ export interface ModelSummary {
1874
2064
  */
1875
2065
  CreatedAt?: Date;
1876
2066
  }
2067
+ /**
2068
+ * @public
2069
+ */
1877
2070
  export interface ListModelsResponse {
1878
2071
  /**
1879
2072
  * <p> An opaque pagination token indicating where to continue the listing of ML models.
@@ -1886,6 +2079,9 @@ export interface ListModelsResponse {
1886
2079
  */
1887
2080
  ModelSummaries?: ModelSummary[];
1888
2081
  }
2082
+ /**
2083
+ * @public
2084
+ */
1889
2085
  export interface ListSensorStatisticsRequest {
1890
2086
  /**
1891
2087
  * <p> The name of the dataset associated with the list of Sensor Statistics. </p>
@@ -1907,11 +2103,15 @@ export interface ListSensorStatisticsRequest {
1907
2103
  */
1908
2104
  NextToken?: string;
1909
2105
  }
2106
+ /**
2107
+ * @public
2108
+ */
1910
2109
  export declare enum StatisticalIssueStatus {
1911
2110
  NO_ISSUE_DETECTED = "NO_ISSUE_DETECTED",
1912
2111
  POTENTIAL_ISSUE_DETECTED = "POTENTIAL_ISSUE_DETECTED"
1913
2112
  }
1914
2113
  /**
2114
+ * @public
1915
2115
  * <p> Entity that comprises information on categorical values in data. </p>
1916
2116
  */
1917
2117
  export interface CategoricalValues {
@@ -1926,6 +2126,7 @@ export interface CategoricalValues {
1926
2126
  NumberOfCategory?: number;
1927
2127
  }
1928
2128
  /**
2129
+ * @public
1929
2130
  * <p> Entity that comprises information of count and percentage. </p>
1930
2131
  */
1931
2132
  export interface CountPercent {
@@ -1939,6 +2140,7 @@ export interface CountPercent {
1939
2140
  Percentage: number | undefined;
1940
2141
  }
1941
2142
  /**
2143
+ * @public
1942
2144
  * <p> Entity that comprises information on large gaps between consecutive timestamps in data.
1943
2145
  * </p>
1944
2146
  */
@@ -1957,12 +2159,16 @@ export interface LargeTimestampGaps {
1957
2159
  */
1958
2160
  MaxTimestampGapInDays?: number;
1959
2161
  }
2162
+ /**
2163
+ * @public
2164
+ */
1960
2165
  export declare enum Monotonicity {
1961
2166
  DECREASING = "DECREASING",
1962
2167
  INCREASING = "INCREASING",
1963
2168
  STATIC = "STATIC"
1964
2169
  }
1965
2170
  /**
2171
+ * @public
1966
2172
  * <p> Entity that comprises information on monotonic values in the data. </p>
1967
2173
  */
1968
2174
  export interface MonotonicValues {
@@ -1977,6 +2183,7 @@ export interface MonotonicValues {
1977
2183
  Monotonicity?: Monotonicity | string;
1978
2184
  }
1979
2185
  /**
2186
+ * @public
1980
2187
  * <p> Entity that comprises information on operating modes in data. </p>
1981
2188
  */
1982
2189
  export interface MultipleOperatingModes {
@@ -1987,6 +2194,7 @@ export interface MultipleOperatingModes {
1987
2194
  Status: StatisticalIssueStatus | string | undefined;
1988
2195
  }
1989
2196
  /**
2197
+ * @public
1990
2198
  * <p> Summary of ingestion statistics like whether data exists, number of missing values,
1991
2199
  * number of invalid values and so on related to the particular sensor. </p>
1992
2200
  */
@@ -2056,6 +2264,9 @@ export interface SensorStatisticsSummary {
2056
2264
  */
2057
2265
  DataEndTime?: Date;
2058
2266
  }
2267
+ /**
2268
+ * @public
2269
+ */
2059
2270
  export interface ListSensorStatisticsResponse {
2060
2271
  /**
2061
2272
  * <p>Provides ingestion-based statistics regarding the specified sensor with respect to
@@ -2069,6 +2280,9 @@ export interface ListSensorStatisticsResponse {
2069
2280
  */
2070
2281
  NextToken?: string;
2071
2282
  }
2283
+ /**
2284
+ * @public
2285
+ */
2072
2286
  export interface ListTagsForResourceRequest {
2073
2287
  /**
2074
2288
  * <p>The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is
@@ -2076,12 +2290,18 @@ export interface ListTagsForResourceRequest {
2076
2290
  */
2077
2291
  ResourceArn: string | undefined;
2078
2292
  }
2293
+ /**
2294
+ * @public
2295
+ */
2079
2296
  export interface ListTagsForResourceResponse {
2080
2297
  /**
2081
2298
  * <p> Any tags associated with the resource. </p>
2082
2299
  */
2083
2300
  Tags?: Tag[];
2084
2301
  }
2302
+ /**
2303
+ * @public
2304
+ */
2085
2305
  export interface StartDataIngestionJobRequest {
2086
2306
  /**
2087
2307
  * <p>The name of the dataset being used by the data ingestion job. </p>
@@ -2103,6 +2323,9 @@ export interface StartDataIngestionJobRequest {
2103
2323
  */
2104
2324
  ClientToken?: string;
2105
2325
  }
2326
+ /**
2327
+ * @public
2328
+ */
2106
2329
  export interface StartDataIngestionJobResponse {
2107
2330
  /**
2108
2331
  * <p>Indicates the job ID of the data ingestion job. </p>
@@ -2113,12 +2336,18 @@ export interface StartDataIngestionJobResponse {
2113
2336
  */
2114
2337
  Status?: IngestionJobStatus | string;
2115
2338
  }
2339
+ /**
2340
+ * @public
2341
+ */
2116
2342
  export interface StartInferenceSchedulerRequest {
2117
2343
  /**
2118
2344
  * <p>The name of the inference scheduler to be started. </p>
2119
2345
  */
2120
2346
  InferenceSchedulerName: string | undefined;
2121
2347
  }
2348
+ /**
2349
+ * @public
2350
+ */
2122
2351
  export interface StartInferenceSchedulerResponse {
2123
2352
  /**
2124
2353
  * <p>The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.
@@ -2142,12 +2371,18 @@ export interface StartInferenceSchedulerResponse {
2142
2371
  */
2143
2372
  Status?: InferenceSchedulerStatus | string;
2144
2373
  }
2374
+ /**
2375
+ * @public
2376
+ */
2145
2377
  export interface StopInferenceSchedulerRequest {
2146
2378
  /**
2147
2379
  * <p>The name of the inference scheduler to be stopped. </p>
2148
2380
  */
2149
2381
  InferenceSchedulerName: string | undefined;
2150
2382
  }
2383
+ /**
2384
+ * @public
2385
+ */
2151
2386
  export interface StopInferenceSchedulerResponse {
2152
2387
  /**
2153
2388
  * <p>The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being
@@ -2171,6 +2406,9 @@ export interface StopInferenceSchedulerResponse {
2171
2406
  */
2172
2407
  Status?: InferenceSchedulerStatus | string;
2173
2408
  }
2409
+ /**
2410
+ * @public
2411
+ */
2174
2412
  export interface TagResourceRequest {
2175
2413
  /**
2176
2414
  * <p>The Amazon Resource Name (ARN) of the specific resource to which the tag should be
@@ -2183,8 +2421,14 @@ export interface TagResourceRequest {
2183
2421
  */
2184
2422
  Tags: Tag[] | undefined;
2185
2423
  }
2424
+ /**
2425
+ * @public
2426
+ */
2186
2427
  export interface TagResourceResponse {
2187
2428
  }
2429
+ /**
2430
+ * @public
2431
+ */
2188
2432
  export interface UntagResourceRequest {
2189
2433
  /**
2190
2434
  * <p>The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.
@@ -2196,8 +2440,14 @@ export interface UntagResourceRequest {
2196
2440
  */
2197
2441
  TagKeys: string[] | undefined;
2198
2442
  }
2443
+ /**
2444
+ * @public
2445
+ */
2199
2446
  export interface UntagResourceResponse {
2200
2447
  }
2448
+ /**
2449
+ * @public
2450
+ */
2201
2451
  export interface UpdateInferenceSchedulerRequest {
2202
2452
  /**
2203
2453
  * <p>The name of the inference scheduler to be updated. </p>
@@ -2237,6 +2487,9 @@ export interface UpdateInferenceSchedulerRequest {
2237
2487
  */
2238
2488
  RoleArn?: string;
2239
2489
  }
2490
+ /**
2491
+ * @public
2492
+ */
2240
2493
  export interface UpdateLabelGroupRequest {
2241
2494
  /**
2242
2495
  * <p>