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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutequipment/client.rb +1095 -49
- data/lib/aws-sdk-lookoutequipment/client_api.rb +516 -0
- data/lib/aws-sdk-lookoutequipment/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-lookoutequipment/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-lookoutequipment/endpoints.rb +224 -0
- data/lib/aws-sdk-lookoutequipment/plugins/endpoints.rb +32 -0
- data/lib/aws-sdk-lookoutequipment/types.rb +1503 -188
- data/lib/aws-sdk-lookoutequipment.rb +1 -1
- metadata +2 -2
@@ -400,10 +400,9 @@ module Aws::LookoutEquipment
|
|
400
400
|
|
401
401
|
# Creates a container for a collection of data being ingested for
|
402
402
|
# analysis. The dataset contains the metadata describing where the data
|
403
|
-
# is and what the data actually looks like.
|
404
|
-
#
|
405
|
-
#
|
406
|
-
# ingested data.
|
403
|
+
# is and what the data actually looks like. For example, it contains the
|
404
|
+
# location of the data source, the data schema, and other information. A
|
405
|
+
# dataset also contains any tags associated with the ingested data.
|
407
406
|
#
|
408
407
|
# @option params [required, String] :dataset_name
|
409
408
|
# The name of the dataset being created.
|
@@ -453,7 +452,7 @@ module Aws::LookoutEquipment
|
|
453
452
|
#
|
454
453
|
# resp.dataset_name #=> String
|
455
454
|
# resp.dataset_arn #=> String
|
456
|
-
# resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
|
455
|
+
# resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE", "IMPORT_IN_PROGRESS"
|
457
456
|
#
|
458
457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateDataset AWS API Documentation
|
459
458
|
#
|
@@ -473,8 +472,8 @@ module Aws::LookoutEquipment
|
|
473
472
|
# output data.
|
474
473
|
#
|
475
474
|
# @option params [required, String] :model_name
|
476
|
-
# The name of the previously trained
|
477
|
-
# inference scheduler.
|
475
|
+
# The name of the previously trained machine learning model being used
|
476
|
+
# to create the inference scheduler.
|
478
477
|
#
|
479
478
|
# @option params [required, String] :inference_scheduler_name
|
480
479
|
# The name of the inference scheduler being created.
|
@@ -728,7 +727,7 @@ module Aws::LookoutEquipment
|
|
728
727
|
req.send_request(options)
|
729
728
|
end
|
730
729
|
|
731
|
-
# Creates
|
730
|
+
# Creates a machine learning model for data inference.
|
732
731
|
#
|
733
732
|
# A machine-learning (ML) model is a mathematical model that finds
|
734
733
|
# patterns in your data. In Amazon Lookout for Equipment, the model
|
@@ -743,17 +742,17 @@ module Aws::LookoutEquipment
|
|
743
742
|
# is used to evaluate the model's accuracy.
|
744
743
|
#
|
745
744
|
# @option params [required, String] :model_name
|
746
|
-
# The name for the
|
745
|
+
# The name for the machine learning model to be created.
|
747
746
|
#
|
748
747
|
# @option params [required, String] :dataset_name
|
749
|
-
# The name of the dataset for the
|
748
|
+
# The name of the dataset for the machine learning model being created.
|
750
749
|
#
|
751
750
|
# @option params [Types::DatasetSchema] :dataset_schema
|
752
|
-
# The data schema for the
|
751
|
+
# The data schema for the machine learning model being created.
|
753
752
|
#
|
754
753
|
# @option params [Types::LabelsInputConfiguration] :labels_input_configuration
|
755
|
-
# The input configuration for the labels being used for the
|
756
|
-
# that's being created.
|
754
|
+
# The input configuration for the labels being used for the machine
|
755
|
+
# learning model that's being created.
|
757
756
|
#
|
758
757
|
# @option params [required, String] :client_token
|
759
758
|
# A unique identifier for the request. If you do not set the client
|
@@ -764,23 +763,23 @@ module Aws::LookoutEquipment
|
|
764
763
|
#
|
765
764
|
# @option params [Time,DateTime,Date,Integer,String] :training_data_start_time
|
766
765
|
# Indicates the time reference in the dataset that should be used to
|
767
|
-
# begin the subset of training data for the
|
766
|
+
# begin the subset of training data for the machine learning model.
|
768
767
|
#
|
769
768
|
# @option params [Time,DateTime,Date,Integer,String] :training_data_end_time
|
770
769
|
# Indicates the time reference in the dataset that should be used to end
|
771
|
-
# the subset of training data for the
|
770
|
+
# the subset of training data for the machine learning model.
|
772
771
|
#
|
773
772
|
# @option params [Time,DateTime,Date,Integer,String] :evaluation_data_start_time
|
774
773
|
# Indicates the time reference in the dataset that should be used to
|
775
|
-
# begin the subset of evaluation data for the
|
774
|
+
# begin the subset of evaluation data for the machine learning model.
|
776
775
|
#
|
777
776
|
# @option params [Time,DateTime,Date,Integer,String] :evaluation_data_end_time
|
778
777
|
# Indicates the time reference in the dataset that should be used to end
|
779
|
-
# the subset of evaluation data for the
|
778
|
+
# the subset of evaluation data for the machine learning model.
|
780
779
|
#
|
781
780
|
# @option params [String] :role_arn
|
782
781
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
783
|
-
# data source being used to create the
|
782
|
+
# data source being used to create the machine learning model.
|
784
783
|
#
|
785
784
|
# @option params [Types::DataPreProcessingConfiguration] :data_pre_processing_configuration
|
786
785
|
# The configuration is the `TargetSamplingRate`, which is the sampling
|
@@ -799,7 +798,7 @@ module Aws::LookoutEquipment
|
|
799
798
|
# Amazon Lookout for Equipment.
|
800
799
|
#
|
801
800
|
# @option params [Array<Types::Tag>] :tags
|
802
|
-
# Any tags associated with the
|
801
|
+
# Any tags associated with the machine learning model being created.
|
803
802
|
#
|
804
803
|
# @option params [String] :off_condition
|
805
804
|
# Indicates that the asset associated with this sensor has been shut
|
@@ -848,7 +847,7 @@ module Aws::LookoutEquipment
|
|
848
847
|
# @example Response structure
|
849
848
|
#
|
850
849
|
# resp.model_arn #=> String
|
851
|
-
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
850
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
852
851
|
#
|
853
852
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateModel AWS API Documentation
|
854
853
|
#
|
@@ -859,6 +858,119 @@ module Aws::LookoutEquipment
|
|
859
858
|
req.send_request(options)
|
860
859
|
end
|
861
860
|
|
861
|
+
# Creates a retraining scheduler on the specified model.
|
862
|
+
#
|
863
|
+
# @option params [required, String] :model_name
|
864
|
+
# The name of the model to add the retraining scheduler to.
|
865
|
+
#
|
866
|
+
# @option params [Time,DateTime,Date,Integer,String] :retraining_start_date
|
867
|
+
# The start date for the retraining scheduler. Lookout for Equipment
|
868
|
+
# truncates the time you provide to the nearest UTC day.
|
869
|
+
#
|
870
|
+
# @option params [required, String] :retraining_frequency
|
871
|
+
# This parameter uses the [ISO 8601][1] standard to set the frequency at
|
872
|
+
# which you want retraining to occur in terms of Years, Months, and/or
|
873
|
+
# Days (note: other parameters like Time are not currently supported).
|
874
|
+
# The minimum value is 30 days (P30D) and the maximum value is 1 year
|
875
|
+
# (P1Y). For example, the following values are valid:
|
876
|
+
#
|
877
|
+
# * P3M15D – Every 3 months and 15 days
|
878
|
+
#
|
879
|
+
# * P2M – Every 2 months
|
880
|
+
#
|
881
|
+
# * P150D – Every 150 days
|
882
|
+
#
|
883
|
+
#
|
884
|
+
#
|
885
|
+
# [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
|
886
|
+
#
|
887
|
+
# @option params [required, String] :lookback_window
|
888
|
+
# The number of past days of data that will be used for retraining.
|
889
|
+
#
|
890
|
+
# @option params [String] :promote_mode
|
891
|
+
# Indicates how the service will use new models. In `MANAGED` mode, new
|
892
|
+
# models will automatically be used for inference if they have better
|
893
|
+
# performance than the current model. In `MANUAL` mode, the new models
|
894
|
+
# will not be used [until they are manually activated][1].
|
895
|
+
#
|
896
|
+
#
|
897
|
+
#
|
898
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
|
899
|
+
#
|
900
|
+
# @option params [required, String] :client_token
|
901
|
+
# A unique identifier for the request. If you do not set the client
|
902
|
+
# request token, Amazon Lookout for Equipment generates one.
|
903
|
+
#
|
904
|
+
# **A suitable default value is auto-generated.** You should normally
|
905
|
+
# not need to pass this option.**
|
906
|
+
#
|
907
|
+
# @return [Types::CreateRetrainingSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
908
|
+
#
|
909
|
+
# * {Types::CreateRetrainingSchedulerResponse#model_name #model_name} => String
|
910
|
+
# * {Types::CreateRetrainingSchedulerResponse#model_arn #model_arn} => String
|
911
|
+
# * {Types::CreateRetrainingSchedulerResponse#status #status} => String
|
912
|
+
#
|
913
|
+
#
|
914
|
+
# @example Example: Creates a retraining scheduler with manual promote mode
|
915
|
+
#
|
916
|
+
# resp = client.create_retraining_scheduler({
|
917
|
+
# client_token: "sample-client-token",
|
918
|
+
# lookback_window: "P360D",
|
919
|
+
# model_name: "sample-model",
|
920
|
+
# promote_mode: "MANUAL",
|
921
|
+
# retraining_frequency: "P1M",
|
922
|
+
# })
|
923
|
+
#
|
924
|
+
# resp.to_h outputs the following:
|
925
|
+
# {
|
926
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
927
|
+
# model_name: "sample-model",
|
928
|
+
# status: "PENDING",
|
929
|
+
# }
|
930
|
+
#
|
931
|
+
# @example Example: Creates a retraining scheduler with a specific start date
|
932
|
+
#
|
933
|
+
# resp = client.create_retraining_scheduler({
|
934
|
+
# client_token: "sample-client-token",
|
935
|
+
# lookback_window: "P360D",
|
936
|
+
# model_name: "sample-model",
|
937
|
+
# retraining_frequency: "P1M",
|
938
|
+
# retraining_start_date: Time.parse("2024-01-01T00:00:00Z"),
|
939
|
+
# })
|
940
|
+
#
|
941
|
+
# resp.to_h outputs the following:
|
942
|
+
# {
|
943
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
944
|
+
# model_name: "sample-model",
|
945
|
+
# status: "PENDING",
|
946
|
+
# }
|
947
|
+
#
|
948
|
+
# @example Request syntax with placeholder values
|
949
|
+
#
|
950
|
+
# resp = client.create_retraining_scheduler({
|
951
|
+
# model_name: "ModelName", # required
|
952
|
+
# retraining_start_date: Time.now,
|
953
|
+
# retraining_frequency: "RetrainingFrequency", # required
|
954
|
+
# lookback_window: "LookbackWindow", # required
|
955
|
+
# promote_mode: "MANAGED", # accepts MANAGED, MANUAL
|
956
|
+
# client_token: "IdempotenceToken", # required
|
957
|
+
# })
|
958
|
+
#
|
959
|
+
# @example Response structure
|
960
|
+
#
|
961
|
+
# resp.model_name #=> String
|
962
|
+
# resp.model_arn #=> String
|
963
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
964
|
+
#
|
965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateRetrainingScheduler AWS API Documentation
|
966
|
+
#
|
967
|
+
# @overload create_retraining_scheduler(params = {})
|
968
|
+
# @param [Hash] params ({})
|
969
|
+
def create_retraining_scheduler(params = {}, options = {})
|
970
|
+
req = build_request(:create_retraining_scheduler, params)
|
971
|
+
req.send_request(options)
|
972
|
+
end
|
973
|
+
|
862
974
|
# Deletes a dataset and associated artifacts. The operation will check
|
863
975
|
# to see if any inference scheduler or data ingestion job is currently
|
864
976
|
# using the dataset, and if there isn't, the dataset, its metadata, and
|
@@ -886,8 +998,8 @@ module Aws::LookoutEquipment
|
|
886
998
|
req.send_request(options)
|
887
999
|
end
|
888
1000
|
|
889
|
-
# Deletes an inference scheduler that has been set up.
|
890
|
-
#
|
1001
|
+
# Deletes an inference scheduler that has been set up. Prior inference
|
1002
|
+
# results will not be deleted.
|
891
1003
|
#
|
892
1004
|
# @option params [required, String] :inference_scheduler_name
|
893
1005
|
# The name of the inference scheduler to be deleted.
|
@@ -961,12 +1073,12 @@ module Aws::LookoutEquipment
|
|
961
1073
|
req.send_request(options)
|
962
1074
|
end
|
963
1075
|
|
964
|
-
# Deletes
|
965
|
-
# Equipment. This will prevent it from being used with an
|
966
|
-
# scheduler, even one that is already set up.
|
1076
|
+
# Deletes a machine learning model currently available for Amazon
|
1077
|
+
# Lookout for Equipment. This will prevent it from being used with an
|
1078
|
+
# inference scheduler, even one that is already set up.
|
967
1079
|
#
|
968
1080
|
# @option params [required, String] :model_name
|
969
|
-
# The name of the
|
1081
|
+
# The name of the machine learning model to be deleted.
|
970
1082
|
#
|
971
1083
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
972
1084
|
#
|
@@ -985,6 +1097,59 @@ module Aws::LookoutEquipment
|
|
985
1097
|
req.send_request(options)
|
986
1098
|
end
|
987
1099
|
|
1100
|
+
# Deletes the resource policy attached to the resource.
|
1101
|
+
#
|
1102
|
+
# @option params [required, String] :resource_arn
|
1103
|
+
# The Amazon Resource Name (ARN) of the resource for which the resource
|
1104
|
+
# policy should be deleted.
|
1105
|
+
#
|
1106
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1107
|
+
#
|
1108
|
+
# @example Request syntax with placeholder values
|
1109
|
+
#
|
1110
|
+
# resp = client.delete_resource_policy({
|
1111
|
+
# resource_arn: "ResourceArn", # required
|
1112
|
+
# })
|
1113
|
+
#
|
1114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteResourcePolicy AWS API Documentation
|
1115
|
+
#
|
1116
|
+
# @overload delete_resource_policy(params = {})
|
1117
|
+
# @param [Hash] params ({})
|
1118
|
+
def delete_resource_policy(params = {}, options = {})
|
1119
|
+
req = build_request(:delete_resource_policy, params)
|
1120
|
+
req.send_request(options)
|
1121
|
+
end
|
1122
|
+
|
1123
|
+
# Deletes a retraining scheduler from a model. The retraining scheduler
|
1124
|
+
# must be in the `STOPPED` status.
|
1125
|
+
#
|
1126
|
+
# @option params [required, String] :model_name
|
1127
|
+
# The name of the model whose retraining scheduler you want to delete.
|
1128
|
+
#
|
1129
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1130
|
+
#
|
1131
|
+
#
|
1132
|
+
# @example Example: Deletes a retraining scheduler
|
1133
|
+
#
|
1134
|
+
# resp = client.delete_retraining_scheduler({
|
1135
|
+
# model_name: "sample-model",
|
1136
|
+
# })
|
1137
|
+
#
|
1138
|
+
# @example Request syntax with placeholder values
|
1139
|
+
#
|
1140
|
+
# resp = client.delete_retraining_scheduler({
|
1141
|
+
# model_name: "ModelName", # required
|
1142
|
+
# })
|
1143
|
+
#
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteRetrainingScheduler AWS API Documentation
|
1145
|
+
#
|
1146
|
+
# @overload delete_retraining_scheduler(params = {})
|
1147
|
+
# @param [Hash] params ({})
|
1148
|
+
def delete_retraining_scheduler(params = {}, options = {})
|
1149
|
+
req = build_request(:delete_retraining_scheduler, params)
|
1150
|
+
req.send_request(options)
|
1151
|
+
end
|
1152
|
+
|
988
1153
|
# Provides information on a specific data ingestion job such as creation
|
989
1154
|
# time, dataset ARN, and status.
|
990
1155
|
#
|
@@ -1006,6 +1171,7 @@ module Aws::LookoutEquipment
|
|
1006
1171
|
# * {Types::DescribeDataIngestionJobResponse#ingested_data_size #ingested_data_size} => Integer
|
1007
1172
|
# * {Types::DescribeDataIngestionJobResponse#data_start_time #data_start_time} => Time
|
1008
1173
|
# * {Types::DescribeDataIngestionJobResponse#data_end_time #data_end_time} => Time
|
1174
|
+
# * {Types::DescribeDataIngestionJobResponse#source_dataset_arn #source_dataset_arn} => String
|
1009
1175
|
#
|
1010
1176
|
# @example Request syntax with placeholder values
|
1011
1177
|
#
|
@@ -1022,7 +1188,7 @@ module Aws::LookoutEquipment
|
|
1022
1188
|
# resp.ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
|
1023
1189
|
# resp.role_arn #=> String
|
1024
1190
|
# resp.created_at #=> Time
|
1025
|
-
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
1191
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
1026
1192
|
# resp.failed_reason #=> String
|
1027
1193
|
# resp.data_quality_summary.insufficient_sensor_data.missing_complete_sensor_data.affected_sensor_count #=> Integer
|
1028
1194
|
# resp.data_quality_summary.insufficient_sensor_data.sensors_with_short_date_range.affected_sensor_count #=> Integer
|
@@ -1041,6 +1207,7 @@ module Aws::LookoutEquipment
|
|
1041
1207
|
# resp.ingested_data_size #=> Integer
|
1042
1208
|
# resp.data_start_time #=> Time
|
1043
1209
|
# resp.data_end_time #=> Time
|
1210
|
+
# resp.source_dataset_arn #=> String
|
1044
1211
|
#
|
1045
1212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJob AWS API Documentation
|
1046
1213
|
#
|
@@ -1072,6 +1239,7 @@ module Aws::LookoutEquipment
|
|
1072
1239
|
# * {Types::DescribeDatasetResponse#role_arn #role_arn} => String
|
1073
1240
|
# * {Types::DescribeDatasetResponse#data_start_time #data_start_time} => Time
|
1074
1241
|
# * {Types::DescribeDatasetResponse#data_end_time #data_end_time} => Time
|
1242
|
+
# * {Types::DescribeDatasetResponse#source_dataset_arn #source_dataset_arn} => String
|
1075
1243
|
#
|
1076
1244
|
# @example Request syntax with placeholder values
|
1077
1245
|
#
|
@@ -1085,7 +1253,7 @@ module Aws::LookoutEquipment
|
|
1085
1253
|
# resp.dataset_arn #=> String
|
1086
1254
|
# resp.created_at #=> Time
|
1087
1255
|
# resp.last_updated_at #=> Time
|
1088
|
-
# resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
|
1256
|
+
# resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE", "IMPORT_IN_PROGRESS"
|
1089
1257
|
# resp.schema #=> String
|
1090
1258
|
# resp.server_side_kms_key_id #=> String
|
1091
1259
|
# resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
|
@@ -1107,6 +1275,7 @@ module Aws::LookoutEquipment
|
|
1107
1275
|
# resp.role_arn #=> String
|
1108
1276
|
# resp.data_start_time #=> Time
|
1109
1277
|
# resp.data_end_time #=> Time
|
1278
|
+
# resp.source_dataset_arn #=> String
|
1110
1279
|
#
|
1111
1280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataset AWS API Documentation
|
1112
1281
|
#
|
@@ -1265,12 +1434,12 @@ module Aws::LookoutEquipment
|
|
1265
1434
|
req.send_request(options)
|
1266
1435
|
end
|
1267
1436
|
|
1268
|
-
# Provides a JSON containing the overall information about a specific
|
1269
|
-
# model, including model name and ARN, dataset,
|
1270
|
-
# information, status, and so on.
|
1437
|
+
# Provides a JSON containing the overall information about a specific
|
1438
|
+
# machine learning model, including model name and ARN, dataset,
|
1439
|
+
# training and evaluation information, status, and so on.
|
1271
1440
|
#
|
1272
1441
|
# @option params [required, String] :model_name
|
1273
|
-
# The name of the
|
1442
|
+
# The name of the machine learning model to be described.
|
1274
1443
|
#
|
1275
1444
|
# @return [Types::DescribeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
1445
|
#
|
@@ -1295,6 +1464,25 @@ module Aws::LookoutEquipment
|
|
1295
1464
|
# * {Types::DescribeModelResponse#created_at #created_at} => Time
|
1296
1465
|
# * {Types::DescribeModelResponse#server_side_kms_key_id #server_side_kms_key_id} => String
|
1297
1466
|
# * {Types::DescribeModelResponse#off_condition #off_condition} => String
|
1467
|
+
# * {Types::DescribeModelResponse#source_model_version_arn #source_model_version_arn} => String
|
1468
|
+
# * {Types::DescribeModelResponse#import_job_start_time #import_job_start_time} => Time
|
1469
|
+
# * {Types::DescribeModelResponse#import_job_end_time #import_job_end_time} => Time
|
1470
|
+
# * {Types::DescribeModelResponse#active_model_version #active_model_version} => Integer
|
1471
|
+
# * {Types::DescribeModelResponse#active_model_version_arn #active_model_version_arn} => String
|
1472
|
+
# * {Types::DescribeModelResponse#model_version_activated_at #model_version_activated_at} => Time
|
1473
|
+
# * {Types::DescribeModelResponse#previous_active_model_version #previous_active_model_version} => Integer
|
1474
|
+
# * {Types::DescribeModelResponse#previous_active_model_version_arn #previous_active_model_version_arn} => String
|
1475
|
+
# * {Types::DescribeModelResponse#previous_model_version_activated_at #previous_model_version_activated_at} => Time
|
1476
|
+
# * {Types::DescribeModelResponse#prior_model_metrics #prior_model_metrics} => String
|
1477
|
+
# * {Types::DescribeModelResponse#latest_scheduled_retraining_failed_reason #latest_scheduled_retraining_failed_reason} => String
|
1478
|
+
# * {Types::DescribeModelResponse#latest_scheduled_retraining_status #latest_scheduled_retraining_status} => String
|
1479
|
+
# * {Types::DescribeModelResponse#latest_scheduled_retraining_model_version #latest_scheduled_retraining_model_version} => Integer
|
1480
|
+
# * {Types::DescribeModelResponse#latest_scheduled_retraining_start_time #latest_scheduled_retraining_start_time} => Time
|
1481
|
+
# * {Types::DescribeModelResponse#latest_scheduled_retraining_available_data_in_days #latest_scheduled_retraining_available_data_in_days} => Integer
|
1482
|
+
# * {Types::DescribeModelResponse#next_scheduled_retraining_start_date #next_scheduled_retraining_start_date} => Time
|
1483
|
+
# * {Types::DescribeModelResponse#accumulated_inference_data_start_time #accumulated_inference_data_start_time} => Time
|
1484
|
+
# * {Types::DescribeModelResponse#accumulated_inference_data_end_time #accumulated_inference_data_end_time} => Time
|
1485
|
+
# * {Types::DescribeModelResponse#retraining_scheduler_status #retraining_scheduler_status} => String
|
1298
1486
|
#
|
1299
1487
|
# @example Request syntax with placeholder values
|
1300
1488
|
#
|
@@ -1318,7 +1506,7 @@ module Aws::LookoutEquipment
|
|
1318
1506
|
# resp.evaluation_data_end_time #=> Time
|
1319
1507
|
# resp.role_arn #=> String
|
1320
1508
|
# resp.data_pre_processing_configuration.target_sampling_rate #=> String, one of "PT1S", "PT5S", "PT10S", "PT15S", "PT30S", "PT1M", "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
|
1321
|
-
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
1509
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
1322
1510
|
# resp.training_execution_start_time #=> Time
|
1323
1511
|
# resp.training_execution_end_time #=> Time
|
1324
1512
|
# resp.failed_reason #=> String
|
@@ -1327,6 +1515,25 @@ module Aws::LookoutEquipment
|
|
1327
1515
|
# resp.created_at #=> Time
|
1328
1516
|
# resp.server_side_kms_key_id #=> String
|
1329
1517
|
# resp.off_condition #=> String
|
1518
|
+
# resp.source_model_version_arn #=> String
|
1519
|
+
# resp.import_job_start_time #=> Time
|
1520
|
+
# resp.import_job_end_time #=> Time
|
1521
|
+
# resp.active_model_version #=> Integer
|
1522
|
+
# resp.active_model_version_arn #=> String
|
1523
|
+
# resp.model_version_activated_at #=> Time
|
1524
|
+
# resp.previous_active_model_version #=> Integer
|
1525
|
+
# resp.previous_active_model_version_arn #=> String
|
1526
|
+
# resp.previous_model_version_activated_at #=> Time
|
1527
|
+
# resp.prior_model_metrics #=> String
|
1528
|
+
# resp.latest_scheduled_retraining_failed_reason #=> String
|
1529
|
+
# resp.latest_scheduled_retraining_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS", "CANCELED"
|
1530
|
+
# resp.latest_scheduled_retraining_model_version #=> Integer
|
1531
|
+
# resp.latest_scheduled_retraining_start_time #=> Time
|
1532
|
+
# resp.latest_scheduled_retraining_available_data_in_days #=> Integer
|
1533
|
+
# resp.next_scheduled_retraining_start_date #=> Time
|
1534
|
+
# resp.accumulated_inference_data_start_time #=> Time
|
1535
|
+
# resp.accumulated_inference_data_end_time #=> Time
|
1536
|
+
# resp.retraining_scheduler_status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
1330
1537
|
#
|
1331
1538
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModel AWS API Documentation
|
1332
1539
|
#
|
@@ -1337,6 +1544,363 @@ module Aws::LookoutEquipment
|
|
1337
1544
|
req.send_request(options)
|
1338
1545
|
end
|
1339
1546
|
|
1547
|
+
# Retrieves information about a specific machine learning model version.
|
1548
|
+
#
|
1549
|
+
# @option params [required, String] :model_name
|
1550
|
+
# The name of the machine learning model that this version belongs to.
|
1551
|
+
#
|
1552
|
+
# @option params [required, Integer] :model_version
|
1553
|
+
# The version of the machine learning model.
|
1554
|
+
#
|
1555
|
+
# @return [Types::DescribeModelVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1556
|
+
#
|
1557
|
+
# * {Types::DescribeModelVersionResponse#model_name #model_name} => String
|
1558
|
+
# * {Types::DescribeModelVersionResponse#model_arn #model_arn} => String
|
1559
|
+
# * {Types::DescribeModelVersionResponse#model_version #model_version} => Integer
|
1560
|
+
# * {Types::DescribeModelVersionResponse#model_version_arn #model_version_arn} => String
|
1561
|
+
# * {Types::DescribeModelVersionResponse#status #status} => String
|
1562
|
+
# * {Types::DescribeModelVersionResponse#source_type #source_type} => String
|
1563
|
+
# * {Types::DescribeModelVersionResponse#dataset_name #dataset_name} => String
|
1564
|
+
# * {Types::DescribeModelVersionResponse#dataset_arn #dataset_arn} => String
|
1565
|
+
# * {Types::DescribeModelVersionResponse#schema #schema} => String
|
1566
|
+
# * {Types::DescribeModelVersionResponse#labels_input_configuration #labels_input_configuration} => Types::LabelsInputConfiguration
|
1567
|
+
# * {Types::DescribeModelVersionResponse#training_data_start_time #training_data_start_time} => Time
|
1568
|
+
# * {Types::DescribeModelVersionResponse#training_data_end_time #training_data_end_time} => Time
|
1569
|
+
# * {Types::DescribeModelVersionResponse#evaluation_data_start_time #evaluation_data_start_time} => Time
|
1570
|
+
# * {Types::DescribeModelVersionResponse#evaluation_data_end_time #evaluation_data_end_time} => Time
|
1571
|
+
# * {Types::DescribeModelVersionResponse#role_arn #role_arn} => String
|
1572
|
+
# * {Types::DescribeModelVersionResponse#data_pre_processing_configuration #data_pre_processing_configuration} => Types::DataPreProcessingConfiguration
|
1573
|
+
# * {Types::DescribeModelVersionResponse#training_execution_start_time #training_execution_start_time} => Time
|
1574
|
+
# * {Types::DescribeModelVersionResponse#training_execution_end_time #training_execution_end_time} => Time
|
1575
|
+
# * {Types::DescribeModelVersionResponse#failed_reason #failed_reason} => String
|
1576
|
+
# * {Types::DescribeModelVersionResponse#model_metrics #model_metrics} => String
|
1577
|
+
# * {Types::DescribeModelVersionResponse#last_updated_time #last_updated_time} => Time
|
1578
|
+
# * {Types::DescribeModelVersionResponse#created_at #created_at} => Time
|
1579
|
+
# * {Types::DescribeModelVersionResponse#server_side_kms_key_id #server_side_kms_key_id} => String
|
1580
|
+
# * {Types::DescribeModelVersionResponse#off_condition #off_condition} => String
|
1581
|
+
# * {Types::DescribeModelVersionResponse#source_model_version_arn #source_model_version_arn} => String
|
1582
|
+
# * {Types::DescribeModelVersionResponse#import_job_start_time #import_job_start_time} => Time
|
1583
|
+
# * {Types::DescribeModelVersionResponse#import_job_end_time #import_job_end_time} => Time
|
1584
|
+
# * {Types::DescribeModelVersionResponse#imported_data_size_in_bytes #imported_data_size_in_bytes} => Integer
|
1585
|
+
# * {Types::DescribeModelVersionResponse#prior_model_metrics #prior_model_metrics} => String
|
1586
|
+
# * {Types::DescribeModelVersionResponse#retraining_available_data_in_days #retraining_available_data_in_days} => Integer
|
1587
|
+
# * {Types::DescribeModelVersionResponse#auto_promotion_result #auto_promotion_result} => String
|
1588
|
+
# * {Types::DescribeModelVersionResponse#auto_promotion_result_reason #auto_promotion_result_reason} => String
|
1589
|
+
#
|
1590
|
+
# @example Request syntax with placeholder values
|
1591
|
+
#
|
1592
|
+
# resp = client.describe_model_version({
|
1593
|
+
# model_name: "ModelName", # required
|
1594
|
+
# model_version: 1, # required
|
1595
|
+
# })
|
1596
|
+
#
|
1597
|
+
# @example Response structure
|
1598
|
+
#
|
1599
|
+
# resp.model_name #=> String
|
1600
|
+
# resp.model_arn #=> String
|
1601
|
+
# resp.model_version #=> Integer
|
1602
|
+
# resp.model_version_arn #=> String
|
1603
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS", "CANCELED"
|
1604
|
+
# resp.source_type #=> String, one of "TRAINING", "RETRAINING", "IMPORT"
|
1605
|
+
# resp.dataset_name #=> String
|
1606
|
+
# resp.dataset_arn #=> String
|
1607
|
+
# resp.schema #=> String
|
1608
|
+
# resp.labels_input_configuration.s3_input_configuration.bucket #=> String
|
1609
|
+
# resp.labels_input_configuration.s3_input_configuration.prefix #=> String
|
1610
|
+
# resp.labels_input_configuration.label_group_name #=> String
|
1611
|
+
# resp.training_data_start_time #=> Time
|
1612
|
+
# resp.training_data_end_time #=> Time
|
1613
|
+
# resp.evaluation_data_start_time #=> Time
|
1614
|
+
# resp.evaluation_data_end_time #=> Time
|
1615
|
+
# resp.role_arn #=> String
|
1616
|
+
# resp.data_pre_processing_configuration.target_sampling_rate #=> String, one of "PT1S", "PT5S", "PT10S", "PT15S", "PT30S", "PT1M", "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
|
1617
|
+
# resp.training_execution_start_time #=> Time
|
1618
|
+
# resp.training_execution_end_time #=> Time
|
1619
|
+
# resp.failed_reason #=> String
|
1620
|
+
# resp.model_metrics #=> String
|
1621
|
+
# resp.last_updated_time #=> Time
|
1622
|
+
# resp.created_at #=> Time
|
1623
|
+
# resp.server_side_kms_key_id #=> String
|
1624
|
+
# resp.off_condition #=> String
|
1625
|
+
# resp.source_model_version_arn #=> String
|
1626
|
+
# resp.import_job_start_time #=> Time
|
1627
|
+
# resp.import_job_end_time #=> Time
|
1628
|
+
# resp.imported_data_size_in_bytes #=> Integer
|
1629
|
+
# resp.prior_model_metrics #=> String
|
1630
|
+
# resp.retraining_available_data_in_days #=> Integer
|
1631
|
+
# resp.auto_promotion_result #=> String, one of "MODEL_PROMOTED", "MODEL_NOT_PROMOTED", "RETRAINING_INTERNAL_ERROR", "RETRAINING_CUSTOMER_ERROR", "RETRAINING_CANCELLED"
|
1632
|
+
# resp.auto_promotion_result_reason #=> String
|
1633
|
+
#
|
1634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeModelVersion AWS API Documentation
|
1635
|
+
#
|
1636
|
+
# @overload describe_model_version(params = {})
|
1637
|
+
# @param [Hash] params ({})
|
1638
|
+
def describe_model_version(params = {}, options = {})
|
1639
|
+
req = build_request(:describe_model_version, params)
|
1640
|
+
req.send_request(options)
|
1641
|
+
end
|
1642
|
+
|
1643
|
+
# Provides the details of a resource policy attached to a resource.
|
1644
|
+
#
|
1645
|
+
# @option params [required, String] :resource_arn
|
1646
|
+
# The Amazon Resource Name (ARN) of the resource that is associated with
|
1647
|
+
# the resource policy.
|
1648
|
+
#
|
1649
|
+
# @return [Types::DescribeResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1650
|
+
#
|
1651
|
+
# * {Types::DescribeResourcePolicyResponse#policy_revision_id #policy_revision_id} => String
|
1652
|
+
# * {Types::DescribeResourcePolicyResponse#resource_policy #resource_policy} => String
|
1653
|
+
# * {Types::DescribeResourcePolicyResponse#creation_time #creation_time} => Time
|
1654
|
+
# * {Types::DescribeResourcePolicyResponse#last_modified_time #last_modified_time} => Time
|
1655
|
+
#
|
1656
|
+
# @example Request syntax with placeholder values
|
1657
|
+
#
|
1658
|
+
# resp = client.describe_resource_policy({
|
1659
|
+
# resource_arn: "ResourceArn", # required
|
1660
|
+
# })
|
1661
|
+
#
|
1662
|
+
# @example Response structure
|
1663
|
+
#
|
1664
|
+
# resp.policy_revision_id #=> String
|
1665
|
+
# resp.resource_policy #=> String
|
1666
|
+
# resp.creation_time #=> Time
|
1667
|
+
# resp.last_modified_time #=> Time
|
1668
|
+
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeResourcePolicy AWS API Documentation
|
1670
|
+
#
|
1671
|
+
# @overload describe_resource_policy(params = {})
|
1672
|
+
# @param [Hash] params ({})
|
1673
|
+
def describe_resource_policy(params = {}, options = {})
|
1674
|
+
req = build_request(:describe_resource_policy, params)
|
1675
|
+
req.send_request(options)
|
1676
|
+
end
|
1677
|
+
|
1678
|
+
# Provides a description of the retraining scheduler, including
|
1679
|
+
# information such as the model name and retraining parameters.
|
1680
|
+
#
|
1681
|
+
# @option params [required, String] :model_name
|
1682
|
+
# The name of the model that the retraining scheduler is attached to.
|
1683
|
+
#
|
1684
|
+
# @return [Types::DescribeRetrainingSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1685
|
+
#
|
1686
|
+
# * {Types::DescribeRetrainingSchedulerResponse#model_name #model_name} => String
|
1687
|
+
# * {Types::DescribeRetrainingSchedulerResponse#model_arn #model_arn} => String
|
1688
|
+
# * {Types::DescribeRetrainingSchedulerResponse#retraining_start_date #retraining_start_date} => Time
|
1689
|
+
# * {Types::DescribeRetrainingSchedulerResponse#retraining_frequency #retraining_frequency} => String
|
1690
|
+
# * {Types::DescribeRetrainingSchedulerResponse#lookback_window #lookback_window} => String
|
1691
|
+
# * {Types::DescribeRetrainingSchedulerResponse#status #status} => String
|
1692
|
+
# * {Types::DescribeRetrainingSchedulerResponse#promote_mode #promote_mode} => String
|
1693
|
+
# * {Types::DescribeRetrainingSchedulerResponse#created_at #created_at} => Time
|
1694
|
+
# * {Types::DescribeRetrainingSchedulerResponse#updated_at #updated_at} => Time
|
1695
|
+
#
|
1696
|
+
#
|
1697
|
+
# @example Example: Describes a retraining scheduler
|
1698
|
+
#
|
1699
|
+
# resp = client.describe_retraining_scheduler({
|
1700
|
+
# model_name: "sample-model",
|
1701
|
+
# })
|
1702
|
+
#
|
1703
|
+
# resp.to_h outputs the following:
|
1704
|
+
# {
|
1705
|
+
# created_at: Time.parse("2023-10-01T15:00:00Z"),
|
1706
|
+
# lookback_window: "P360D",
|
1707
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
1708
|
+
# model_name: "sample-model",
|
1709
|
+
# promote_mode: "MANAGED",
|
1710
|
+
# retraining_frequency: "P1M",
|
1711
|
+
# retraining_start_date: Time.parse("2023-11-01T00:00:00Z"),
|
1712
|
+
# status: "RUNNING",
|
1713
|
+
# updated_at: Time.parse("2023-10-01T15:00:00Z"),
|
1714
|
+
# }
|
1715
|
+
#
|
1716
|
+
# @example Request syntax with placeholder values
|
1717
|
+
#
|
1718
|
+
# resp = client.describe_retraining_scheduler({
|
1719
|
+
# model_name: "ModelName", # required
|
1720
|
+
# })
|
1721
|
+
#
|
1722
|
+
# @example Response structure
|
1723
|
+
#
|
1724
|
+
# resp.model_name #=> String
|
1725
|
+
# resp.model_arn #=> String
|
1726
|
+
# resp.retraining_start_date #=> Time
|
1727
|
+
# resp.retraining_frequency #=> String
|
1728
|
+
# resp.lookback_window #=> String
|
1729
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
1730
|
+
# resp.promote_mode #=> String, one of "MANAGED", "MANUAL"
|
1731
|
+
# resp.created_at #=> Time
|
1732
|
+
# resp.updated_at #=> Time
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeRetrainingScheduler AWS API Documentation
|
1735
|
+
#
|
1736
|
+
# @overload describe_retraining_scheduler(params = {})
|
1737
|
+
# @param [Hash] params ({})
|
1738
|
+
def describe_retraining_scheduler(params = {}, options = {})
|
1739
|
+
req = build_request(:describe_retraining_scheduler, params)
|
1740
|
+
req.send_request(options)
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
# Imports a dataset.
|
1744
|
+
#
|
1745
|
+
# @option params [required, String] :source_dataset_arn
|
1746
|
+
# The Amazon Resource Name (ARN) of the dataset to import.
|
1747
|
+
#
|
1748
|
+
# @option params [String] :dataset_name
|
1749
|
+
# The name of the machine learning dataset to be created. If the dataset
|
1750
|
+
# already exists, Amazon Lookout for Equipment overwrites the existing
|
1751
|
+
# dataset. If you don't specify this field, it is filled with the name
|
1752
|
+
# of the source dataset.
|
1753
|
+
#
|
1754
|
+
# @option params [required, String] :client_token
|
1755
|
+
# A unique identifier for the request. If you do not set the client
|
1756
|
+
# request token, Amazon Lookout for Equipment generates one.
|
1757
|
+
#
|
1758
|
+
# **A suitable default value is auto-generated.** You should normally
|
1759
|
+
# not need to pass this option.**
|
1760
|
+
#
|
1761
|
+
# @option params [String] :server_side_kms_key_id
|
1762
|
+
# Provides the identifier of the KMS key key used to encrypt model data
|
1763
|
+
# by Amazon Lookout for Equipment.
|
1764
|
+
#
|
1765
|
+
# @option params [Array<Types::Tag>] :tags
|
1766
|
+
# Any tags associated with the dataset to be created.
|
1767
|
+
#
|
1768
|
+
# @return [Types::ImportDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1769
|
+
#
|
1770
|
+
# * {Types::ImportDatasetResponse#dataset_name #dataset_name} => String
|
1771
|
+
# * {Types::ImportDatasetResponse#dataset_arn #dataset_arn} => String
|
1772
|
+
# * {Types::ImportDatasetResponse#status #status} => String
|
1773
|
+
# * {Types::ImportDatasetResponse#job_id #job_id} => String
|
1774
|
+
#
|
1775
|
+
# @example Request syntax with placeholder values
|
1776
|
+
#
|
1777
|
+
# resp = client.import_dataset({
|
1778
|
+
# source_dataset_arn: "DatasetArn", # required
|
1779
|
+
# dataset_name: "DatasetName",
|
1780
|
+
# client_token: "IdempotenceToken", # required
|
1781
|
+
# server_side_kms_key_id: "NameOrArn",
|
1782
|
+
# tags: [
|
1783
|
+
# {
|
1784
|
+
# key: "TagKey", # required
|
1785
|
+
# value: "TagValue", # required
|
1786
|
+
# },
|
1787
|
+
# ],
|
1788
|
+
# })
|
1789
|
+
#
|
1790
|
+
# @example Response structure
|
1791
|
+
#
|
1792
|
+
# resp.dataset_name #=> String
|
1793
|
+
# resp.dataset_arn #=> String
|
1794
|
+
# resp.status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE", "IMPORT_IN_PROGRESS"
|
1795
|
+
# resp.job_id #=> String
|
1796
|
+
#
|
1797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportDataset AWS API Documentation
|
1798
|
+
#
|
1799
|
+
# @overload import_dataset(params = {})
|
1800
|
+
# @param [Hash] params ({})
|
1801
|
+
def import_dataset(params = {}, options = {})
|
1802
|
+
req = build_request(:import_dataset, params)
|
1803
|
+
req.send_request(options)
|
1804
|
+
end
|
1805
|
+
|
1806
|
+
# Imports a model that has been trained successfully.
|
1807
|
+
#
|
1808
|
+
# @option params [required, String] :source_model_version_arn
|
1809
|
+
# The Amazon Resource Name (ARN) of the model version to import.
|
1810
|
+
#
|
1811
|
+
# @option params [String] :model_name
|
1812
|
+
# The name for the machine learning model to be created. If the model
|
1813
|
+
# already exists, Amazon Lookout for Equipment creates a new version. If
|
1814
|
+
# you do not specify this field, it is filled with the name of the
|
1815
|
+
# source model.
|
1816
|
+
#
|
1817
|
+
# @option params [required, String] :dataset_name
|
1818
|
+
# The name of the dataset for the machine learning model being imported.
|
1819
|
+
#
|
1820
|
+
# @option params [Types::LabelsInputConfiguration] :labels_input_configuration
|
1821
|
+
# Contains the configuration information for the S3 location being used
|
1822
|
+
# to hold label data.
|
1823
|
+
#
|
1824
|
+
# @option params [required, String] :client_token
|
1825
|
+
# A unique identifier for the request. If you do not set the client
|
1826
|
+
# request token, Amazon Lookout for Equipment generates one.
|
1827
|
+
#
|
1828
|
+
# **A suitable default value is auto-generated.** You should normally
|
1829
|
+
# not need to pass this option.**
|
1830
|
+
#
|
1831
|
+
# @option params [String] :role_arn
|
1832
|
+
# The Amazon Resource Name (ARN) of a role with permission to access the
|
1833
|
+
# data source being used to create the machine learning model.
|
1834
|
+
#
|
1835
|
+
# @option params [String] :server_side_kms_key_id
|
1836
|
+
# Provides the identifier of the KMS key key used to encrypt model data
|
1837
|
+
# by Amazon Lookout for Equipment.
|
1838
|
+
#
|
1839
|
+
# @option params [Array<Types::Tag>] :tags
|
1840
|
+
# The tags associated with the machine learning model to be created.
|
1841
|
+
#
|
1842
|
+
# @option params [String] :inference_data_import_strategy
|
1843
|
+
# Indicates how to import the accumulated inference data when a model
|
1844
|
+
# version is imported. The possible values are as follows:
|
1845
|
+
#
|
1846
|
+
# * NO\_IMPORT – Don't import the data.
|
1847
|
+
#
|
1848
|
+
# * ADD\_WHEN\_EMPTY – Only import the data from the source model if
|
1849
|
+
# there is no existing data in the target model.
|
1850
|
+
#
|
1851
|
+
# * OVERWRITE – Import the data from the source model and overwrite the
|
1852
|
+
# existing data in the target model.
|
1853
|
+
#
|
1854
|
+
# @return [Types::ImportModelVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1855
|
+
#
|
1856
|
+
# * {Types::ImportModelVersionResponse#model_name #model_name} => String
|
1857
|
+
# * {Types::ImportModelVersionResponse#model_arn #model_arn} => String
|
1858
|
+
# * {Types::ImportModelVersionResponse#model_version_arn #model_version_arn} => String
|
1859
|
+
# * {Types::ImportModelVersionResponse#model_version #model_version} => Integer
|
1860
|
+
# * {Types::ImportModelVersionResponse#status #status} => String
|
1861
|
+
#
|
1862
|
+
# @example Request syntax with placeholder values
|
1863
|
+
#
|
1864
|
+
# resp = client.import_model_version({
|
1865
|
+
# source_model_version_arn: "ModelVersionArn", # required
|
1866
|
+
# model_name: "ModelName",
|
1867
|
+
# dataset_name: "DatasetIdentifier", # required
|
1868
|
+
# labels_input_configuration: {
|
1869
|
+
# s3_input_configuration: {
|
1870
|
+
# bucket: "S3Bucket", # required
|
1871
|
+
# prefix: "S3Prefix",
|
1872
|
+
# },
|
1873
|
+
# label_group_name: "LabelGroupName",
|
1874
|
+
# },
|
1875
|
+
# client_token: "IdempotenceToken", # required
|
1876
|
+
# role_arn: "IamRoleArn",
|
1877
|
+
# server_side_kms_key_id: "NameOrArn",
|
1878
|
+
# tags: [
|
1879
|
+
# {
|
1880
|
+
# key: "TagKey", # required
|
1881
|
+
# value: "TagValue", # required
|
1882
|
+
# },
|
1883
|
+
# ],
|
1884
|
+
# inference_data_import_strategy: "NO_IMPORT", # accepts NO_IMPORT, ADD_WHEN_EMPTY, OVERWRITE
|
1885
|
+
# })
|
1886
|
+
#
|
1887
|
+
# @example Response structure
|
1888
|
+
#
|
1889
|
+
# resp.model_name #=> String
|
1890
|
+
# resp.model_arn #=> String
|
1891
|
+
# resp.model_version_arn #=> String
|
1892
|
+
# resp.model_version #=> Integer
|
1893
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS", "CANCELED"
|
1894
|
+
#
|
1895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ImportModelVersion AWS API Documentation
|
1896
|
+
#
|
1897
|
+
# @overload import_model_version(params = {})
|
1898
|
+
# @param [Hash] params ({})
|
1899
|
+
def import_model_version(params = {}, options = {})
|
1900
|
+
req = build_request(:import_model_version, params)
|
1901
|
+
req.send_request(options)
|
1902
|
+
end
|
1903
|
+
|
1340
1904
|
# Provides a list of all data ingestion jobs, including dataset name and
|
1341
1905
|
# ARN, S3 location of the input data, status, and so on.
|
1342
1906
|
#
|
@@ -1366,7 +1930,7 @@ module Aws::LookoutEquipment
|
|
1366
1930
|
# dataset_name: "DatasetName",
|
1367
1931
|
# next_token: "NextToken",
|
1368
1932
|
# max_results: 1,
|
1369
|
-
# status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED
|
1933
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED, IMPORT_IN_PROGRESS
|
1370
1934
|
# })
|
1371
1935
|
#
|
1372
1936
|
# @example Response structure
|
@@ -1379,7 +1943,7 @@ module Aws::LookoutEquipment
|
|
1379
1943
|
# resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.bucket #=> String
|
1380
1944
|
# resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.prefix #=> String
|
1381
1945
|
# resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
|
1382
|
-
# resp.data_ingestion_job_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
1946
|
+
# resp.data_ingestion_job_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
1383
1947
|
#
|
1384
1948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDataIngestionJobs AWS API Documentation
|
1385
1949
|
#
|
@@ -1424,7 +1988,7 @@ module Aws::LookoutEquipment
|
|
1424
1988
|
# resp.dataset_summaries #=> Array
|
1425
1989
|
# resp.dataset_summaries[0].dataset_name #=> String
|
1426
1990
|
# resp.dataset_summaries[0].dataset_arn #=> String
|
1427
|
-
# resp.dataset_summaries[0].status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE"
|
1991
|
+
# resp.dataset_summaries[0].status #=> String, one of "CREATED", "INGESTION_IN_PROGRESS", "ACTIVE", "IMPORT_IN_PROGRESS"
|
1428
1992
|
# resp.dataset_summaries[0].created_at #=> Time
|
1429
1993
|
#
|
1430
1994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDatasets AWS API Documentation
|
@@ -1455,7 +2019,7 @@ module Aws::LookoutEquipment
|
|
1455
2019
|
#
|
1456
2020
|
# @option params [required, Time,DateTime,Date,Integer,String] :interval_end_time
|
1457
2021
|
# Returns all the inference events with an end start time equal to or
|
1458
|
-
# greater than less than the end time given
|
2022
|
+
# greater than less than the end time given.
|
1459
2023
|
#
|
1460
2024
|
# @return [Types::ListInferenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1461
2025
|
#
|
@@ -1560,6 +2124,8 @@ module Aws::LookoutEquipment
|
|
1560
2124
|
# resp.inference_execution_summaries[0].customer_result_object.key #=> String
|
1561
2125
|
# resp.inference_execution_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
1562
2126
|
# resp.inference_execution_summaries[0].failed_reason #=> String
|
2127
|
+
# resp.inference_execution_summaries[0].model_version #=> Integer
|
2128
|
+
# resp.inference_execution_summaries[0].model_version_arn #=> String
|
1563
2129
|
#
|
1564
2130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceExecutions AWS API Documentation
|
1565
2131
|
#
|
@@ -1584,10 +2150,11 @@ module Aws::LookoutEquipment
|
|
1584
2150
|
# The beginning of the name of the inference schedulers to be listed.
|
1585
2151
|
#
|
1586
2152
|
# @option params [String] :model_name
|
1587
|
-
# The name of the
|
2153
|
+
# The name of the machine learning model used by the inference scheduler
|
2154
|
+
# to be listed.
|
1588
2155
|
#
|
1589
2156
|
# @option params [String] :status
|
1590
|
-
# Specifies the current status of the inference schedulers
|
2157
|
+
# Specifies the current status of the inference schedulers.
|
1591
2158
|
#
|
1592
2159
|
# @return [Types::ListInferenceSchedulersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1593
2160
|
#
|
@@ -1740,25 +2307,106 @@ module Aws::LookoutEquipment
|
|
1740
2307
|
req.send_request(options)
|
1741
2308
|
end
|
1742
2309
|
|
2310
|
+
# Generates a list of all model versions for a given model, including
|
2311
|
+
# the model version, model version ARN, and status. To list a subset of
|
2312
|
+
# versions, use the `MaxModelVersion` and `MinModelVersion` fields.
|
2313
|
+
#
|
2314
|
+
# @option params [required, String] :model_name
|
2315
|
+
# Then name of the machine learning model for which the model versions
|
2316
|
+
# are to be listed.
|
2317
|
+
#
|
2318
|
+
# @option params [String] :next_token
|
2319
|
+
# If the total number of results exceeds the limit that the response can
|
2320
|
+
# display, the response returns an opaque pagination token indicating
|
2321
|
+
# where to continue the listing of machine learning model versions. Use
|
2322
|
+
# this token in the `NextToken` field in the request to list the next
|
2323
|
+
# page of results.
|
2324
|
+
#
|
2325
|
+
# @option params [Integer] :max_results
|
2326
|
+
# Specifies the maximum number of machine learning model versions to
|
2327
|
+
# list.
|
2328
|
+
#
|
2329
|
+
# @option params [String] :status
|
2330
|
+
# Filter the results based on the current status of the model version.
|
2331
|
+
#
|
2332
|
+
# @option params [String] :source_type
|
2333
|
+
# Filter the results based on the way the model version was generated.
|
2334
|
+
#
|
2335
|
+
# @option params [Time,DateTime,Date,Integer,String] :created_at_end_time
|
2336
|
+
# Filter results to return all the model versions created before this
|
2337
|
+
# time.
|
2338
|
+
#
|
2339
|
+
# @option params [Time,DateTime,Date,Integer,String] :created_at_start_time
|
2340
|
+
# Filter results to return all the model versions created after this
|
2341
|
+
# time.
|
2342
|
+
#
|
2343
|
+
# @option params [Integer] :max_model_version
|
2344
|
+
# Specifies the highest version of the model to return in the list.
|
2345
|
+
#
|
2346
|
+
# @option params [Integer] :min_model_version
|
2347
|
+
# Specifies the lowest version of the model to return in the list.
|
2348
|
+
#
|
2349
|
+
# @return [Types::ListModelVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2350
|
+
#
|
2351
|
+
# * {Types::ListModelVersionsResponse#next_token #next_token} => String
|
2352
|
+
# * {Types::ListModelVersionsResponse#model_version_summaries #model_version_summaries} => Array<Types::ModelVersionSummary>
|
2353
|
+
#
|
2354
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2355
|
+
#
|
2356
|
+
# @example Request syntax with placeholder values
|
2357
|
+
#
|
2358
|
+
# resp = client.list_model_versions({
|
2359
|
+
# model_name: "ModelName", # required
|
2360
|
+
# next_token: "NextToken",
|
2361
|
+
# max_results: 1,
|
2362
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED, IMPORT_IN_PROGRESS, CANCELED
|
2363
|
+
# source_type: "TRAINING", # accepts TRAINING, RETRAINING, IMPORT
|
2364
|
+
# created_at_end_time: Time.now,
|
2365
|
+
# created_at_start_time: Time.now,
|
2366
|
+
# max_model_version: 1,
|
2367
|
+
# min_model_version: 1,
|
2368
|
+
# })
|
2369
|
+
#
|
2370
|
+
# @example Response structure
|
2371
|
+
#
|
2372
|
+
# resp.next_token #=> String
|
2373
|
+
# resp.model_version_summaries #=> Array
|
2374
|
+
# resp.model_version_summaries[0].model_name #=> String
|
2375
|
+
# resp.model_version_summaries[0].model_arn #=> String
|
2376
|
+
# resp.model_version_summaries[0].model_version #=> Integer
|
2377
|
+
# resp.model_version_summaries[0].model_version_arn #=> String
|
2378
|
+
# resp.model_version_summaries[0].created_at #=> Time
|
2379
|
+
# resp.model_version_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS", "CANCELED"
|
2380
|
+
# resp.model_version_summaries[0].source_type #=> String, one of "TRAINING", "RETRAINING", "IMPORT"
|
2381
|
+
#
|
2382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModelVersions AWS API Documentation
|
2383
|
+
#
|
2384
|
+
# @overload list_model_versions(params = {})
|
2385
|
+
# @param [Hash] params ({})
|
2386
|
+
def list_model_versions(params = {}, options = {})
|
2387
|
+
req = build_request(:list_model_versions, params)
|
2388
|
+
req.send_request(options)
|
2389
|
+
end
|
2390
|
+
|
1743
2391
|
# Generates a list of all models in the account, including model name
|
1744
2392
|
# and ARN, dataset, and status.
|
1745
2393
|
#
|
1746
2394
|
# @option params [String] :next_token
|
1747
2395
|
# An opaque pagination token indicating where to continue the listing of
|
1748
|
-
#
|
2396
|
+
# machine learning models.
|
1749
2397
|
#
|
1750
2398
|
# @option params [Integer] :max_results
|
1751
|
-
# Specifies the maximum number of
|
2399
|
+
# Specifies the maximum number of machine learning models to list.
|
1752
2400
|
#
|
1753
2401
|
# @option params [String] :status
|
1754
|
-
# The status of the
|
2402
|
+
# The status of the machine learning model.
|
1755
2403
|
#
|
1756
2404
|
# @option params [String] :model_name_begins_with
|
1757
|
-
# The beginning of the name of the
|
2405
|
+
# The beginning of the name of the machine learning models being listed.
|
1758
2406
|
#
|
1759
2407
|
# @option params [String] :dataset_name_begins_with
|
1760
|
-
# The beginning of the name of the dataset of the
|
1761
|
-
# listed.
|
2408
|
+
# The beginning of the name of the dataset of the machine learning
|
2409
|
+
# models to be listed.
|
1762
2410
|
#
|
1763
2411
|
# @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1764
2412
|
#
|
@@ -1772,7 +2420,7 @@ module Aws::LookoutEquipment
|
|
1772
2420
|
# resp = client.list_models({
|
1773
2421
|
# next_token: "NextToken",
|
1774
2422
|
# max_results: 1,
|
1775
|
-
# status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED
|
2423
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, SUCCESS, FAILED, IMPORT_IN_PROGRESS
|
1776
2424
|
# model_name_begins_with: "ModelName",
|
1777
2425
|
# dataset_name_begins_with: "DatasetName",
|
1778
2426
|
# })
|
@@ -1785,8 +2433,15 @@ module Aws::LookoutEquipment
|
|
1785
2433
|
# resp.model_summaries[0].model_arn #=> String
|
1786
2434
|
# resp.model_summaries[0].dataset_name #=> String
|
1787
2435
|
# resp.model_summaries[0].dataset_arn #=> String
|
1788
|
-
# resp.model_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
2436
|
+
# resp.model_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
1789
2437
|
# resp.model_summaries[0].created_at #=> Time
|
2438
|
+
# resp.model_summaries[0].active_model_version #=> Integer
|
2439
|
+
# resp.model_summaries[0].active_model_version_arn #=> String
|
2440
|
+
# resp.model_summaries[0].latest_scheduled_retraining_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS", "CANCELED"
|
2441
|
+
# resp.model_summaries[0].latest_scheduled_retraining_model_version #=> Integer
|
2442
|
+
# resp.model_summaries[0].latest_scheduled_retraining_start_time #=> Time
|
2443
|
+
# resp.model_summaries[0].next_scheduled_retraining_start_date #=> Time
|
2444
|
+
# resp.model_summaries[0].retraining_scheduler_status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
1790
2445
|
#
|
1791
2446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListModels AWS API Documentation
|
1792
2447
|
#
|
@@ -1797,6 +2452,98 @@ module Aws::LookoutEquipment
|
|
1797
2452
|
req.send_request(options)
|
1798
2453
|
end
|
1799
2454
|
|
2455
|
+
# Lists all retraining schedulers in your account, filtering by model
|
2456
|
+
# name prefix and status.
|
2457
|
+
#
|
2458
|
+
# @option params [String] :model_name_begins_with
|
2459
|
+
# Specify this field to only list retraining schedulers whose machine
|
2460
|
+
# learning models begin with the value you specify.
|
2461
|
+
#
|
2462
|
+
# @option params [String] :status
|
2463
|
+
# Specify this field to only list retraining schedulers whose status
|
2464
|
+
# matches the value you specify.
|
2465
|
+
#
|
2466
|
+
# @option params [String] :next_token
|
2467
|
+
# If the number of results exceeds the maximum, a pagination token is
|
2468
|
+
# returned. Use the token in the request to show the next page of
|
2469
|
+
# retraining schedulers.
|
2470
|
+
#
|
2471
|
+
# @option params [Integer] :max_results
|
2472
|
+
# Specifies the maximum number of retraining schedulers to list.
|
2473
|
+
#
|
2474
|
+
# @return [Types::ListRetrainingSchedulersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2475
|
+
#
|
2476
|
+
# * {Types::ListRetrainingSchedulersResponse#retraining_scheduler_summaries #retraining_scheduler_summaries} => Array<Types::RetrainingSchedulerSummary>
|
2477
|
+
# * {Types::ListRetrainingSchedulersResponse#next_token #next_token} => String
|
2478
|
+
#
|
2479
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2480
|
+
#
|
2481
|
+
#
|
2482
|
+
# @example Example: Listing retraining schedulers
|
2483
|
+
#
|
2484
|
+
# resp = client.list_retraining_schedulers({
|
2485
|
+
# max_results: 50,
|
2486
|
+
# })
|
2487
|
+
#
|
2488
|
+
# resp.to_h outputs the following:
|
2489
|
+
# {
|
2490
|
+
# retraining_scheduler_summaries: [
|
2491
|
+
# {
|
2492
|
+
# lookback_window: "P180D",
|
2493
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
2494
|
+
# model_name: "sample-model-1",
|
2495
|
+
# retraining_frequency: "P1M",
|
2496
|
+
# retraining_start_date: Time.parse("2023-06-01T00:00:00Z"),
|
2497
|
+
# status: "RUNNING",
|
2498
|
+
# },
|
2499
|
+
# {
|
2500
|
+
# lookback_window: "P180D",
|
2501
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
|
2502
|
+
# model_name: "sample-model-2",
|
2503
|
+
# retraining_frequency: "P30D",
|
2504
|
+
# retraining_start_date: Time.parse("2023-08-15T00:00:00Z"),
|
2505
|
+
# status: "RUNNING",
|
2506
|
+
# },
|
2507
|
+
# {
|
2508
|
+
# lookback_window: "P360D",
|
2509
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
|
2510
|
+
# model_name: "sample-model-3",
|
2511
|
+
# retraining_frequency: "P1M",
|
2512
|
+
# retraining_start_date: Time.parse("2023-09-01T00:00:00Z"),
|
2513
|
+
# status: "STOPPED",
|
2514
|
+
# },
|
2515
|
+
# ],
|
2516
|
+
# }
|
2517
|
+
#
|
2518
|
+
# @example Request syntax with placeholder values
|
2519
|
+
#
|
2520
|
+
# resp = client.list_retraining_schedulers({
|
2521
|
+
# model_name_begins_with: "ModelName",
|
2522
|
+
# status: "PENDING", # accepts PENDING, RUNNING, STOPPING, STOPPED
|
2523
|
+
# next_token: "NextToken",
|
2524
|
+
# max_results: 1,
|
2525
|
+
# })
|
2526
|
+
#
|
2527
|
+
# @example Response structure
|
2528
|
+
#
|
2529
|
+
# resp.retraining_scheduler_summaries #=> Array
|
2530
|
+
# resp.retraining_scheduler_summaries[0].model_name #=> String
|
2531
|
+
# resp.retraining_scheduler_summaries[0].model_arn #=> String
|
2532
|
+
# resp.retraining_scheduler_summaries[0].status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
2533
|
+
# resp.retraining_scheduler_summaries[0].retraining_start_date #=> Time
|
2534
|
+
# resp.retraining_scheduler_summaries[0].retraining_frequency #=> String
|
2535
|
+
# resp.retraining_scheduler_summaries[0].lookback_window #=> String
|
2536
|
+
# resp.next_token #=> String
|
2537
|
+
#
|
2538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListRetrainingSchedulers AWS API Documentation
|
2539
|
+
#
|
2540
|
+
# @overload list_retraining_schedulers(params = {})
|
2541
|
+
# @param [Hash] params ({})
|
2542
|
+
def list_retraining_schedulers(params = {}, options = {})
|
2543
|
+
req = build_request(:list_retraining_schedulers, params)
|
2544
|
+
req.send_request(options)
|
2545
|
+
end
|
2546
|
+
|
1800
2547
|
# Lists statistics about the data collected for each of the sensors that
|
1801
2548
|
# have been successfully ingested in the particular dataset. Can also be
|
1802
2549
|
# used to retreive Sensor Statistics for a previous ingestion job.
|
@@ -1899,6 +2646,53 @@ module Aws::LookoutEquipment
|
|
1899
2646
|
req.send_request(options)
|
1900
2647
|
end
|
1901
2648
|
|
2649
|
+
# Creates a resource control policy for a given resource.
|
2650
|
+
#
|
2651
|
+
# @option params [required, String] :resource_arn
|
2652
|
+
# The Amazon Resource Name (ARN) of the resource for which the policy is
|
2653
|
+
# being created.
|
2654
|
+
#
|
2655
|
+
# @option params [required, String] :resource_policy
|
2656
|
+
# The JSON-formatted resource policy to create.
|
2657
|
+
#
|
2658
|
+
# @option params [String] :policy_revision_id
|
2659
|
+
# A unique identifier for a revision of the resource policy.
|
2660
|
+
#
|
2661
|
+
# @option params [required, String] :client_token
|
2662
|
+
# A unique identifier for the request. If you do not set the client
|
2663
|
+
# request token, Amazon Lookout for Equipment generates one.
|
2664
|
+
#
|
2665
|
+
# **A suitable default value is auto-generated.** You should normally
|
2666
|
+
# not need to pass this option.**
|
2667
|
+
#
|
2668
|
+
# @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2669
|
+
#
|
2670
|
+
# * {Types::PutResourcePolicyResponse#resource_arn #resource_arn} => String
|
2671
|
+
# * {Types::PutResourcePolicyResponse#policy_revision_id #policy_revision_id} => String
|
2672
|
+
#
|
2673
|
+
# @example Request syntax with placeholder values
|
2674
|
+
#
|
2675
|
+
# resp = client.put_resource_policy({
|
2676
|
+
# resource_arn: "ResourceArn", # required
|
2677
|
+
# resource_policy: "Policy", # required
|
2678
|
+
# policy_revision_id: "PolicyRevisionId",
|
2679
|
+
# client_token: "IdempotenceToken", # required
|
2680
|
+
# })
|
2681
|
+
#
|
2682
|
+
# @example Response structure
|
2683
|
+
#
|
2684
|
+
# resp.resource_arn #=> String
|
2685
|
+
# resp.policy_revision_id #=> String
|
2686
|
+
#
|
2687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/PutResourcePolicy AWS API Documentation
|
2688
|
+
#
|
2689
|
+
# @overload put_resource_policy(params = {})
|
2690
|
+
# @param [Hash] params ({})
|
2691
|
+
def put_resource_policy(params = {}, options = {})
|
2692
|
+
req = build_request(:put_resource_policy, params)
|
2693
|
+
req.send_request(options)
|
2694
|
+
end
|
2695
|
+
|
1902
2696
|
# Starts a data ingestion job. Amazon Lookout for Equipment returns the
|
1903
2697
|
# job status.
|
1904
2698
|
#
|
@@ -1943,7 +2737,7 @@ module Aws::LookoutEquipment
|
|
1943
2737
|
# @example Response structure
|
1944
2738
|
#
|
1945
2739
|
# resp.job_id #=> String
|
1946
|
-
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
|
2740
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "IMPORT_IN_PROGRESS"
|
1947
2741
|
#
|
1948
2742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartDataIngestionJob AWS API Documentation
|
1949
2743
|
#
|
@@ -1990,6 +2784,52 @@ module Aws::LookoutEquipment
|
|
1990
2784
|
req.send_request(options)
|
1991
2785
|
end
|
1992
2786
|
|
2787
|
+
# Starts a retraining scheduler.
|
2788
|
+
#
|
2789
|
+
# @option params [required, String] :model_name
|
2790
|
+
# The name of the model whose retraining scheduler you want to start.
|
2791
|
+
#
|
2792
|
+
# @return [Types::StartRetrainingSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2793
|
+
#
|
2794
|
+
# * {Types::StartRetrainingSchedulerResponse#model_name #model_name} => String
|
2795
|
+
# * {Types::StartRetrainingSchedulerResponse#model_arn #model_arn} => String
|
2796
|
+
# * {Types::StartRetrainingSchedulerResponse#status #status} => String
|
2797
|
+
#
|
2798
|
+
#
|
2799
|
+
# @example Example: Starts a retraining scheduler
|
2800
|
+
#
|
2801
|
+
# resp = client.start_retraining_scheduler({
|
2802
|
+
# model_name: "sample-model",
|
2803
|
+
# })
|
2804
|
+
#
|
2805
|
+
# resp.to_h outputs the following:
|
2806
|
+
# {
|
2807
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
2808
|
+
# model_name: "sample-model",
|
2809
|
+
# status: "PENDING",
|
2810
|
+
# }
|
2811
|
+
#
|
2812
|
+
# @example Request syntax with placeholder values
|
2813
|
+
#
|
2814
|
+
# resp = client.start_retraining_scheduler({
|
2815
|
+
# model_name: "ModelName", # required
|
2816
|
+
# })
|
2817
|
+
#
|
2818
|
+
# @example Response structure
|
2819
|
+
#
|
2820
|
+
# resp.model_name #=> String
|
2821
|
+
# resp.model_arn #=> String
|
2822
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
2823
|
+
#
|
2824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartRetrainingScheduler AWS API Documentation
|
2825
|
+
#
|
2826
|
+
# @overload start_retraining_scheduler(params = {})
|
2827
|
+
# @param [Hash] params ({})
|
2828
|
+
def start_retraining_scheduler(params = {}, options = {})
|
2829
|
+
req = build_request(:start_retraining_scheduler, params)
|
2830
|
+
req.send_request(options)
|
2831
|
+
end
|
2832
|
+
|
1993
2833
|
# Stops an inference scheduler.
|
1994
2834
|
#
|
1995
2835
|
# @option params [required, String] :inference_scheduler_name
|
@@ -2026,6 +2866,52 @@ module Aws::LookoutEquipment
|
|
2026
2866
|
req.send_request(options)
|
2027
2867
|
end
|
2028
2868
|
|
2869
|
+
# Stops a retraining scheduler.
|
2870
|
+
#
|
2871
|
+
# @option params [required, String] :model_name
|
2872
|
+
# The name of the model whose retraining scheduler you want to stop.
|
2873
|
+
#
|
2874
|
+
# @return [Types::StopRetrainingSchedulerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2875
|
+
#
|
2876
|
+
# * {Types::StopRetrainingSchedulerResponse#model_name #model_name} => String
|
2877
|
+
# * {Types::StopRetrainingSchedulerResponse#model_arn #model_arn} => String
|
2878
|
+
# * {Types::StopRetrainingSchedulerResponse#status #status} => String
|
2879
|
+
#
|
2880
|
+
#
|
2881
|
+
# @example Example: Stops a retraining scheduler
|
2882
|
+
#
|
2883
|
+
# resp = client.stop_retraining_scheduler({
|
2884
|
+
# model_name: "sample-model",
|
2885
|
+
# })
|
2886
|
+
#
|
2887
|
+
# resp.to_h outputs the following:
|
2888
|
+
# {
|
2889
|
+
# model_arn: "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
2890
|
+
# model_name: "sample-model",
|
2891
|
+
# status: "STOPPING",
|
2892
|
+
# }
|
2893
|
+
#
|
2894
|
+
# @example Request syntax with placeholder values
|
2895
|
+
#
|
2896
|
+
# resp = client.stop_retraining_scheduler({
|
2897
|
+
# model_name: "ModelName", # required
|
2898
|
+
# })
|
2899
|
+
#
|
2900
|
+
# @example Response structure
|
2901
|
+
#
|
2902
|
+
# resp.model_name #=> String
|
2903
|
+
# resp.model_arn #=> String
|
2904
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
2905
|
+
#
|
2906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StopRetrainingScheduler AWS API Documentation
|
2907
|
+
#
|
2908
|
+
# @overload stop_retraining_scheduler(params = {})
|
2909
|
+
# @param [Hash] params ({})
|
2910
|
+
def stop_retraining_scheduler(params = {}, options = {})
|
2911
|
+
req = build_request(:stop_retraining_scheduler, params)
|
2912
|
+
req.send_request(options)
|
2913
|
+
end
|
2914
|
+
|
2029
2915
|
# Associates a given tag to a resource in your account. A tag is a
|
2030
2916
|
# key-value pair which can be added to an Amazon Lookout for Equipment
|
2031
2917
|
# resource as metadata. Tags can be used for organizing your resources
|
@@ -2092,6 +2978,50 @@ module Aws::LookoutEquipment
|
|
2092
2978
|
req.send_request(options)
|
2093
2979
|
end
|
2094
2980
|
|
2981
|
+
# Sets the active model version for a given machine learning model.
|
2982
|
+
#
|
2983
|
+
# @option params [required, String] :model_name
|
2984
|
+
# The name of the machine learning model for which the active model
|
2985
|
+
# version is being set.
|
2986
|
+
#
|
2987
|
+
# @option params [required, Integer] :model_version
|
2988
|
+
# The version of the machine learning model for which the active model
|
2989
|
+
# version is being set.
|
2990
|
+
#
|
2991
|
+
# @return [Types::UpdateActiveModelVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2992
|
+
#
|
2993
|
+
# * {Types::UpdateActiveModelVersionResponse#model_name #model_name} => String
|
2994
|
+
# * {Types::UpdateActiveModelVersionResponse#model_arn #model_arn} => String
|
2995
|
+
# * {Types::UpdateActiveModelVersionResponse#current_active_version #current_active_version} => Integer
|
2996
|
+
# * {Types::UpdateActiveModelVersionResponse#previous_active_version #previous_active_version} => Integer
|
2997
|
+
# * {Types::UpdateActiveModelVersionResponse#current_active_version_arn #current_active_version_arn} => String
|
2998
|
+
# * {Types::UpdateActiveModelVersionResponse#previous_active_version_arn #previous_active_version_arn} => String
|
2999
|
+
#
|
3000
|
+
# @example Request syntax with placeholder values
|
3001
|
+
#
|
3002
|
+
# resp = client.update_active_model_version({
|
3003
|
+
# model_name: "ModelName", # required
|
3004
|
+
# model_version: 1, # required
|
3005
|
+
# })
|
3006
|
+
#
|
3007
|
+
# @example Response structure
|
3008
|
+
#
|
3009
|
+
# resp.model_name #=> String
|
3010
|
+
# resp.model_arn #=> String
|
3011
|
+
# resp.current_active_version #=> Integer
|
3012
|
+
# resp.previous_active_version #=> Integer
|
3013
|
+
# resp.current_active_version_arn #=> String
|
3014
|
+
# resp.previous_active_version_arn #=> String
|
3015
|
+
#
|
3016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateActiveModelVersion AWS API Documentation
|
3017
|
+
#
|
3018
|
+
# @overload update_active_model_version(params = {})
|
3019
|
+
# @param [Hash] params ({})
|
3020
|
+
def update_active_model_version(params = {}, options = {})
|
3021
|
+
req = build_request(:update_active_model_version, params)
|
3022
|
+
req.send_request(options)
|
3023
|
+
end
|
3024
|
+
|
2095
3025
|
# Updates an inference scheduler.
|
2096
3026
|
#
|
2097
3027
|
# @option params [required, String] :inference_scheduler_name
|
@@ -2197,6 +3127,122 @@ module Aws::LookoutEquipment
|
|
2197
3127
|
req.send_request(options)
|
2198
3128
|
end
|
2199
3129
|
|
3130
|
+
# Updates a model in the account.
|
3131
|
+
#
|
3132
|
+
# @option params [required, String] :model_name
|
3133
|
+
# The name of the model to update.
|
3134
|
+
#
|
3135
|
+
# @option params [Types::LabelsInputConfiguration] :labels_input_configuration
|
3136
|
+
# Contains the configuration information for the S3 location being used
|
3137
|
+
# to hold label data.
|
3138
|
+
#
|
3139
|
+
# @option params [String] :role_arn
|
3140
|
+
# The ARN of the model to update.
|
3141
|
+
#
|
3142
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3143
|
+
#
|
3144
|
+
#
|
3145
|
+
# @example Example: Updates a model
|
3146
|
+
#
|
3147
|
+
# resp = client.update_model({
|
3148
|
+
# labels_input_configuration: {
|
3149
|
+
# label_group_name: "sample-label-group",
|
3150
|
+
# },
|
3151
|
+
# model_name: "sample-model",
|
3152
|
+
# })
|
3153
|
+
#
|
3154
|
+
# @example Request syntax with placeholder values
|
3155
|
+
#
|
3156
|
+
# resp = client.update_model({
|
3157
|
+
# model_name: "ModelName", # required
|
3158
|
+
# labels_input_configuration: {
|
3159
|
+
# s3_input_configuration: {
|
3160
|
+
# bucket: "S3Bucket", # required
|
3161
|
+
# prefix: "S3Prefix",
|
3162
|
+
# },
|
3163
|
+
# label_group_name: "LabelGroupName",
|
3164
|
+
# },
|
3165
|
+
# role_arn: "IamRoleArn",
|
3166
|
+
# })
|
3167
|
+
#
|
3168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateModel AWS API Documentation
|
3169
|
+
#
|
3170
|
+
# @overload update_model(params = {})
|
3171
|
+
# @param [Hash] params ({})
|
3172
|
+
def update_model(params = {}, options = {})
|
3173
|
+
req = build_request(:update_model, params)
|
3174
|
+
req.send_request(options)
|
3175
|
+
end
|
3176
|
+
|
3177
|
+
# Updates a retraining scheduler.
|
3178
|
+
#
|
3179
|
+
# @option params [required, String] :model_name
|
3180
|
+
# The name of the model whose retraining scheduler you want to update.
|
3181
|
+
#
|
3182
|
+
# @option params [Time,DateTime,Date,Integer,String] :retraining_start_date
|
3183
|
+
# The start date for the retraining scheduler. Lookout for Equipment
|
3184
|
+
# truncates the time you provide to the nearest UTC day.
|
3185
|
+
#
|
3186
|
+
# @option params [String] :retraining_frequency
|
3187
|
+
# This parameter uses the [ISO 8601][1] standard to set the frequency at
|
3188
|
+
# which you want retraining to occur in terms of Years, Months, and/or
|
3189
|
+
# Days (note: other parameters like Time are not currently supported).
|
3190
|
+
# The minimum value is 30 days (P30D) and the maximum value is 1 year
|
3191
|
+
# (P1Y). For example, the following values are valid:
|
3192
|
+
#
|
3193
|
+
# * P3M15D – Every 3 months and 15 days
|
3194
|
+
#
|
3195
|
+
# * P2M – Every 2 months
|
3196
|
+
#
|
3197
|
+
# * P150D – Every 150 days
|
3198
|
+
#
|
3199
|
+
#
|
3200
|
+
#
|
3201
|
+
# [1]: https://en.wikipedia.org/wiki/ISO_8601#Durations
|
3202
|
+
#
|
3203
|
+
# @option params [String] :lookback_window
|
3204
|
+
# The number of past days of data that will be used for retraining.
|
3205
|
+
#
|
3206
|
+
# @option params [String] :promote_mode
|
3207
|
+
# Indicates how the service will use new models. In `MANAGED` mode, new
|
3208
|
+
# models will automatically be used for inference if they have better
|
3209
|
+
# performance than the current model. In `MANUAL` mode, the new models
|
3210
|
+
# will not be used [until they are manually activated][1].
|
3211
|
+
#
|
3212
|
+
#
|
3213
|
+
#
|
3214
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation
|
3215
|
+
#
|
3216
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3217
|
+
#
|
3218
|
+
#
|
3219
|
+
# @example Example: Updates a retraining scheduler
|
3220
|
+
#
|
3221
|
+
# resp = client.update_retraining_scheduler({
|
3222
|
+
# model_name: "sample-model",
|
3223
|
+
# retraining_frequency: "P1Y",
|
3224
|
+
# retraining_start_date: Time.parse("2024-01-01T00:00:00Z"),
|
3225
|
+
# })
|
3226
|
+
#
|
3227
|
+
# @example Request syntax with placeholder values
|
3228
|
+
#
|
3229
|
+
# resp = client.update_retraining_scheduler({
|
3230
|
+
# model_name: "ModelName", # required
|
3231
|
+
# retraining_start_date: Time.now,
|
3232
|
+
# retraining_frequency: "RetrainingFrequency",
|
3233
|
+
# lookback_window: "LookbackWindow",
|
3234
|
+
# promote_mode: "MANAGED", # accepts MANAGED, MANUAL
|
3235
|
+
# })
|
3236
|
+
#
|
3237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateRetrainingScheduler AWS API Documentation
|
3238
|
+
#
|
3239
|
+
# @overload update_retraining_scheduler(params = {})
|
3240
|
+
# @param [Hash] params ({})
|
3241
|
+
def update_retraining_scheduler(params = {}, options = {})
|
3242
|
+
req = build_request(:update_retraining_scheduler, params)
|
3243
|
+
req.send_request(options)
|
3244
|
+
end
|
3245
|
+
|
2200
3246
|
# @!endgroup
|
2201
3247
|
|
2202
3248
|
# @param params ({})
|
@@ -2210,7 +3256,7 @@ module Aws::LookoutEquipment
|
|
2210
3256
|
params: params,
|
2211
3257
|
config: config)
|
2212
3258
|
context[:gem_name] = 'aws-sdk-lookoutequipment'
|
2213
|
-
context[:gem_version] = '1.
|
3259
|
+
context[:gem_version] = '1.23.0'
|
2214
3260
|
Seahorse::Client::Request.new(handlers, context)
|
2215
3261
|
end
|
2216
3262
|
|