aws-sdk-lookoutequipment 1.12.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutequipment/client.rb +452 -21
- data/lib/aws-sdk-lookoutequipment/client_api.rb +268 -1
- data/lib/aws-sdk-lookoutequipment/types.rb +652 -25
- data/lib/aws-sdk-lookoutequipment.rb +1 -1
- metadata +2 -2
@@ -202,25 +202,36 @@ module Aws::LookoutEquipment
|
|
202
202
|
# @return [String]
|
203
203
|
#
|
204
204
|
# @!attribute [rw] data_delay_offset_in_minutes
|
205
|
-
#
|
206
|
-
#
|
207
|
-
# delay
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
# delay
|
212
|
-
#
|
213
|
-
#
|
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
|
214
220
|
# @return [Integer]
|
215
221
|
#
|
216
222
|
# @!attribute [rw] data_upload_frequency
|
217
|
-
# How often data is uploaded to the source S3 bucket for the
|
218
|
-
# data. The value chosen is the length of time between data
|
219
|
-
# For instance, if you select 5 minutes, Amazon Lookout for
|
220
|
-
# will upload the real-time data to the source bucket once
|
221
|
-
# minutes. This frequency also determines how often Amazon
|
222
|
-
#
|
223
|
-
#
|
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
|
224
235
|
# @return [String]
|
225
236
|
#
|
226
237
|
# @!attribute [rw] data_input_configuration
|
@@ -296,6 +307,172 @@ module Aws::LookoutEquipment
|
|
296
307
|
include Aws::Structure
|
297
308
|
end
|
298
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
|
+
|
299
476
|
# @note When making an API call, you may pass CreateModelRequest
|
300
477
|
# data as a hash:
|
301
478
|
#
|
@@ -306,10 +483,11 @@ module Aws::LookoutEquipment
|
|
306
483
|
# inline_data_schema: "InlineDataSchema",
|
307
484
|
# },
|
308
485
|
# labels_input_configuration: {
|
309
|
-
# s3_input_configuration: {
|
486
|
+
# s3_input_configuration: {
|
310
487
|
# bucket: "S3Bucket", # required
|
311
488
|
# prefix: "S3Prefix",
|
312
489
|
# },
|
490
|
+
# label_group_name: "LabelGroupName",
|
313
491
|
# },
|
314
492
|
# client_token: "IdempotenceToken", # required
|
315
493
|
# training_data_start_time: Time.now,
|
@@ -657,6 +835,54 @@ module Aws::LookoutEquipment
|
|
657
835
|
include Aws::Structure
|
658
836
|
end
|
659
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
|
+
|
660
886
|
# @note When making an API call, you may pass DeleteModelRequest
|
661
887
|
# data as a hash:
|
662
888
|
#
|
@@ -977,6 +1203,12 @@ module Aws::LookoutEquipment
|
|
977
1203
|
# scheduler data by Amazon Lookout for Equipment.
|
978
1204
|
# @return [String]
|
979
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
|
+
#
|
980
1212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceSchedulerResponse AWS API Documentation
|
981
1213
|
#
|
982
1214
|
class DescribeInferenceSchedulerResponse < Struct.new(
|
@@ -992,7 +1224,148 @@ module Aws::LookoutEquipment
|
|
992
1224
|
:data_input_configuration,
|
993
1225
|
:data_output_configuration,
|
994
1226
|
:role_arn,
|
995
|
-
:server_side_kms_key_id
|
1227
|
+
:server_side_kms_key_id,
|
1228
|
+
:latest_inference_result)
|
1229
|
+
SENSITIVE = []
|
1230
|
+
include Aws::Structure
|
1231
|
+
end
|
1232
|
+
|
1233
|
+
# @note When making an API call, you may pass DescribeLabelGroupRequest
|
1234
|
+
# data as a hash:
|
1235
|
+
#
|
1236
|
+
# {
|
1237
|
+
# label_group_name: "LabelGroupName", # required
|
1238
|
+
# }
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] label_group_name
|
1241
|
+
# Returns the name of the label group.
|
1242
|
+
# @return [String]
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelGroupRequest AWS API Documentation
|
1245
|
+
#
|
1246
|
+
class DescribeLabelGroupRequest < Struct.new(
|
1247
|
+
:label_group_name)
|
1248
|
+
SENSITIVE = []
|
1249
|
+
include Aws::Structure
|
1250
|
+
end
|
1251
|
+
|
1252
|
+
# @!attribute [rw] label_group_name
|
1253
|
+
# The name of the label group.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] label_group_arn
|
1257
|
+
# The ARN of the label group.
|
1258
|
+
# @return [String]
|
1259
|
+
#
|
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.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] label_id
|
1298
|
+
# Returns the ID of the label.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
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.
|
1312
|
+
# @return [String]
|
1313
|
+
#
|
1314
|
+
# @!attribute [rw] label_group_arn
|
1315
|
+
# The ARN of the requested label group.
|
1316
|
+
# @return [String]
|
1317
|
+
#
|
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.
|
1324
|
+
# @return [Time]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] end_time
|
1327
|
+
# The end time of the requested label.
|
1328
|
+
# @return [Time]
|
1329
|
+
#
|
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)
|
996
1369
|
SENSITIVE = []
|
997
1370
|
include Aws::Structure
|
998
1371
|
end
|
@@ -1502,6 +1875,12 @@ module Aws::LookoutEquipment
|
|
1502
1875
|
# example, it starts once every 5 minutes.
|
1503
1876
|
# @return [String]
|
1504
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
|
+
#
|
1505
1884
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceSchedulerSummary AWS API Documentation
|
1506
1885
|
#
|
1507
1886
|
class InferenceSchedulerSummary < Struct.new(
|
@@ -1511,7 +1890,8 @@ module Aws::LookoutEquipment
|
|
1511
1890
|
:inference_scheduler_arn,
|
1512
1891
|
:status,
|
1513
1892
|
:data_delay_offset_in_minutes,
|
1514
|
-
:data_upload_frequency
|
1893
|
+
:data_upload_frequency,
|
1894
|
+
:latest_inference_result)
|
1515
1895
|
SENSITIVE = []
|
1516
1896
|
include Aws::Structure
|
1517
1897
|
end
|
@@ -1667,6 +2047,92 @@ module Aws::LookoutEquipment
|
|
1667
2047
|
include Aws::Structure
|
1668
2048
|
end
|
1669
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
|
+
|
1670
2136
|
# Contains the configuration information for the S3 location being used
|
1671
2137
|
# to hold label data.
|
1672
2138
|
#
|
@@ -1674,10 +2140,11 @@ module Aws::LookoutEquipment
|
|
1674
2140
|
# data as a hash:
|
1675
2141
|
#
|
1676
2142
|
# {
|
1677
|
-
# s3_input_configuration: {
|
2143
|
+
# s3_input_configuration: {
|
1678
2144
|
# bucket: "S3Bucket", # required
|
1679
2145
|
# prefix: "S3Prefix",
|
1680
2146
|
# },
|
2147
|
+
# label_group_name: "LabelGroupName",
|
1681
2148
|
# }
|
1682
2149
|
#
|
1683
2150
|
# @!attribute [rw] s3_input_configuration
|
@@ -1685,10 +2152,15 @@ module Aws::LookoutEquipment
|
|
1685
2152
|
# label data.
|
1686
2153
|
# @return [Types::LabelsS3InputConfiguration]
|
1687
2154
|
#
|
2155
|
+
# @!attribute [rw] label_group_name
|
2156
|
+
# The name of the label group to be used for label data.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
1688
2159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/LabelsInputConfiguration AWS API Documentation
|
1689
2160
|
#
|
1690
2161
|
class LabelsInputConfiguration < Struct.new(
|
1691
|
-
:s3_input_configuration
|
2162
|
+
:s3_input_configuration,
|
2163
|
+
:label_group_name)
|
1692
2164
|
SENSITIVE = []
|
1693
2165
|
include Aws::Structure
|
1694
2166
|
end
|
@@ -1880,13 +2352,13 @@ module Aws::LookoutEquipment
|
|
1880
2352
|
# @return [String]
|
1881
2353
|
#
|
1882
2354
|
# @!attribute [rw] interval_start_time
|
1883
|
-
# Lookout for Equipment will return all the inference events with
|
1884
|
-
#
|
2355
|
+
# Lookout for Equipment will return all the inference events with an
|
2356
|
+
# end time equal to or greater than the start time given.
|
1885
2357
|
# @return [Time]
|
1886
2358
|
#
|
1887
2359
|
# @!attribute [rw] interval_end_time
|
1888
|
-
#
|
1889
|
-
#
|
2360
|
+
# Returns all the inference events with an end start time equal to or
|
2361
|
+
# greater than less than the end time given
|
1890
2362
|
# @return [Time]
|
1891
2363
|
#
|
1892
2364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsRequest AWS API Documentation
|
@@ -2054,6 +2526,132 @@ module Aws::LookoutEquipment
|
|
2054
2526
|
include Aws::Structure
|
2055
2527
|
end
|
2056
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
|
+
|
2057
2655
|
# @note When making an API call, you may pass ListModelsRequest
|
2058
2656
|
# data as a hash:
|
2059
2657
|
#
|
@@ -2857,6 +3455,35 @@ module Aws::LookoutEquipment
|
|
2857
3455
|
include Aws::Structure
|
2858
3456
|
end
|
2859
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
|
+
|
2860
3487
|
# The input fails to satisfy constraints specified by Amazon Lookout for
|
2861
3488
|
# Equipment or a related AWS service that's being utilized.
|
2862
3489
|
#
|