aws-sdk-lookoutequipment 1.10.0 → 1.13.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 +631 -23
- data/lib/aws-sdk-lookoutequipment/client_api.rb +458 -2
- data/lib/aws-sdk-lookoutequipment/types.rb +1336 -64
- data/lib/aws-sdk-lookoutequipment.rb +1 -1
- metadata +2 -2
@@ -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",
|
@@ -163,25 +202,36 @@ module Aws::LookoutEquipment
|
|
163
202
|
# @return [String]
|
164
203
|
#
|
165
204
|
# @!attribute [rw] data_delay_offset_in_minutes
|
166
|
-
#
|
167
|
-
#
|
168
|
-
# delay
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
# delay
|
173
|
-
#
|
174
|
-
#
|
205
|
+
# The interval (in minutes) of planned delay at the start of each
|
206
|
+
# inference segment. For example, if inference is set to run every ten
|
207
|
+
# minutes, the delay is set to five minutes and the time is 09:08. The
|
208
|
+
# inference scheduler will wake up at the configured interval (which,
|
209
|
+
# without a delay configured, would be 09:10) plus the additional five
|
210
|
+
# minute delay time (so 09:15) to check your Amazon S3 bucket. The
|
211
|
+
# delay provides a buffer for you to upload data at the same
|
212
|
+
# frequency, so that you don't have to stop and restart the scheduler
|
213
|
+
# when uploading new data.
|
214
|
+
#
|
215
|
+
# For more information, see [Understanding the inference process][1].
|
216
|
+
#
|
217
|
+
#
|
218
|
+
#
|
219
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
|
175
220
|
# @return [Integer]
|
176
221
|
#
|
177
222
|
# @!attribute [rw] data_upload_frequency
|
178
|
-
# How often data is uploaded to the source S3 bucket for the
|
179
|
-
# data. The value chosen is the length of time between data
|
180
|
-
# For instance, if you select 5 minutes, Amazon Lookout for
|
181
|
-
# will upload the real-time data to the source bucket once
|
182
|
-
# minutes. This frequency also determines how often Amazon
|
183
|
-
#
|
184
|
-
#
|
223
|
+
# How often data is uploaded to the source Amazon S3 bucket for the
|
224
|
+
# input data. The value chosen is the length of time between data
|
225
|
+
# uploads. For instance, if you select 5 minutes, Amazon Lookout for
|
226
|
+
# Equipment will upload the real-time data to the source bucket once
|
227
|
+
# every 5 minutes. This frequency also determines how often Amazon
|
228
|
+
# Lookout for Equipment runs inference on your data.
|
229
|
+
#
|
230
|
+
# For more information, see [Understanding the inference process][1].
|
231
|
+
#
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
|
185
235
|
# @return [String]
|
186
236
|
#
|
187
237
|
# @!attribute [rw] data_input_configuration
|
@@ -257,6 +307,172 @@ module Aws::LookoutEquipment
|
|
257
307
|
include Aws::Structure
|
258
308
|
end
|
259
309
|
|
310
|
+
# @note When making an API call, you may pass CreateLabelGroupRequest
|
311
|
+
# data as a hash:
|
312
|
+
#
|
313
|
+
# {
|
314
|
+
# label_group_name: "LabelGroupName", # required
|
315
|
+
# fault_codes: ["FaultCode"],
|
316
|
+
# client_token: "IdempotenceToken", # required
|
317
|
+
# tags: [
|
318
|
+
# {
|
319
|
+
# key: "TagKey", # required
|
320
|
+
# value: "TagValue", # required
|
321
|
+
# },
|
322
|
+
# ],
|
323
|
+
# }
|
324
|
+
#
|
325
|
+
# @!attribute [rw] label_group_name
|
326
|
+
# Names a group of labels.
|
327
|
+
#
|
328
|
+
# Data in this field will be retained for service usage. Follow best
|
329
|
+
# practices for the security of your data.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] fault_codes
|
333
|
+
# The acceptable fault codes (indicating the type of anomaly
|
334
|
+
# associated with the label) that can be used with this label group.
|
335
|
+
#
|
336
|
+
# Data in this field will be retained for service usage. Follow best
|
337
|
+
# practices for the security of your data.
|
338
|
+
# @return [Array<String>]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] client_token
|
341
|
+
# A unique identifier for the request to create a label group. If you
|
342
|
+
# do not set the client request token, Lookout for Equipment generates
|
343
|
+
# one.
|
344
|
+
#
|
345
|
+
# **A suitable default value is auto-generated.** You should normally
|
346
|
+
# not need to pass this option.
|
347
|
+
# @return [String]
|
348
|
+
#
|
349
|
+
# @!attribute [rw] tags
|
350
|
+
# Tags that provide metadata about the label group you are creating.
|
351
|
+
#
|
352
|
+
# Data in this field will be retained for service usage. Follow best
|
353
|
+
# practices for the security of your data.
|
354
|
+
# @return [Array<Types::Tag>]
|
355
|
+
#
|
356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelGroupRequest AWS API Documentation
|
357
|
+
#
|
358
|
+
class CreateLabelGroupRequest < Struct.new(
|
359
|
+
:label_group_name,
|
360
|
+
:fault_codes,
|
361
|
+
:client_token,
|
362
|
+
:tags)
|
363
|
+
SENSITIVE = []
|
364
|
+
include Aws::Structure
|
365
|
+
end
|
366
|
+
|
367
|
+
# @!attribute [rw] label_group_name
|
368
|
+
# The name of the label group that you have created. Data in this
|
369
|
+
# field will be retained for service usage. Follow best practices for
|
370
|
+
# the security of your data.
|
371
|
+
# @return [String]
|
372
|
+
#
|
373
|
+
# @!attribute [rw] label_group_arn
|
374
|
+
# The ARN of the label group that you have created.
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelGroupResponse AWS API Documentation
|
378
|
+
#
|
379
|
+
class CreateLabelGroupResponse < Struct.new(
|
380
|
+
:label_group_name,
|
381
|
+
:label_group_arn)
|
382
|
+
SENSITIVE = []
|
383
|
+
include Aws::Structure
|
384
|
+
end
|
385
|
+
|
386
|
+
# @note When making an API call, you may pass CreateLabelRequest
|
387
|
+
# data as a hash:
|
388
|
+
#
|
389
|
+
# {
|
390
|
+
# label_group_name: "LabelGroupName", # required
|
391
|
+
# start_time: Time.now, # required
|
392
|
+
# end_time: Time.now, # required
|
393
|
+
# rating: "ANOMALY", # required, accepts ANOMALY, NO_ANOMALY, NEUTRAL
|
394
|
+
# fault_code: "FaultCode",
|
395
|
+
# notes: "Comments",
|
396
|
+
# equipment: "Equipment",
|
397
|
+
# client_token: "IdempotenceToken", # required
|
398
|
+
# }
|
399
|
+
#
|
400
|
+
# @!attribute [rw] label_group_name
|
401
|
+
# The name of a group of labels.
|
402
|
+
#
|
403
|
+
# Data in this field will be retained for service usage. Follow best
|
404
|
+
# practices for the security of your data.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] start_time
|
408
|
+
# The start time of the labeled event.
|
409
|
+
# @return [Time]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] end_time
|
412
|
+
# The end time of the labeled event.
|
413
|
+
# @return [Time]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] rating
|
416
|
+
# Indicates whether a labeled event represents an anomaly.
|
417
|
+
# @return [String]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] fault_code
|
420
|
+
# Provides additional information about the label. The fault code must
|
421
|
+
# be defined in the FaultCodes attribute of the label group.
|
422
|
+
#
|
423
|
+
# Data in this field will be retained for service usage. Follow best
|
424
|
+
# practices for the security of your data.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] notes
|
428
|
+
# Metadata providing additional information about the label.
|
429
|
+
#
|
430
|
+
# Data in this field will be retained for service usage. Follow best
|
431
|
+
# practices for the security of your data.
|
432
|
+
# @return [String]
|
433
|
+
#
|
434
|
+
# @!attribute [rw] equipment
|
435
|
+
# Indicates that a label pertains to a particular piece of equipment.
|
436
|
+
#
|
437
|
+
# Data in this field will be retained for service usage. Follow best
|
438
|
+
# practices for the security of your data.
|
439
|
+
# @return [String]
|
440
|
+
#
|
441
|
+
# @!attribute [rw] client_token
|
442
|
+
# A unique identifier for the request to create a label. If you do not
|
443
|
+
# set the client request token, Lookout for Equipment generates one.
|
444
|
+
#
|
445
|
+
# **A suitable default value is auto-generated.** You should normally
|
446
|
+
# not need to pass this option.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelRequest AWS API Documentation
|
450
|
+
#
|
451
|
+
class CreateLabelRequest < Struct.new(
|
452
|
+
:label_group_name,
|
453
|
+
:start_time,
|
454
|
+
:end_time,
|
455
|
+
:rating,
|
456
|
+
:fault_code,
|
457
|
+
:notes,
|
458
|
+
:equipment,
|
459
|
+
:client_token)
|
460
|
+
SENSITIVE = []
|
461
|
+
include Aws::Structure
|
462
|
+
end
|
463
|
+
|
464
|
+
# @!attribute [rw] label_id
|
465
|
+
# The ID of the label that you have created.
|
466
|
+
# @return [String]
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelResponse AWS API Documentation
|
469
|
+
#
|
470
|
+
class CreateLabelResponse < Struct.new(
|
471
|
+
:label_id)
|
472
|
+
SENSITIVE = []
|
473
|
+
include Aws::Structure
|
474
|
+
end
|
475
|
+
|
260
476
|
# @note When making an API call, you may pass CreateModelRequest
|
261
477
|
# data as a hash:
|
262
478
|
#
|
@@ -267,10 +483,11 @@ module Aws::LookoutEquipment
|
|
267
483
|
# inline_data_schema: "InlineDataSchema",
|
268
484
|
# },
|
269
485
|
# labels_input_configuration: {
|
270
|
-
# s3_input_configuration: {
|
486
|
+
# s3_input_configuration: {
|
271
487
|
# bucket: "S3Bucket", # required
|
272
488
|
# prefix: "S3Prefix",
|
273
489
|
# },
|
490
|
+
# label_group_name: "LabelGroupName",
|
274
491
|
# },
|
275
492
|
# client_token: "IdempotenceToken", # required
|
276
493
|
# training_data_start_time: Time.now,
|
@@ -426,7 +643,7 @@ module Aws::LookoutEquipment
|
|
426
643
|
#
|
427
644
|
# @!attribute [rw] ingestion_input_configuration
|
428
645
|
# Specifies information for the input data for the data inference job,
|
429
|
-
# including data S3 location parameters.
|
646
|
+
# including data Amazon S3 location parameters.
|
430
647
|
# @return [Types::IngestionInputConfiguration]
|
431
648
|
#
|
432
649
|
# @!attribute [rw] status
|
@@ -484,6 +701,50 @@ module Aws::LookoutEquipment
|
|
484
701
|
include Aws::Structure
|
485
702
|
end
|
486
703
|
|
704
|
+
# DataQualitySummary gives aggregated statistics over all the sensors
|
705
|
+
# about a completed ingestion job. It primarily gives more information
|
706
|
+
# about statistics over different incorrect data like
|
707
|
+
# MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,
|
708
|
+
# InsufficientSensorData, DuplicateTimeStamps.
|
709
|
+
#
|
710
|
+
# @!attribute [rw] insufficient_sensor_data
|
711
|
+
# Parameter that gives information about insufficient data for sensors
|
712
|
+
# in the dataset. This includes information about those sensors that
|
713
|
+
# have complete data missing and those with a short date range.
|
714
|
+
# @return [Types::InsufficientSensorData]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] missing_sensor_data
|
717
|
+
# Parameter that gives information about data that is missing over all
|
718
|
+
# the sensors in the input data.
|
719
|
+
# @return [Types::MissingSensorData]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] invalid_sensor_data
|
722
|
+
# Parameter that gives information about data that is invalid over all
|
723
|
+
# the sensors in the input data.
|
724
|
+
# @return [Types::InvalidSensorData]
|
725
|
+
#
|
726
|
+
# @!attribute [rw] unsupported_timestamps
|
727
|
+
# Parameter that gives information about unsupported timestamps in the
|
728
|
+
# input data.
|
729
|
+
# @return [Types::UnsupportedTimestamps]
|
730
|
+
#
|
731
|
+
# @!attribute [rw] duplicate_timestamps
|
732
|
+
# Parameter that gives information about duplicate timestamps in the
|
733
|
+
# input data.
|
734
|
+
# @return [Types::DuplicateTimestamps]
|
735
|
+
#
|
736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DataQualitySummary AWS API Documentation
|
737
|
+
#
|
738
|
+
class DataQualitySummary < Struct.new(
|
739
|
+
:insufficient_sensor_data,
|
740
|
+
:missing_sensor_data,
|
741
|
+
:invalid_sensor_data,
|
742
|
+
:unsupported_timestamps,
|
743
|
+
:duplicate_timestamps)
|
744
|
+
SENSITIVE = []
|
745
|
+
include Aws::Structure
|
746
|
+
end
|
747
|
+
|
487
748
|
# Provides information about the data schema used with the given
|
488
749
|
# dataset.
|
489
750
|
#
|
@@ -574,6 +835,54 @@ module Aws::LookoutEquipment
|
|
574
835
|
include Aws::Structure
|
575
836
|
end
|
576
837
|
|
838
|
+
# @note When making an API call, you may pass DeleteLabelGroupRequest
|
839
|
+
# data as a hash:
|
840
|
+
#
|
841
|
+
# {
|
842
|
+
# label_group_name: "LabelGroupName", # required
|
843
|
+
# }
|
844
|
+
#
|
845
|
+
# @!attribute [rw] label_group_name
|
846
|
+
# The name of the label group that you want to delete. Data in this
|
847
|
+
# field will be retained for service usage. Follow best practices for
|
848
|
+
# the security of your data.
|
849
|
+
# @return [String]
|
850
|
+
#
|
851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabelGroupRequest AWS API Documentation
|
852
|
+
#
|
853
|
+
class DeleteLabelGroupRequest < Struct.new(
|
854
|
+
:label_group_name)
|
855
|
+
SENSITIVE = []
|
856
|
+
include Aws::Structure
|
857
|
+
end
|
858
|
+
|
859
|
+
# @note When making an API call, you may pass DeleteLabelRequest
|
860
|
+
# data as a hash:
|
861
|
+
#
|
862
|
+
# {
|
863
|
+
# label_group_name: "LabelGroupName", # required
|
864
|
+
# label_id: "LabelId", # required
|
865
|
+
# }
|
866
|
+
#
|
867
|
+
# @!attribute [rw] label_group_name
|
868
|
+
# The name of the label group that contains the label that you want to
|
869
|
+
# delete. Data in this field will be retained for service usage.
|
870
|
+
# Follow best practices for the security of your data.
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] label_id
|
874
|
+
# The ID of the label that you want to delete.
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabelRequest AWS API Documentation
|
878
|
+
#
|
879
|
+
class DeleteLabelRequest < Struct.new(
|
880
|
+
:label_group_name,
|
881
|
+
:label_id)
|
882
|
+
SENSITIVE = []
|
883
|
+
include Aws::Structure
|
884
|
+
end
|
885
|
+
|
577
886
|
# @note When making an API call, you may pass DeleteModelRequest
|
578
887
|
# data as a hash:
|
579
888
|
#
|
@@ -644,6 +953,38 @@ module Aws::LookoutEquipment
|
|
644
953
|
# failed.
|
645
954
|
# @return [String]
|
646
955
|
#
|
956
|
+
# @!attribute [rw] data_quality_summary
|
957
|
+
# Gives statistics about a completed ingestion job. These statistics
|
958
|
+
# primarily relate to quantifying incorrect data such as
|
959
|
+
# MissingCompleteSensorData, MissingSensorData,
|
960
|
+
# UnsupportedDateFormats, InsufficientSensorData, and
|
961
|
+
# DuplicateTimeStamps.
|
962
|
+
# @return [Types::DataQualitySummary]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] ingested_files_summary
|
965
|
+
# Gives statistics about how many files have been ingested, and which
|
966
|
+
# files have not been ingested, for a particular ingestion job.
|
967
|
+
# @return [Types::IngestedFilesSummary]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] status_detail
|
970
|
+
# Provides details about status of the ingestion job that is currently
|
971
|
+
# in progress.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] ingested_data_size
|
975
|
+
# Indicates the size of the ingested dataset.
|
976
|
+
# @return [Integer]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] data_start_time
|
979
|
+
# Indicates the earliest timestamp corresponding to data that was
|
980
|
+
# successfully ingested during this specific ingestion job.
|
981
|
+
# @return [Time]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] data_end_time
|
984
|
+
# Indicates the latest timestamp corresponding to data that was
|
985
|
+
# successfully ingested during this specific ingestion job.
|
986
|
+
# @return [Time]
|
987
|
+
#
|
647
988
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJobResponse AWS API Documentation
|
648
989
|
#
|
649
990
|
class DescribeDataIngestionJobResponse < Struct.new(
|
@@ -653,7 +994,13 @@ module Aws::LookoutEquipment
|
|
653
994
|
:role_arn,
|
654
995
|
:created_at,
|
655
996
|
:status,
|
656
|
-
:failed_reason
|
997
|
+
:failed_reason,
|
998
|
+
:data_quality_summary,
|
999
|
+
:ingested_files_summary,
|
1000
|
+
:status_detail,
|
1001
|
+
:ingested_data_size,
|
1002
|
+
:data_start_time,
|
1003
|
+
:data_end_time)
|
657
1004
|
SENSITIVE = []
|
658
1005
|
include Aws::Structure
|
659
1006
|
end
|
@@ -686,8 +1033,7 @@ module Aws::LookoutEquipment
|
|
686
1033
|
# @return [String]
|
687
1034
|
#
|
688
1035
|
# @!attribute [rw] created_at
|
689
|
-
# Specifies the time the dataset was created in
|
690
|
-
# Equipment.
|
1036
|
+
# Specifies the time the dataset was created in Lookout for Equipment.
|
691
1037
|
# @return [Time]
|
692
1038
|
#
|
693
1039
|
# @!attribute [rw] last_updated_at
|
@@ -713,6 +1059,37 @@ module Aws::LookoutEquipment
|
|
713
1059
|
# data ingestion job.
|
714
1060
|
# @return [Types::IngestionInputConfiguration]
|
715
1061
|
#
|
1062
|
+
# @!attribute [rw] data_quality_summary
|
1063
|
+
# Gives statistics associated with the given dataset for the latest
|
1064
|
+
# successful associated ingestion job id. These statistics primarily
|
1065
|
+
# relate to quantifying incorrect data such as
|
1066
|
+
# MissingCompleteSensorData, MissingSensorData,
|
1067
|
+
# UnsupportedDateFormats, InsufficientSensorData, and
|
1068
|
+
# DuplicateTimeStamps.
|
1069
|
+
# @return [Types::DataQualitySummary]
|
1070
|
+
#
|
1071
|
+
# @!attribute [rw] ingested_files_summary
|
1072
|
+
# IngestedFilesSummary associated with the given dataset for the
|
1073
|
+
# latest successful associated ingestion job id.
|
1074
|
+
# @return [Types::IngestedFilesSummary]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] role_arn
|
1077
|
+
# The Amazon Resource Name (ARN) of the IAM role that you are using
|
1078
|
+
# for this the data ingestion job.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @!attribute [rw] data_start_time
|
1082
|
+
# Indicates the earliest timestamp corresponding to data that was
|
1083
|
+
# successfully ingested during the most recent ingestion of this
|
1084
|
+
# particular dataset.
|
1085
|
+
# @return [Time]
|
1086
|
+
#
|
1087
|
+
# @!attribute [rw] data_end_time
|
1088
|
+
# Indicates the latest timestamp corresponding to data that was
|
1089
|
+
# successfully ingested during the most recent ingestion of this
|
1090
|
+
# particular dataset.
|
1091
|
+
# @return [Time]
|
1092
|
+
#
|
716
1093
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDatasetResponse AWS API Documentation
|
717
1094
|
#
|
718
1095
|
class DescribeDatasetResponse < Struct.new(
|
@@ -723,7 +1100,12 @@ module Aws::LookoutEquipment
|
|
723
1100
|
:status,
|
724
1101
|
:schema,
|
725
1102
|
:server_side_kms_key_id,
|
726
|
-
:ingestion_input_configuration
|
1103
|
+
:ingestion_input_configuration,
|
1104
|
+
:data_quality_summary,
|
1105
|
+
:ingested_files_summary,
|
1106
|
+
:role_arn,
|
1107
|
+
:data_start_time,
|
1108
|
+
:data_end_time)
|
727
1109
|
SENSITIVE = []
|
728
1110
|
include Aws::Structure
|
729
1111
|
end
|
@@ -821,6 +1203,12 @@ module Aws::LookoutEquipment
|
|
821
1203
|
# scheduler data by Amazon Lookout for Equipment.
|
822
1204
|
# @return [String]
|
823
1205
|
#
|
1206
|
+
# @!attribute [rw] latest_inference_result
|
1207
|
+
# Indicates whether the latest execution for the inference scheduler
|
1208
|
+
# was Anomalous (anomalous events found) or Normal (no anomalous
|
1209
|
+
# events found).
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
824
1212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceSchedulerResponse AWS API Documentation
|
825
1213
|
#
|
826
1214
|
class DescribeInferenceSchedulerResponse < Struct.new(
|
@@ -836,69 +1224,210 @@ module Aws::LookoutEquipment
|
|
836
1224
|
:data_input_configuration,
|
837
1225
|
:data_output_configuration,
|
838
1226
|
:role_arn,
|
839
|
-
:server_side_kms_key_id
|
1227
|
+
:server_side_kms_key_id,
|
1228
|
+
:latest_inference_result)
|
840
1229
|
SENSITIVE = []
|
841
1230
|
include Aws::Structure
|
842
1231
|
end
|
843
1232
|
|
844
|
-
# @note When making an API call, you may pass
|
1233
|
+
# @note When making an API call, you may pass DescribeLabelGroupRequest
|
845
1234
|
# data as a hash:
|
846
1235
|
#
|
847
1236
|
# {
|
848
|
-
#
|
1237
|
+
# label_group_name: "LabelGroupName", # required
|
849
1238
|
# }
|
850
1239
|
#
|
851
|
-
# @!attribute [rw]
|
852
|
-
#
|
1240
|
+
# @!attribute [rw] label_group_name
|
1241
|
+
# Returns the name of the label group.
|
853
1242
|
# @return [String]
|
854
1243
|
#
|
855
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelGroupRequest AWS API Documentation
|
856
1245
|
#
|
857
|
-
class
|
858
|
-
:
|
1246
|
+
class DescribeLabelGroupRequest < Struct.new(
|
1247
|
+
:label_group_name)
|
859
1248
|
SENSITIVE = []
|
860
1249
|
include Aws::Structure
|
861
1250
|
end
|
862
1251
|
|
863
|
-
# @!attribute [rw]
|
864
|
-
# The name of the
|
1252
|
+
# @!attribute [rw] label_group_name
|
1253
|
+
# The name of the label group.
|
865
1254
|
# @return [String]
|
866
1255
|
#
|
867
|
-
# @!attribute [rw]
|
868
|
-
# The
|
1256
|
+
# @!attribute [rw] label_group_arn
|
1257
|
+
# The ARN of the label group.
|
869
1258
|
# @return [String]
|
870
1259
|
#
|
871
|
-
# @!attribute [rw]
|
872
|
-
#
|
1260
|
+
# @!attribute [rw] fault_codes
|
1261
|
+
# Codes indicating the type of anomaly associated with the labels in
|
1262
|
+
# the lagbel group.
|
1263
|
+
# @return [Array<String>]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] created_at
|
1266
|
+
# The time at which the label group was created.
|
1267
|
+
# @return [Time]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] updated_at
|
1270
|
+
# The time at which the label group was updated.
|
1271
|
+
# @return [Time]
|
1272
|
+
#
|
1273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelGroupResponse AWS API Documentation
|
1274
|
+
#
|
1275
|
+
class DescribeLabelGroupResponse < Struct.new(
|
1276
|
+
:label_group_name,
|
1277
|
+
:label_group_arn,
|
1278
|
+
:fault_codes,
|
1279
|
+
:created_at,
|
1280
|
+
:updated_at)
|
1281
|
+
SENSITIVE = []
|
1282
|
+
include Aws::Structure
|
1283
|
+
end
|
1284
|
+
|
1285
|
+
# @note When making an API call, you may pass DescribeLabelRequest
|
1286
|
+
# data as a hash:
|
1287
|
+
#
|
1288
|
+
# {
|
1289
|
+
# label_group_name: "LabelGroupName", # required
|
1290
|
+
# label_id: "LabelId", # required
|
1291
|
+
# }
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] label_group_name
|
1294
|
+
# Returns the name of the group containing the label.
|
873
1295
|
# @return [String]
|
874
1296
|
#
|
875
|
-
# @!attribute [rw]
|
876
|
-
#
|
877
|
-
# model being described.
|
1297
|
+
# @!attribute [rw] label_id
|
1298
|
+
# Returns the ID of the label.
|
878
1299
|
# @return [String]
|
879
1300
|
#
|
880
|
-
#
|
881
|
-
#
|
882
|
-
|
1301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelRequest AWS API Documentation
|
1302
|
+
#
|
1303
|
+
class DescribeLabelRequest < Struct.new(
|
1304
|
+
:label_group_name,
|
1305
|
+
:label_id)
|
1306
|
+
SENSITIVE = []
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
# @!attribute [rw] label_group_name
|
1311
|
+
# The name of the requested label group.
|
883
1312
|
# @return [String]
|
884
1313
|
#
|
885
|
-
# @!attribute [rw]
|
886
|
-
#
|
887
|
-
#
|
888
|
-
# @return [Types::LabelsInputConfiguration]
|
1314
|
+
# @!attribute [rw] label_group_arn
|
1315
|
+
# The ARN of the requested label group.
|
1316
|
+
# @return [String]
|
889
1317
|
#
|
890
|
-
# @!attribute [rw]
|
891
|
-
#
|
892
|
-
#
|
1318
|
+
# @!attribute [rw] label_id
|
1319
|
+
# The ID of the requested label.
|
1320
|
+
# @return [String]
|
1321
|
+
#
|
1322
|
+
# @!attribute [rw] start_time
|
1323
|
+
# The start time of the requested label.
|
893
1324
|
# @return [Time]
|
894
1325
|
#
|
895
|
-
# @!attribute [rw]
|
896
|
-
#
|
897
|
-
# subset of training data for the ML model.
|
1326
|
+
# @!attribute [rw] end_time
|
1327
|
+
# The end time of the requested label.
|
898
1328
|
# @return [Time]
|
899
1329
|
#
|
900
|
-
# @!attribute [rw]
|
901
|
-
# Indicates
|
1330
|
+
# @!attribute [rw] rating
|
1331
|
+
# Indicates whether a labeled event represents an anomaly.
|
1332
|
+
# @return [String]
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] fault_code
|
1335
|
+
# Indicates the type of anomaly associated with the label.
|
1336
|
+
#
|
1337
|
+
# Data in this field will be retained for service usage. Follow best
|
1338
|
+
# practices for the security of your data.
|
1339
|
+
# @return [String]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] notes
|
1342
|
+
# Metadata providing additional information about the label.
|
1343
|
+
#
|
1344
|
+
# Data in this field will be retained for service usage. Follow best
|
1345
|
+
# practices for the security of your data.
|
1346
|
+
# @return [String]
|
1347
|
+
#
|
1348
|
+
# @!attribute [rw] equipment
|
1349
|
+
# Indicates that a label pertains to a particular piece of equipment.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] created_at
|
1353
|
+
# The time at which the label was created.
|
1354
|
+
# @return [Time]
|
1355
|
+
#
|
1356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelResponse AWS API Documentation
|
1357
|
+
#
|
1358
|
+
class DescribeLabelResponse < Struct.new(
|
1359
|
+
:label_group_name,
|
1360
|
+
:label_group_arn,
|
1361
|
+
:label_id,
|
1362
|
+
:start_time,
|
1363
|
+
:end_time,
|
1364
|
+
:rating,
|
1365
|
+
:fault_code,
|
1366
|
+
:notes,
|
1367
|
+
:equipment,
|
1368
|
+
:created_at)
|
1369
|
+
SENSITIVE = []
|
1370
|
+
include Aws::Structure
|
1371
|
+
end
|
1372
|
+
|
1373
|
+
# @note When making an API call, you may pass DescribeModelRequest
|
1374
|
+
# data as a hash:
|
1375
|
+
#
|
1376
|
+
# {
|
1377
|
+
# model_name: "ModelName", # required
|
1378
|
+
# }
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] model_name
|
1381
|
+
# The name of the ML model to be described.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelRequest AWS API Documentation
|
1385
|
+
#
|
1386
|
+
class DescribeModelRequest < Struct.new(
|
1387
|
+
:model_name)
|
1388
|
+
SENSITIVE = []
|
1389
|
+
include Aws::Structure
|
1390
|
+
end
|
1391
|
+
|
1392
|
+
# @!attribute [rw] model_name
|
1393
|
+
# The name of the ML model being described.
|
1394
|
+
# @return [String]
|
1395
|
+
#
|
1396
|
+
# @!attribute [rw] model_arn
|
1397
|
+
# The Amazon Resource Name (ARN) of the ML model being described.
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] dataset_name
|
1401
|
+
# The name of the dataset being used by the ML being described.
|
1402
|
+
# @return [String]
|
1403
|
+
#
|
1404
|
+
# @!attribute [rw] dataset_arn
|
1405
|
+
# The Amazon Resouce Name (ARN) of the dataset used to create the ML
|
1406
|
+
# model being described.
|
1407
|
+
# @return [String]
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] schema
|
1410
|
+
# A JSON description of the data that is in each time series dataset,
|
1411
|
+
# including names, column names, and data types.
|
1412
|
+
# @return [String]
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] labels_input_configuration
|
1415
|
+
# Specifies configuration information about the labels input,
|
1416
|
+
# including its S3 location.
|
1417
|
+
# @return [Types::LabelsInputConfiguration]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] training_data_start_time
|
1420
|
+
# Indicates the time reference in the dataset that was used to begin
|
1421
|
+
# the subset of training data for the ML model.
|
1422
|
+
# @return [Time]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] training_data_end_time
|
1425
|
+
# Indicates the time reference in the dataset that was used to end the
|
1426
|
+
# subset of training data for the ML model.
|
1427
|
+
# @return [Time]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] evaluation_data_start_time
|
1430
|
+
# Indicates the time reference in the dataset that was used to begin
|
902
1431
|
# the subset of evaluation data for the ML model.
|
903
1432
|
# @return [Time]
|
904
1433
|
#
|
@@ -999,6 +1528,64 @@ module Aws::LookoutEquipment
|
|
999
1528
|
include Aws::Structure
|
1000
1529
|
end
|
1001
1530
|
|
1531
|
+
# Entity that comprises information abount duplicate timestamps in the
|
1532
|
+
# dataset.
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] total_number_of_duplicate_timestamps
|
1535
|
+
# Indicates the total number of duplicate timestamps.
|
1536
|
+
# @return [Integer]
|
1537
|
+
#
|
1538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DuplicateTimestamps AWS API Documentation
|
1539
|
+
#
|
1540
|
+
class DuplicateTimestamps < Struct.new(
|
1541
|
+
:total_number_of_duplicate_timestamps)
|
1542
|
+
SENSITIVE = []
|
1543
|
+
include Aws::Structure
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# Contains information about the specific inference event, including
|
1547
|
+
# start and end time, diagnostics information, event duration and so on.
|
1548
|
+
#
|
1549
|
+
# @!attribute [rw] inference_scheduler_arn
|
1550
|
+
# The Amazon Resource Name (ARN) of the inference scheduler being used
|
1551
|
+
# for the inference event.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] inference_scheduler_name
|
1555
|
+
# The name of the inference scheduler being used for the inference
|
1556
|
+
# events.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] event_start_time
|
1560
|
+
# Indicates the starting time of an inference event.
|
1561
|
+
# @return [Time]
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] event_end_time
|
1564
|
+
# Indicates the ending time of an inference event.
|
1565
|
+
# @return [Time]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] diagnostics
|
1568
|
+
# An array which specifies the names and values of all sensors
|
1569
|
+
# contributing to an inference event.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] event_duration_in_seconds
|
1573
|
+
# Indicates the size of an inference event in seconds.
|
1574
|
+
# @return [Integer]
|
1575
|
+
#
|
1576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceEventSummary AWS API Documentation
|
1577
|
+
#
|
1578
|
+
class InferenceEventSummary < Struct.new(
|
1579
|
+
:inference_scheduler_arn,
|
1580
|
+
:inference_scheduler_name,
|
1581
|
+
:event_start_time,
|
1582
|
+
:event_end_time,
|
1583
|
+
:diagnostics,
|
1584
|
+
:event_duration_in_seconds)
|
1585
|
+
SENSITIVE = []
|
1586
|
+
include Aws::Structure
|
1587
|
+
end
|
1588
|
+
|
1002
1589
|
# Contains information about the specific inference execution, including
|
1003
1590
|
# input and output data configuration, inference scheduling information,
|
1004
1591
|
# status, and so on.
|
@@ -1045,7 +1632,7 @@ module Aws::LookoutEquipment
|
|
1045
1632
|
#
|
1046
1633
|
# @!attribute [rw] data_output_configuration
|
1047
1634
|
# Specifies configuration information for the output results from for
|
1048
|
-
# the inference execution, including the output S3 location.
|
1635
|
+
# the inference execution, including the output Amazon S3 location.
|
1049
1636
|
# @return [Types::InferenceOutputConfiguration]
|
1050
1637
|
#
|
1051
1638
|
# @!attribute [rw] customer_result_object
|
@@ -1080,7 +1667,7 @@ module Aws::LookoutEquipment
|
|
1080
1667
|
end
|
1081
1668
|
|
1082
1669
|
# Specifies configuration information for the input data for the
|
1083
|
-
# inference, including S3 location of input data..
|
1670
|
+
# inference, including Amazon S3 location of input data..
|
1084
1671
|
#
|
1085
1672
|
# @note When making an API call, you may pass InferenceInputConfiguration
|
1086
1673
|
# data as a hash:
|
@@ -1099,12 +1686,12 @@ module Aws::LookoutEquipment
|
|
1099
1686
|
#
|
1100
1687
|
# @!attribute [rw] s3_input_configuration
|
1101
1688
|
# Specifies configuration information for the input data for the
|
1102
|
-
# inference, including S3 location of input data
|
1689
|
+
# inference, including Amazon S3 location of input data.
|
1103
1690
|
# @return [Types::InferenceS3InputConfiguration]
|
1104
1691
|
#
|
1105
1692
|
# @!attribute [rw] input_time_zone_offset
|
1106
|
-
# Indicates the difference between your time zone and
|
1107
|
-
# Time (
|
1693
|
+
# Indicates the difference between your time zone and Coordinated
|
1694
|
+
# Universal Time (UTC).
|
1108
1695
|
# @return [String]
|
1109
1696
|
#
|
1110
1697
|
# @!attribute [rw] inference_input_name_configuration
|
@@ -1288,6 +1875,12 @@ module Aws::LookoutEquipment
|
|
1288
1875
|
# example, it starts once every 5 minutes.
|
1289
1876
|
# @return [String]
|
1290
1877
|
#
|
1878
|
+
# @!attribute [rw] latest_inference_result
|
1879
|
+
# Indicates whether the latest execution for the inference scheduler
|
1880
|
+
# was Anomalous (anomalous events found) or Normal (no anomalous
|
1881
|
+
# events found).
|
1882
|
+
# @return [String]
|
1883
|
+
#
|
1291
1884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceSchedulerSummary AWS API Documentation
|
1292
1885
|
#
|
1293
1886
|
class InferenceSchedulerSummary < Struct.new(
|
@@ -1297,7 +1890,36 @@ module Aws::LookoutEquipment
|
|
1297
1890
|
:inference_scheduler_arn,
|
1298
1891
|
:status,
|
1299
1892
|
:data_delay_offset_in_minutes,
|
1300
|
-
:data_upload_frequency
|
1893
|
+
:data_upload_frequency,
|
1894
|
+
:latest_inference_result)
|
1895
|
+
SENSITIVE = []
|
1896
|
+
include Aws::Structure
|
1897
|
+
end
|
1898
|
+
|
1899
|
+
# Gives statistics about how many files have been ingested, and which
|
1900
|
+
# files have not been ingested, for a particular ingestion job.
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] total_number_of_files
|
1903
|
+
# Indicates the total number of files that were submitted for
|
1904
|
+
# ingestion.
|
1905
|
+
# @return [Integer]
|
1906
|
+
#
|
1907
|
+
# @!attribute [rw] ingested_number_of_files
|
1908
|
+
# Indicates the number of files that were successfully ingested.
|
1909
|
+
# @return [Integer]
|
1910
|
+
#
|
1911
|
+
# @!attribute [rw] discarded_files
|
1912
|
+
# Indicates the number of files that were discarded. A file could be
|
1913
|
+
# discarded because its format is invalid (for example, a jpg or pdf)
|
1914
|
+
# or not readable.
|
1915
|
+
# @return [Array<Types::S3Object>]
|
1916
|
+
#
|
1917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/IngestedFilesSummary AWS API Documentation
|
1918
|
+
#
|
1919
|
+
class IngestedFilesSummary < Struct.new(
|
1920
|
+
:total_number_of_files,
|
1921
|
+
:ingested_number_of_files,
|
1922
|
+
:discarded_files)
|
1301
1923
|
SENSITIVE = []
|
1302
1924
|
include Aws::Structure
|
1303
1925
|
end
|
@@ -1312,6 +1934,7 @@ module Aws::LookoutEquipment
|
|
1312
1934
|
# s3_input_configuration: { # required
|
1313
1935
|
# bucket: "S3Bucket", # required
|
1314
1936
|
# prefix: "S3Prefix",
|
1937
|
+
# key_pattern: "KeyPattern",
|
1315
1938
|
# },
|
1316
1939
|
# }
|
1317
1940
|
#
|
@@ -1337,6 +1960,7 @@ module Aws::LookoutEquipment
|
|
1337
1960
|
# {
|
1338
1961
|
# bucket: "S3Bucket", # required
|
1339
1962
|
# prefix: "S3Prefix",
|
1963
|
+
# key_pattern: "KeyPattern",
|
1340
1964
|
# }
|
1341
1965
|
#
|
1342
1966
|
# @!attribute [rw] bucket
|
@@ -1349,11 +1973,41 @@ module Aws::LookoutEquipment
|
|
1349
1973
|
# data ingestion.
|
1350
1974
|
# @return [String]
|
1351
1975
|
#
|
1976
|
+
# @!attribute [rw] key_pattern
|
1977
|
+
# Pattern for matching the Amazon S3 files which will be used for
|
1978
|
+
# ingestion. If no KeyPattern is provided, we will use the default
|
1979
|
+
# hierarchy file structure, which is same as KeyPattern
|
1980
|
+
# \\\{prefix\\}/\\\{component\_name\\}/*
|
1981
|
+
# @return [String]
|
1982
|
+
#
|
1352
1983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/IngestionS3InputConfiguration AWS API Documentation
|
1353
1984
|
#
|
1354
1985
|
class IngestionS3InputConfiguration < Struct.new(
|
1355
1986
|
:bucket,
|
1356
|
-
:prefix
|
1987
|
+
:prefix,
|
1988
|
+
:key_pattern)
|
1989
|
+
SENSITIVE = []
|
1990
|
+
include Aws::Structure
|
1991
|
+
end
|
1992
|
+
|
1993
|
+
# Entity that comprises aggregated information on sensors having
|
1994
|
+
# insufficient data.
|
1995
|
+
#
|
1996
|
+
# @!attribute [rw] missing_complete_sensor_data
|
1997
|
+
# Parameter that describes the total number of sensors that have data
|
1998
|
+
# completely missing for it.
|
1999
|
+
# @return [Types::MissingCompleteSensorData]
|
2000
|
+
#
|
2001
|
+
# @!attribute [rw] sensors_with_short_date_range
|
2002
|
+
# Parameter that describes the total number of sensors that have a
|
2003
|
+
# short date range of less than 90 days of data overall.
|
2004
|
+
# @return [Types::SensorsWithShortDateRange]
|
2005
|
+
#
|
2006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InsufficientSensorData AWS API Documentation
|
2007
|
+
#
|
2008
|
+
class InsufficientSensorData < Struct.new(
|
2009
|
+
:missing_complete_sensor_data,
|
2010
|
+
:sensors_with_short_date_range)
|
1357
2011
|
SENSITIVE = []
|
1358
2012
|
include Aws::Structure
|
1359
2013
|
end
|
@@ -1372,6 +2026,113 @@ module Aws::LookoutEquipment
|
|
1372
2026
|
include Aws::Structure
|
1373
2027
|
end
|
1374
2028
|
|
2029
|
+
# Entity that comprises aggregated information on sensors having
|
2030
|
+
# insufficient data.
|
2031
|
+
#
|
2032
|
+
# @!attribute [rw] affected_sensor_count
|
2033
|
+
# Indicates the number of sensors that have at least some invalid
|
2034
|
+
# values.
|
2035
|
+
# @return [Integer]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] total_number_of_invalid_values
|
2038
|
+
# Indicates the total number of invalid values across all the sensors.
|
2039
|
+
# @return [Integer]
|
2040
|
+
#
|
2041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InvalidSensorData AWS API Documentation
|
2042
|
+
#
|
2043
|
+
class InvalidSensorData < Struct.new(
|
2044
|
+
:affected_sensor_count,
|
2045
|
+
:total_number_of_invalid_values)
|
2046
|
+
SENSITIVE = []
|
2047
|
+
include Aws::Structure
|
2048
|
+
end
|
2049
|
+
|
2050
|
+
# Contains information about the label group.
|
2051
|
+
#
|
2052
|
+
# @!attribute [rw] label_group_name
|
2053
|
+
# The name of the label group.
|
2054
|
+
# @return [String]
|
2055
|
+
#
|
2056
|
+
# @!attribute [rw] label_group_arn
|
2057
|
+
# The ARN of the label group.
|
2058
|
+
# @return [String]
|
2059
|
+
#
|
2060
|
+
# @!attribute [rw] created_at
|
2061
|
+
# The time at which the label group was created.
|
2062
|
+
# @return [Time]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] updated_at
|
2065
|
+
# The time at which the label group was updated.
|
2066
|
+
# @return [Time]
|
2067
|
+
#
|
2068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LabelGroupSummary AWS API Documentation
|
2069
|
+
#
|
2070
|
+
class LabelGroupSummary < Struct.new(
|
2071
|
+
:label_group_name,
|
2072
|
+
:label_group_arn,
|
2073
|
+
:created_at,
|
2074
|
+
:updated_at)
|
2075
|
+
SENSITIVE = []
|
2076
|
+
include Aws::Structure
|
2077
|
+
end
|
2078
|
+
|
2079
|
+
# Information about the label.
|
2080
|
+
#
|
2081
|
+
# @!attribute [rw] label_group_name
|
2082
|
+
# The name of the label group.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] label_id
|
2086
|
+
# The ID of the label.
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] label_group_arn
|
2090
|
+
# The ARN of the label group.
|
2091
|
+
# @return [String]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] start_time
|
2094
|
+
# The timestamp indicating the start of the label.
|
2095
|
+
# @return [Time]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] end_time
|
2098
|
+
# The timestamp indicating the end of the label.
|
2099
|
+
# @return [Time]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] rating
|
2102
|
+
# Indicates whether a labeled event represents an anomaly.
|
2103
|
+
# @return [String]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] fault_code
|
2106
|
+
# Indicates the type of anomaly associated with the label.
|
2107
|
+
#
|
2108
|
+
# Data in this field will be retained for service usage. Follow best
|
2109
|
+
# practices for the security of your data.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] equipment
|
2113
|
+
# Indicates that a label pertains to a particular piece of equipment.
|
2114
|
+
# @return [String]
|
2115
|
+
#
|
2116
|
+
# @!attribute [rw] created_at
|
2117
|
+
# The time at which the label was created.
|
2118
|
+
# @return [Time]
|
2119
|
+
#
|
2120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LabelSummary AWS API Documentation
|
2121
|
+
#
|
2122
|
+
class LabelSummary < Struct.new(
|
2123
|
+
:label_group_name,
|
2124
|
+
:label_id,
|
2125
|
+
:label_group_arn,
|
2126
|
+
:start_time,
|
2127
|
+
:end_time,
|
2128
|
+
:rating,
|
2129
|
+
:fault_code,
|
2130
|
+
:equipment,
|
2131
|
+
:created_at)
|
2132
|
+
SENSITIVE = []
|
2133
|
+
include Aws::Structure
|
2134
|
+
end
|
2135
|
+
|
1375
2136
|
# Contains the configuration information for the S3 location being used
|
1376
2137
|
# to hold label data.
|
1377
2138
|
#
|
@@ -1379,10 +2140,11 @@ module Aws::LookoutEquipment
|
|
1379
2140
|
# data as a hash:
|
1380
2141
|
#
|
1381
2142
|
# {
|
1382
|
-
# s3_input_configuration: {
|
2143
|
+
# s3_input_configuration: {
|
1383
2144
|
# bucket: "S3Bucket", # required
|
1384
2145
|
# prefix: "S3Prefix",
|
1385
2146
|
# },
|
2147
|
+
# label_group_name: "LabelGroupName",
|
1386
2148
|
# }
|
1387
2149
|
#
|
1388
2150
|
# @!attribute [rw] s3_input_configuration
|
@@ -1390,10 +2152,15 @@ module Aws::LookoutEquipment
|
|
1390
2152
|
# label data.
|
1391
2153
|
# @return [Types::LabelsS3InputConfiguration]
|
1392
2154
|
#
|
2155
|
+
# @!attribute [rw] label_group_name
|
2156
|
+
# The name of the label group to be used for label data.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
1393
2159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LabelsInputConfiguration AWS API Documentation
|
1394
2160
|
#
|
1395
2161
|
class LabelsInputConfiguration < Struct.new(
|
1396
|
-
:s3_input_configuration
|
2162
|
+
:s3_input_configuration,
|
2163
|
+
:label_group_name)
|
1397
2164
|
SENSITIVE = []
|
1398
2165
|
include Aws::Structure
|
1399
2166
|
end
|
@@ -1426,6 +2193,32 @@ module Aws::LookoutEquipment
|
|
1426
2193
|
include Aws::Structure
|
1427
2194
|
end
|
1428
2195
|
|
2196
|
+
# Entity that comprises information on large gaps between consecutive
|
2197
|
+
# timestamps in data.
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] status
|
2200
|
+
# Indicates whether there is a potential data issue related to large
|
2201
|
+
# gaps in timestamps.
|
2202
|
+
# @return [String]
|
2203
|
+
#
|
2204
|
+
# @!attribute [rw] number_of_large_timestamp_gaps
|
2205
|
+
# Indicates the number of large timestamp gaps, if there are any.
|
2206
|
+
# @return [Integer]
|
2207
|
+
#
|
2208
|
+
# @!attribute [rw] max_timestamp_gap_in_days
|
2209
|
+
# Indicates the size of the largest timestamp gap, in days.
|
2210
|
+
# @return [Integer]
|
2211
|
+
#
|
2212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LargeTimestampGaps AWS API Documentation
|
2213
|
+
#
|
2214
|
+
class LargeTimestampGaps < Struct.new(
|
2215
|
+
:status,
|
2216
|
+
:number_of_large_timestamp_gaps,
|
2217
|
+
:max_timestamp_gap_in_days)
|
2218
|
+
SENSITIVE = []
|
2219
|
+
include Aws::Structure
|
2220
|
+
end
|
2221
|
+
|
1429
2222
|
# @note When making an API call, you may pass ListDataIngestionJobsRequest
|
1430
2223
|
# data as a hash:
|
1431
2224
|
#
|
@@ -1534,6 +2327,73 @@ module Aws::LookoutEquipment
|
|
1534
2327
|
include Aws::Structure
|
1535
2328
|
end
|
1536
2329
|
|
2330
|
+
# @note When making an API call, you may pass ListInferenceEventsRequest
|
2331
|
+
# data as a hash:
|
2332
|
+
#
|
2333
|
+
# {
|
2334
|
+
# next_token: "NextToken",
|
2335
|
+
# max_results: 1,
|
2336
|
+
# inference_scheduler_name: "InferenceSchedulerIdentifier", # required
|
2337
|
+
# interval_start_time: Time.now, # required
|
2338
|
+
# interval_end_time: Time.now, # required
|
2339
|
+
# }
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] next_token
|
2342
|
+
# An opaque pagination token indicating where to continue the listing
|
2343
|
+
# of inference events.
|
2344
|
+
# @return [String]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] max_results
|
2347
|
+
# Specifies the maximum number of inference events to list.
|
2348
|
+
# @return [Integer]
|
2349
|
+
#
|
2350
|
+
# @!attribute [rw] inference_scheduler_name
|
2351
|
+
# The name of the inference scheduler for the inference events listed.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] interval_start_time
|
2355
|
+
# Lookout for Equipment will return all the inference events with an
|
2356
|
+
# end time equal to or greater than the start time given.
|
2357
|
+
# @return [Time]
|
2358
|
+
#
|
2359
|
+
# @!attribute [rw] interval_end_time
|
2360
|
+
# Returns all the inference events with an end start time equal to or
|
2361
|
+
# greater than less than the end time given
|
2362
|
+
# @return [Time]
|
2363
|
+
#
|
2364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsRequest AWS API Documentation
|
2365
|
+
#
|
2366
|
+
class ListInferenceEventsRequest < Struct.new(
|
2367
|
+
:next_token,
|
2368
|
+
:max_results,
|
2369
|
+
:inference_scheduler_name,
|
2370
|
+
:interval_start_time,
|
2371
|
+
:interval_end_time)
|
2372
|
+
SENSITIVE = []
|
2373
|
+
include Aws::Structure
|
2374
|
+
end
|
2375
|
+
|
2376
|
+
# @!attribute [rw] next_token
|
2377
|
+
# An opaque pagination token indicating where to continue the listing
|
2378
|
+
# of inference executions.
|
2379
|
+
# @return [String]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] inference_event_summaries
|
2382
|
+
# Provides an array of information about the individual inference
|
2383
|
+
# events returned from the `ListInferenceEvents` operation, including
|
2384
|
+
# scheduler used, event start time, event end time, diagnostics, and
|
2385
|
+
# so on.
|
2386
|
+
# @return [Array<Types::InferenceEventSummary>]
|
2387
|
+
#
|
2388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsResponse AWS API Documentation
|
2389
|
+
#
|
2390
|
+
class ListInferenceEventsResponse < Struct.new(
|
2391
|
+
:next_token,
|
2392
|
+
:inference_event_summaries)
|
2393
|
+
SENSITIVE = []
|
2394
|
+
include Aws::Structure
|
2395
|
+
end
|
2396
|
+
|
1537
2397
|
# @note When making an API call, you may pass ListInferenceExecutionsRequest
|
1538
2398
|
# data as a hash:
|
1539
2399
|
#
|
@@ -1666,6 +2526,132 @@ module Aws::LookoutEquipment
|
|
1666
2526
|
include Aws::Structure
|
1667
2527
|
end
|
1668
2528
|
|
2529
|
+
# @note When making an API call, you may pass ListLabelGroupsRequest
|
2530
|
+
# data as a hash:
|
2531
|
+
#
|
2532
|
+
# {
|
2533
|
+
# label_group_name_begins_with: "LabelGroupName",
|
2534
|
+
# next_token: "NextToken",
|
2535
|
+
# max_results: 1,
|
2536
|
+
# }
|
2537
|
+
#
|
2538
|
+
# @!attribute [rw] label_group_name_begins_with
|
2539
|
+
# The beginning of the name of the label groups to be listed.
|
2540
|
+
# @return [String]
|
2541
|
+
#
|
2542
|
+
# @!attribute [rw] next_token
|
2543
|
+
# An opaque pagination token indicating where to continue the listing
|
2544
|
+
# of label groups.
|
2545
|
+
# @return [String]
|
2546
|
+
#
|
2547
|
+
# @!attribute [rw] max_results
|
2548
|
+
# Specifies the maximum number of label groups to list.
|
2549
|
+
# @return [Integer]
|
2550
|
+
#
|
2551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelGroupsRequest AWS API Documentation
|
2552
|
+
#
|
2553
|
+
class ListLabelGroupsRequest < Struct.new(
|
2554
|
+
:label_group_name_begins_with,
|
2555
|
+
:next_token,
|
2556
|
+
:max_results)
|
2557
|
+
SENSITIVE = []
|
2558
|
+
include Aws::Structure
|
2559
|
+
end
|
2560
|
+
|
2561
|
+
# @!attribute [rw] next_token
|
2562
|
+
# An opaque pagination token indicating where to continue the listing
|
2563
|
+
# of label groups.
|
2564
|
+
# @return [String]
|
2565
|
+
#
|
2566
|
+
# @!attribute [rw] label_group_summaries
|
2567
|
+
# A summary of the label groups.
|
2568
|
+
# @return [Array<Types::LabelGroupSummary>]
|
2569
|
+
#
|
2570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelGroupsResponse AWS API Documentation
|
2571
|
+
#
|
2572
|
+
class ListLabelGroupsResponse < Struct.new(
|
2573
|
+
:next_token,
|
2574
|
+
:label_group_summaries)
|
2575
|
+
SENSITIVE = []
|
2576
|
+
include Aws::Structure
|
2577
|
+
end
|
2578
|
+
|
2579
|
+
# @note When making an API call, you may pass ListLabelsRequest
|
2580
|
+
# data as a hash:
|
2581
|
+
#
|
2582
|
+
# {
|
2583
|
+
# label_group_name: "LabelGroupName", # required
|
2584
|
+
# interval_start_time: Time.now,
|
2585
|
+
# interval_end_time: Time.now,
|
2586
|
+
# fault_code: "FaultCode",
|
2587
|
+
# equipment: "Equipment",
|
2588
|
+
# next_token: "NextToken",
|
2589
|
+
# max_results: 1,
|
2590
|
+
# }
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] label_group_name
|
2593
|
+
# Retruns the name of the label group.
|
2594
|
+
# @return [String]
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] interval_start_time
|
2597
|
+
# Returns all the labels with a end time equal to or later than the
|
2598
|
+
# start time given.
|
2599
|
+
# @return [Time]
|
2600
|
+
#
|
2601
|
+
# @!attribute [rw] interval_end_time
|
2602
|
+
# Returns all labels with a start time earlier than the end time
|
2603
|
+
# given.
|
2604
|
+
# @return [Time]
|
2605
|
+
#
|
2606
|
+
# @!attribute [rw] fault_code
|
2607
|
+
# Returns labels with a particular fault code.
|
2608
|
+
# @return [String]
|
2609
|
+
#
|
2610
|
+
# @!attribute [rw] equipment
|
2611
|
+
# Lists the labels that pertain to a particular piece of equipment.
|
2612
|
+
# @return [String]
|
2613
|
+
#
|
2614
|
+
# @!attribute [rw] next_token
|
2615
|
+
# An opaque pagination token indicating where to continue the listing
|
2616
|
+
# of label groups.
|
2617
|
+
# @return [String]
|
2618
|
+
#
|
2619
|
+
# @!attribute [rw] max_results
|
2620
|
+
# Specifies the maximum number of labels to list.
|
2621
|
+
# @return [Integer]
|
2622
|
+
#
|
2623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelsRequest AWS API Documentation
|
2624
|
+
#
|
2625
|
+
class ListLabelsRequest < Struct.new(
|
2626
|
+
:label_group_name,
|
2627
|
+
:interval_start_time,
|
2628
|
+
:interval_end_time,
|
2629
|
+
:fault_code,
|
2630
|
+
:equipment,
|
2631
|
+
:next_token,
|
2632
|
+
:max_results)
|
2633
|
+
SENSITIVE = []
|
2634
|
+
include Aws::Structure
|
2635
|
+
end
|
2636
|
+
|
2637
|
+
# @!attribute [rw] next_token
|
2638
|
+
# An opaque pagination token indicating where to continue the listing
|
2639
|
+
# of datasets.
|
2640
|
+
# @return [String]
|
2641
|
+
#
|
2642
|
+
# @!attribute [rw] label_summaries
|
2643
|
+
# A summary of the items in the label group.
|
2644
|
+
# @return [Array<Types::LabelSummary>]
|
2645
|
+
#
|
2646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelsResponse AWS API Documentation
|
2647
|
+
#
|
2648
|
+
class ListLabelsResponse < Struct.new(
|
2649
|
+
:next_token,
|
2650
|
+
:label_summaries)
|
2651
|
+
SENSITIVE = []
|
2652
|
+
include Aws::Structure
|
2653
|
+
end
|
2654
|
+
|
1669
2655
|
# @note When making an API call, you may pass ListModelsRequest
|
1670
2656
|
# data as a hash:
|
1671
2657
|
#
|
@@ -1730,6 +2716,69 @@ module Aws::LookoutEquipment
|
|
1730
2716
|
include Aws::Structure
|
1731
2717
|
end
|
1732
2718
|
|
2719
|
+
# @note When making an API call, you may pass ListSensorStatisticsRequest
|
2720
|
+
# data as a hash:
|
2721
|
+
#
|
2722
|
+
# {
|
2723
|
+
# dataset_name: "DatasetName", # required
|
2724
|
+
# ingestion_job_id: "IngestionJobId",
|
2725
|
+
# max_results: 1,
|
2726
|
+
# next_token: "NextToken",
|
2727
|
+
# }
|
2728
|
+
#
|
2729
|
+
# @!attribute [rw] dataset_name
|
2730
|
+
# The name of the dataset associated with the list of Sensor
|
2731
|
+
# Statistics.
|
2732
|
+
# @return [String]
|
2733
|
+
#
|
2734
|
+
# @!attribute [rw] ingestion_job_id
|
2735
|
+
# The ingestion job id associated with the list of Sensor Statistics.
|
2736
|
+
# To get sensor statistics for a particular ingestion job id, both
|
2737
|
+
# dataset name and ingestion job id must be submitted as inputs.
|
2738
|
+
# @return [String]
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] max_results
|
2741
|
+
# Specifies the maximum number of sensors for which to retrieve
|
2742
|
+
# statistics.
|
2743
|
+
# @return [Integer]
|
2744
|
+
#
|
2745
|
+
# @!attribute [rw] next_token
|
2746
|
+
# An opaque pagination token indicating where to continue the listing
|
2747
|
+
# of sensor statistics.
|
2748
|
+
# @return [String]
|
2749
|
+
#
|
2750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatisticsRequest AWS API Documentation
|
2751
|
+
#
|
2752
|
+
class ListSensorStatisticsRequest < Struct.new(
|
2753
|
+
:dataset_name,
|
2754
|
+
:ingestion_job_id,
|
2755
|
+
:max_results,
|
2756
|
+
:next_token)
|
2757
|
+
SENSITIVE = []
|
2758
|
+
include Aws::Structure
|
2759
|
+
end
|
2760
|
+
|
2761
|
+
# @!attribute [rw] sensor_statistics_summaries
|
2762
|
+
# Provides ingestion-based statistics regarding the specified sensor
|
2763
|
+
# with respect to various validation types, such as whether data
|
2764
|
+
# exists, the number and percentage of missing values, and the number
|
2765
|
+
# and percentage of duplicate timestamps.
|
2766
|
+
# @return [Array<Types::SensorStatisticsSummary>]
|
2767
|
+
#
|
2768
|
+
# @!attribute [rw] next_token
|
2769
|
+
# An opaque pagination token indicating where to continue the listing
|
2770
|
+
# of sensor statistics.
|
2771
|
+
# @return [String]
|
2772
|
+
#
|
2773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatisticsResponse AWS API Documentation
|
2774
|
+
#
|
2775
|
+
class ListSensorStatisticsResponse < Struct.new(
|
2776
|
+
:sensor_statistics_summaries,
|
2777
|
+
:next_token)
|
2778
|
+
SENSITIVE = []
|
2779
|
+
include Aws::Structure
|
2780
|
+
end
|
2781
|
+
|
1733
2782
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
1734
2783
|
# data as a hash:
|
1735
2784
|
#
|
@@ -1762,6 +2811,41 @@ module Aws::LookoutEquipment
|
|
1762
2811
|
include Aws::Structure
|
1763
2812
|
end
|
1764
2813
|
|
2814
|
+
# Entity that comprises information on sensors that have sensor data
|
2815
|
+
# completely missing.
|
2816
|
+
#
|
2817
|
+
# @!attribute [rw] affected_sensor_count
|
2818
|
+
# Indicates the number of sensors that have data missing completely.
|
2819
|
+
# @return [Integer]
|
2820
|
+
#
|
2821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MissingCompleteSensorData AWS API Documentation
|
2822
|
+
#
|
2823
|
+
class MissingCompleteSensorData < Struct.new(
|
2824
|
+
:affected_sensor_count)
|
2825
|
+
SENSITIVE = []
|
2826
|
+
include Aws::Structure
|
2827
|
+
end
|
2828
|
+
|
2829
|
+
# Entity that comprises aggregated information on sensors having missing
|
2830
|
+
# data.
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] affected_sensor_count
|
2833
|
+
# Indicates the number of sensors that have atleast some data missing.
|
2834
|
+
# @return [Integer]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] total_number_of_missing_values
|
2837
|
+
# Indicates the total number of missing values across all the sensors.
|
2838
|
+
# @return [Integer]
|
2839
|
+
#
|
2840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MissingSensorData AWS API Documentation
|
2841
|
+
#
|
2842
|
+
class MissingSensorData < Struct.new(
|
2843
|
+
:affected_sensor_count,
|
2844
|
+
:total_number_of_missing_values)
|
2845
|
+
SENSITIVE = []
|
2846
|
+
include Aws::Structure
|
2847
|
+
end
|
2848
|
+
|
1765
2849
|
# Provides information about the specified ML model, including dataset
|
1766
2850
|
# and model names and ARNs, as well as status.
|
1767
2851
|
#
|
@@ -1803,6 +2887,42 @@ module Aws::LookoutEquipment
|
|
1803
2887
|
include Aws::Structure
|
1804
2888
|
end
|
1805
2889
|
|
2890
|
+
# Entity that comprises information on monotonic values in the data.
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] status
|
2893
|
+
# Indicates whether there is a potential data issue related to having
|
2894
|
+
# monotonic values.
|
2895
|
+
# @return [String]
|
2896
|
+
#
|
2897
|
+
# @!attribute [rw] monotonicity
|
2898
|
+
# Indicates the monotonicity of values. Can be INCREASING, DECREASING,
|
2899
|
+
# or STATIC.
|
2900
|
+
# @return [String]
|
2901
|
+
#
|
2902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MonotonicValues AWS API Documentation
|
2903
|
+
#
|
2904
|
+
class MonotonicValues < Struct.new(
|
2905
|
+
:status,
|
2906
|
+
:monotonicity)
|
2907
|
+
SENSITIVE = []
|
2908
|
+
include Aws::Structure
|
2909
|
+
end
|
2910
|
+
|
2911
|
+
# Entity that comprises information on operating modes in data.
|
2912
|
+
#
|
2913
|
+
# @!attribute [rw] status
|
2914
|
+
# Indicates whether there is a potential data issue related to having
|
2915
|
+
# multiple operating modes.
|
2916
|
+
# @return [String]
|
2917
|
+
#
|
2918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/MultipleOperatingModes AWS API Documentation
|
2919
|
+
#
|
2920
|
+
class MultipleOperatingModes < Struct.new(
|
2921
|
+
:status)
|
2922
|
+
SENSITIVE = []
|
2923
|
+
include Aws::Structure
|
2924
|
+
end
|
2925
|
+
|
1806
2926
|
# The resource requested could not be found. Verify the resource ID and
|
1807
2927
|
# retry your request.
|
1808
2928
|
#
|
@@ -1838,6 +2958,112 @@ module Aws::LookoutEquipment
|
|
1838
2958
|
include Aws::Structure
|
1839
2959
|
end
|
1840
2960
|
|
2961
|
+
# Summary of ingestion statistics like whether data exists, number of
|
2962
|
+
# missing values, number of invalid values and so on related to the
|
2963
|
+
# particular sensor.
|
2964
|
+
#
|
2965
|
+
# @!attribute [rw] component_name
|
2966
|
+
# Name of the component to which the particular sensor belongs for
|
2967
|
+
# which the statistics belong to.
|
2968
|
+
# @return [String]
|
2969
|
+
#
|
2970
|
+
# @!attribute [rw] sensor_name
|
2971
|
+
# Name of the sensor that the statistics belong to.
|
2972
|
+
# @return [String]
|
2973
|
+
#
|
2974
|
+
# @!attribute [rw] data_exists
|
2975
|
+
# Parameter that indicates whether data exists for the sensor that the
|
2976
|
+
# statistics belong to.
|
2977
|
+
# @return [Boolean]
|
2978
|
+
#
|
2979
|
+
# @!attribute [rw] missing_values
|
2980
|
+
# Parameter that describes the total number of, and percentage of,
|
2981
|
+
# values that are missing for the sensor that the statistics belong
|
2982
|
+
# to.
|
2983
|
+
# @return [Types::CountPercent]
|
2984
|
+
#
|
2985
|
+
# @!attribute [rw] invalid_values
|
2986
|
+
# Parameter that describes the total number of, and percentage of,
|
2987
|
+
# values that are invalid for the sensor that the statistics belong
|
2988
|
+
# to.
|
2989
|
+
# @return [Types::CountPercent]
|
2990
|
+
#
|
2991
|
+
# @!attribute [rw] invalid_date_entries
|
2992
|
+
# Parameter that describes the total number of invalid date entries
|
2993
|
+
# associated with the sensor that the statistics belong to.
|
2994
|
+
# @return [Types::CountPercent]
|
2995
|
+
#
|
2996
|
+
# @!attribute [rw] duplicate_timestamps
|
2997
|
+
# Parameter that describes the total number of duplicate timestamp
|
2998
|
+
# records associated with the sensor that the statistics belong to.
|
2999
|
+
# @return [Types::CountPercent]
|
3000
|
+
#
|
3001
|
+
# @!attribute [rw] categorical_values
|
3002
|
+
# Parameter that describes potential risk about whether data
|
3003
|
+
# associated with the sensor is categorical.
|
3004
|
+
# @return [Types::CategoricalValues]
|
3005
|
+
#
|
3006
|
+
# @!attribute [rw] multiple_operating_modes
|
3007
|
+
# Parameter that describes potential risk about whether data
|
3008
|
+
# associated with the sensor has more than one operating mode.
|
3009
|
+
# @return [Types::MultipleOperatingModes]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] large_timestamp_gaps
|
3012
|
+
# Parameter that describes potential risk about whether data
|
3013
|
+
# associated with the sensor contains one or more large gaps between
|
3014
|
+
# consecutive timestamps.
|
3015
|
+
# @return [Types::LargeTimestampGaps]
|
3016
|
+
#
|
3017
|
+
# @!attribute [rw] monotonic_values
|
3018
|
+
# Parameter that describes potential risk about whether data
|
3019
|
+
# associated with the sensor is mostly monotonic.
|
3020
|
+
# @return [Types::MonotonicValues]
|
3021
|
+
#
|
3022
|
+
# @!attribute [rw] data_start_time
|
3023
|
+
# Indicates the time reference to indicate the beginning of valid data
|
3024
|
+
# associated with the sensor that the statistics belong to.
|
3025
|
+
# @return [Time]
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] data_end_time
|
3028
|
+
# Indicates the time reference to indicate the end of valid data
|
3029
|
+
# associated with the sensor that the statistics belong to.
|
3030
|
+
# @return [Time]
|
3031
|
+
#
|
3032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/SensorStatisticsSummary AWS API Documentation
|
3033
|
+
#
|
3034
|
+
class SensorStatisticsSummary < Struct.new(
|
3035
|
+
:component_name,
|
3036
|
+
:sensor_name,
|
3037
|
+
:data_exists,
|
3038
|
+
:missing_values,
|
3039
|
+
:invalid_values,
|
3040
|
+
:invalid_date_entries,
|
3041
|
+
:duplicate_timestamps,
|
3042
|
+
:categorical_values,
|
3043
|
+
:multiple_operating_modes,
|
3044
|
+
:large_timestamp_gaps,
|
3045
|
+
:monotonic_values,
|
3046
|
+
:data_start_time,
|
3047
|
+
:data_end_time)
|
3048
|
+
SENSITIVE = []
|
3049
|
+
include Aws::Structure
|
3050
|
+
end
|
3051
|
+
|
3052
|
+
# Entity that comprises information on sensors that have shorter date
|
3053
|
+
# range.
|
3054
|
+
#
|
3055
|
+
# @!attribute [rw] affected_sensor_count
|
3056
|
+
# Indicates the number of sensors that have less than 90 days of data.
|
3057
|
+
# @return [Integer]
|
3058
|
+
#
|
3059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/SensorsWithShortDateRange AWS API Documentation
|
3060
|
+
#
|
3061
|
+
class SensorsWithShortDateRange < Struct.new(
|
3062
|
+
:affected_sensor_count)
|
3063
|
+
SENSITIVE = []
|
3064
|
+
include Aws::Structure
|
3065
|
+
end
|
3066
|
+
|
1841
3067
|
# Resource limitations have been exceeded.
|
1842
3068
|
#
|
1843
3069
|
# @!attribute [rw] message
|
@@ -1860,6 +3086,7 @@ module Aws::LookoutEquipment
|
|
1860
3086
|
# s3_input_configuration: { # required
|
1861
3087
|
# bucket: "S3Bucket", # required
|
1862
3088
|
# prefix: "S3Prefix",
|
3089
|
+
# key_pattern: "KeyPattern",
|
1863
3090
|
# },
|
1864
3091
|
# },
|
1865
3092
|
# role_arn: "IamRoleArn", # required
|
@@ -2099,6 +3326,22 @@ module Aws::LookoutEquipment
|
|
2099
3326
|
include Aws::Structure
|
2100
3327
|
end
|
2101
3328
|
|
3329
|
+
# Entity that comprises information abount unsupported timestamps in the
|
3330
|
+
# dataset.
|
3331
|
+
#
|
3332
|
+
# @!attribute [rw] total_number_of_unsupported_timestamps
|
3333
|
+
# Indicates the total number of unsupported timestamps across the
|
3334
|
+
# ingested data.
|
3335
|
+
# @return [Integer]
|
3336
|
+
#
|
3337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UnsupportedTimestamps AWS API Documentation
|
3338
|
+
#
|
3339
|
+
class UnsupportedTimestamps < Struct.new(
|
3340
|
+
:total_number_of_unsupported_timestamps)
|
3341
|
+
SENSITIVE = []
|
3342
|
+
include Aws::Structure
|
3343
|
+
end
|
3344
|
+
|
2102
3345
|
# @note When making an API call, you may pass UntagResourceRequest
|
2103
3346
|
# data as a hash:
|
2104
3347
|
#
|
@@ -2212,6 +3455,35 @@ module Aws::LookoutEquipment
|
|
2212
3455
|
include Aws::Structure
|
2213
3456
|
end
|
2214
3457
|
|
3458
|
+
# @note When making an API call, you may pass UpdateLabelGroupRequest
|
3459
|
+
# data as a hash:
|
3460
|
+
#
|
3461
|
+
# {
|
3462
|
+
# label_group_name: "LabelGroupName", # required
|
3463
|
+
# fault_codes: ["FaultCode"],
|
3464
|
+
# }
|
3465
|
+
#
|
3466
|
+
# @!attribute [rw] label_group_name
|
3467
|
+
# The name of the label group to be updated.
|
3468
|
+
# @return [String]
|
3469
|
+
#
|
3470
|
+
# @!attribute [rw] fault_codes
|
3471
|
+
# Updates the code indicating the type of anomaly associated with the
|
3472
|
+
# label.
|
3473
|
+
#
|
3474
|
+
# Data in this field will be retained for service usage. Follow best
|
3475
|
+
# practices for the security of your data.
|
3476
|
+
# @return [Array<String>]
|
3477
|
+
#
|
3478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroupRequest AWS API Documentation
|
3479
|
+
#
|
3480
|
+
class UpdateLabelGroupRequest < Struct.new(
|
3481
|
+
:label_group_name,
|
3482
|
+
:fault_codes)
|
3483
|
+
SENSITIVE = []
|
3484
|
+
include Aws::Structure
|
3485
|
+
end
|
3486
|
+
|
2215
3487
|
# The input fails to satisfy constraints specified by Amazon Lookout for
|
2216
3488
|
# Equipment or a related AWS service that's being utilized.
|
2217
3489
|
#
|