aws-sdk-lookoutequipment 1.9.0 → 1.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutequipment/client.rb +185 -6
- data/lib/aws-sdk-lookoutequipment/client_api.rb +190 -1
- data/lib/aws-sdk-lookoutequipment/types.rb +657 -12
- data/lib/aws-sdk-lookoutequipment.rb +1 -1
- metadata +4 -4
@@ -24,6 +24,26 @@ module Aws::LookoutEquipment
|
|
24
24
|
include Aws::Structure
|
25
25
|
end
|
26
26
|
|
27
|
+
# Entity that comprises information on categorical values in data.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] status
|
30
|
+
# Indicates whether there is a potential data issue related to
|
31
|
+
# categorical values.
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] number_of_category
|
35
|
+
# Indicates the number of categories in the data.
|
36
|
+
# @return [Integer]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CategoricalValues AWS API Documentation
|
39
|
+
#
|
40
|
+
class CategoricalValues < Struct.new(
|
41
|
+
:status,
|
42
|
+
:number_of_category)
|
43
|
+
SENSITIVE = []
|
44
|
+
include Aws::Structure
|
45
|
+
end
|
46
|
+
|
27
47
|
# The request could not be completed due to a conflict with the current
|
28
48
|
# state of the target resource.
|
29
49
|
#
|
@@ -38,12 +58,31 @@ module Aws::LookoutEquipment
|
|
38
58
|
include Aws::Structure
|
39
59
|
end
|
40
60
|
|
61
|
+
# Entity that comprises information of count and percentage.
|
62
|
+
#
|
63
|
+
# @!attribute [rw] count
|
64
|
+
# Indicates the count of occurences of the given statistic.
|
65
|
+
# @return [Integer]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] percentage
|
68
|
+
# Indicates the percentage of occurances of the given statistic.
|
69
|
+
# @return [Float]
|
70
|
+
#
|
71
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CountPercent AWS API Documentation
|
72
|
+
#
|
73
|
+
class CountPercent < Struct.new(
|
74
|
+
:count,
|
75
|
+
:percentage)
|
76
|
+
SENSITIVE = []
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
41
80
|
# @note When making an API call, you may pass CreateDatasetRequest
|
42
81
|
# data as a hash:
|
43
82
|
#
|
44
83
|
# {
|
45
84
|
# dataset_name: "DatasetName", # required
|
46
|
-
# dataset_schema: {
|
85
|
+
# dataset_schema: {
|
47
86
|
# inline_data_schema: "InlineDataSchema",
|
48
87
|
# },
|
49
88
|
# server_side_kms_key_id: "NameOrArn",
|
@@ -426,7 +465,7 @@ module Aws::LookoutEquipment
|
|
426
465
|
#
|
427
466
|
# @!attribute [rw] ingestion_input_configuration
|
428
467
|
# Specifies information for the input data for the data inference job,
|
429
|
-
# including data S3 location parameters.
|
468
|
+
# including data Amazon S3 location parameters.
|
430
469
|
# @return [Types::IngestionInputConfiguration]
|
431
470
|
#
|
432
471
|
# @!attribute [rw] status
|
@@ -484,6 +523,50 @@ module Aws::LookoutEquipment
|
|
484
523
|
include Aws::Structure
|
485
524
|
end
|
486
525
|
|
526
|
+
# DataQualitySummary gives aggregated statistics over all the sensors
|
527
|
+
# about a completed ingestion job. It primarily gives more information
|
528
|
+
# about statistics over different incorrect data like
|
529
|
+
# MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,
|
530
|
+
# InsufficientSensorData, DuplicateTimeStamps.
|
531
|
+
#
|
532
|
+
# @!attribute [rw] insufficient_sensor_data
|
533
|
+
# Parameter that gives information about insufficient data for sensors
|
534
|
+
# in the dataset. This includes information about those sensors that
|
535
|
+
# have complete data missing and those with a short date range.
|
536
|
+
# @return [Types::InsufficientSensorData]
|
537
|
+
#
|
538
|
+
# @!attribute [rw] missing_sensor_data
|
539
|
+
# Parameter that gives information about data that is missing over all
|
540
|
+
# the sensors in the input data.
|
541
|
+
# @return [Types::MissingSensorData]
|
542
|
+
#
|
543
|
+
# @!attribute [rw] invalid_sensor_data
|
544
|
+
# Parameter that gives information about data that is invalid over all
|
545
|
+
# the sensors in the input data.
|
546
|
+
# @return [Types::InvalidSensorData]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] unsupported_timestamps
|
549
|
+
# Parameter that gives information about unsupported timestamps in the
|
550
|
+
# input data.
|
551
|
+
# @return [Types::UnsupportedTimestamps]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] duplicate_timestamps
|
554
|
+
# Parameter that gives information about duplicate timestamps in the
|
555
|
+
# input data.
|
556
|
+
# @return [Types::DuplicateTimestamps]
|
557
|
+
#
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DataQualitySummary AWS API Documentation
|
559
|
+
#
|
560
|
+
class DataQualitySummary < Struct.new(
|
561
|
+
:insufficient_sensor_data,
|
562
|
+
:missing_sensor_data,
|
563
|
+
:invalid_sensor_data,
|
564
|
+
:unsupported_timestamps,
|
565
|
+
:duplicate_timestamps)
|
566
|
+
SENSITIVE = []
|
567
|
+
include Aws::Structure
|
568
|
+
end
|
569
|
+
|
487
570
|
# Provides information about the data schema used with the given
|
488
571
|
# dataset.
|
489
572
|
#
|
@@ -644,6 +727,38 @@ module Aws::LookoutEquipment
|
|
644
727
|
# failed.
|
645
728
|
# @return [String]
|
646
729
|
#
|
730
|
+
# @!attribute [rw] data_quality_summary
|
731
|
+
# Gives statistics about a completed ingestion job. These statistics
|
732
|
+
# primarily relate to quantifying incorrect data such as
|
733
|
+
# MissingCompleteSensorData, MissingSensorData,
|
734
|
+
# UnsupportedDateFormats, InsufficientSensorData, and
|
735
|
+
# DuplicateTimeStamps.
|
736
|
+
# @return [Types::DataQualitySummary]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] ingested_files_summary
|
739
|
+
# Gives statistics about how many files have been ingested, and which
|
740
|
+
# files have not been ingested, for a particular ingestion job.
|
741
|
+
# @return [Types::IngestedFilesSummary]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] status_detail
|
744
|
+
# Provides details about status of the ingestion job that is currently
|
745
|
+
# in progress.
|
746
|
+
# @return [String]
|
747
|
+
#
|
748
|
+
# @!attribute [rw] ingested_data_size
|
749
|
+
# Indicates the size of the ingested dataset.
|
750
|
+
# @return [Integer]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] data_start_time
|
753
|
+
# Indicates the earliest timestamp corresponding to data that was
|
754
|
+
# successfully ingested during this specific ingestion job.
|
755
|
+
# @return [Time]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] data_end_time
|
758
|
+
# Indicates the latest timestamp corresponding to data that was
|
759
|
+
# successfully ingested during this specific ingestion job.
|
760
|
+
# @return [Time]
|
761
|
+
#
|
647
762
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJobResponse AWS API Documentation
|
648
763
|
#
|
649
764
|
class DescribeDataIngestionJobResponse < Struct.new(
|
@@ -653,7 +768,13 @@ module Aws::LookoutEquipment
|
|
653
768
|
:role_arn,
|
654
769
|
:created_at,
|
655
770
|
:status,
|
656
|
-
:failed_reason
|
771
|
+
:failed_reason,
|
772
|
+
:data_quality_summary,
|
773
|
+
:ingested_files_summary,
|
774
|
+
:status_detail,
|
775
|
+
:ingested_data_size,
|
776
|
+
:data_start_time,
|
777
|
+
:data_end_time)
|
657
778
|
SENSITIVE = []
|
658
779
|
include Aws::Structure
|
659
780
|
end
|
@@ -686,8 +807,7 @@ module Aws::LookoutEquipment
|
|
686
807
|
# @return [String]
|
687
808
|
#
|
688
809
|
# @!attribute [rw] created_at
|
689
|
-
# Specifies the time the dataset was created in
|
690
|
-
# Equipment.
|
810
|
+
# Specifies the time the dataset was created in Lookout for Equipment.
|
691
811
|
# @return [Time]
|
692
812
|
#
|
693
813
|
# @!attribute [rw] last_updated_at
|
@@ -713,6 +833,37 @@ module Aws::LookoutEquipment
|
|
713
833
|
# data ingestion job.
|
714
834
|
# @return [Types::IngestionInputConfiguration]
|
715
835
|
#
|
836
|
+
# @!attribute [rw] data_quality_summary
|
837
|
+
# Gives statistics associated with the given dataset for the latest
|
838
|
+
# successful associated ingestion job id. These statistics primarily
|
839
|
+
# relate to quantifying incorrect data such as
|
840
|
+
# MissingCompleteSensorData, MissingSensorData,
|
841
|
+
# UnsupportedDateFormats, InsufficientSensorData, and
|
842
|
+
# DuplicateTimeStamps.
|
843
|
+
# @return [Types::DataQualitySummary]
|
844
|
+
#
|
845
|
+
# @!attribute [rw] ingested_files_summary
|
846
|
+
# IngestedFilesSummary associated with the given dataset for the
|
847
|
+
# latest successful associated ingestion job id.
|
848
|
+
# @return [Types::IngestedFilesSummary]
|
849
|
+
#
|
850
|
+
# @!attribute [rw] role_arn
|
851
|
+
# The Amazon Resource Name (ARN) of the IAM role that you are using
|
852
|
+
# for this the data ingestion job.
|
853
|
+
# @return [String]
|
854
|
+
#
|
855
|
+
# @!attribute [rw] data_start_time
|
856
|
+
# Indicates the earliest timestamp corresponding to data that was
|
857
|
+
# successfully ingested during the most recent ingestion of this
|
858
|
+
# particular dataset.
|
859
|
+
# @return [Time]
|
860
|
+
#
|
861
|
+
# @!attribute [rw] data_end_time
|
862
|
+
# Indicates the latest timestamp corresponding to data that was
|
863
|
+
# successfully ingested during the most recent ingestion of this
|
864
|
+
# particular dataset.
|
865
|
+
# @return [Time]
|
866
|
+
#
|
716
867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDatasetResponse AWS API Documentation
|
717
868
|
#
|
718
869
|
class DescribeDatasetResponse < Struct.new(
|
@@ -723,7 +874,12 @@ module Aws::LookoutEquipment
|
|
723
874
|
:status,
|
724
875
|
:schema,
|
725
876
|
:server_side_kms_key_id,
|
726
|
-
:ingestion_input_configuration
|
877
|
+
:ingestion_input_configuration,
|
878
|
+
:data_quality_summary,
|
879
|
+
:ingested_files_summary,
|
880
|
+
:role_arn,
|
881
|
+
:data_start_time,
|
882
|
+
:data_end_time)
|
727
883
|
SENSITIVE = []
|
728
884
|
include Aws::Structure
|
729
885
|
end
|
@@ -999,6 +1155,64 @@ module Aws::LookoutEquipment
|
|
999
1155
|
include Aws::Structure
|
1000
1156
|
end
|
1001
1157
|
|
1158
|
+
# Entity that comprises information abount duplicate timestamps in the
|
1159
|
+
# dataset.
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] total_number_of_duplicate_timestamps
|
1162
|
+
# Indicates the total number of duplicate timestamps.
|
1163
|
+
# @return [Integer]
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DuplicateTimestamps AWS API Documentation
|
1166
|
+
#
|
1167
|
+
class DuplicateTimestamps < Struct.new(
|
1168
|
+
:total_number_of_duplicate_timestamps)
|
1169
|
+
SENSITIVE = []
|
1170
|
+
include Aws::Structure
|
1171
|
+
end
|
1172
|
+
|
1173
|
+
# Contains information about the specific inference event, including
|
1174
|
+
# start and end time, diagnostics information, event duration and so on.
|
1175
|
+
#
|
1176
|
+
# @!attribute [rw] inference_scheduler_arn
|
1177
|
+
# The Amazon Resource Name (ARN) of the inference scheduler being used
|
1178
|
+
# for the inference event.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] inference_scheduler_name
|
1182
|
+
# The name of the inference scheduler being used for the inference
|
1183
|
+
# events.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] event_start_time
|
1187
|
+
# Indicates the starting time of an inference event.
|
1188
|
+
# @return [Time]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] event_end_time
|
1191
|
+
# Indicates the ending time of an inference event.
|
1192
|
+
# @return [Time]
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] diagnostics
|
1195
|
+
# An array which specifies the names and values of all sensors
|
1196
|
+
# contributing to an inference event.
|
1197
|
+
# @return [String]
|
1198
|
+
#
|
1199
|
+
# @!attribute [rw] event_duration_in_seconds
|
1200
|
+
# Indicates the size of an inference event in seconds.
|
1201
|
+
# @return [Integer]
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceEventSummary AWS API Documentation
|
1204
|
+
#
|
1205
|
+
class InferenceEventSummary < Struct.new(
|
1206
|
+
:inference_scheduler_arn,
|
1207
|
+
:inference_scheduler_name,
|
1208
|
+
:event_start_time,
|
1209
|
+
:event_end_time,
|
1210
|
+
:diagnostics,
|
1211
|
+
:event_duration_in_seconds)
|
1212
|
+
SENSITIVE = []
|
1213
|
+
include Aws::Structure
|
1214
|
+
end
|
1215
|
+
|
1002
1216
|
# Contains information about the specific inference execution, including
|
1003
1217
|
# input and output data configuration, inference scheduling information,
|
1004
1218
|
# status, and so on.
|
@@ -1045,7 +1259,7 @@ module Aws::LookoutEquipment
|
|
1045
1259
|
#
|
1046
1260
|
# @!attribute [rw] data_output_configuration
|
1047
1261
|
# Specifies configuration information for the output results from for
|
1048
|
-
# the inference execution, including the output S3 location.
|
1262
|
+
# the inference execution, including the output Amazon S3 location.
|
1049
1263
|
# @return [Types::InferenceOutputConfiguration]
|
1050
1264
|
#
|
1051
1265
|
# @!attribute [rw] customer_result_object
|
@@ -1080,7 +1294,7 @@ module Aws::LookoutEquipment
|
|
1080
1294
|
end
|
1081
1295
|
|
1082
1296
|
# Specifies configuration information for the input data for the
|
1083
|
-
# inference, including S3 location of input data..
|
1297
|
+
# inference, including Amazon S3 location of input data..
|
1084
1298
|
#
|
1085
1299
|
# @note When making an API call, you may pass InferenceInputConfiguration
|
1086
1300
|
# data as a hash:
|
@@ -1099,12 +1313,12 @@ module Aws::LookoutEquipment
|
|
1099
1313
|
#
|
1100
1314
|
# @!attribute [rw] s3_input_configuration
|
1101
1315
|
# Specifies configuration information for the input data for the
|
1102
|
-
# inference, including S3 location of input data
|
1316
|
+
# inference, including Amazon S3 location of input data.
|
1103
1317
|
# @return [Types::InferenceS3InputConfiguration]
|
1104
1318
|
#
|
1105
1319
|
# @!attribute [rw] input_time_zone_offset
|
1106
|
-
# Indicates the difference between your time zone and
|
1107
|
-
# Time (
|
1320
|
+
# Indicates the difference between your time zone and Coordinated
|
1321
|
+
# Universal Time (UTC).
|
1108
1322
|
# @return [String]
|
1109
1323
|
#
|
1110
1324
|
# @!attribute [rw] inference_input_name_configuration
|
@@ -1302,6 +1516,34 @@ module Aws::LookoutEquipment
|
|
1302
1516
|
include Aws::Structure
|
1303
1517
|
end
|
1304
1518
|
|
1519
|
+
# Gives statistics about how many files have been ingested, and which
|
1520
|
+
# files have not been ingested, for a particular ingestion job.
|
1521
|
+
#
|
1522
|
+
# @!attribute [rw] total_number_of_files
|
1523
|
+
# Indicates the total number of files that were submitted for
|
1524
|
+
# ingestion.
|
1525
|
+
# @return [Integer]
|
1526
|
+
#
|
1527
|
+
# @!attribute [rw] ingested_number_of_files
|
1528
|
+
# Indicates the number of files that were successfully ingested.
|
1529
|
+
# @return [Integer]
|
1530
|
+
#
|
1531
|
+
# @!attribute [rw] discarded_files
|
1532
|
+
# Indicates the number of files that were discarded. A file could be
|
1533
|
+
# discarded because its format is invalid (for example, a jpg or pdf)
|
1534
|
+
# or not readable.
|
1535
|
+
# @return [Array<Types::S3Object>]
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/IngestedFilesSummary AWS API Documentation
|
1538
|
+
#
|
1539
|
+
class IngestedFilesSummary < Struct.new(
|
1540
|
+
:total_number_of_files,
|
1541
|
+
:ingested_number_of_files,
|
1542
|
+
:discarded_files)
|
1543
|
+
SENSITIVE = []
|
1544
|
+
include Aws::Structure
|
1545
|
+
end
|
1546
|
+
|
1305
1547
|
# Specifies configuration information for the input data for the data
|
1306
1548
|
# ingestion job, including input data S3 location.
|
1307
1549
|
#
|
@@ -1312,6 +1554,7 @@ module Aws::LookoutEquipment
|
|
1312
1554
|
# s3_input_configuration: { # required
|
1313
1555
|
# bucket: "S3Bucket", # required
|
1314
1556
|
# prefix: "S3Prefix",
|
1557
|
+
# key_pattern: "KeyPattern",
|
1315
1558
|
# },
|
1316
1559
|
# }
|
1317
1560
|
#
|
@@ -1337,6 +1580,7 @@ module Aws::LookoutEquipment
|
|
1337
1580
|
# {
|
1338
1581
|
# bucket: "S3Bucket", # required
|
1339
1582
|
# prefix: "S3Prefix",
|
1583
|
+
# key_pattern: "KeyPattern",
|
1340
1584
|
# }
|
1341
1585
|
#
|
1342
1586
|
# @!attribute [rw] bucket
|
@@ -1349,11 +1593,41 @@ module Aws::LookoutEquipment
|
|
1349
1593
|
# data ingestion.
|
1350
1594
|
# @return [String]
|
1351
1595
|
#
|
1596
|
+
# @!attribute [rw] key_pattern
|
1597
|
+
# Pattern for matching the Amazon S3 files which will be used for
|
1598
|
+
# ingestion. If no KeyPattern is provided, we will use the default
|
1599
|
+
# hierarchy file structure, which is same as KeyPattern
|
1600
|
+
# \\\{prefix\\}/\\\{component\_name\\}/*
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1352
1603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/IngestionS3InputConfiguration AWS API Documentation
|
1353
1604
|
#
|
1354
1605
|
class IngestionS3InputConfiguration < Struct.new(
|
1355
1606
|
:bucket,
|
1356
|
-
:prefix
|
1607
|
+
:prefix,
|
1608
|
+
:key_pattern)
|
1609
|
+
SENSITIVE = []
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
# Entity that comprises aggregated information on sensors having
|
1614
|
+
# insufficient data.
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] missing_complete_sensor_data
|
1617
|
+
# Parameter that describes the total number of sensors that have data
|
1618
|
+
# completely missing for it.
|
1619
|
+
# @return [Types::MissingCompleteSensorData]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] sensors_with_short_date_range
|
1622
|
+
# Parameter that describes the total number of sensors that have a
|
1623
|
+
# short date range of less than 90 days of data overall.
|
1624
|
+
# @return [Types::SensorsWithShortDateRange]
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InsufficientSensorData AWS API Documentation
|
1627
|
+
#
|
1628
|
+
class InsufficientSensorData < Struct.new(
|
1629
|
+
:missing_complete_sensor_data,
|
1630
|
+
:sensors_with_short_date_range)
|
1357
1631
|
SENSITIVE = []
|
1358
1632
|
include Aws::Structure
|
1359
1633
|
end
|
@@ -1372,6 +1646,27 @@ module Aws::LookoutEquipment
|
|
1372
1646
|
include Aws::Structure
|
1373
1647
|
end
|
1374
1648
|
|
1649
|
+
# Entity that comprises aggregated information on sensors having
|
1650
|
+
# insufficient data.
|
1651
|
+
#
|
1652
|
+
# @!attribute [rw] affected_sensor_count
|
1653
|
+
# Indicates the number of sensors that have at least some invalid
|
1654
|
+
# values.
|
1655
|
+
# @return [Integer]
|
1656
|
+
#
|
1657
|
+
# @!attribute [rw] total_number_of_invalid_values
|
1658
|
+
# Indicates the total number of invalid values across all the sensors.
|
1659
|
+
# @return [Integer]
|
1660
|
+
#
|
1661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InvalidSensorData AWS API Documentation
|
1662
|
+
#
|
1663
|
+
class InvalidSensorData < Struct.new(
|
1664
|
+
:affected_sensor_count,
|
1665
|
+
:total_number_of_invalid_values)
|
1666
|
+
SENSITIVE = []
|
1667
|
+
include Aws::Structure
|
1668
|
+
end
|
1669
|
+
|
1375
1670
|
# Contains the configuration information for the S3 location being used
|
1376
1671
|
# to hold label data.
|
1377
1672
|
#
|
@@ -1426,6 +1721,32 @@ module Aws::LookoutEquipment
|
|
1426
1721
|
include Aws::Structure
|
1427
1722
|
end
|
1428
1723
|
|
1724
|
+
# Entity that comprises information on large gaps between consecutive
|
1725
|
+
# timestamps in data.
|
1726
|
+
#
|
1727
|
+
# @!attribute [rw] status
|
1728
|
+
# Indicates whether there is a potential data issue related to large
|
1729
|
+
# gaps in timestamps.
|
1730
|
+
# @return [String]
|
1731
|
+
#
|
1732
|
+
# @!attribute [rw] number_of_large_timestamp_gaps
|
1733
|
+
# Indicates the number of large timestamp gaps, if there are any.
|
1734
|
+
# @return [Integer]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] max_timestamp_gap_in_days
|
1737
|
+
# Indicates the size of the largest timestamp gap, in days.
|
1738
|
+
# @return [Integer]
|
1739
|
+
#
|
1740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LargeTimestampGaps AWS API Documentation
|
1741
|
+
#
|
1742
|
+
class LargeTimestampGaps < Struct.new(
|
1743
|
+
:status,
|
1744
|
+
:number_of_large_timestamp_gaps,
|
1745
|
+
:max_timestamp_gap_in_days)
|
1746
|
+
SENSITIVE = []
|
1747
|
+
include Aws::Structure
|
1748
|
+
end
|
1749
|
+
|
1429
1750
|
# @note When making an API call, you may pass ListDataIngestionJobsRequest
|
1430
1751
|
# data as a hash:
|
1431
1752
|
#
|
@@ -1534,6 +1855,73 @@ module Aws::LookoutEquipment
|
|
1534
1855
|
include Aws::Structure
|
1535
1856
|
end
|
1536
1857
|
|
1858
|
+
# @note When making an API call, you may pass ListInferenceEventsRequest
|
1859
|
+
# data as a hash:
|
1860
|
+
#
|
1861
|
+
# {
|
1862
|
+
# next_token: "NextToken",
|
1863
|
+
# max_results: 1,
|
1864
|
+
# inference_scheduler_name: "InferenceSchedulerIdentifier", # required
|
1865
|
+
# interval_start_time: Time.now, # required
|
1866
|
+
# interval_end_time: Time.now, # required
|
1867
|
+
# }
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] next_token
|
1870
|
+
# An opaque pagination token indicating where to continue the listing
|
1871
|
+
# of inference events.
|
1872
|
+
# @return [String]
|
1873
|
+
#
|
1874
|
+
# @!attribute [rw] max_results
|
1875
|
+
# Specifies the maximum number of inference events to list.
|
1876
|
+
# @return [Integer]
|
1877
|
+
#
|
1878
|
+
# @!attribute [rw] inference_scheduler_name
|
1879
|
+
# The name of the inference scheduler for the inference events listed.
|
1880
|
+
# @return [String]
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] interval_start_time
|
1883
|
+
# Lookout for Equipment will return all the inference events with
|
1884
|
+
# start time equal to or greater than the start time given.
|
1885
|
+
# @return [Time]
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] interval_end_time
|
1888
|
+
# Lookout for Equipment will return all the inference events with end
|
1889
|
+
# time equal to or less than the end time given.
|
1890
|
+
# @return [Time]
|
1891
|
+
#
|
1892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsRequest AWS API Documentation
|
1893
|
+
#
|
1894
|
+
class ListInferenceEventsRequest < Struct.new(
|
1895
|
+
:next_token,
|
1896
|
+
:max_results,
|
1897
|
+
:inference_scheduler_name,
|
1898
|
+
:interval_start_time,
|
1899
|
+
:interval_end_time)
|
1900
|
+
SENSITIVE = []
|
1901
|
+
include Aws::Structure
|
1902
|
+
end
|
1903
|
+
|
1904
|
+
# @!attribute [rw] next_token
|
1905
|
+
# An opaque pagination token indicating where to continue the listing
|
1906
|
+
# of inference executions.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] inference_event_summaries
|
1910
|
+
# Provides an array of information about the individual inference
|
1911
|
+
# events returned from the `ListInferenceEvents` operation, including
|
1912
|
+
# scheduler used, event start time, event end time, diagnostics, and
|
1913
|
+
# so on.
|
1914
|
+
# @return [Array<Types::InferenceEventSummary>]
|
1915
|
+
#
|
1916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsResponse AWS API Documentation
|
1917
|
+
#
|
1918
|
+
class ListInferenceEventsResponse < Struct.new(
|
1919
|
+
:next_token,
|
1920
|
+
:inference_event_summaries)
|
1921
|
+
SENSITIVE = []
|
1922
|
+
include Aws::Structure
|
1923
|
+
end
|
1924
|
+
|
1537
1925
|
# @note When making an API call, you may pass ListInferenceExecutionsRequest
|
1538
1926
|
# data as a hash:
|
1539
1927
|
#
|
@@ -1730,6 +2118,69 @@ module Aws::LookoutEquipment
|
|
1730
2118
|
include Aws::Structure
|
1731
2119
|
end
|
1732
2120
|
|
2121
|
+
# @note When making an API call, you may pass ListSensorStatisticsRequest
|
2122
|
+
# data as a hash:
|
2123
|
+
#
|
2124
|
+
# {
|
2125
|
+
# dataset_name: "DatasetName", # required
|
2126
|
+
# ingestion_job_id: "IngestionJobId",
|
2127
|
+
# max_results: 1,
|
2128
|
+
# next_token: "NextToken",
|
2129
|
+
# }
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] dataset_name
|
2132
|
+
# The name of the dataset associated with the list of Sensor
|
2133
|
+
# Statistics.
|
2134
|
+
# @return [String]
|
2135
|
+
#
|
2136
|
+
# @!attribute [rw] ingestion_job_id
|
2137
|
+
# The ingestion job id associated with the list of Sensor Statistics.
|
2138
|
+
# To get sensor statistics for a particular ingestion job id, both
|
2139
|
+
# dataset name and ingestion job id must be submitted as inputs.
|
2140
|
+
# @return [String]
|
2141
|
+
#
|
2142
|
+
# @!attribute [rw] max_results
|
2143
|
+
# Specifies the maximum number of sensors for which to retrieve
|
2144
|
+
# statistics.
|
2145
|
+
# @return [Integer]
|
2146
|
+
#
|
2147
|
+
# @!attribute [rw] next_token
|
2148
|
+
# An opaque pagination token indicating where to continue the listing
|
2149
|
+
# of sensor statistics.
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
2152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatisticsRequest AWS API Documentation
|
2153
|
+
#
|
2154
|
+
class ListSensorStatisticsRequest < Struct.new(
|
2155
|
+
:dataset_name,
|
2156
|
+
:ingestion_job_id,
|
2157
|
+
:max_results,
|
2158
|
+
:next_token)
|
2159
|
+
SENSITIVE = []
|
2160
|
+
include Aws::Structure
|
2161
|
+
end
|
2162
|
+
|
2163
|
+
# @!attribute [rw] sensor_statistics_summaries
|
2164
|
+
# Provides ingestion-based statistics regarding the specified sensor
|
2165
|
+
# with respect to various validation types, such as whether data
|
2166
|
+
# exists, the number and percentage of missing values, and the number
|
2167
|
+
# and percentage of duplicate timestamps.
|
2168
|
+
# @return [Array<Types::SensorStatisticsSummary>]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] next_token
|
2171
|
+
# An opaque pagination token indicating where to continue the listing
|
2172
|
+
# of sensor statistics.
|
2173
|
+
# @return [String]
|
2174
|
+
#
|
2175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatisticsResponse AWS API Documentation
|
2176
|
+
#
|
2177
|
+
class ListSensorStatisticsResponse < Struct.new(
|
2178
|
+
:sensor_statistics_summaries,
|
2179
|
+
:next_token)
|
2180
|
+
SENSITIVE = []
|
2181
|
+
include Aws::Structure
|
2182
|
+
end
|
2183
|
+
|
1733
2184
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1734
2185
|
# data as a hash:
|
1735
2186
|
#
|
@@ -1762,6 +2213,41 @@ module Aws::LookoutEquipment
|
|
1762
2213
|
include Aws::Structure
|
1763
2214
|
end
|
1764
2215
|
|
2216
|
+
# Entity that comprises information on sensors that have sensor data
|
2217
|
+
# completely missing.
|
2218
|
+
#
|
2219
|
+
# @!attribute [rw] affected_sensor_count
|
2220
|
+
# Indicates the number of sensors that have data missing completely.
|
2221
|
+
# @return [Integer]
|
2222
|
+
#
|
2223
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MissingCompleteSensorData AWS API Documentation
|
2224
|
+
#
|
2225
|
+
class MissingCompleteSensorData < Struct.new(
|
2226
|
+
:affected_sensor_count)
|
2227
|
+
SENSITIVE = []
|
2228
|
+
include Aws::Structure
|
2229
|
+
end
|
2230
|
+
|
2231
|
+
# Entity that comprises aggregated information on sensors having missing
|
2232
|
+
# data.
|
2233
|
+
#
|
2234
|
+
# @!attribute [rw] affected_sensor_count
|
2235
|
+
# Indicates the number of sensors that have atleast some data missing.
|
2236
|
+
# @return [Integer]
|
2237
|
+
#
|
2238
|
+
# @!attribute [rw] total_number_of_missing_values
|
2239
|
+
# Indicates the total number of missing values across all the sensors.
|
2240
|
+
# @return [Integer]
|
2241
|
+
#
|
2242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MissingSensorData AWS API Documentation
|
2243
|
+
#
|
2244
|
+
class MissingSensorData < Struct.new(
|
2245
|
+
:affected_sensor_count,
|
2246
|
+
:total_number_of_missing_values)
|
2247
|
+
SENSITIVE = []
|
2248
|
+
include Aws::Structure
|
2249
|
+
end
|
2250
|
+
|
1765
2251
|
# Provides information about the specified ML model, including dataset
|
1766
2252
|
# and model names and ARNs, as well as status.
|
1767
2253
|
#
|
@@ -1803,6 +2289,42 @@ module Aws::LookoutEquipment
|
|
1803
2289
|
include Aws::Structure
|
1804
2290
|
end
|
1805
2291
|
|
2292
|
+
# Entity that comprises information on monotonic values in the data.
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] status
|
2295
|
+
# Indicates whether there is a potential data issue related to having
|
2296
|
+
# monotonic values.
|
2297
|
+
# @return [String]
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] monotonicity
|
2300
|
+
# Indicates the monotonicity of values. Can be INCREASING, DECREASING,
|
2301
|
+
# or STATIC.
|
2302
|
+
# @return [String]
|
2303
|
+
#
|
2304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MonotonicValues AWS API Documentation
|
2305
|
+
#
|
2306
|
+
class MonotonicValues < Struct.new(
|
2307
|
+
:status,
|
2308
|
+
:monotonicity)
|
2309
|
+
SENSITIVE = []
|
2310
|
+
include Aws::Structure
|
2311
|
+
end
|
2312
|
+
|
2313
|
+
# Entity that comprises information on operating modes in data.
|
2314
|
+
#
|
2315
|
+
# @!attribute [rw] status
|
2316
|
+
# Indicates whether there is a potential data issue related to having
|
2317
|
+
# multiple operating modes.
|
2318
|
+
# @return [String]
|
2319
|
+
#
|
2320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MultipleOperatingModes AWS API Documentation
|
2321
|
+
#
|
2322
|
+
class MultipleOperatingModes < Struct.new(
|
2323
|
+
:status)
|
2324
|
+
SENSITIVE = []
|
2325
|
+
include Aws::Structure
|
2326
|
+
end
|
2327
|
+
|
1806
2328
|
# The resource requested could not be found. Verify the resource ID and
|
1807
2329
|
# retry your request.
|
1808
2330
|
#
|
@@ -1838,6 +2360,112 @@ module Aws::LookoutEquipment
|
|
1838
2360
|
include Aws::Structure
|
1839
2361
|
end
|
1840
2362
|
|
2363
|
+
# Summary of ingestion statistics like whether data exists, number of
|
2364
|
+
# missing values, number of invalid values and so on related to the
|
2365
|
+
# particular sensor.
|
2366
|
+
#
|
2367
|
+
# @!attribute [rw] component_name
|
2368
|
+
# Name of the component to which the particular sensor belongs for
|
2369
|
+
# which the statistics belong to.
|
2370
|
+
# @return [String]
|
2371
|
+
#
|
2372
|
+
# @!attribute [rw] sensor_name
|
2373
|
+
# Name of the sensor that the statistics belong to.
|
2374
|
+
# @return [String]
|
2375
|
+
#
|
2376
|
+
# @!attribute [rw] data_exists
|
2377
|
+
# Parameter that indicates whether data exists for the sensor that the
|
2378
|
+
# statistics belong to.
|
2379
|
+
# @return [Boolean]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] missing_values
|
2382
|
+
# Parameter that describes the total number of, and percentage of,
|
2383
|
+
# values that are missing for the sensor that the statistics belong
|
2384
|
+
# to.
|
2385
|
+
# @return [Types::CountPercent]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] invalid_values
|
2388
|
+
# Parameter that describes the total number of, and percentage of,
|
2389
|
+
# values that are invalid for the sensor that the statistics belong
|
2390
|
+
# to.
|
2391
|
+
# @return [Types::CountPercent]
|
2392
|
+
#
|
2393
|
+
# @!attribute [rw] invalid_date_entries
|
2394
|
+
# Parameter that describes the total number of invalid date entries
|
2395
|
+
# associated with the sensor that the statistics belong to.
|
2396
|
+
# @return [Types::CountPercent]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] duplicate_timestamps
|
2399
|
+
# Parameter that describes the total number of duplicate timestamp
|
2400
|
+
# records associated with the sensor that the statistics belong to.
|
2401
|
+
# @return [Types::CountPercent]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] categorical_values
|
2404
|
+
# Parameter that describes potential risk about whether data
|
2405
|
+
# associated with the sensor is categorical.
|
2406
|
+
# @return [Types::CategoricalValues]
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] multiple_operating_modes
|
2409
|
+
# Parameter that describes potential risk about whether data
|
2410
|
+
# associated with the sensor has more than one operating mode.
|
2411
|
+
# @return [Types::MultipleOperatingModes]
|
2412
|
+
#
|
2413
|
+
# @!attribute [rw] large_timestamp_gaps
|
2414
|
+
# Parameter that describes potential risk about whether data
|
2415
|
+
# associated with the sensor contains one or more large gaps between
|
2416
|
+
# consecutive timestamps.
|
2417
|
+
# @return [Types::LargeTimestampGaps]
|
2418
|
+
#
|
2419
|
+
# @!attribute [rw] monotonic_values
|
2420
|
+
# Parameter that describes potential risk about whether data
|
2421
|
+
# associated with the sensor is mostly monotonic.
|
2422
|
+
# @return [Types::MonotonicValues]
|
2423
|
+
#
|
2424
|
+
# @!attribute [rw] data_start_time
|
2425
|
+
# Indicates the time reference to indicate the beginning of valid data
|
2426
|
+
# associated with the sensor that the statistics belong to.
|
2427
|
+
# @return [Time]
|
2428
|
+
#
|
2429
|
+
# @!attribute [rw] data_end_time
|
2430
|
+
# Indicates the time reference to indicate the end of valid data
|
2431
|
+
# associated with the sensor that the statistics belong to.
|
2432
|
+
# @return [Time]
|
2433
|
+
#
|
2434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/SensorStatisticsSummary AWS API Documentation
|
2435
|
+
#
|
2436
|
+
class SensorStatisticsSummary < Struct.new(
|
2437
|
+
:component_name,
|
2438
|
+
:sensor_name,
|
2439
|
+
:data_exists,
|
2440
|
+
:missing_values,
|
2441
|
+
:invalid_values,
|
2442
|
+
:invalid_date_entries,
|
2443
|
+
:duplicate_timestamps,
|
2444
|
+
:categorical_values,
|
2445
|
+
:multiple_operating_modes,
|
2446
|
+
:large_timestamp_gaps,
|
2447
|
+
:monotonic_values,
|
2448
|
+
:data_start_time,
|
2449
|
+
:data_end_time)
|
2450
|
+
SENSITIVE = []
|
2451
|
+
include Aws::Structure
|
2452
|
+
end
|
2453
|
+
|
2454
|
+
# Entity that comprises information on sensors that have shorter date
|
2455
|
+
# range.
|
2456
|
+
#
|
2457
|
+
# @!attribute [rw] affected_sensor_count
|
2458
|
+
# Indicates the number of sensors that have less than 90 days of data.
|
2459
|
+
# @return [Integer]
|
2460
|
+
#
|
2461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/SensorsWithShortDateRange AWS API Documentation
|
2462
|
+
#
|
2463
|
+
class SensorsWithShortDateRange < Struct.new(
|
2464
|
+
:affected_sensor_count)
|
2465
|
+
SENSITIVE = []
|
2466
|
+
include Aws::Structure
|
2467
|
+
end
|
2468
|
+
|
1841
2469
|
# Resource limitations have been exceeded.
|
1842
2470
|
#
|
1843
2471
|
# @!attribute [rw] message
|
@@ -1860,6 +2488,7 @@ module Aws::LookoutEquipment
|
|
1860
2488
|
# s3_input_configuration: { # required
|
1861
2489
|
# bucket: "S3Bucket", # required
|
1862
2490
|
# prefix: "S3Prefix",
|
2491
|
+
# key_pattern: "KeyPattern",
|
1863
2492
|
# },
|
1864
2493
|
# },
|
1865
2494
|
# role_arn: "IamRoleArn", # required
|
@@ -2099,6 +2728,22 @@ module Aws::LookoutEquipment
|
|
2099
2728
|
include Aws::Structure
|
2100
2729
|
end
|
2101
2730
|
|
2731
|
+
# Entity that comprises information abount unsupported timestamps in the
|
2732
|
+
# dataset.
|
2733
|
+
#
|
2734
|
+
# @!attribute [rw] total_number_of_unsupported_timestamps
|
2735
|
+
# Indicates the total number of unsupported timestamps across the
|
2736
|
+
# ingested data.
|
2737
|
+
# @return [Integer]
|
2738
|
+
#
|
2739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UnsupportedTimestamps AWS API Documentation
|
2740
|
+
#
|
2741
|
+
class UnsupportedTimestamps < Struct.new(
|
2742
|
+
:total_number_of_unsupported_timestamps)
|
2743
|
+
SENSITIVE = []
|
2744
|
+
include Aws::Structure
|
2745
|
+
end
|
2746
|
+
|
2102
2747
|
# @note When making an API call, you may pass UntagResourceRequest
|
2103
2748
|
# data as a hash:
|
2104
2749
|
#
|