aws-sdk-lookoutequipment 1.22.0 → 1.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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
@@ -391,20 +391,21 @@ module Aws::LookoutEquipment
391
391
  end
392
392
 
393
393
  # @!attribute [rw] model_name
394
- # The name for the ML model to be created.
394
+ # The name for the machine learning model to be created.
395
395
  # @return [String]
396
396
  #
397
397
  # @!attribute [rw] dataset_name
398
- # 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.
399
400
  # @return [String]
400
401
  #
401
402
  # @!attribute [rw] dataset_schema
402
- # The data schema for the ML model being created.
403
+ # The data schema for the machine learning model being created.
403
404
  # @return [Types::DatasetSchema]
404
405
  #
405
406
  # @!attribute [rw] labels_input_configuration
406
- # The input configuration for the labels being used for the ML model
407
- # that's being created.
407
+ # The input configuration for the labels being used for the machine
408
+ # learning model that's being created.
408
409
  # @return [Types::LabelsInputConfiguration]
409
410
  #
410
411
  # @!attribute [rw] client_token
@@ -417,27 +418,27 @@ module Aws::LookoutEquipment
417
418
  #
418
419
  # @!attribute [rw] training_data_start_time
419
420
  # Indicates the time reference in the dataset that should be used to
420
- # begin the subset of training data for the ML model.
421
+ # begin the subset of training data for the machine learning model.
421
422
  # @return [Time]
422
423
  #
423
424
  # @!attribute [rw] training_data_end_time
424
425
  # Indicates the time reference in the dataset that should be used to
425
- # end the subset of training data for the ML model.
426
+ # end the subset of training data for the machine learning model.
426
427
  # @return [Time]
427
428
  #
428
429
  # @!attribute [rw] evaluation_data_start_time
429
430
  # Indicates the time reference in the dataset that should be used to
430
- # begin the subset of evaluation data for the ML model.
431
+ # begin the subset of evaluation data for the machine learning model.
431
432
  # @return [Time]
432
433
  #
433
434
  # @!attribute [rw] evaluation_data_end_time
434
435
  # Indicates the time reference in the dataset that should be used to
435
- # end the subset of evaluation data for the ML model.
436
+ # end the subset of evaluation data for the machine learning model.
436
437
  # @return [Time]
437
438
  #
438
439
  # @!attribute [rw] role_arn
439
440
  # The Amazon Resource Name (ARN) of a role with permission to access
440
- # the data source being used to create the ML model.
441
+ # the data source being used to create the machine learning model.
441
442
  # @return [String]
442
443
  #
443
444
  # @!attribute [rw] data_pre_processing_configuration
@@ -460,7 +461,7 @@ module Aws::LookoutEquipment
460
461
  # @return [String]
461
462
  #
462
463
  # @!attribute [rw] tags
463
- # Any tags associated with the ML model being created.
464
+ # Any tags associated with the machine learning model being created.
464
465
  # @return [Array<Types::Tag>]
465
466
  #
466
467
  # @!attribute [rw] off_condition
@@ -507,6 +508,91 @@ module Aws::LookoutEquipment
507
508
  include Aws::Structure
508
509
  end
509
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
+
510
596
  # Provides information about a specified data ingestion job, including
511
597
  # dataset information, data ingestion configuration, and status.
512
598
  #
@@ -624,6 +710,7 @@ module Aws::LookoutEquipment
624
710
  # dataset.
625
711
  #
626
712
  # @!attribute [rw] inline_data_schema
713
+ # The data schema used within the given dataset.
627
714
  # @return [String]
628
715
  #
629
716
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DatasetSchema AWS API Documentation
@@ -723,7 +810,7 @@ module Aws::LookoutEquipment
723
810
  end
724
811
 
725
812
  # @!attribute [rw] model_name
726
- # The name of the ML model to be deleted.
813
+ # The name of the machine learning model to be deleted.
727
814
  # @return [String]
728
815
  #
729
816
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteModelRequest AWS API Documentation
@@ -747,6 +834,18 @@ module Aws::LookoutEquipment
747
834
  include Aws::Structure
748
835
  end
749
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
+
750
849
  # @!attribute [rw] job_id
751
850
  # The job ID of the data ingestion job.
752
851
  # @return [String]
@@ -966,12 +1065,13 @@ module Aws::LookoutEquipment
966
1065
  end
967
1066
 
968
1067
  # @!attribute [rw] model_arn
969
- # The Amazon Resource Name (ARN) of the ML model of the inference
970
- # scheduler being described.
1068
+ # The Amazon Resource Name (ARN) of the machine learning model of the
1069
+ # inference scheduler being described.
971
1070
  # @return [String]
972
1071
  #
973
1072
  # @!attribute [rw] model_name
974
- # 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.
975
1075
  # @return [String]
976
1076
  #
977
1077
  # @!attribute [rw] inference_scheduler_name
@@ -1192,7 +1292,7 @@ module Aws::LookoutEquipment
1192
1292
  end
1193
1293
 
1194
1294
  # @!attribute [rw] model_name
1195
- # The name of the ML model to be described.
1295
+ # The name of the machine learning model to be described.
1196
1296
  # @return [String]
1197
1297
  #
1198
1298
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelRequest AWS API Documentation
@@ -1204,20 +1304,22 @@ module Aws::LookoutEquipment
1204
1304
  end
1205
1305
 
1206
1306
  # @!attribute [rw] model_name
1207
- # The name of the ML model being described.
1307
+ # The name of the machine learning model being described.
1208
1308
  # @return [String]
1209
1309
  #
1210
1310
  # @!attribute [rw] model_arn
1211
- # 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.
1212
1313
  # @return [String]
1213
1314
  #
1214
1315
  # @!attribute [rw] dataset_name
1215
- # 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.
1216
1318
  # @return [String]
1217
1319
  #
1218
1320
  # @!attribute [rw] dataset_arn
1219
- # The Amazon Resouce Name (ARN) of the dataset used to create the ML
1220
- # model being described.
1321
+ # The Amazon Resouce Name (ARN) of the dataset used to create the
1322
+ # machine learning model being described.
1221
1323
  # @return [String]
1222
1324
  #
1223
1325
  # @!attribute [rw] schema
@@ -1232,27 +1334,27 @@ module Aws::LookoutEquipment
1232
1334
  #
1233
1335
  # @!attribute [rw] training_data_start_time
1234
1336
  # Indicates the time reference in the dataset that was used to begin
1235
- # the subset of training data for the ML model.
1337
+ # the subset of training data for the machine learning model.
1236
1338
  # @return [Time]
1237
1339
  #
1238
1340
  # @!attribute [rw] training_data_end_time
1239
1341
  # Indicates the time reference in the dataset that was used to end the
1240
- # subset of training data for the ML model.
1342
+ # subset of training data for the machine learning model.
1241
1343
  # @return [Time]
1242
1344
  #
1243
1345
  # @!attribute [rw] evaluation_data_start_time
1244
1346
  # Indicates the time reference in the dataset that was used to begin
1245
- # the subset of evaluation data for the ML model.
1347
+ # the subset of evaluation data for the machine learning model.
1246
1348
  # @return [Time]
1247
1349
  #
1248
1350
  # @!attribute [rw] evaluation_data_end_time
1249
1351
  # Indicates the time reference in the dataset that was used to end the
1250
- # subset of evaluation data for the ML model.
1352
+ # subset of evaluation data for the machine learning model.
1251
1353
  # @return [Time]
1252
1354
  #
1253
1355
  # @!attribute [rw] role_arn
1254
1356
  # The Amazon Resource Name (ARN) of a role with permission to access
1255
- # the data source for the ML model being described.
1357
+ # the data source for the machine learning model being described.
1256
1358
  # @return [String]
1257
1359
  #
1258
1360
  # @!attribute [rw] data_pre_processing_configuration
@@ -1275,17 +1377,18 @@ module Aws::LookoutEquipment
1275
1377
  # @return [String]
1276
1378
  #
1277
1379
  # @!attribute [rw] training_execution_start_time
1278
- # 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.
1279
1382
  # @return [Time]
1280
1383
  #
1281
1384
  # @!attribute [rw] training_execution_end_time
1282
- # Indicates the time at which the training of the ML model was
1283
- # completed.
1385
+ # Indicates the time at which the training of the machine learning
1386
+ # model was completed.
1284
1387
  # @return [Time]
1285
1388
  #
1286
1389
  # @!attribute [rw] failed_reason
1287
- # If the training of the ML model failed, this indicates the reason
1288
- # for that failure.
1390
+ # If the training of the machine learning model failed, this indicates
1391
+ # the reason for that failure.
1289
1392
  # @return [String]
1290
1393
  #
1291
1394
  # @!attribute [rw] model_metrics
@@ -1295,12 +1398,13 @@ module Aws::LookoutEquipment
1295
1398
  # @return [String]
1296
1399
  #
1297
1400
  # @!attribute [rw] last_updated_time
1298
- # Indicates the last time the ML model was updated. The type of update
1299
- # is not specified.
1401
+ # Indicates the last time the machine learning model was updated. The
1402
+ # type of update is not specified.
1300
1403
  # @return [Time]
1301
1404
  #
1302
1405
  # @!attribute [rw] created_at
1303
- # 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.
1304
1408
  # @return [Time]
1305
1409
  #
1306
1410
  # @!attribute [rw] server_side_kms_key_id
@@ -1358,6 +1462,57 @@ module Aws::LookoutEquipment
1358
1462
  # activated.
1359
1463
  # @return [Time]
1360
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
+ #
1361
1516
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelResponse AWS API Documentation
1362
1517
  #
1363
1518
  class DescribeModelResponse < Struct.new(
@@ -1390,7 +1545,17 @@ module Aws::LookoutEquipment
1390
1545
  :model_version_activated_at,
1391
1546
  :previous_active_model_version,
1392
1547
  :previous_active_model_version_arn,
1393
- :previous_model_version_activated_at)
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)
1394
1559
  SENSITIVE = []
1395
1560
  include Aws::Structure
1396
1561
  end
@@ -1558,6 +1723,33 @@ module Aws::LookoutEquipment
1558
1723
  # model version was imported.
1559
1724
  # @return [Integer]
1560
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
+ #
1561
1753
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelVersionResponse AWS API Documentation
1562
1754
  #
1563
1755
  class DescribeModelVersionResponse < Struct.new(
@@ -1588,7 +1780,11 @@ module Aws::LookoutEquipment
1588
1780
  :source_model_version_arn,
1589
1781
  :import_job_start_time,
1590
1782
  :import_job_end_time,
1591
- :imported_data_size_in_bytes)
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)
1592
1788
  SENSITIVE = []
1593
1789
  include Aws::Structure
1594
1790
  end
@@ -1633,6 +1829,85 @@ module Aws::LookoutEquipment
1633
1829
  include Aws::Structure
1634
1830
  end
1635
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
+
1636
1911
  # Entity that comprises information abount duplicate timestamps in the
1637
1912
  # dataset.
1638
1913
  #
@@ -1758,6 +2033,19 @@ module Aws::LookoutEquipment
1758
2033
  # The tags associated with the machine learning model to be created.
1759
2034
  # @return [Array<Types::Tag>]
1760
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
+ #
1761
2049
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportModelVersionRequest AWS API Documentation
1762
2050
  #
1763
2051
  class ImportModelVersionRequest < Struct.new(
@@ -1768,7 +2056,8 @@ module Aws::LookoutEquipment
1768
2056
  :client_token,
1769
2057
  :role_arn,
1770
2058
  :server_side_kms_key_id,
1771
- :tags)
2059
+ :tags,
2060
+ :inference_data_import_strategy)
1772
2061
  SENSITIVE = []
1773
2062
  include Aws::Structure
1774
2063
  end
@@ -1853,12 +2142,13 @@ module Aws::LookoutEquipment
1853
2142
  # status, and so on.
1854
2143
  #
1855
2144
  # @!attribute [rw] model_name
1856
- # The name of the ML model being used for the inference execution.
2145
+ # The name of the machine learning model being used for the inference
2146
+ # execution.
1857
2147
  # @return [String]
1858
2148
  #
1859
2149
  # @!attribute [rw] model_arn
1860
- # The Amazon Resource Name (ARN) of the ML model used for the
1861
- # inference execution.
2150
+ # The Amazon Resource Name (ARN) of the machine learning model used
2151
+ # for the inference execution.
1862
2152
  # @return [String]
1863
2153
  #
1864
2154
  # @!attribute [rw] inference_scheduler_name
@@ -1898,6 +2188,7 @@ module Aws::LookoutEquipment
1898
2188
  # @return [Types::InferenceOutputConfiguration]
1899
2189
  #
1900
2190
  # @!attribute [rw] customer_result_object
2191
+ # The S3 object that the inference execution results were uploaded to.
1901
2192
  # @return [Types::S3Object]
1902
2193
  #
1903
2194
  # @!attribute [rw] status
@@ -1909,6 +2200,15 @@ module Aws::LookoutEquipment
1909
2200
  # failed.
1910
2201
  # @return [String]
1911
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
+ #
1912
2212
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceExecutionSummary AWS API Documentation
1913
2213
  #
1914
2214
  class InferenceExecutionSummary < Struct.new(
@@ -1923,7 +2223,9 @@ module Aws::LookoutEquipment
1923
2223
  :data_output_configuration,
1924
2224
  :customer_result_object,
1925
2225
  :status,
1926
- :failed_reason)
2226
+ :failed_reason,
2227
+ :model_version,
2228
+ :model_version_arn)
1927
2229
  SENSITIVE = []
1928
2230
  include Aws::Structure
1929
2231
  end
@@ -2045,12 +2347,13 @@ module Aws::LookoutEquipment
2045
2347
  # data delay offset, model name and ARN, status, and so on.
2046
2348
  #
2047
2349
  # @!attribute [rw] model_name
2048
- # 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.
2049
2352
  # @return [String]
2050
2353
  #
2051
2354
  # @!attribute [rw] model_arn
2052
- # The Amazon Resource Name (ARN) of the ML model used by the inference
2053
- # scheduler.
2355
+ # The Amazon Resource Name (ARN) of the machine learning model used by
2356
+ # the inference scheduler.
2054
2357
  # @return [String]
2055
2358
  #
2056
2359
  # @!attribute [rw] inference_scheduler_name
@@ -2620,8 +2923,8 @@ module Aws::LookoutEquipment
2620
2923
  # @return [String]
2621
2924
  #
2622
2925
  # @!attribute [rw] model_name
2623
- # The name of the ML model used by the inference scheduler to be
2624
- # listed.
2926
+ # The name of the machine learning model used by the inference
2927
+ # scheduler to be listed.
2625
2928
  # @return [String]
2626
2929
  #
2627
2930
  # @!attribute [rw] status
@@ -2847,24 +3150,25 @@ module Aws::LookoutEquipment
2847
3150
 
2848
3151
  # @!attribute [rw] next_token
2849
3152
  # An opaque pagination token indicating where to continue the listing
2850
- # of ML models.
3153
+ # of machine learning models.
2851
3154
  # @return [String]
2852
3155
  #
2853
3156
  # @!attribute [rw] max_results
2854
- # Specifies the maximum number of ML models to list.
3157
+ # Specifies the maximum number of machine learning models to list.
2855
3158
  # @return [Integer]
2856
3159
  #
2857
3160
  # @!attribute [rw] status
2858
- # The status of the ML model.
3161
+ # The status of the machine learning model.
2859
3162
  # @return [String]
2860
3163
  #
2861
3164
  # @!attribute [rw] model_name_begins_with
2862
- # 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.
2863
3167
  # @return [String]
2864
3168
  #
2865
3169
  # @!attribute [rw] dataset_name_begins_with
2866
- # The beginning of the name of the dataset of the ML models to be
2867
- # listed.
3170
+ # The beginning of the name of the dataset of the machine learning
3171
+ # models to be listed.
2868
3172
  # @return [String]
2869
3173
  #
2870
3174
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelsRequest AWS API Documentation
@@ -2881,7 +3185,7 @@ module Aws::LookoutEquipment
2881
3185
 
2882
3186
  # @!attribute [rw] next_token
2883
3187
  # An opaque pagination token indicating where to continue the listing
2884
- # of ML models.
3188
+ # of machine learning models.
2885
3189
  # @return [String]
2886
3190
  #
2887
3191
  # @!attribute [rw] model_summaries
@@ -2898,6 +3202,57 @@ module Aws::LookoutEquipment
2898
3202
  include Aws::Structure
2899
3203
  end
2900
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)
3232
+ SENSITIVE = []
3233
+ include Aws::Structure
3234
+ end
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
+ #
3241
+ # @!attribute [rw] next_token
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.
3245
+ # @return [String]
3246
+ #
3247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulersResponse AWS API Documentation
3248
+ #
3249
+ class ListRetrainingSchedulersResponse < Struct.new(
3250
+ :retraining_scheduler_summaries,
3251
+ :next_token)
3252
+ SENSITIVE = []
3253
+ include Aws::Structure
3254
+ end
3255
+
2901
3256
  # @!attribute [rw] dataset_name
2902
3257
  # The name of the dataset associated with the list of Sensor
2903
3258
  # Statistics.
@@ -3011,19 +3366,19 @@ module Aws::LookoutEquipment
3011
3366
  include Aws::Structure
3012
3367
  end
3013
3368
 
3014
- # Provides information about the specified ML model, including dataset
3015
- # 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.
3016
3371
  #
3017
3372
  # @!attribute [rw] model_name
3018
- # The name of the ML model.
3373
+ # The name of the machine learning model.
3019
3374
  # @return [String]
3020
3375
  #
3021
3376
  # @!attribute [rw] model_arn
3022
- # The Amazon Resource Name (ARN) of the ML model.
3377
+ # The Amazon Resource Name (ARN) of the machine learning model.
3023
3378
  # @return [String]
3024
3379
  #
3025
3380
  # @!attribute [rw] dataset_name
3026
- # The name of the dataset being used for the ML model.
3381
+ # The name of the dataset being used for the machine learning model.
3027
3382
  # @return [String]
3028
3383
  #
3029
3384
  # @!attribute [rw] dataset_arn
@@ -3032,7 +3387,7 @@ module Aws::LookoutEquipment
3032
3387
  # @return [String]
3033
3388
  #
3034
3389
  # @!attribute [rw] status
3035
- # Indicates the status of the ML model.
3390
+ # Indicates the status of the machine learning model.
3036
3391
  # @return [String]
3037
3392
  #
3038
3393
  # @!attribute [rw] created_at
@@ -3050,6 +3405,34 @@ module Aws::LookoutEquipment
3050
3405
  # inference scheduler uses to run an inference execution.
3051
3406
  # @return [String]
3052
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
+ #
3053
3436
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ModelSummary AWS API Documentation
3054
3437
  #
3055
3438
  class ModelSummary < Struct.new(
@@ -3060,7 +3443,12 @@ module Aws::LookoutEquipment
3060
3443
  :status,
3061
3444
  :created_at,
3062
3445
  :active_model_version,
3063
- :active_model_version_arn)
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)
3064
3452
  SENSITIVE = []
3065
3453
  include Aws::Structure
3066
3454
  end
@@ -3210,6 +3598,53 @@ module Aws::LookoutEquipment
3210
3598
  include Aws::Structure
3211
3599
  end
3212
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
+
3213
3648
  # Contains information about an S3 bucket.
3214
3649
  #
3215
3650
  # @!attribute [rw] bucket
@@ -3413,12 +3848,13 @@ module Aws::LookoutEquipment
3413
3848
  end
3414
3849
 
3415
3850
  # @!attribute [rw] model_arn
3416
- # The Amazon Resource Name (ARN) of the ML model being used by the
3417
- # inference scheduler.
3851
+ # The Amazon Resource Name (ARN) of the machine learning model being
3852
+ # used by the inference scheduler.
3418
3853
  # @return [String]
3419
3854
  #
3420
3855
  # @!attribute [rw] model_name
3421
- # 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.
3422
3858
  # @return [String]
3423
3859
  #
3424
3860
  # @!attribute [rw] inference_scheduler_name
@@ -3446,6 +3882,40 @@ module Aws::LookoutEquipment
3446
3882
  include Aws::Structure
3447
3883
  end
3448
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
+
3449
3919
  # @!attribute [rw] inference_scheduler_name
3450
3920
  # The name of the inference scheduler to be stopped.
3451
3921
  # @return [String]
@@ -3459,13 +3929,13 @@ module Aws::LookoutEquipment
3459
3929
  end
3460
3930
 
3461
3931
  # @!attribute [rw] model_arn
3462
- # The Amazon Resource Name (ARN) of the ML model used by the inference
3463
- # scheduler being stopped.
3932
+ # The Amazon Resource Name (ARN) of the machine learning model used by
3933
+ # the inference scheduler being stopped.
3464
3934
  # @return [String]
3465
3935
  #
3466
3936
  # @!attribute [rw] model_name
3467
- # The name of the ML model used by the inference scheduler being
3468
- # stopped.
3937
+ # The name of the machine learning model used by the inference
3938
+ # scheduler being stopped.
3469
3939
  # @return [String]
3470
3940
  #
3471
3941
  # @!attribute [rw] inference_scheduler_name
@@ -3493,6 +3963,40 @@ module Aws::LookoutEquipment
3493
3963
  include Aws::Structure
3494
3964
  end
3495
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
+
3496
4000
  # A tag is a key-value pair that can be added to a resource as metadata.
3497
4001
  #
3498
4002
  # @!attribute [rw] key
@@ -3724,6 +4228,83 @@ module Aws::LookoutEquipment
3724
4228
  include Aws::Structure
3725
4229
  end
3726
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
+
3727
4308
  # The input fails to satisfy constraints specified by Amazon Lookout for
3728
4309
  # Equipment or a related Amazon Web Services service that's being
3729
4310
  # utilized.