aws-sdk-lookoutequipment 1.21.0 → 1.23.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -138,8 +138,8 @@ module Aws::LookoutEquipment
138
138
  end
139
139
 
140
140
  # @!attribute [rw] model_name
141
- # The name of the previously trained ML model being used to create the
142
- # inference scheduler.
141
+ # The name of the previously trained machine learning model being used
142
+ # to create the inference scheduler.
143
143
  # @return [String]
144
144
  #
145
145
  # @!attribute [rw] inference_scheduler_name
@@ -301,7 +301,8 @@ module Aws::LookoutEquipment
301
301
  # @return [String]
302
302
  #
303
303
  # @!attribute [rw] label_group_arn
304
- # The ARN of the label group that you have created.
304
+ # The Amazon Resource Name (ARN) of the label group that you have
305
+ # created.
305
306
  # @return [String]
306
307
  #
307
308
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelGroupResponse AWS API Documentation
@@ -390,20 +391,21 @@ module Aws::LookoutEquipment
390
391
  end
391
392
 
392
393
  # @!attribute [rw] model_name
393
- # The name for the ML model to be created.
394
+ # The name for the machine learning model to be created.
394
395
  # @return [String]
395
396
  #
396
397
  # @!attribute [rw] dataset_name
397
- # The name of the dataset for the ML model being created.
398
+ # The name of the dataset for the machine learning model being
399
+ # created.
398
400
  # @return [String]
399
401
  #
400
402
  # @!attribute [rw] dataset_schema
401
- # The data schema for the ML model being created.
403
+ # The data schema for the machine learning model being created.
402
404
  # @return [Types::DatasetSchema]
403
405
  #
404
406
  # @!attribute [rw] labels_input_configuration
405
- # The input configuration for the labels being used for the ML model
406
- # that's being created.
407
+ # The input configuration for the labels being used for the machine
408
+ # learning model that's being created.
407
409
  # @return [Types::LabelsInputConfiguration]
408
410
  #
409
411
  # @!attribute [rw] client_token
@@ -416,27 +418,27 @@ module Aws::LookoutEquipment
416
418
  #
417
419
  # @!attribute [rw] training_data_start_time
418
420
  # Indicates the time reference in the dataset that should be used to
419
- # begin the subset of training data for the ML model.
421
+ # begin the subset of training data for the machine learning model.
420
422
  # @return [Time]
421
423
  #
422
424
  # @!attribute [rw] training_data_end_time
423
425
  # Indicates the time reference in the dataset that should be used to
424
- # end the subset of training data for the ML model.
426
+ # end the subset of training data for the machine learning model.
425
427
  # @return [Time]
426
428
  #
427
429
  # @!attribute [rw] evaluation_data_start_time
428
430
  # Indicates the time reference in the dataset that should be used to
429
- # begin the subset of evaluation data for the ML model.
431
+ # begin the subset of evaluation data for the machine learning model.
430
432
  # @return [Time]
431
433
  #
432
434
  # @!attribute [rw] evaluation_data_end_time
433
435
  # Indicates the time reference in the dataset that should be used to
434
- # end the subset of evaluation data for the ML model.
436
+ # end the subset of evaluation data for the machine learning model.
435
437
  # @return [Time]
436
438
  #
437
439
  # @!attribute [rw] role_arn
438
440
  # The Amazon Resource Name (ARN) of a role with permission to access
439
- # the data source being used to create the ML model.
441
+ # the data source being used to create the machine learning model.
440
442
  # @return [String]
441
443
  #
442
444
  # @!attribute [rw] data_pre_processing_configuration
@@ -459,7 +461,7 @@ module Aws::LookoutEquipment
459
461
  # @return [String]
460
462
  #
461
463
  # @!attribute [rw] tags
462
- # Any tags associated with the ML model being created.
464
+ # Any tags associated with the machine learning model being created.
463
465
  # @return [Array<Types::Tag>]
464
466
  #
465
467
  # @!attribute [rw] off_condition
@@ -506,6 +508,91 @@ module Aws::LookoutEquipment
506
508
  include Aws::Structure
507
509
  end
508
510
 
511
+ # @!attribute [rw] model_name
512
+ # The name of the model to add the retraining scheduler to.
513
+ # @return [String]
514
+ #
515
+ # @!attribute [rw] retraining_start_date
516
+ # The start date for the retraining scheduler. Lookout for Equipment
517
+ # truncates the time you provide to the nearest UTC day.
518
+ # @return [Time]
519
+ #
520
+ # @!attribute [rw] retraining_frequency
521
+ # This parameter uses the [ISO 8601][1] standard to set the frequency
522
+ # at which you want retraining to occur in terms of Years, Months,
523
+ # and/or Days (note: other parameters like Time are not currently
524
+ # supported). The minimum value is 30 days (P30D) and the maximum
525
+ # value is 1 year (P1Y). For example, the following values are valid:
526
+ #
527
+ # * P3M15D – Every 3 months and 15 days
528
+ #
529
+ # * P2M – Every 2 months
530
+ #
531
+ # * P150D – Every 150 days
532
+ #
533
+ #
534
+ #
535
+ # [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
536
+ # @return [String]
537
+ #
538
+ # @!attribute [rw] lookback_window
539
+ # The number of past days of data that will be used for retraining.
540
+ # @return [String]
541
+ #
542
+ # @!attribute [rw] promote_mode
543
+ # Indicates how the service will use new models. In `MANAGED` mode,
544
+ # new models will automatically be used for inference if they have
545
+ # better performance than the current model. In `MANUAL` mode, the new
546
+ # models will not be used [until they are manually activated][1].
547
+ #
548
+ #
549
+ #
550
+ # [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] client_token
554
+ # A unique identifier for the request. If you do not set the client
555
+ # request token, Amazon Lookout for Equipment generates one.
556
+ #
557
+ # **A suitable default value is auto-generated.** You should normally
558
+ # not need to pass this option.
559
+ # @return [String]
560
+ #
561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateRetrainingSchedulerRequest AWS API Documentation
562
+ #
563
+ class CreateRetrainingSchedulerRequest < Struct.new(
564
+ :model_name,
565
+ :retraining_start_date,
566
+ :retraining_frequency,
567
+ :lookback_window,
568
+ :promote_mode,
569
+ :client_token)
570
+ SENSITIVE = []
571
+ include Aws::Structure
572
+ end
573
+
574
+ # @!attribute [rw] model_name
575
+ # The name of the model that you added the retraining scheduler to.
576
+ # @return [String]
577
+ #
578
+ # @!attribute [rw] model_arn
579
+ # The ARN of the model that you added the retraining scheduler to.
580
+ # @return [String]
581
+ #
582
+ # @!attribute [rw] status
583
+ # The status of the retraining scheduler.
584
+ # @return [String]
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateRetrainingSchedulerResponse AWS API Documentation
587
+ #
588
+ class CreateRetrainingSchedulerResponse < Struct.new(
589
+ :model_name,
590
+ :model_arn,
591
+ :status)
592
+ SENSITIVE = []
593
+ include Aws::Structure
594
+ end
595
+
509
596
  # Provides information about a specified data ingestion job, including
510
597
  # dataset information, data ingestion configuration, and status.
511
598
  #
@@ -623,6 +710,7 @@ module Aws::LookoutEquipment
623
710
  # dataset.
624
711
  #
625
712
  # @!attribute [rw] inline_data_schema
713
+ # The data schema used within the given dataset.
626
714
  # @return [String]
627
715
  #
628
716
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DatasetSchema AWS API Documentation
@@ -722,7 +810,7 @@ module Aws::LookoutEquipment
722
810
  end
723
811
 
724
812
  # @!attribute [rw] model_name
725
- # The name of the ML model to be deleted.
813
+ # The name of the machine learning model to be deleted.
726
814
  # @return [String]
727
815
  #
728
816
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteModelRequest AWS API Documentation
@@ -733,6 +821,31 @@ module Aws::LookoutEquipment
733
821
  include Aws::Structure
734
822
  end
735
823
 
824
+ # @!attribute [rw] resource_arn
825
+ # The Amazon Resource Name (ARN) of the resource for which the
826
+ # resource policy should be deleted.
827
+ # @return [String]
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteResourcePolicyRequest AWS API Documentation
830
+ #
831
+ class DeleteResourcePolicyRequest < Struct.new(
832
+ :resource_arn)
833
+ SENSITIVE = []
834
+ include Aws::Structure
835
+ end
836
+
837
+ # @!attribute [rw] model_name
838
+ # The name of the model whose retraining scheduler you want to delete.
839
+ # @return [String]
840
+ #
841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteRetrainingSchedulerRequest AWS API Documentation
842
+ #
843
+ class DeleteRetrainingSchedulerRequest < Struct.new(
844
+ :model_name)
845
+ SENSITIVE = []
846
+ include Aws::Structure
847
+ end
848
+
736
849
  # @!attribute [rw] job_id
737
850
  # The job ID of the data ingestion job.
738
851
  # @return [String]
@@ -809,6 +922,11 @@ module Aws::LookoutEquipment
809
922
  # successfully ingested during this specific ingestion job.
810
923
  # @return [Time]
811
924
  #
925
+ # @!attribute [rw] source_dataset_arn
926
+ # The Amazon Resource Name (ARN) of the source dataset from which the
927
+ # data used for the data ingestion job was imported from.
928
+ # @return [String]
929
+ #
812
930
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJobResponse AWS API Documentation
813
931
  #
814
932
  class DescribeDataIngestionJobResponse < Struct.new(
@@ -824,7 +942,8 @@ module Aws::LookoutEquipment
824
942
  :status_detail,
825
943
  :ingested_data_size,
826
944
  :data_start_time,
827
- :data_end_time)
945
+ :data_end_time,
946
+ :source_dataset_arn)
828
947
  SENSITIVE = []
829
948
  include Aws::Structure
830
949
  end
@@ -907,6 +1026,11 @@ module Aws::LookoutEquipment
907
1026
  # particular dataset.
908
1027
  # @return [Time]
909
1028
  #
1029
+ # @!attribute [rw] source_dataset_arn
1030
+ # The Amazon Resource Name (ARN) of the source dataset from which the
1031
+ # current data being described was imported from.
1032
+ # @return [String]
1033
+ #
910
1034
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDatasetResponse AWS API Documentation
911
1035
  #
912
1036
  class DescribeDatasetResponse < Struct.new(
@@ -922,7 +1046,8 @@ module Aws::LookoutEquipment
922
1046
  :ingested_files_summary,
923
1047
  :role_arn,
924
1048
  :data_start_time,
925
- :data_end_time)
1049
+ :data_end_time,
1050
+ :source_dataset_arn)
926
1051
  SENSITIVE = []
927
1052
  include Aws::Structure
928
1053
  end
@@ -940,12 +1065,13 @@ module Aws::LookoutEquipment
940
1065
  end
941
1066
 
942
1067
  # @!attribute [rw] model_arn
943
- # The Amazon Resource Name (ARN) of the ML model of the inference
944
- # scheduler being described.
1068
+ # The Amazon Resource Name (ARN) of the machine learning model of the
1069
+ # inference scheduler being described.
945
1070
  # @return [String]
946
1071
  #
947
1072
  # @!attribute [rw] model_name
948
- # The name of the ML model of the inference scheduler being described.
1073
+ # The name of the machine learning model of the inference scheduler
1074
+ # being described.
949
1075
  # @return [String]
950
1076
  #
951
1077
  # @!attribute [rw] inference_scheduler_name
@@ -1057,7 +1183,7 @@ module Aws::LookoutEquipment
1057
1183
  # @return [String]
1058
1184
  #
1059
1185
  # @!attribute [rw] label_group_arn
1060
- # The ARN of the label group.
1186
+ # The Amazon Resource Name (ARN) of the label group.
1061
1187
  # @return [String]
1062
1188
  #
1063
1189
  # @!attribute [rw] fault_codes
@@ -1107,7 +1233,7 @@ module Aws::LookoutEquipment
1107
1233
  # @return [String]
1108
1234
  #
1109
1235
  # @!attribute [rw] label_group_arn
1110
- # The ARN of the requested label group.
1236
+ # The Amazon Resource Name (ARN) of the requested label group.
1111
1237
  # @return [String]
1112
1238
  #
1113
1239
  # @!attribute [rw] label_id
@@ -1166,7 +1292,7 @@ module Aws::LookoutEquipment
1166
1292
  end
1167
1293
 
1168
1294
  # @!attribute [rw] model_name
1169
- # The name of the ML model to be described.
1295
+ # The name of the machine learning model to be described.
1170
1296
  # @return [String]
1171
1297
  #
1172
1298
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelRequest AWS API Documentation
@@ -1178,20 +1304,22 @@ module Aws::LookoutEquipment
1178
1304
  end
1179
1305
 
1180
1306
  # @!attribute [rw] model_name
1181
- # The name of the ML model being described.
1307
+ # The name of the machine learning model being described.
1182
1308
  # @return [String]
1183
1309
  #
1184
1310
  # @!attribute [rw] model_arn
1185
- # The Amazon Resource Name (ARN) of the ML model being described.
1311
+ # The Amazon Resource Name (ARN) of the machine learning model being
1312
+ # described.
1186
1313
  # @return [String]
1187
1314
  #
1188
1315
  # @!attribute [rw] dataset_name
1189
- # The name of the dataset being used by the ML being described.
1316
+ # The name of the dataset being used by the machine learning being
1317
+ # described.
1190
1318
  # @return [String]
1191
1319
  #
1192
1320
  # @!attribute [rw] dataset_arn
1193
- # The Amazon Resouce Name (ARN) of the dataset used to create the ML
1194
- # model being described.
1321
+ # The Amazon Resouce Name (ARN) of the dataset used to create the
1322
+ # machine learning model being described.
1195
1323
  # @return [String]
1196
1324
  #
1197
1325
  # @!attribute [rw] schema
@@ -1206,27 +1334,27 @@ module Aws::LookoutEquipment
1206
1334
  #
1207
1335
  # @!attribute [rw] training_data_start_time
1208
1336
  # Indicates the time reference in the dataset that was used to begin
1209
- # the subset of training data for the ML model.
1337
+ # the subset of training data for the machine learning model.
1210
1338
  # @return [Time]
1211
1339
  #
1212
1340
  # @!attribute [rw] training_data_end_time
1213
1341
  # Indicates the time reference in the dataset that was used to end the
1214
- # subset of training data for the ML model.
1342
+ # subset of training data for the machine learning model.
1215
1343
  # @return [Time]
1216
1344
  #
1217
1345
  # @!attribute [rw] evaluation_data_start_time
1218
1346
  # Indicates the time reference in the dataset that was used to begin
1219
- # the subset of evaluation data for the ML model.
1347
+ # the subset of evaluation data for the machine learning model.
1220
1348
  # @return [Time]
1221
1349
  #
1222
1350
  # @!attribute [rw] evaluation_data_end_time
1223
1351
  # Indicates the time reference in the dataset that was used to end the
1224
- # subset of evaluation data for the ML model.
1352
+ # subset of evaluation data for the machine learning model.
1225
1353
  # @return [Time]
1226
1354
  #
1227
1355
  # @!attribute [rw] role_arn
1228
1356
  # The Amazon Resource Name (ARN) of a role with permission to access
1229
- # the data source for the ML model being described.
1357
+ # the data source for the machine learning model being described.
1230
1358
  # @return [String]
1231
1359
  #
1232
1360
  # @!attribute [rw] data_pre_processing_configuration
@@ -1249,17 +1377,18 @@ module Aws::LookoutEquipment
1249
1377
  # @return [String]
1250
1378
  #
1251
1379
  # @!attribute [rw] training_execution_start_time
1252
- # Indicates the time at which the training of the ML model began.
1380
+ # Indicates the time at which the training of the machine learning
1381
+ # model began.
1253
1382
  # @return [Time]
1254
1383
  #
1255
1384
  # @!attribute [rw] training_execution_end_time
1256
- # Indicates the time at which the training of the ML model was
1257
- # completed.
1385
+ # Indicates the time at which the training of the machine learning
1386
+ # model was completed.
1258
1387
  # @return [Time]
1259
1388
  #
1260
1389
  # @!attribute [rw] failed_reason
1261
- # If the training of the ML model failed, this indicates the reason
1262
- # for that failure.
1390
+ # If the training of the machine learning model failed, this indicates
1391
+ # the reason for that failure.
1263
1392
  # @return [String]
1264
1393
  #
1265
1394
  # @!attribute [rw] model_metrics
@@ -1269,12 +1398,13 @@ module Aws::LookoutEquipment
1269
1398
  # @return [String]
1270
1399
  #
1271
1400
  # @!attribute [rw] last_updated_time
1272
- # Indicates the last time the ML model was updated. The type of update
1273
- # is not specified.
1401
+ # Indicates the last time the machine learning model was updated. The
1402
+ # type of update is not specified.
1274
1403
  # @return [Time]
1275
1404
  #
1276
1405
  # @!attribute [rw] created_at
1277
- # Indicates the time and date at which the ML model was created.
1406
+ # Indicates the time and date at which the machine learning model was
1407
+ # created.
1278
1408
  # @return [Time]
1279
1409
  #
1280
1410
  # @!attribute [rw] server_side_kms_key_id
@@ -1288,6 +1418,101 @@ module Aws::LookoutEquipment
1288
1418
  # not use data from this asset for training, evaluation, or inference.
1289
1419
  # @return [String]
1290
1420
  #
1421
+ # @!attribute [rw] source_model_version_arn
1422
+ # The Amazon Resource Name (ARN) of the source model version. This
1423
+ # field appears if the active model version was imported.
1424
+ # @return [String]
1425
+ #
1426
+ # @!attribute [rw] import_job_start_time
1427
+ # The date and time when the import job was started. This field
1428
+ # appears if the active model version was imported.
1429
+ # @return [Time]
1430
+ #
1431
+ # @!attribute [rw] import_job_end_time
1432
+ # The date and time when the import job was completed. This field
1433
+ # appears if the active model version was imported.
1434
+ # @return [Time]
1435
+ #
1436
+ # @!attribute [rw] active_model_version
1437
+ # The name of the model version used by the inference schedular when
1438
+ # running a scheduled inference execution.
1439
+ # @return [Integer]
1440
+ #
1441
+ # @!attribute [rw] active_model_version_arn
1442
+ # The Amazon Resource Name (ARN) of the model version used by the
1443
+ # inference scheduler when running a scheduled inference execution.
1444
+ # @return [String]
1445
+ #
1446
+ # @!attribute [rw] model_version_activated_at
1447
+ # The date the active model version was activated.
1448
+ # @return [Time]
1449
+ #
1450
+ # @!attribute [rw] previous_active_model_version
1451
+ # The model version that was set as the active model version prior to
1452
+ # the current active model version.
1453
+ # @return [Integer]
1454
+ #
1455
+ # @!attribute [rw] previous_active_model_version_arn
1456
+ # The ARN of the model version that was set as the active model
1457
+ # version prior to the current active model version.
1458
+ # @return [String]
1459
+ #
1460
+ # @!attribute [rw] previous_model_version_activated_at
1461
+ # The date and time when the previous active model version was
1462
+ # activated.
1463
+ # @return [Time]
1464
+ #
1465
+ # @!attribute [rw] prior_model_metrics
1466
+ # If the model version was retrained, this field shows a summary of
1467
+ # the performance of the prior model on the new training range. You
1468
+ # can use the information in this JSON-formatted object to compare the
1469
+ # new model version and the prior model version.
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] latest_scheduled_retraining_failed_reason
1473
+ # If the model version was generated by retraining and the training
1474
+ # failed, this indicates the reason for that failure.
1475
+ # @return [String]
1476
+ #
1477
+ # @!attribute [rw] latest_scheduled_retraining_status
1478
+ # Indicates the status of the most recent scheduled retraining run.
1479
+ # @return [String]
1480
+ #
1481
+ # @!attribute [rw] latest_scheduled_retraining_model_version
1482
+ # Indicates the most recent model version that was generated by
1483
+ # retraining.
1484
+ # @return [Integer]
1485
+ #
1486
+ # @!attribute [rw] latest_scheduled_retraining_start_time
1487
+ # Indicates the start time of the most recent scheduled retraining
1488
+ # run.
1489
+ # @return [Time]
1490
+ #
1491
+ # @!attribute [rw] latest_scheduled_retraining_available_data_in_days
1492
+ # Indicates the number of days of data used in the most recent
1493
+ # scheduled retraining run.
1494
+ # @return [Integer]
1495
+ #
1496
+ # @!attribute [rw] next_scheduled_retraining_start_date
1497
+ # Indicates the date and time that the next scheduled retraining run
1498
+ # will start on. Lookout for Equipment truncates the time you provide
1499
+ # to the nearest UTC day.
1500
+ # @return [Time]
1501
+ #
1502
+ # @!attribute [rw] accumulated_inference_data_start_time
1503
+ # Indicates the start time of the inference data that has been
1504
+ # accumulated.
1505
+ # @return [Time]
1506
+ #
1507
+ # @!attribute [rw] accumulated_inference_data_end_time
1508
+ # Indicates the end time of the inference data that has been
1509
+ # accumulated.
1510
+ # @return [Time]
1511
+ #
1512
+ # @!attribute [rw] retraining_scheduler_status
1513
+ # Indicates the status of the retraining scheduler.
1514
+ # @return [String]
1515
+ #
1291
1516
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelResponse AWS API Documentation
1292
1517
  #
1293
1518
  class DescribeModelResponse < Struct.new(
@@ -1311,145 +1536,696 @@ module Aws::LookoutEquipment
1311
1536
  :last_updated_time,
1312
1537
  :created_at,
1313
1538
  :server_side_kms_key_id,
1314
- :off_condition)
1539
+ :off_condition,
1540
+ :source_model_version_arn,
1541
+ :import_job_start_time,
1542
+ :import_job_end_time,
1543
+ :active_model_version,
1544
+ :active_model_version_arn,
1545
+ :model_version_activated_at,
1546
+ :previous_active_model_version,
1547
+ :previous_active_model_version_arn,
1548
+ :previous_model_version_activated_at,
1549
+ :prior_model_metrics,
1550
+ :latest_scheduled_retraining_failed_reason,
1551
+ :latest_scheduled_retraining_status,
1552
+ :latest_scheduled_retraining_model_version,
1553
+ :latest_scheduled_retraining_start_time,
1554
+ :latest_scheduled_retraining_available_data_in_days,
1555
+ :next_scheduled_retraining_start_date,
1556
+ :accumulated_inference_data_start_time,
1557
+ :accumulated_inference_data_end_time,
1558
+ :retraining_scheduler_status)
1315
1559
  SENSITIVE = []
1316
1560
  include Aws::Structure
1317
1561
  end
1318
1562
 
1319
- # Entity that comprises information abount duplicate timestamps in the
1320
- # dataset.
1563
+ # @!attribute [rw] model_name
1564
+ # The name of the machine learning model that this version belongs to.
1565
+ # @return [String]
1321
1566
  #
1322
- # @!attribute [rw] total_number_of_duplicate_timestamps
1323
- # Indicates the total number of duplicate timestamps.
1567
+ # @!attribute [rw] model_version
1568
+ # The version of the machine learning model.
1324
1569
  # @return [Integer]
1325
1570
  #
1326
- # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DuplicateTimestamps AWS API Documentation
1571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelVersionRequest AWS API Documentation
1327
1572
  #
1328
- class DuplicateTimestamps < Struct.new(
1329
- :total_number_of_duplicate_timestamps)
1573
+ class DescribeModelVersionRequest < Struct.new(
1574
+ :model_name,
1575
+ :model_version)
1330
1576
  SENSITIVE = []
1331
1577
  include Aws::Structure
1332
1578
  end
1333
1579
 
1334
- # Contains information about the specific inference event, including
1335
- # start and end time, diagnostics information, event duration and so on.
1336
- #
1337
- # @!attribute [rw] inference_scheduler_arn
1338
- # The Amazon Resource Name (ARN) of the inference scheduler being used
1339
- # for the inference event.
1340
- # @return [String]
1341
- #
1342
- # @!attribute [rw] inference_scheduler_name
1343
- # The name of the inference scheduler being used for the inference
1344
- # events.
1580
+ # @!attribute [rw] model_name
1581
+ # The name of the machine learning model that this version belongs to.
1345
1582
  # @return [String]
1346
1583
  #
1347
- # @!attribute [rw] event_start_time
1348
- # Indicates the starting time of an inference event.
1349
- # @return [Time]
1350
- #
1351
- # @!attribute [rw] event_end_time
1352
- # Indicates the ending time of an inference event.
1353
- # @return [Time]
1354
- #
1355
- # @!attribute [rw] diagnostics
1356
- # An array which specifies the names and values of all sensors
1357
- # contributing to an inference event.
1584
+ # @!attribute [rw] model_arn
1585
+ # The Amazon Resource Name (ARN) of the parent machine learning model
1586
+ # that this version belong to.
1358
1587
  # @return [String]
1359
1588
  #
1360
- # @!attribute [rw] event_duration_in_seconds
1361
- # Indicates the size of an inference event in seconds.
1589
+ # @!attribute [rw] model_version
1590
+ # The version of the machine learning model.
1362
1591
  # @return [Integer]
1363
1592
  #
1364
- # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceEventSummary AWS API Documentation
1593
+ # @!attribute [rw] model_version_arn
1594
+ # The Amazon Resource Name (ARN) of the model version.
1595
+ # @return [String]
1365
1596
  #
1366
- class InferenceEventSummary < Struct.new(
1367
- :inference_scheduler_arn,
1368
- :inference_scheduler_name,
1369
- :event_start_time,
1370
- :event_end_time,
1371
- :diagnostics,
1372
- :event_duration_in_seconds)
1373
- SENSITIVE = []
1374
- include Aws::Structure
1375
- end
1376
-
1377
- # Contains information about the specific inference execution, including
1378
- # input and output data configuration, inference scheduling information,
1379
- # status, and so on.
1597
+ # @!attribute [rw] status
1598
+ # The current status of the model version.
1599
+ # @return [String]
1380
1600
  #
1381
- # @!attribute [rw] model_name
1382
- # The name of the ML model being used for the inference execution.
1601
+ # @!attribute [rw] source_type
1602
+ # Indicates whether this model version was created by training or by
1603
+ # importing.
1383
1604
  # @return [String]
1384
1605
  #
1385
- # @!attribute [rw] model_arn
1386
- # The Amazon Resource Name (ARN) of the ML model used for the
1387
- # inference execution.
1606
+ # @!attribute [rw] dataset_name
1607
+ # The name of the dataset used to train the model version.
1388
1608
  # @return [String]
1389
1609
  #
1390
- # @!attribute [rw] inference_scheduler_name
1391
- # The name of the inference scheduler being used for the inference
1392
- # execution.
1610
+ # @!attribute [rw] dataset_arn
1611
+ # The Amazon Resource Name (ARN) of the dataset used to train the
1612
+ # model version.
1393
1613
  # @return [String]
1394
1614
  #
1395
- # @!attribute [rw] inference_scheduler_arn
1396
- # The Amazon Resource Name (ARN) of the inference scheduler being used
1397
- # for the inference execution.
1615
+ # @!attribute [rw] schema
1616
+ # The schema of the data used to train the model version.
1398
1617
  # @return [String]
1399
1618
  #
1400
- # @!attribute [rw] scheduled_start_time
1401
- # Indicates the start time at which the inference scheduler began the
1402
- # specific inference execution.
1619
+ # @!attribute [rw] labels_input_configuration
1620
+ # Contains the configuration information for the S3 location being
1621
+ # used to hold label data.
1622
+ # @return [Types::LabelsInputConfiguration]
1623
+ #
1624
+ # @!attribute [rw] training_data_start_time
1625
+ # The date on which the training data began being gathered. If you
1626
+ # imported the version, this is the date that the training data in the
1627
+ # source version began being gathered.
1403
1628
  # @return [Time]
1404
1629
  #
1405
- # @!attribute [rw] data_start_time
1406
- # Indicates the time reference in the dataset at which the inference
1407
- # execution began.
1630
+ # @!attribute [rw] training_data_end_time
1631
+ # The date on which the training data finished being gathered. If you
1632
+ # imported the version, this is the date that the training data in the
1633
+ # source version finished being gathered.
1408
1634
  # @return [Time]
1409
1635
  #
1410
- # @!attribute [rw] data_end_time
1411
- # Indicates the time reference in the dataset at which the inference
1412
- # execution stopped.
1636
+ # @!attribute [rw] evaluation_data_start_time
1637
+ # The date on which the data in the evaluation set began being
1638
+ # gathered. If you imported the version, this is the date that the
1639
+ # evaluation set data in the source version began being gathered.
1413
1640
  # @return [Time]
1414
1641
  #
1415
- # @!attribute [rw] data_input_configuration
1416
- # Specifies configuration information for the input data for the
1417
- # inference scheduler, including delimiter, format, and dataset
1418
- # location.
1419
- # @return [Types::InferenceInputConfiguration]
1642
+ # @!attribute [rw] evaluation_data_end_time
1643
+ # The date on which the data in the evaluation set began being
1644
+ # gathered. If you imported the version, this is the date that the
1645
+ # evaluation set data in the source version finished being gathered.
1646
+ # @return [Time]
1420
1647
  #
1421
- # @!attribute [rw] data_output_configuration
1422
- # Specifies configuration information for the output results from for
1423
- # the inference execution, including the output Amazon S3 location.
1424
- # @return [Types::InferenceOutputConfiguration]
1648
+ # @!attribute [rw] role_arn
1649
+ # The Amazon Resource Name (ARN) of the role that was used to train
1650
+ # the model version.
1651
+ # @return [String]
1425
1652
  #
1426
- # @!attribute [rw] customer_result_object
1427
- # @return [Types::S3Object]
1653
+ # @!attribute [rw] data_pre_processing_configuration
1654
+ # The configuration is the `TargetSamplingRate`, which is the sampling
1655
+ # rate of the data after post processing by Amazon Lookout for
1656
+ # Equipment. For example, if you provide data that has been collected
1657
+ # at a 1 second level and you want the system to resample the data at
1658
+ # a 1 minute rate before training, the `TargetSamplingRate` is 1
1659
+ # minute.
1428
1660
  #
1429
- # @!attribute [rw] status
1430
- # Indicates the status of the inference execution.
1431
- # @return [String]
1661
+ # When providing a value for the `TargetSamplingRate`, you must attach
1662
+ # the prefix "PT" to the rate you want. The value for a 1 second
1663
+ # rate is therefore *PT1S*, the value for a 15 minute rate is *PT15M*,
1664
+ # and the value for a 1 hour rate is *PT1H*
1665
+ # @return [Types::DataPreProcessingConfiguration]
1666
+ #
1667
+ # @!attribute [rw] training_execution_start_time
1668
+ # The time when the training of the version began.
1669
+ # @return [Time]
1670
+ #
1671
+ # @!attribute [rw] training_execution_end_time
1672
+ # The time when the training of the version completed.
1673
+ # @return [Time]
1432
1674
  #
1433
1675
  # @!attribute [rw] failed_reason
1434
- # Specifies the reason for failure when an inference execution has
1435
- # failed.
1676
+ # The failure message if the training of the model version failed.
1436
1677
  # @return [String]
1437
1678
  #
1438
- # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceExecutionSummary AWS API Documentation
1679
+ # @!attribute [rw] model_metrics
1680
+ # Shows an aggregated summary, in JSON format, of the model's
1681
+ # performance within the evaluation time range. These metrics are
1682
+ # created when evaluating the model.
1683
+ # @return [String]
1439
1684
  #
1440
- class InferenceExecutionSummary < Struct.new(
1441
- :model_name,
1442
- :model_arn,
1443
- :inference_scheduler_name,
1444
- :inference_scheduler_arn,
1445
- :scheduled_start_time,
1446
- :data_start_time,
1447
- :data_end_time,
1448
- :data_input_configuration,
1449
- :data_output_configuration,
1450
- :customer_result_object,
1451
- :status,
1452
- :failed_reason)
1685
+ # @!attribute [rw] last_updated_time
1686
+ # Indicates the last time the machine learning model version was
1687
+ # updated.
1688
+ # @return [Time]
1689
+ #
1690
+ # @!attribute [rw] created_at
1691
+ # Indicates the time and date at which the machine learning model
1692
+ # version was created.
1693
+ # @return [Time]
1694
+ #
1695
+ # @!attribute [rw] server_side_kms_key_id
1696
+ # The identifier of the KMS key key used to encrypt model version data
1697
+ # by Amazon Lookout for Equipment.
1698
+ # @return [String]
1699
+ #
1700
+ # @!attribute [rw] off_condition
1701
+ # Indicates that the asset associated with this sensor has been shut
1702
+ # off. As long as this condition is met, Lookout for Equipment will
1703
+ # not use data from this asset for training, evaluation, or inference.
1704
+ # @return [String]
1705
+ #
1706
+ # @!attribute [rw] source_model_version_arn
1707
+ # If model version was imported, then this field is the arn of the
1708
+ # source model version.
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] import_job_start_time
1712
+ # The date and time when the import job began. This field appears if
1713
+ # the model version was imported.
1714
+ # @return [Time]
1715
+ #
1716
+ # @!attribute [rw] import_job_end_time
1717
+ # The date and time when the import job completed. This field appears
1718
+ # if the model version was imported.
1719
+ # @return [Time]
1720
+ #
1721
+ # @!attribute [rw] imported_data_size_in_bytes
1722
+ # The size in bytes of the imported data. This field appears if the
1723
+ # model version was imported.
1724
+ # @return [Integer]
1725
+ #
1726
+ # @!attribute [rw] prior_model_metrics
1727
+ # If the model version was retrained, this field shows a summary of
1728
+ # the performance of the prior model on the new training range. You
1729
+ # can use the information in this JSON-formatted object to compare the
1730
+ # new model version and the prior model version.
1731
+ # @return [String]
1732
+ #
1733
+ # @!attribute [rw] retraining_available_data_in_days
1734
+ # Indicates the number of days of data used in the most recent
1735
+ # scheduled retraining run.
1736
+ # @return [Integer]
1737
+ #
1738
+ # @!attribute [rw] auto_promotion_result
1739
+ # Indicates whether the model version was promoted to be the active
1740
+ # version after retraining or if there was an error with or
1741
+ # cancellation of the retraining.
1742
+ # @return [String]
1743
+ #
1744
+ # @!attribute [rw] auto_promotion_result_reason
1745
+ # Indicates the reason for the `AutoPromotionResult`. For example, a
1746
+ # model might not be promoted if its performance was worse than the
1747
+ # active version, if there was an error during training, or if the
1748
+ # retraining scheduler was using `MANUAL` promote mode. The model will
1749
+ # be promoted in `MANAGED` promote mode if the performance is better
1750
+ # than the previous model.
1751
+ # @return [String]
1752
+ #
1753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelVersionResponse AWS API Documentation
1754
+ #
1755
+ class DescribeModelVersionResponse < Struct.new(
1756
+ :model_name,
1757
+ :model_arn,
1758
+ :model_version,
1759
+ :model_version_arn,
1760
+ :status,
1761
+ :source_type,
1762
+ :dataset_name,
1763
+ :dataset_arn,
1764
+ :schema,
1765
+ :labels_input_configuration,
1766
+ :training_data_start_time,
1767
+ :training_data_end_time,
1768
+ :evaluation_data_start_time,
1769
+ :evaluation_data_end_time,
1770
+ :role_arn,
1771
+ :data_pre_processing_configuration,
1772
+ :training_execution_start_time,
1773
+ :training_execution_end_time,
1774
+ :failed_reason,
1775
+ :model_metrics,
1776
+ :last_updated_time,
1777
+ :created_at,
1778
+ :server_side_kms_key_id,
1779
+ :off_condition,
1780
+ :source_model_version_arn,
1781
+ :import_job_start_time,
1782
+ :import_job_end_time,
1783
+ :imported_data_size_in_bytes,
1784
+ :prior_model_metrics,
1785
+ :retraining_available_data_in_days,
1786
+ :auto_promotion_result,
1787
+ :auto_promotion_result_reason)
1788
+ SENSITIVE = []
1789
+ include Aws::Structure
1790
+ end
1791
+
1792
+ # @!attribute [rw] resource_arn
1793
+ # The Amazon Resource Name (ARN) of the resource that is associated
1794
+ # with the resource policy.
1795
+ # @return [String]
1796
+ #
1797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeResourcePolicyRequest AWS API Documentation
1798
+ #
1799
+ class DescribeResourcePolicyRequest < Struct.new(
1800
+ :resource_arn)
1801
+ SENSITIVE = []
1802
+ include Aws::Structure
1803
+ end
1804
+
1805
+ # @!attribute [rw] policy_revision_id
1806
+ # A unique identifier for a revision of the resource policy.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] resource_policy
1810
+ # The resource policy in a JSON-formatted string.
1811
+ # @return [String]
1812
+ #
1813
+ # @!attribute [rw] creation_time
1814
+ # The time when the resource policy was created.
1815
+ # @return [Time]
1816
+ #
1817
+ # @!attribute [rw] last_modified_time
1818
+ # The time when the resource policy was last modified.
1819
+ # @return [Time]
1820
+ #
1821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeResourcePolicyResponse AWS API Documentation
1822
+ #
1823
+ class DescribeResourcePolicyResponse < Struct.new(
1824
+ :policy_revision_id,
1825
+ :resource_policy,
1826
+ :creation_time,
1827
+ :last_modified_time)
1828
+ SENSITIVE = []
1829
+ include Aws::Structure
1830
+ end
1831
+
1832
+ # @!attribute [rw] model_name
1833
+ # The name of the model that the retraining scheduler is attached to.
1834
+ # @return [String]
1835
+ #
1836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeRetrainingSchedulerRequest AWS API Documentation
1837
+ #
1838
+ class DescribeRetrainingSchedulerRequest < Struct.new(
1839
+ :model_name)
1840
+ SENSITIVE = []
1841
+ include Aws::Structure
1842
+ end
1843
+
1844
+ # @!attribute [rw] model_name
1845
+ # The name of the model that the retraining scheduler is attached to.
1846
+ # @return [String]
1847
+ #
1848
+ # @!attribute [rw] model_arn
1849
+ # The ARN of the model that the retraining scheduler is attached to.
1850
+ # @return [String]
1851
+ #
1852
+ # @!attribute [rw] retraining_start_date
1853
+ # The start date for the retraining scheduler. Lookout for Equipment
1854
+ # truncates the time you provide to the nearest UTC day.
1855
+ # @return [Time]
1856
+ #
1857
+ # @!attribute [rw] retraining_frequency
1858
+ # The frequency at which the model retraining is set. This follows the
1859
+ # [ISO 8601][1] guidelines.
1860
+ #
1861
+ #
1862
+ #
1863
+ # [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
1864
+ # @return [String]
1865
+ #
1866
+ # @!attribute [rw] lookback_window
1867
+ # The number of past days of data used for retraining.
1868
+ # @return [String]
1869
+ #
1870
+ # @!attribute [rw] status
1871
+ # The status of the retraining scheduler.
1872
+ # @return [String]
1873
+ #
1874
+ # @!attribute [rw] promote_mode
1875
+ # Indicates how the service uses new models. In `MANAGED` mode, new
1876
+ # models are used for inference if they have better performance than
1877
+ # the current model. In `MANUAL` mode, the new models are not used
1878
+ # until they are [manually activated][1].
1879
+ #
1880
+ #
1881
+ #
1882
+ # [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
1883
+ # @return [String]
1884
+ #
1885
+ # @!attribute [rw] created_at
1886
+ # Indicates the time and date at which the retraining scheduler was
1887
+ # created.
1888
+ # @return [Time]
1889
+ #
1890
+ # @!attribute [rw] updated_at
1891
+ # Indicates the time and date at which the retraining scheduler was
1892
+ # updated.
1893
+ # @return [Time]
1894
+ #
1895
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeRetrainingSchedulerResponse AWS API Documentation
1896
+ #
1897
+ class DescribeRetrainingSchedulerResponse < Struct.new(
1898
+ :model_name,
1899
+ :model_arn,
1900
+ :retraining_start_date,
1901
+ :retraining_frequency,
1902
+ :lookback_window,
1903
+ :status,
1904
+ :promote_mode,
1905
+ :created_at,
1906
+ :updated_at)
1907
+ SENSITIVE = []
1908
+ include Aws::Structure
1909
+ end
1910
+
1911
+ # Entity that comprises information abount duplicate timestamps in the
1912
+ # dataset.
1913
+ #
1914
+ # @!attribute [rw] total_number_of_duplicate_timestamps
1915
+ # Indicates the total number of duplicate timestamps.
1916
+ # @return [Integer]
1917
+ #
1918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DuplicateTimestamps AWS API Documentation
1919
+ #
1920
+ class DuplicateTimestamps < Struct.new(
1921
+ :total_number_of_duplicate_timestamps)
1922
+ SENSITIVE = []
1923
+ include Aws::Structure
1924
+ end
1925
+
1926
+ # @!attribute [rw] source_dataset_arn
1927
+ # The Amazon Resource Name (ARN) of the dataset to import.
1928
+ # @return [String]
1929
+ #
1930
+ # @!attribute [rw] dataset_name
1931
+ # The name of the machine learning dataset to be created. If the
1932
+ # dataset already exists, Amazon Lookout for Equipment overwrites the
1933
+ # existing dataset. If you don't specify this field, it is filled
1934
+ # with the name of the source dataset.
1935
+ # @return [String]
1936
+ #
1937
+ # @!attribute [rw] client_token
1938
+ # A unique identifier for the request. If you do not set the client
1939
+ # request token, Amazon Lookout for Equipment generates one.
1940
+ #
1941
+ # **A suitable default value is auto-generated.** You should normally
1942
+ # not need to pass this option.
1943
+ # @return [String]
1944
+ #
1945
+ # @!attribute [rw] server_side_kms_key_id
1946
+ # Provides the identifier of the KMS key key used to encrypt model
1947
+ # data by Amazon Lookout for Equipment.
1948
+ # @return [String]
1949
+ #
1950
+ # @!attribute [rw] tags
1951
+ # Any tags associated with the dataset to be created.
1952
+ # @return [Array<Types::Tag>]
1953
+ #
1954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportDatasetRequest AWS API Documentation
1955
+ #
1956
+ class ImportDatasetRequest < Struct.new(
1957
+ :source_dataset_arn,
1958
+ :dataset_name,
1959
+ :client_token,
1960
+ :server_side_kms_key_id,
1961
+ :tags)
1962
+ SENSITIVE = []
1963
+ include Aws::Structure
1964
+ end
1965
+
1966
+ # @!attribute [rw] dataset_name
1967
+ # The name of the created machine learning dataset.
1968
+ # @return [String]
1969
+ #
1970
+ # @!attribute [rw] dataset_arn
1971
+ # The Amazon Resource Name (ARN) of the dataset that was imported.
1972
+ # @return [String]
1973
+ #
1974
+ # @!attribute [rw] status
1975
+ # The status of the `ImportDataset` operation.
1976
+ # @return [String]
1977
+ #
1978
+ # @!attribute [rw] job_id
1979
+ # A unique identifier for the job of importing the dataset.
1980
+ # @return [String]
1981
+ #
1982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportDatasetResponse AWS API Documentation
1983
+ #
1984
+ class ImportDatasetResponse < Struct.new(
1985
+ :dataset_name,
1986
+ :dataset_arn,
1987
+ :status,
1988
+ :job_id)
1989
+ SENSITIVE = []
1990
+ include Aws::Structure
1991
+ end
1992
+
1993
+ # @!attribute [rw] source_model_version_arn
1994
+ # The Amazon Resource Name (ARN) of the model version to import.
1995
+ # @return [String]
1996
+ #
1997
+ # @!attribute [rw] model_name
1998
+ # The name for the machine learning model to be created. If the model
1999
+ # already exists, Amazon Lookout for Equipment creates a new version.
2000
+ # If you do not specify this field, it is filled with the name of the
2001
+ # source model.
2002
+ # @return [String]
2003
+ #
2004
+ # @!attribute [rw] dataset_name
2005
+ # The name of the dataset for the machine learning model being
2006
+ # imported.
2007
+ # @return [String]
2008
+ #
2009
+ # @!attribute [rw] labels_input_configuration
2010
+ # Contains the configuration information for the S3 location being
2011
+ # used to hold label data.
2012
+ # @return [Types::LabelsInputConfiguration]
2013
+ #
2014
+ # @!attribute [rw] client_token
2015
+ # A unique identifier for the request. If you do not set the client
2016
+ # request token, Amazon Lookout for Equipment generates one.
2017
+ #
2018
+ # **A suitable default value is auto-generated.** You should normally
2019
+ # not need to pass this option.
2020
+ # @return [String]
2021
+ #
2022
+ # @!attribute [rw] role_arn
2023
+ # The Amazon Resource Name (ARN) of a role with permission to access
2024
+ # the data source being used to create the machine learning model.
2025
+ # @return [String]
2026
+ #
2027
+ # @!attribute [rw] server_side_kms_key_id
2028
+ # Provides the identifier of the KMS key key used to encrypt model
2029
+ # data by Amazon Lookout for Equipment.
2030
+ # @return [String]
2031
+ #
2032
+ # @!attribute [rw] tags
2033
+ # The tags associated with the machine learning model to be created.
2034
+ # @return [Array<Types::Tag>]
2035
+ #
2036
+ # @!attribute [rw] inference_data_import_strategy
2037
+ # Indicates how to import the accumulated inference data when a model
2038
+ # version is imported. The possible values are as follows:
2039
+ #
2040
+ # * NO\_IMPORT – Don't import the data.
2041
+ #
2042
+ # * ADD\_WHEN\_EMPTY – Only import the data from the source model if
2043
+ # there is no existing data in the target model.
2044
+ #
2045
+ # * OVERWRITE – Import the data from the source model and overwrite
2046
+ # the existing data in the target model.
2047
+ # @return [String]
2048
+ #
2049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportModelVersionRequest AWS API Documentation
2050
+ #
2051
+ class ImportModelVersionRequest < Struct.new(
2052
+ :source_model_version_arn,
2053
+ :model_name,
2054
+ :dataset_name,
2055
+ :labels_input_configuration,
2056
+ :client_token,
2057
+ :role_arn,
2058
+ :server_side_kms_key_id,
2059
+ :tags,
2060
+ :inference_data_import_strategy)
2061
+ SENSITIVE = []
2062
+ include Aws::Structure
2063
+ end
2064
+
2065
+ # @!attribute [rw] model_name
2066
+ # The name for the machine learning model.
2067
+ # @return [String]
2068
+ #
2069
+ # @!attribute [rw] model_arn
2070
+ # The Amazon Resource Name (ARN) of the model being created.
2071
+ # @return [String]
2072
+ #
2073
+ # @!attribute [rw] model_version_arn
2074
+ # The Amazon Resource Name (ARN) of the model version being created.
2075
+ # @return [String]
2076
+ #
2077
+ # @!attribute [rw] model_version
2078
+ # The version of the model being created.
2079
+ # @return [Integer]
2080
+ #
2081
+ # @!attribute [rw] status
2082
+ # The status of the `ImportModelVersion` operation.
2083
+ # @return [String]
2084
+ #
2085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportModelVersionResponse AWS API Documentation
2086
+ #
2087
+ class ImportModelVersionResponse < Struct.new(
2088
+ :model_name,
2089
+ :model_arn,
2090
+ :model_version_arn,
2091
+ :model_version,
2092
+ :status)
2093
+ SENSITIVE = []
2094
+ include Aws::Structure
2095
+ end
2096
+
2097
+ # Contains information about the specific inference event, including
2098
+ # start and end time, diagnostics information, event duration and so on.
2099
+ #
2100
+ # @!attribute [rw] inference_scheduler_arn
2101
+ # The Amazon Resource Name (ARN) of the inference scheduler being used
2102
+ # for the inference event.
2103
+ # @return [String]
2104
+ #
2105
+ # @!attribute [rw] inference_scheduler_name
2106
+ # The name of the inference scheduler being used for the inference
2107
+ # events.
2108
+ # @return [String]
2109
+ #
2110
+ # @!attribute [rw] event_start_time
2111
+ # Indicates the starting time of an inference event.
2112
+ # @return [Time]
2113
+ #
2114
+ # @!attribute [rw] event_end_time
2115
+ # Indicates the ending time of an inference event.
2116
+ # @return [Time]
2117
+ #
2118
+ # @!attribute [rw] diagnostics
2119
+ # An array which specifies the names and values of all sensors
2120
+ # contributing to an inference event.
2121
+ # @return [String]
2122
+ #
2123
+ # @!attribute [rw] event_duration_in_seconds
2124
+ # Indicates the size of an inference event in seconds.
2125
+ # @return [Integer]
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceEventSummary AWS API Documentation
2128
+ #
2129
+ class InferenceEventSummary < Struct.new(
2130
+ :inference_scheduler_arn,
2131
+ :inference_scheduler_name,
2132
+ :event_start_time,
2133
+ :event_end_time,
2134
+ :diagnostics,
2135
+ :event_duration_in_seconds)
2136
+ SENSITIVE = []
2137
+ include Aws::Structure
2138
+ end
2139
+
2140
+ # Contains information about the specific inference execution, including
2141
+ # input and output data configuration, inference scheduling information,
2142
+ # status, and so on.
2143
+ #
2144
+ # @!attribute [rw] model_name
2145
+ # The name of the machine learning model being used for the inference
2146
+ # execution.
2147
+ # @return [String]
2148
+ #
2149
+ # @!attribute [rw] model_arn
2150
+ # The Amazon Resource Name (ARN) of the machine learning model used
2151
+ # for the inference execution.
2152
+ # @return [String]
2153
+ #
2154
+ # @!attribute [rw] inference_scheduler_name
2155
+ # The name of the inference scheduler being used for the inference
2156
+ # execution.
2157
+ # @return [String]
2158
+ #
2159
+ # @!attribute [rw] inference_scheduler_arn
2160
+ # The Amazon Resource Name (ARN) of the inference scheduler being used
2161
+ # for the inference execution.
2162
+ # @return [String]
2163
+ #
2164
+ # @!attribute [rw] scheduled_start_time
2165
+ # Indicates the start time at which the inference scheduler began the
2166
+ # specific inference execution.
2167
+ # @return [Time]
2168
+ #
2169
+ # @!attribute [rw] data_start_time
2170
+ # Indicates the time reference in the dataset at which the inference
2171
+ # execution began.
2172
+ # @return [Time]
2173
+ #
2174
+ # @!attribute [rw] data_end_time
2175
+ # Indicates the time reference in the dataset at which the inference
2176
+ # execution stopped.
2177
+ # @return [Time]
2178
+ #
2179
+ # @!attribute [rw] data_input_configuration
2180
+ # Specifies configuration information for the input data for the
2181
+ # inference scheduler, including delimiter, format, and dataset
2182
+ # location.
2183
+ # @return [Types::InferenceInputConfiguration]
2184
+ #
2185
+ # @!attribute [rw] data_output_configuration
2186
+ # Specifies configuration information for the output results from for
2187
+ # the inference execution, including the output Amazon S3 location.
2188
+ # @return [Types::InferenceOutputConfiguration]
2189
+ #
2190
+ # @!attribute [rw] customer_result_object
2191
+ # The S3 object that the inference execution results were uploaded to.
2192
+ # @return [Types::S3Object]
2193
+ #
2194
+ # @!attribute [rw] status
2195
+ # Indicates the status of the inference execution.
2196
+ # @return [String]
2197
+ #
2198
+ # @!attribute [rw] failed_reason
2199
+ # Specifies the reason for failure when an inference execution has
2200
+ # failed.
2201
+ # @return [String]
2202
+ #
2203
+ # @!attribute [rw] model_version
2204
+ # The model version used for the inference execution.
2205
+ # @return [Integer]
2206
+ #
2207
+ # @!attribute [rw] model_version_arn
2208
+ # The Amazon Resource Number (ARN) of the model version used for the
2209
+ # inference execution.
2210
+ # @return [String]
2211
+ #
2212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceExecutionSummary AWS API Documentation
2213
+ #
2214
+ class InferenceExecutionSummary < Struct.new(
2215
+ :model_name,
2216
+ :model_arn,
2217
+ :inference_scheduler_name,
2218
+ :inference_scheduler_arn,
2219
+ :scheduled_start_time,
2220
+ :data_start_time,
2221
+ :data_end_time,
2222
+ :data_input_configuration,
2223
+ :data_output_configuration,
2224
+ :customer_result_object,
2225
+ :status,
2226
+ :failed_reason,
2227
+ :model_version,
2228
+ :model_version_arn)
1453
2229
  SENSITIVE = []
1454
2230
  include Aws::Structure
1455
2231
  end
@@ -1512,7 +2288,7 @@ module Aws::LookoutEquipment
1512
2288
  # @return [Types::InferenceS3OutputConfiguration]
1513
2289
  #
1514
2290
  # @!attribute [rw] kms_key_id
1515
- # The ID number for the AWS KMS key used to encrypt the inference
2291
+ # The ID number for the KMS key key used to encrypt the inference
1516
2292
  # output.
1517
2293
  # @return [String]
1518
2294
  #
@@ -1571,12 +2347,13 @@ module Aws::LookoutEquipment
1571
2347
  # data delay offset, model name and ARN, status, and so on.
1572
2348
  #
1573
2349
  # @!attribute [rw] model_name
1574
- # The name of the ML model used for the inference scheduler.
2350
+ # The name of the machine learning model used for the inference
2351
+ # scheduler.
1575
2352
  # @return [String]
1576
2353
  #
1577
2354
  # @!attribute [rw] model_arn
1578
- # The Amazon Resource Name (ARN) of the ML model used by the inference
1579
- # scheduler.
2355
+ # The Amazon Resource Name (ARN) of the machine learning model used by
2356
+ # the inference scheduler.
1580
2357
  # @return [String]
1581
2358
  #
1582
2359
  # @!attribute [rw] inference_scheduler_name
@@ -1692,10 +2469,17 @@ module Aws::LookoutEquipment
1692
2469
  # @return [String]
1693
2470
  #
1694
2471
  # @!attribute [rw] key_pattern
1695
- # Pattern for matching the Amazon S3 files which will be used for
1696
- # ingestion. If no KeyPattern is provided, we will use the default
1697
- # hierarchy file structure, which is same as KeyPattern
1698
- # \\\{prefix\\}/\\\{component\_name\\}/*
2472
+ # The pattern for matching the Amazon S3 files that will be used for
2473
+ # ingestion. If the schema was created previously without any
2474
+ # KeyPattern, then the default KeyPattern
2475
+ # \\\{prefix\\}/\\\{component\_name\\}/* is used to download files
2476
+ # from Amazon S3 according to the schema. This field is required when
2477
+ # ingestion is being done for the first time.
2478
+ #
2479
+ # Valid Values: \\\{prefix\\}/\\\{component\_name\\}\_* \|
2480
+ # \\\{prefix\\}/\\\{component\_name\\}/* \|
2481
+ # \\\{prefix\\}/\\\{component\_name\\}\[DELIMITER\]* (Allowed
2482
+ # delimiters : space, dot, underscore, hyphen)
1699
2483
  # @return [String]
1700
2484
  #
1701
2485
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/IngestionS3InputConfiguration AWS API Documentation
@@ -1772,7 +2556,7 @@ module Aws::LookoutEquipment
1772
2556
  # @return [String]
1773
2557
  #
1774
2558
  # @!attribute [rw] label_group_arn
1775
- # The ARN of the label group.
2559
+ # The Amazon Resource Name (ARN) of the label group.
1776
2560
  # @return [String]
1777
2561
  #
1778
2562
  # @!attribute [rw] created_at
@@ -1805,7 +2589,7 @@ module Aws::LookoutEquipment
1805
2589
  # @return [String]
1806
2590
  #
1807
2591
  # @!attribute [rw] label_group_arn
1808
- # The ARN of the label group.
2592
+ # The Amazon Resource Name (ARN) of the label group.
1809
2593
  # @return [String]
1810
2594
  #
1811
2595
  # @!attribute [rw] start_time
@@ -2027,7 +2811,7 @@ module Aws::LookoutEquipment
2027
2811
  #
2028
2812
  # @!attribute [rw] interval_end_time
2029
2813
  # Returns all the inference events with an end start time equal to or
2030
- # greater than less than the end time given
2814
+ # greater than less than the end time given.
2031
2815
  # @return [Time]
2032
2816
  #
2033
2817
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsRequest AWS API Documentation
@@ -2139,12 +2923,12 @@ module Aws::LookoutEquipment
2139
2923
  # @return [String]
2140
2924
  #
2141
2925
  # @!attribute [rw] model_name
2142
- # The name of the ML model used by the inference scheduler to be
2143
- # listed.
2926
+ # The name of the machine learning model used by the inference
2927
+ # scheduler to be listed.
2144
2928
  # @return [String]
2145
2929
  #
2146
2930
  # @!attribute [rw] status
2147
- # Specifies the current status of the inference schedulers to list.
2931
+ # Specifies the current status of the inference schedulers.
2148
2932
  # @return [String]
2149
2933
  #
2150
2934
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceSchedulersRequest AWS API Documentation
@@ -2282,26 +3066,109 @@ module Aws::LookoutEquipment
2282
3066
  include Aws::Structure
2283
3067
  end
2284
3068
 
3069
+ # @!attribute [rw] model_name
3070
+ # Then name of the machine learning model for which the model versions
3071
+ # are to be listed.
3072
+ # @return [String]
3073
+ #
3074
+ # @!attribute [rw] next_token
3075
+ # If the total number of results exceeds the limit that the response
3076
+ # can display, the response returns an opaque pagination token
3077
+ # indicating where to continue the listing of machine learning model
3078
+ # versions. Use this token in the `NextToken` field in the request to
3079
+ # list the next page of results.
3080
+ # @return [String]
3081
+ #
3082
+ # @!attribute [rw] max_results
3083
+ # Specifies the maximum number of machine learning model versions to
3084
+ # list.
3085
+ # @return [Integer]
3086
+ #
3087
+ # @!attribute [rw] status
3088
+ # Filter the results based on the current status of the model version.
3089
+ # @return [String]
3090
+ #
3091
+ # @!attribute [rw] source_type
3092
+ # Filter the results based on the way the model version was generated.
3093
+ # @return [String]
3094
+ #
3095
+ # @!attribute [rw] created_at_end_time
3096
+ # Filter results to return all the model versions created before this
3097
+ # time.
3098
+ # @return [Time]
3099
+ #
3100
+ # @!attribute [rw] created_at_start_time
3101
+ # Filter results to return all the model versions created after this
3102
+ # time.
3103
+ # @return [Time]
3104
+ #
3105
+ # @!attribute [rw] max_model_version
3106
+ # Specifies the highest version of the model to return in the list.
3107
+ # @return [Integer]
3108
+ #
3109
+ # @!attribute [rw] min_model_version
3110
+ # Specifies the lowest version of the model to return in the list.
3111
+ # @return [Integer]
3112
+ #
3113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelVersionsRequest AWS API Documentation
3114
+ #
3115
+ class ListModelVersionsRequest < Struct.new(
3116
+ :model_name,
3117
+ :next_token,
3118
+ :max_results,
3119
+ :status,
3120
+ :source_type,
3121
+ :created_at_end_time,
3122
+ :created_at_start_time,
3123
+ :max_model_version,
3124
+ :min_model_version)
3125
+ SENSITIVE = []
3126
+ include Aws::Structure
3127
+ end
3128
+
3129
+ # @!attribute [rw] next_token
3130
+ # If the total number of results exceeds the limit that the response
3131
+ # can display, the response returns an opaque pagination token
3132
+ # indicating where to continue the listing of machine learning model
3133
+ # versions. Use this token in the `NextToken` field in the request to
3134
+ # list the next page of results.
3135
+ # @return [String]
3136
+ #
3137
+ # @!attribute [rw] model_version_summaries
3138
+ # Provides information on the specified model version, including the
3139
+ # created time, model and dataset ARNs, and status.
3140
+ # @return [Array<Types::ModelVersionSummary>]
3141
+ #
3142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelVersionsResponse AWS API Documentation
3143
+ #
3144
+ class ListModelVersionsResponse < Struct.new(
3145
+ :next_token,
3146
+ :model_version_summaries)
3147
+ SENSITIVE = []
3148
+ include Aws::Structure
3149
+ end
3150
+
2285
3151
  # @!attribute [rw] next_token
2286
3152
  # An opaque pagination token indicating where to continue the listing
2287
- # of ML models.
3153
+ # of machine learning models.
2288
3154
  # @return [String]
2289
3155
  #
2290
3156
  # @!attribute [rw] max_results
2291
- # Specifies the maximum number of ML models to list.
3157
+ # Specifies the maximum number of machine learning models to list.
2292
3158
  # @return [Integer]
2293
3159
  #
2294
3160
  # @!attribute [rw] status
2295
- # The status of the ML model.
3161
+ # The status of the machine learning model.
2296
3162
  # @return [String]
2297
3163
  #
2298
3164
  # @!attribute [rw] model_name_begins_with
2299
- # The beginning of the name of the ML models being listed.
3165
+ # The beginning of the name of the machine learning models being
3166
+ # listed.
2300
3167
  # @return [String]
2301
3168
  #
2302
3169
  # @!attribute [rw] dataset_name_begins_with
2303
- # The beginning of the name of the dataset of the ML models to be
2304
- # listed.
3170
+ # The beginning of the name of the dataset of the machine learning
3171
+ # models to be listed.
2305
3172
  # @return [String]
2306
3173
  #
2307
3174
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelsRequest AWS API Documentation
@@ -2311,26 +3178,77 @@ module Aws::LookoutEquipment
2311
3178
  :max_results,
2312
3179
  :status,
2313
3180
  :model_name_begins_with,
2314
- :dataset_name_begins_with)
3181
+ :dataset_name_begins_with)
3182
+ SENSITIVE = []
3183
+ include Aws::Structure
3184
+ end
3185
+
3186
+ # @!attribute [rw] next_token
3187
+ # An opaque pagination token indicating where to continue the listing
3188
+ # of machine learning models.
3189
+ # @return [String]
3190
+ #
3191
+ # @!attribute [rw] model_summaries
3192
+ # Provides information on the specified model, including created time,
3193
+ # model and dataset ARNs, and status.
3194
+ # @return [Array<Types::ModelSummary>]
3195
+ #
3196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelsResponse AWS API Documentation
3197
+ #
3198
+ class ListModelsResponse < Struct.new(
3199
+ :next_token,
3200
+ :model_summaries)
3201
+ SENSITIVE = []
3202
+ include Aws::Structure
3203
+ end
3204
+
3205
+ # @!attribute [rw] model_name_begins_with
3206
+ # Specify this field to only list retraining schedulers whose machine
3207
+ # learning models begin with the value you specify.
3208
+ # @return [String]
3209
+ #
3210
+ # @!attribute [rw] status
3211
+ # Specify this field to only list retraining schedulers whose status
3212
+ # matches the value you specify.
3213
+ # @return [String]
3214
+ #
3215
+ # @!attribute [rw] next_token
3216
+ # If the number of results exceeds the maximum, a pagination token is
3217
+ # returned. Use the token in the request to show the next page of
3218
+ # retraining schedulers.
3219
+ # @return [String]
3220
+ #
3221
+ # @!attribute [rw] max_results
3222
+ # Specifies the maximum number of retraining schedulers to list.
3223
+ # @return [Integer]
3224
+ #
3225
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulersRequest AWS API Documentation
3226
+ #
3227
+ class ListRetrainingSchedulersRequest < Struct.new(
3228
+ :model_name_begins_with,
3229
+ :status,
3230
+ :next_token,
3231
+ :max_results)
2315
3232
  SENSITIVE = []
2316
3233
  include Aws::Structure
2317
3234
  end
2318
3235
 
3236
+ # @!attribute [rw] retraining_scheduler_summaries
3237
+ # Provides information on the specified retraining scheduler,
3238
+ # including the model name, model ARN, status, and start date.
3239
+ # @return [Array<Types::RetrainingSchedulerSummary>]
3240
+ #
2319
3241
  # @!attribute [rw] next_token
2320
- # An opaque pagination token indicating where to continue the listing
2321
- # of ML models.
3242
+ # If the number of results exceeds the maximum, this pagination token
3243
+ # is returned. Use this token in the request to show the next page of
3244
+ # retraining schedulers.
2322
3245
  # @return [String]
2323
3246
  #
2324
- # @!attribute [rw] model_summaries
2325
- # Provides information on the specified model, including created time,
2326
- # model and dataset ARNs, and status.
2327
- # @return [Array<Types::ModelSummary>]
2328
- #
2329
- # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelsResponse AWS API Documentation
3247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulersResponse AWS API Documentation
2330
3248
  #
2331
- class ListModelsResponse < Struct.new(
2332
- :next_token,
2333
- :model_summaries)
3249
+ class ListRetrainingSchedulersResponse < Struct.new(
3250
+ :retraining_scheduler_summaries,
3251
+ :next_token)
2334
3252
  SENSITIVE = []
2335
3253
  include Aws::Structure
2336
3254
  end
@@ -2448,19 +3366,19 @@ module Aws::LookoutEquipment
2448
3366
  include Aws::Structure
2449
3367
  end
2450
3368
 
2451
- # Provides information about the specified ML model, including dataset
2452
- # and model names and ARNs, as well as status.
3369
+ # Provides information about the specified machine learning model,
3370
+ # including dataset and model names and ARNs, as well as status.
2453
3371
  #
2454
3372
  # @!attribute [rw] model_name
2455
- # The name of the ML model.
3373
+ # The name of the machine learning model.
2456
3374
  # @return [String]
2457
3375
  #
2458
3376
  # @!attribute [rw] model_arn
2459
- # The Amazon Resource Name (ARN) of the ML model.
3377
+ # The Amazon Resource Name (ARN) of the machine learning model.
2460
3378
  # @return [String]
2461
3379
  #
2462
3380
  # @!attribute [rw] dataset_name
2463
- # The name of the dataset being used for the ML model.
3381
+ # The name of the dataset being used for the machine learning model.
2464
3382
  # @return [String]
2465
3383
  #
2466
3384
  # @!attribute [rw] dataset_arn
@@ -2469,13 +3387,52 @@ module Aws::LookoutEquipment
2469
3387
  # @return [String]
2470
3388
  #
2471
3389
  # @!attribute [rw] status
2472
- # Indicates the status of the ML model.
3390
+ # Indicates the status of the machine learning model.
2473
3391
  # @return [String]
2474
3392
  #
2475
3393
  # @!attribute [rw] created_at
2476
3394
  # The time at which the specific model was created.
2477
3395
  # @return [Time]
2478
3396
  #
3397
+ # @!attribute [rw] active_model_version
3398
+ # The model version that the inference scheduler uses to run an
3399
+ # inference execution.
3400
+ # @return [Integer]
3401
+ #
3402
+ # @!attribute [rw] active_model_version_arn
3403
+ # The Amazon Resource Name (ARN) of the model version that is set as
3404
+ # active. The active model version is the model version that the
3405
+ # inference scheduler uses to run an inference execution.
3406
+ # @return [String]
3407
+ #
3408
+ # @!attribute [rw] latest_scheduled_retraining_status
3409
+ # Indicates the status of the most recent scheduled retraining run.
3410
+ # @return [String]
3411
+ #
3412
+ # @!attribute [rw] latest_scheduled_retraining_model_version
3413
+ # Indicates the most recent model version that was generated by
3414
+ # retraining.
3415
+ # @return [Integer]
3416
+ #
3417
+ # @!attribute [rw] latest_scheduled_retraining_start_time
3418
+ # Indicates the start time of the most recent scheduled retraining
3419
+ # run.
3420
+ # @return [Time]
3421
+ #
3422
+ # @!attribute [rw] next_scheduled_retraining_start_date
3423
+ # Indicates the date that the next scheduled retraining run will start
3424
+ # on. Lookout for Equipment truncates the time you provide to [the
3425
+ # nearest UTC day][1].
3426
+ #
3427
+ #
3428
+ #
3429
+ # [1]: https://docs.aws.amazon.com/https:/docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
3430
+ # @return [Time]
3431
+ #
3432
+ # @!attribute [rw] retraining_scheduler_status
3433
+ # Indicates the status of the retraining scheduler.
3434
+ # @return [String]
3435
+ #
2479
3436
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ModelSummary AWS API Documentation
2480
3437
  #
2481
3438
  class ModelSummary < Struct.new(
@@ -2484,7 +3441,59 @@ module Aws::LookoutEquipment
2484
3441
  :dataset_name,
2485
3442
  :dataset_arn,
2486
3443
  :status,
2487
- :created_at)
3444
+ :created_at,
3445
+ :active_model_version,
3446
+ :active_model_version_arn,
3447
+ :latest_scheduled_retraining_status,
3448
+ :latest_scheduled_retraining_model_version,
3449
+ :latest_scheduled_retraining_start_time,
3450
+ :next_scheduled_retraining_start_date,
3451
+ :retraining_scheduler_status)
3452
+ SENSITIVE = []
3453
+ include Aws::Structure
3454
+ end
3455
+
3456
+ # Contains information about the specific model version.
3457
+ #
3458
+ # @!attribute [rw] model_name
3459
+ # The name of the model that this model version is a version of.
3460
+ # @return [String]
3461
+ #
3462
+ # @!attribute [rw] model_arn
3463
+ # The Amazon Resource Name (ARN) of the model that this model version
3464
+ # is a version of.
3465
+ # @return [String]
3466
+ #
3467
+ # @!attribute [rw] model_version
3468
+ # The version of the model.
3469
+ # @return [Integer]
3470
+ #
3471
+ # @!attribute [rw] model_version_arn
3472
+ # The Amazon Resource Name (ARN) of the model version.
3473
+ # @return [String]
3474
+ #
3475
+ # @!attribute [rw] created_at
3476
+ # The time when this model version was created.
3477
+ # @return [Time]
3478
+ #
3479
+ # @!attribute [rw] status
3480
+ # The current status of the model version.
3481
+ # @return [String]
3482
+ #
3483
+ # @!attribute [rw] source_type
3484
+ # Indicates how this model version was generated.
3485
+ # @return [String]
3486
+ #
3487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ModelVersionSummary AWS API Documentation
3488
+ #
3489
+ class ModelVersionSummary < Struct.new(
3490
+ :model_name,
3491
+ :model_arn,
3492
+ :model_version,
3493
+ :model_version_arn,
3494
+ :created_at,
3495
+ :status,
3496
+ :source_type)
2488
3497
  SENSITIVE = []
2489
3498
  include Aws::Structure
2490
3499
  end
@@ -2525,6 +3534,56 @@ module Aws::LookoutEquipment
2525
3534
  include Aws::Structure
2526
3535
  end
2527
3536
 
3537
+ # @!attribute [rw] resource_arn
3538
+ # The Amazon Resource Name (ARN) of the resource for which the policy
3539
+ # is being created.
3540
+ # @return [String]
3541
+ #
3542
+ # @!attribute [rw] resource_policy
3543
+ # The JSON-formatted resource policy to create.
3544
+ # @return [String]
3545
+ #
3546
+ # @!attribute [rw] policy_revision_id
3547
+ # A unique identifier for a revision of the resource policy.
3548
+ # @return [String]
3549
+ #
3550
+ # @!attribute [rw] client_token
3551
+ # A unique identifier for the request. If you do not set the client
3552
+ # request token, Amazon Lookout for Equipment generates one.
3553
+ #
3554
+ # **A suitable default value is auto-generated.** You should normally
3555
+ # not need to pass this option.
3556
+ # @return [String]
3557
+ #
3558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/PutResourcePolicyRequest AWS API Documentation
3559
+ #
3560
+ class PutResourcePolicyRequest < Struct.new(
3561
+ :resource_arn,
3562
+ :resource_policy,
3563
+ :policy_revision_id,
3564
+ :client_token)
3565
+ SENSITIVE = []
3566
+ include Aws::Structure
3567
+ end
3568
+
3569
+ # @!attribute [rw] resource_arn
3570
+ # The Amazon Resource Name (ARN) of the resource for which the policy
3571
+ # was created.
3572
+ # @return [String]
3573
+ #
3574
+ # @!attribute [rw] policy_revision_id
3575
+ # A unique identifier for a revision of the resource policy.
3576
+ # @return [String]
3577
+ #
3578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/PutResourcePolicyResponse AWS API Documentation
3579
+ #
3580
+ class PutResourcePolicyResponse < Struct.new(
3581
+ :resource_arn,
3582
+ :policy_revision_id)
3583
+ SENSITIVE = []
3584
+ include Aws::Structure
3585
+ end
3586
+
2528
3587
  # The resource requested could not be found. Verify the resource ID and
2529
3588
  # retry your request.
2530
3589
  #
@@ -2539,6 +3598,53 @@ module Aws::LookoutEquipment
2539
3598
  include Aws::Structure
2540
3599
  end
2541
3600
 
3601
+ # Provides information about the specified retraining scheduler,
3602
+ # including model name, status, start date, frequency, and lookback
3603
+ # window.
3604
+ #
3605
+ # @!attribute [rw] model_name
3606
+ # The name of the model that the retraining scheduler is attached to.
3607
+ # @return [String]
3608
+ #
3609
+ # @!attribute [rw] model_arn
3610
+ # The ARN of the model that the retraining scheduler is attached to.
3611
+ # @return [String]
3612
+ #
3613
+ # @!attribute [rw] status
3614
+ # The status of the retraining scheduler.
3615
+ # @return [String]
3616
+ #
3617
+ # @!attribute [rw] retraining_start_date
3618
+ # The start date for the retraining scheduler. Lookout for Equipment
3619
+ # truncates the time you provide to the nearest UTC day.
3620
+ # @return [Time]
3621
+ #
3622
+ # @!attribute [rw] retraining_frequency
3623
+ # The frequency at which the model retraining is set. This follows the
3624
+ # [ISO 8601][1] guidelines.
3625
+ #
3626
+ #
3627
+ #
3628
+ # [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
3629
+ # @return [String]
3630
+ #
3631
+ # @!attribute [rw] lookback_window
3632
+ # The number of past days of data used for retraining.
3633
+ # @return [String]
3634
+ #
3635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/RetrainingSchedulerSummary AWS API Documentation
3636
+ #
3637
+ class RetrainingSchedulerSummary < Struct.new(
3638
+ :model_name,
3639
+ :model_arn,
3640
+ :status,
3641
+ :retraining_start_date,
3642
+ :retraining_frequency,
3643
+ :lookback_window)
3644
+ SENSITIVE = []
3645
+ include Aws::Structure
3646
+ end
3647
+
2542
3648
  # Contains information about an S3 bucket.
2543
3649
  #
2544
3650
  # @!attribute [rw] bucket
@@ -2546,9 +3652,9 @@ module Aws::LookoutEquipment
2546
3652
  # @return [String]
2547
3653
  #
2548
3654
  # @!attribute [rw] key
2549
- # The AWS Key Management Service (AWS KMS) key being used to encrypt
2550
- # the S3 object. Without this key, data in the bucket is not
2551
- # accessible.
3655
+ # The Amazon Web Services Key Management Service (KMS key) key being
3656
+ # used to encrypt the S3 object. Without this key, data in the bucket
3657
+ # is not accessible.
2552
3658
  # @return [String]
2553
3659
  #
2554
3660
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/S3Object AWS API Documentation
@@ -2742,12 +3848,13 @@ module Aws::LookoutEquipment
2742
3848
  end
2743
3849
 
2744
3850
  # @!attribute [rw] model_arn
2745
- # The Amazon Resource Name (ARN) of the ML model being used by the
2746
- # inference scheduler.
3851
+ # The Amazon Resource Name (ARN) of the machine learning model being
3852
+ # used by the inference scheduler.
2747
3853
  # @return [String]
2748
3854
  #
2749
3855
  # @!attribute [rw] model_name
2750
- # The name of the ML model being used by the inference scheduler.
3856
+ # The name of the machine learning model being used by the inference
3857
+ # scheduler.
2751
3858
  # @return [String]
2752
3859
  #
2753
3860
  # @!attribute [rw] inference_scheduler_name
@@ -2775,6 +3882,40 @@ module Aws::LookoutEquipment
2775
3882
  include Aws::Structure
2776
3883
  end
2777
3884
 
3885
+ # @!attribute [rw] model_name
3886
+ # The name of the model whose retraining scheduler you want to start.
3887
+ # @return [String]
3888
+ #
3889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartRetrainingSchedulerRequest AWS API Documentation
3890
+ #
3891
+ class StartRetrainingSchedulerRequest < Struct.new(
3892
+ :model_name)
3893
+ SENSITIVE = []
3894
+ include Aws::Structure
3895
+ end
3896
+
3897
+ # @!attribute [rw] model_name
3898
+ # The name of the model whose retraining scheduler is being started.
3899
+ # @return [String]
3900
+ #
3901
+ # @!attribute [rw] model_arn
3902
+ # The ARN of the model whose retraining scheduler is being started.
3903
+ # @return [String]
3904
+ #
3905
+ # @!attribute [rw] status
3906
+ # The status of the retraining scheduler.
3907
+ # @return [String]
3908
+ #
3909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartRetrainingSchedulerResponse AWS API Documentation
3910
+ #
3911
+ class StartRetrainingSchedulerResponse < Struct.new(
3912
+ :model_name,
3913
+ :model_arn,
3914
+ :status)
3915
+ SENSITIVE = []
3916
+ include Aws::Structure
3917
+ end
3918
+
2778
3919
  # @!attribute [rw] inference_scheduler_name
2779
3920
  # The name of the inference scheduler to be stopped.
2780
3921
  # @return [String]
@@ -2788,13 +3929,13 @@ module Aws::LookoutEquipment
2788
3929
  end
2789
3930
 
2790
3931
  # @!attribute [rw] model_arn
2791
- # The Amazon Resource Name (ARN) of the ML model used by the inference
2792
- # scheduler being stopped.
3932
+ # The Amazon Resource Name (ARN) of the machine learning model used by
3933
+ # the inference scheduler being stopped.
2793
3934
  # @return [String]
2794
3935
  #
2795
3936
  # @!attribute [rw] model_name
2796
- # The name of the ML model used by the inference scheduler being
2797
- # stopped.
3937
+ # The name of the machine learning model used by the inference
3938
+ # scheduler being stopped.
2798
3939
  # @return [String]
2799
3940
  #
2800
3941
  # @!attribute [rw] inference_scheduler_name
@@ -2822,6 +3963,40 @@ module Aws::LookoutEquipment
2822
3963
  include Aws::Structure
2823
3964
  end
2824
3965
 
3966
+ # @!attribute [rw] model_name
3967
+ # The name of the model whose retraining scheduler you want to stop.
3968
+ # @return [String]
3969
+ #
3970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopRetrainingSchedulerRequest AWS API Documentation
3971
+ #
3972
+ class StopRetrainingSchedulerRequest < Struct.new(
3973
+ :model_name)
3974
+ SENSITIVE = []
3975
+ include Aws::Structure
3976
+ end
3977
+
3978
+ # @!attribute [rw] model_name
3979
+ # The name of the model whose retraining scheduler is being stopped.
3980
+ # @return [String]
3981
+ #
3982
+ # @!attribute [rw] model_arn
3983
+ # The ARN of the model whose retraining scheduler is being stopped.
3984
+ # @return [String]
3985
+ #
3986
+ # @!attribute [rw] status
3987
+ # The status of the retraining scheduler.
3988
+ # @return [String]
3989
+ #
3990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopRetrainingSchedulerResponse AWS API Documentation
3991
+ #
3992
+ class StopRetrainingSchedulerResponse < Struct.new(
3993
+ :model_name,
3994
+ :model_arn,
3995
+ :status)
3996
+ SENSITIVE = []
3997
+ include Aws::Structure
3998
+ end
3999
+
2825
4000
  # A tag is a key-value pair that can be added to a resource as metadata.
2826
4001
  #
2827
4002
  # @!attribute [rw] key
@@ -2916,6 +4091,68 @@ module Aws::LookoutEquipment
2916
4091
  #
2917
4092
  class UntagResourceResponse < Aws::EmptyStructure; end
2918
4093
 
4094
+ # @!attribute [rw] model_name
4095
+ # The name of the machine learning model for which the active model
4096
+ # version is being set.
4097
+ # @return [String]
4098
+ #
4099
+ # @!attribute [rw] model_version
4100
+ # The version of the machine learning model for which the active model
4101
+ # version is being set.
4102
+ # @return [Integer]
4103
+ #
4104
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateActiveModelVersionRequest AWS API Documentation
4105
+ #
4106
+ class UpdateActiveModelVersionRequest < Struct.new(
4107
+ :model_name,
4108
+ :model_version)
4109
+ SENSITIVE = []
4110
+ include Aws::Structure
4111
+ end
4112
+
4113
+ # @!attribute [rw] model_name
4114
+ # The name of the machine learning model for which the active model
4115
+ # version was set.
4116
+ # @return [String]
4117
+ #
4118
+ # @!attribute [rw] model_arn
4119
+ # The Amazon Resource Name (ARN) of the machine learning model for
4120
+ # which the active model version was set.
4121
+ # @return [String]
4122
+ #
4123
+ # @!attribute [rw] current_active_version
4124
+ # The version that is currently active of the machine learning model
4125
+ # for which the active model version was set.
4126
+ # @return [Integer]
4127
+ #
4128
+ # @!attribute [rw] previous_active_version
4129
+ # The previous version that was active of the machine learning model
4130
+ # for which the active model version was set.
4131
+ # @return [Integer]
4132
+ #
4133
+ # @!attribute [rw] current_active_version_arn
4134
+ # The Amazon Resource Name (ARN) of the machine learning model version
4135
+ # that is the current active model version.
4136
+ # @return [String]
4137
+ #
4138
+ # @!attribute [rw] previous_active_version_arn
4139
+ # The Amazon Resource Name (ARN) of the machine learning model version
4140
+ # that was the previous active model version.
4141
+ # @return [String]
4142
+ #
4143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateActiveModelVersionResponse AWS API Documentation
4144
+ #
4145
+ class UpdateActiveModelVersionResponse < Struct.new(
4146
+ :model_name,
4147
+ :model_arn,
4148
+ :current_active_version,
4149
+ :previous_active_version,
4150
+ :current_active_version_arn,
4151
+ :previous_active_version_arn)
4152
+ SENSITIVE = []
4153
+ include Aws::Structure
4154
+ end
4155
+
2919
4156
  # @!attribute [rw] inference_scheduler_name
2920
4157
  # The name of the inference scheduler to be updated.
2921
4158
  # @return [String]
@@ -2991,8 +4228,86 @@ module Aws::LookoutEquipment
2991
4228
  include Aws::Structure
2992
4229
  end
2993
4230
 
4231
+ # @!attribute [rw] model_name
4232
+ # The name of the model to update.
4233
+ # @return [String]
4234
+ #
4235
+ # @!attribute [rw] labels_input_configuration
4236
+ # Contains the configuration information for the S3 location being
4237
+ # used to hold label data.
4238
+ # @return [Types::LabelsInputConfiguration]
4239
+ #
4240
+ # @!attribute [rw] role_arn
4241
+ # The ARN of the model to update.
4242
+ # @return [String]
4243
+ #
4244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateModelRequest AWS API Documentation
4245
+ #
4246
+ class UpdateModelRequest < Struct.new(
4247
+ :model_name,
4248
+ :labels_input_configuration,
4249
+ :role_arn)
4250
+ SENSITIVE = []
4251
+ include Aws::Structure
4252
+ end
4253
+
4254
+ # @!attribute [rw] model_name
4255
+ # The name of the model whose retraining scheduler you want to update.
4256
+ # @return [String]
4257
+ #
4258
+ # @!attribute [rw] retraining_start_date
4259
+ # The start date for the retraining scheduler. Lookout for Equipment
4260
+ # truncates the time you provide to the nearest UTC day.
4261
+ # @return [Time]
4262
+ #
4263
+ # @!attribute [rw] retraining_frequency
4264
+ # This parameter uses the [ISO 8601][1] standard to set the frequency
4265
+ # at which you want retraining to occur in terms of Years, Months,
4266
+ # and/or Days (note: other parameters like Time are not currently
4267
+ # supported). The minimum value is 30 days (P30D) and the maximum
4268
+ # value is 1 year (P1Y). For example, the following values are valid:
4269
+ #
4270
+ # * P3M15D – Every 3 months and 15 days
4271
+ #
4272
+ # * P2M – Every 2 months
4273
+ #
4274
+ # * P150D – Every 150 days
4275
+ #
4276
+ #
4277
+ #
4278
+ # [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
4279
+ # @return [String]
4280
+ #
4281
+ # @!attribute [rw] lookback_window
4282
+ # The number of past days of data that will be used for retraining.
4283
+ # @return [String]
4284
+ #
4285
+ # @!attribute [rw] promote_mode
4286
+ # Indicates how the service will use new models. In `MANAGED` mode,
4287
+ # new models will automatically be used for inference if they have
4288
+ # better performance than the current model. In `MANUAL` mode, the new
4289
+ # models will not be used [until they are manually activated][1].
4290
+ #
4291
+ #
4292
+ #
4293
+ # [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
4294
+ # @return [String]
4295
+ #
4296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateRetrainingSchedulerRequest AWS API Documentation
4297
+ #
4298
+ class UpdateRetrainingSchedulerRequest < Struct.new(
4299
+ :model_name,
4300
+ :retraining_start_date,
4301
+ :retraining_frequency,
4302
+ :lookback_window,
4303
+ :promote_mode)
4304
+ SENSITIVE = []
4305
+ include Aws::Structure
4306
+ end
4307
+
2994
4308
  # The input fails to satisfy constraints specified by Amazon Lookout for
2995
- # Equipment or a related AWS service that's being utilized.
4309
+ # Equipment or a related Amazon Web Services service that's being
4310
+ # utilized.
2996
4311
  #
2997
4312
  # @!attribute [rw] message
2998
4313
  # @return [String]