aws-sdk-lookoutequipment 1.12.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutequipment/client.rb +452 -21
- data/lib/aws-sdk-lookoutequipment/client_api.rb +268 -1
- data/lib/aws-sdk-lookoutequipment/types.rb +652 -25
- data/lib/aws-sdk-lookoutequipment.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e566374ac7e5bc11d4bb61ca290caee4d3bae985e0b7852a6c196d2cab5564ab
|
4
|
+
data.tar.gz: a2c99877d36506b4a0ab89477e47c4921e7cbb09c4d8f925adb4c18e0620a561
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a65ef48fb40f03745ce17f2c0ed0d501a159af718413c9c3ba8b99ca5b46742cf896fd40cb6f00b70980c497389c945e9553365150cf9627b4c2c98629c61587
|
7
|
+
data.tar.gz: 60c9c7f1351379a51357b2cd0d8effaf068e7ecd1b2e4dddf72d0f6e7ae5370a2b79721a1b08f31c365e86ad41acbab1aff63e4a9594d69ce7fd306e4ff37b17
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.13.0
|
@@ -443,24 +443,35 @@ module Aws::LookoutEquipment
|
|
443
443
|
# The name of the inference scheduler being created.
|
444
444
|
#
|
445
445
|
# @option params [Integer] :data_delay_offset_in_minutes
|
446
|
-
#
|
447
|
-
#
|
448
|
-
# delay
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
446
|
+
# The interval (in minutes) of planned delay at the start of each
|
447
|
+
# inference segment. For example, if inference is set to run every ten
|
448
|
+
# minutes, the delay is set to five minutes and the time is 09:08. The
|
449
|
+
# inference scheduler will wake up at the configured interval (which,
|
450
|
+
# without a delay configured, would be 09:10) plus the additional five
|
451
|
+
# minute delay time (so 09:15) to check your Amazon S3 bucket. The delay
|
452
|
+
# provides a buffer for you to upload data at the same frequency, so
|
453
|
+
# that you don't have to stop and restart the scheduler when uploading
|
454
|
+
# new data.
|
455
|
+
#
|
456
|
+
# For more information, see [Understanding the inference process][1].
|
457
|
+
#
|
458
|
+
#
|
459
|
+
#
|
460
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
|
455
461
|
#
|
456
462
|
# @option params [required, String] :data_upload_frequency
|
457
|
-
# How often data is uploaded to the source S3 bucket for the
|
458
|
-
# The value chosen is the length of time between data
|
459
|
-
# instance, if you select 5 minutes, Amazon Lookout for
|
460
|
-
# upload the real-time data to the source bucket once
|
461
|
-
# This frequency also determines how often Amazon
|
462
|
-
#
|
463
|
-
#
|
463
|
+
# How often data is uploaded to the source Amazon S3 bucket for the
|
464
|
+
# input data. The value chosen is the length of time between data
|
465
|
+
# uploads. For instance, if you select 5 minutes, Amazon Lookout for
|
466
|
+
# Equipment will upload the real-time data to the source bucket once
|
467
|
+
# every 5 minutes. This frequency also determines how often Amazon
|
468
|
+
# Lookout for Equipment runs inference on your data.
|
469
|
+
#
|
470
|
+
# For more information, see [Understanding the inference process][1].
|
471
|
+
#
|
472
|
+
#
|
473
|
+
#
|
474
|
+
# [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
|
464
475
|
#
|
465
476
|
# @option params [required, Types::InferenceInputConfiguration] :data_input_configuration
|
466
477
|
# Specifies configuration information for the input data for the
|
@@ -546,6 +557,140 @@ module Aws::LookoutEquipment
|
|
546
557
|
req.send_request(options)
|
547
558
|
end
|
548
559
|
|
560
|
+
# Creates a label for an event.
|
561
|
+
#
|
562
|
+
# @option params [required, String] :label_group_name
|
563
|
+
# The name of a group of labels.
|
564
|
+
#
|
565
|
+
# Data in this field will be retained for service usage. Follow best
|
566
|
+
# practices for the security of your data.
|
567
|
+
#
|
568
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
569
|
+
# The start time of the labeled event.
|
570
|
+
#
|
571
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
572
|
+
# The end time of the labeled event.
|
573
|
+
#
|
574
|
+
# @option params [required, String] :rating
|
575
|
+
# Indicates whether a labeled event represents an anomaly.
|
576
|
+
#
|
577
|
+
# @option params [String] :fault_code
|
578
|
+
# Provides additional information about the label. The fault code must
|
579
|
+
# be defined in the FaultCodes attribute of the label group.
|
580
|
+
#
|
581
|
+
# Data in this field will be retained for service usage. Follow best
|
582
|
+
# practices for the security of your data.
|
583
|
+
#
|
584
|
+
# @option params [String] :notes
|
585
|
+
# Metadata providing additional information about the label.
|
586
|
+
#
|
587
|
+
# Data in this field will be retained for service usage. Follow best
|
588
|
+
# practices for the security of your data.
|
589
|
+
#
|
590
|
+
# @option params [String] :equipment
|
591
|
+
# Indicates that a label pertains to a particular piece of equipment.
|
592
|
+
#
|
593
|
+
# Data in this field will be retained for service usage. Follow best
|
594
|
+
# practices for the security of your data.
|
595
|
+
#
|
596
|
+
# @option params [required, String] :client_token
|
597
|
+
# A unique identifier for the request to create a label. If you do not
|
598
|
+
# set the client request token, Lookout for Equipment generates one.
|
599
|
+
#
|
600
|
+
# **A suitable default value is auto-generated.** You should normally
|
601
|
+
# not need to pass this option.**
|
602
|
+
#
|
603
|
+
# @return [Types::CreateLabelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
604
|
+
#
|
605
|
+
# * {Types::CreateLabelResponse#label_id #label_id} => String
|
606
|
+
#
|
607
|
+
# @example Request syntax with placeholder values
|
608
|
+
#
|
609
|
+
# resp = client.create_label({
|
610
|
+
# label_group_name: "LabelGroupName", # required
|
611
|
+
# start_time: Time.now, # required
|
612
|
+
# end_time: Time.now, # required
|
613
|
+
# rating: "ANOMALY", # required, accepts ANOMALY, NO_ANOMALY, NEUTRAL
|
614
|
+
# fault_code: "FaultCode",
|
615
|
+
# notes: "Comments",
|
616
|
+
# equipment: "Equipment",
|
617
|
+
# client_token: "IdempotenceToken", # required
|
618
|
+
# })
|
619
|
+
#
|
620
|
+
# @example Response structure
|
621
|
+
#
|
622
|
+
# resp.label_id #=> String
|
623
|
+
#
|
624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabel AWS API Documentation
|
625
|
+
#
|
626
|
+
# @overload create_label(params = {})
|
627
|
+
# @param [Hash] params ({})
|
628
|
+
def create_label(params = {}, options = {})
|
629
|
+
req = build_request(:create_label, params)
|
630
|
+
req.send_request(options)
|
631
|
+
end
|
632
|
+
|
633
|
+
# Creates a group of labels.
|
634
|
+
#
|
635
|
+
# @option params [required, String] :label_group_name
|
636
|
+
# Names a group of labels.
|
637
|
+
#
|
638
|
+
# Data in this field will be retained for service usage. Follow best
|
639
|
+
# practices for the security of your data.
|
640
|
+
#
|
641
|
+
# @option params [Array<String>] :fault_codes
|
642
|
+
# The acceptable fault codes (indicating the type of anomaly associated
|
643
|
+
# with the label) that can be used with this label group.
|
644
|
+
#
|
645
|
+
# Data in this field will be retained for service usage. Follow best
|
646
|
+
# practices for the security of your data.
|
647
|
+
#
|
648
|
+
# @option params [required, String] :client_token
|
649
|
+
# A unique identifier for the request to create a label group. If you do
|
650
|
+
# not set the client request token, Lookout for Equipment generates one.
|
651
|
+
#
|
652
|
+
# **A suitable default value is auto-generated.** You should normally
|
653
|
+
# not need to pass this option.**
|
654
|
+
#
|
655
|
+
# @option params [Array<Types::Tag>] :tags
|
656
|
+
# Tags that provide metadata about the label group you are creating.
|
657
|
+
#
|
658
|
+
# Data in this field will be retained for service usage. Follow best
|
659
|
+
# practices for the security of your data.
|
660
|
+
#
|
661
|
+
# @return [Types::CreateLabelGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
662
|
+
#
|
663
|
+
# * {Types::CreateLabelGroupResponse#label_group_name #label_group_name} => String
|
664
|
+
# * {Types::CreateLabelGroupResponse#label_group_arn #label_group_arn} => String
|
665
|
+
#
|
666
|
+
# @example Request syntax with placeholder values
|
667
|
+
#
|
668
|
+
# resp = client.create_label_group({
|
669
|
+
# label_group_name: "LabelGroupName", # required
|
670
|
+
# fault_codes: ["FaultCode"],
|
671
|
+
# client_token: "IdempotenceToken", # required
|
672
|
+
# tags: [
|
673
|
+
# {
|
674
|
+
# key: "TagKey", # required
|
675
|
+
# value: "TagValue", # required
|
676
|
+
# },
|
677
|
+
# ],
|
678
|
+
# })
|
679
|
+
#
|
680
|
+
# @example Response structure
|
681
|
+
#
|
682
|
+
# resp.label_group_name #=> String
|
683
|
+
# resp.label_group_arn #=> String
|
684
|
+
#
|
685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelGroup AWS API Documentation
|
686
|
+
#
|
687
|
+
# @overload create_label_group(params = {})
|
688
|
+
# @param [Hash] params ({})
|
689
|
+
def create_label_group(params = {}, options = {})
|
690
|
+
req = build_request(:create_label_group, params)
|
691
|
+
req.send_request(options)
|
692
|
+
end
|
693
|
+
|
549
694
|
# Creates an ML model for data inference.
|
550
695
|
#
|
551
696
|
# A machine-learning (ML) model is a mathematical model that finds
|
@@ -638,10 +783,11 @@ module Aws::LookoutEquipment
|
|
638
783
|
# inline_data_schema: "InlineDataSchema",
|
639
784
|
# },
|
640
785
|
# labels_input_configuration: {
|
641
|
-
# s3_input_configuration: {
|
786
|
+
# s3_input_configuration: {
|
642
787
|
# bucket: "S3Bucket", # required
|
643
788
|
# prefix: "S3Prefix",
|
644
789
|
# },
|
790
|
+
# label_group_name: "LabelGroupName",
|
645
791
|
# },
|
646
792
|
# client_token: "IdempotenceToken", # required
|
647
793
|
# training_data_start_time: Time.now,
|
@@ -726,6 +872,58 @@ module Aws::LookoutEquipment
|
|
726
872
|
req.send_request(options)
|
727
873
|
end
|
728
874
|
|
875
|
+
# Deletes a label.
|
876
|
+
#
|
877
|
+
# @option params [required, String] :label_group_name
|
878
|
+
# The name of the label group that contains the label that you want to
|
879
|
+
# delete. Data in this field will be retained for service usage. Follow
|
880
|
+
# best practices for the security of your data.
|
881
|
+
#
|
882
|
+
# @option params [required, String] :label_id
|
883
|
+
# The ID of the label that you want to delete.
|
884
|
+
#
|
885
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
886
|
+
#
|
887
|
+
# @example Request syntax with placeholder values
|
888
|
+
#
|
889
|
+
# resp = client.delete_label({
|
890
|
+
# label_group_name: "LabelGroupName", # required
|
891
|
+
# label_id: "LabelId", # required
|
892
|
+
# })
|
893
|
+
#
|
894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabel AWS API Documentation
|
895
|
+
#
|
896
|
+
# @overload delete_label(params = {})
|
897
|
+
# @param [Hash] params ({})
|
898
|
+
def delete_label(params = {}, options = {})
|
899
|
+
req = build_request(:delete_label, params)
|
900
|
+
req.send_request(options)
|
901
|
+
end
|
902
|
+
|
903
|
+
# Deletes a group of labels.
|
904
|
+
#
|
905
|
+
# @option params [required, String] :label_group_name
|
906
|
+
# The name of the label group that you want to delete. Data in this
|
907
|
+
# field will be retained for service usage. Follow best practices for
|
908
|
+
# the security of your data.
|
909
|
+
#
|
910
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
911
|
+
#
|
912
|
+
# @example Request syntax with placeholder values
|
913
|
+
#
|
914
|
+
# resp = client.delete_label_group({
|
915
|
+
# label_group_name: "LabelGroupName", # required
|
916
|
+
# })
|
917
|
+
#
|
918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabelGroup AWS API Documentation
|
919
|
+
#
|
920
|
+
# @overload delete_label_group(params = {})
|
921
|
+
# @param [Hash] params ({})
|
922
|
+
def delete_label_group(params = {}, options = {})
|
923
|
+
req = build_request(:delete_label_group, params)
|
924
|
+
req.send_request(options)
|
925
|
+
end
|
926
|
+
|
729
927
|
# Deletes an ML model currently available for Amazon Lookout for
|
730
928
|
# Equipment. This will prevent it from being used with an inference
|
731
929
|
# scheduler, even one that is already set up.
|
@@ -903,6 +1101,7 @@ module Aws::LookoutEquipment
|
|
903
1101
|
# * {Types::DescribeInferenceSchedulerResponse#data_output_configuration #data_output_configuration} => Types::InferenceOutputConfiguration
|
904
1102
|
# * {Types::DescribeInferenceSchedulerResponse#role_arn #role_arn} => String
|
905
1103
|
# * {Types::DescribeInferenceSchedulerResponse#server_side_kms_key_id #server_side_kms_key_id} => String
|
1104
|
+
# * {Types::DescribeInferenceSchedulerResponse#latest_inference_result #latest_inference_result} => String
|
906
1105
|
#
|
907
1106
|
# @example Request syntax with placeholder values
|
908
1107
|
#
|
@@ -931,6 +1130,7 @@ module Aws::LookoutEquipment
|
|
931
1130
|
# resp.data_output_configuration.kms_key_id #=> String
|
932
1131
|
# resp.role_arn #=> String
|
933
1132
|
# resp.server_side_kms_key_id #=> String
|
1133
|
+
# resp.latest_inference_result #=> String, one of "ANOMALOUS", "NORMAL"
|
934
1134
|
#
|
935
1135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceScheduler AWS API Documentation
|
936
1136
|
#
|
@@ -941,6 +1141,93 @@ module Aws::LookoutEquipment
|
|
941
1141
|
req.send_request(options)
|
942
1142
|
end
|
943
1143
|
|
1144
|
+
# Returns the name of the label.
|
1145
|
+
#
|
1146
|
+
# @option params [required, String] :label_group_name
|
1147
|
+
# Returns the name of the group containing the label.
|
1148
|
+
#
|
1149
|
+
# @option params [required, String] :label_id
|
1150
|
+
# Returns the ID of the label.
|
1151
|
+
#
|
1152
|
+
# @return [Types::DescribeLabelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1153
|
+
#
|
1154
|
+
# * {Types::DescribeLabelResponse#label_group_name #label_group_name} => String
|
1155
|
+
# * {Types::DescribeLabelResponse#label_group_arn #label_group_arn} => String
|
1156
|
+
# * {Types::DescribeLabelResponse#label_id #label_id} => String
|
1157
|
+
# * {Types::DescribeLabelResponse#start_time #start_time} => Time
|
1158
|
+
# * {Types::DescribeLabelResponse#end_time #end_time} => Time
|
1159
|
+
# * {Types::DescribeLabelResponse#rating #rating} => String
|
1160
|
+
# * {Types::DescribeLabelResponse#fault_code #fault_code} => String
|
1161
|
+
# * {Types::DescribeLabelResponse#notes #notes} => String
|
1162
|
+
# * {Types::DescribeLabelResponse#equipment #equipment} => String
|
1163
|
+
# * {Types::DescribeLabelResponse#created_at #created_at} => Time
|
1164
|
+
#
|
1165
|
+
# @example Request syntax with placeholder values
|
1166
|
+
#
|
1167
|
+
# resp = client.describe_label({
|
1168
|
+
# label_group_name: "LabelGroupName", # required
|
1169
|
+
# label_id: "LabelId", # required
|
1170
|
+
# })
|
1171
|
+
#
|
1172
|
+
# @example Response structure
|
1173
|
+
#
|
1174
|
+
# resp.label_group_name #=> String
|
1175
|
+
# resp.label_group_arn #=> String
|
1176
|
+
# resp.label_id #=> String
|
1177
|
+
# resp.start_time #=> Time
|
1178
|
+
# resp.end_time #=> Time
|
1179
|
+
# resp.rating #=> String, one of "ANOMALY", "NO_ANOMALY", "NEUTRAL"
|
1180
|
+
# resp.fault_code #=> String
|
1181
|
+
# resp.notes #=> String
|
1182
|
+
# resp.equipment #=> String
|
1183
|
+
# resp.created_at #=> Time
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabel AWS API Documentation
|
1186
|
+
#
|
1187
|
+
# @overload describe_label(params = {})
|
1188
|
+
# @param [Hash] params ({})
|
1189
|
+
def describe_label(params = {}, options = {})
|
1190
|
+
req = build_request(:describe_label, params)
|
1191
|
+
req.send_request(options)
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# Returns information about the label group.
|
1195
|
+
#
|
1196
|
+
# @option params [required, String] :label_group_name
|
1197
|
+
# Returns the name of the label group.
|
1198
|
+
#
|
1199
|
+
# @return [Types::DescribeLabelGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1200
|
+
#
|
1201
|
+
# * {Types::DescribeLabelGroupResponse#label_group_name #label_group_name} => String
|
1202
|
+
# * {Types::DescribeLabelGroupResponse#label_group_arn #label_group_arn} => String
|
1203
|
+
# * {Types::DescribeLabelGroupResponse#fault_codes #fault_codes} => Array<String>
|
1204
|
+
# * {Types::DescribeLabelGroupResponse#created_at #created_at} => Time
|
1205
|
+
# * {Types::DescribeLabelGroupResponse#updated_at #updated_at} => Time
|
1206
|
+
#
|
1207
|
+
# @example Request syntax with placeholder values
|
1208
|
+
#
|
1209
|
+
# resp = client.describe_label_group({
|
1210
|
+
# label_group_name: "LabelGroupName", # required
|
1211
|
+
# })
|
1212
|
+
#
|
1213
|
+
# @example Response structure
|
1214
|
+
#
|
1215
|
+
# resp.label_group_name #=> String
|
1216
|
+
# resp.label_group_arn #=> String
|
1217
|
+
# resp.fault_codes #=> Array
|
1218
|
+
# resp.fault_codes[0] #=> String
|
1219
|
+
# resp.created_at #=> Time
|
1220
|
+
# resp.updated_at #=> Time
|
1221
|
+
#
|
1222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelGroup AWS API Documentation
|
1223
|
+
#
|
1224
|
+
# @overload describe_label_group(params = {})
|
1225
|
+
# @param [Hash] params ({})
|
1226
|
+
def describe_label_group(params = {}, options = {})
|
1227
|
+
req = build_request(:describe_label_group, params)
|
1228
|
+
req.send_request(options)
|
1229
|
+
end
|
1230
|
+
|
944
1231
|
# Provides a JSON containing the overall information about a specific ML
|
945
1232
|
# model, including model name and ARN, dataset, training and evaluation
|
946
1233
|
# information, status, and so on.
|
@@ -987,6 +1274,7 @@ module Aws::LookoutEquipment
|
|
987
1274
|
# resp.schema #=> String
|
988
1275
|
# resp.labels_input_configuration.s3_input_configuration.bucket #=> String
|
989
1276
|
# resp.labels_input_configuration.s3_input_configuration.prefix #=> String
|
1277
|
+
# resp.labels_input_configuration.label_group_name #=> String
|
990
1278
|
# resp.training_data_start_time #=> Time
|
991
1279
|
# resp.training_data_end_time #=> Time
|
992
1280
|
# resp.evaluation_data_start_time #=> Time
|
@@ -1125,12 +1413,12 @@ module Aws::LookoutEquipment
|
|
1125
1413
|
# The name of the inference scheduler for the inference events listed.
|
1126
1414
|
#
|
1127
1415
|
# @option params [required, Time,DateTime,Date,Integer,String] :interval_start_time
|
1128
|
-
# Lookout for Equipment will return all the inference events with
|
1416
|
+
# Lookout for Equipment will return all the inference events with an end
|
1129
1417
|
# time equal to or greater than the start time given.
|
1130
1418
|
#
|
1131
1419
|
# @option params [required, Time,DateTime,Date,Integer,String] :interval_end_time
|
1132
|
-
#
|
1133
|
-
#
|
1420
|
+
# Returns all the inference events with an end start time equal to or
|
1421
|
+
# greater than less than the end time given
|
1134
1422
|
#
|
1135
1423
|
# @return [Types::ListInferenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1136
1424
|
#
|
@@ -1288,6 +1576,7 @@ module Aws::LookoutEquipment
|
|
1288
1576
|
# resp.inference_scheduler_summaries[0].status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
|
1289
1577
|
# resp.inference_scheduler_summaries[0].data_delay_offset_in_minutes #=> Integer
|
1290
1578
|
# resp.inference_scheduler_summaries[0].data_upload_frequency #=> String, one of "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
|
1579
|
+
# resp.inference_scheduler_summaries[0].latest_inference_result #=> String, one of "ANOMALOUS", "NORMAL"
|
1291
1580
|
#
|
1292
1581
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceSchedulers AWS API Documentation
|
1293
1582
|
#
|
@@ -1298,6 +1587,118 @@ module Aws::LookoutEquipment
|
|
1298
1587
|
req.send_request(options)
|
1299
1588
|
end
|
1300
1589
|
|
1590
|
+
# Returns a list of the label groups.
|
1591
|
+
#
|
1592
|
+
# @option params [String] :label_group_name_begins_with
|
1593
|
+
# The beginning of the name of the label groups to be listed.
|
1594
|
+
#
|
1595
|
+
# @option params [String] :next_token
|
1596
|
+
# An opaque pagination token indicating where to continue the listing of
|
1597
|
+
# label groups.
|
1598
|
+
#
|
1599
|
+
# @option params [Integer] :max_results
|
1600
|
+
# Specifies the maximum number of label groups to list.
|
1601
|
+
#
|
1602
|
+
# @return [Types::ListLabelGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1603
|
+
#
|
1604
|
+
# * {Types::ListLabelGroupsResponse#next_token #next_token} => String
|
1605
|
+
# * {Types::ListLabelGroupsResponse#label_group_summaries #label_group_summaries} => Array<Types::LabelGroupSummary>
|
1606
|
+
#
|
1607
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1608
|
+
#
|
1609
|
+
# @example Request syntax with placeholder values
|
1610
|
+
#
|
1611
|
+
# resp = client.list_label_groups({
|
1612
|
+
# label_group_name_begins_with: "LabelGroupName",
|
1613
|
+
# next_token: "NextToken",
|
1614
|
+
# max_results: 1,
|
1615
|
+
# })
|
1616
|
+
#
|
1617
|
+
# @example Response structure
|
1618
|
+
#
|
1619
|
+
# resp.next_token #=> String
|
1620
|
+
# resp.label_group_summaries #=> Array
|
1621
|
+
# resp.label_group_summaries[0].label_group_name #=> String
|
1622
|
+
# resp.label_group_summaries[0].label_group_arn #=> String
|
1623
|
+
# resp.label_group_summaries[0].created_at #=> Time
|
1624
|
+
# resp.label_group_summaries[0].updated_at #=> Time
|
1625
|
+
#
|
1626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelGroups AWS API Documentation
|
1627
|
+
#
|
1628
|
+
# @overload list_label_groups(params = {})
|
1629
|
+
# @param [Hash] params ({})
|
1630
|
+
def list_label_groups(params = {}, options = {})
|
1631
|
+
req = build_request(:list_label_groups, params)
|
1632
|
+
req.send_request(options)
|
1633
|
+
end
|
1634
|
+
|
1635
|
+
# Provides a list of labels.
|
1636
|
+
#
|
1637
|
+
# @option params [required, String] :label_group_name
|
1638
|
+
# Retruns the name of the label group.
|
1639
|
+
#
|
1640
|
+
# @option params [Time,DateTime,Date,Integer,String] :interval_start_time
|
1641
|
+
# Returns all the labels with a end time equal to or later than the
|
1642
|
+
# start time given.
|
1643
|
+
#
|
1644
|
+
# @option params [Time,DateTime,Date,Integer,String] :interval_end_time
|
1645
|
+
# Returns all labels with a start time earlier than the end time given.
|
1646
|
+
#
|
1647
|
+
# @option params [String] :fault_code
|
1648
|
+
# Returns labels with a particular fault code.
|
1649
|
+
#
|
1650
|
+
# @option params [String] :equipment
|
1651
|
+
# Lists the labels that pertain to a particular piece of equipment.
|
1652
|
+
#
|
1653
|
+
# @option params [String] :next_token
|
1654
|
+
# An opaque pagination token indicating where to continue the listing of
|
1655
|
+
# label groups.
|
1656
|
+
#
|
1657
|
+
# @option params [Integer] :max_results
|
1658
|
+
# Specifies the maximum number of labels to list.
|
1659
|
+
#
|
1660
|
+
# @return [Types::ListLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1661
|
+
#
|
1662
|
+
# * {Types::ListLabelsResponse#next_token #next_token} => String
|
1663
|
+
# * {Types::ListLabelsResponse#label_summaries #label_summaries} => Array<Types::LabelSummary>
|
1664
|
+
#
|
1665
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1666
|
+
#
|
1667
|
+
# @example Request syntax with placeholder values
|
1668
|
+
#
|
1669
|
+
# resp = client.list_labels({
|
1670
|
+
# label_group_name: "LabelGroupName", # required
|
1671
|
+
# interval_start_time: Time.now,
|
1672
|
+
# interval_end_time: Time.now,
|
1673
|
+
# fault_code: "FaultCode",
|
1674
|
+
# equipment: "Equipment",
|
1675
|
+
# next_token: "NextToken",
|
1676
|
+
# max_results: 1,
|
1677
|
+
# })
|
1678
|
+
#
|
1679
|
+
# @example Response structure
|
1680
|
+
#
|
1681
|
+
# resp.next_token #=> String
|
1682
|
+
# resp.label_summaries #=> Array
|
1683
|
+
# resp.label_summaries[0].label_group_name #=> String
|
1684
|
+
# resp.label_summaries[0].label_id #=> String
|
1685
|
+
# resp.label_summaries[0].label_group_arn #=> String
|
1686
|
+
# resp.label_summaries[0].start_time #=> Time
|
1687
|
+
# resp.label_summaries[0].end_time #=> Time
|
1688
|
+
# resp.label_summaries[0].rating #=> String, one of "ANOMALY", "NO_ANOMALY", "NEUTRAL"
|
1689
|
+
# resp.label_summaries[0].fault_code #=> String
|
1690
|
+
# resp.label_summaries[0].equipment #=> String
|
1691
|
+
# resp.label_summaries[0].created_at #=> Time
|
1692
|
+
#
|
1693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabels AWS API Documentation
|
1694
|
+
#
|
1695
|
+
# @overload list_labels(params = {})
|
1696
|
+
# @param [Hash] params ({})
|
1697
|
+
def list_labels(params = {}, options = {})
|
1698
|
+
req = build_request(:list_labels, params)
|
1699
|
+
req.send_request(options)
|
1700
|
+
end
|
1701
|
+
|
1301
1702
|
# Generates a list of all models in the account, including model name
|
1302
1703
|
# and ARN, dataset, and status.
|
1303
1704
|
#
|
@@ -1725,6 +2126,36 @@ module Aws::LookoutEquipment
|
|
1725
2126
|
req.send_request(options)
|
1726
2127
|
end
|
1727
2128
|
|
2129
|
+
# Updates the label group.
|
2130
|
+
#
|
2131
|
+
# @option params [required, String] :label_group_name
|
2132
|
+
# The name of the label group to be updated.
|
2133
|
+
#
|
2134
|
+
# @option params [Array<String>] :fault_codes
|
2135
|
+
# Updates the code indicating the type of anomaly associated with the
|
2136
|
+
# label.
|
2137
|
+
#
|
2138
|
+
# Data in this field will be retained for service usage. Follow best
|
2139
|
+
# practices for the security of your data.
|
2140
|
+
#
|
2141
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2142
|
+
#
|
2143
|
+
# @example Request syntax with placeholder values
|
2144
|
+
#
|
2145
|
+
# resp = client.update_label_group({
|
2146
|
+
# label_group_name: "LabelGroupName", # required
|
2147
|
+
# fault_codes: ["FaultCode"],
|
2148
|
+
# })
|
2149
|
+
#
|
2150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup AWS API Documentation
|
2151
|
+
#
|
2152
|
+
# @overload update_label_group(params = {})
|
2153
|
+
# @param [Hash] params ({})
|
2154
|
+
def update_label_group(params = {}, options = {})
|
2155
|
+
req = build_request(:update_label_group, params)
|
2156
|
+
req.send_request(options)
|
2157
|
+
end
|
2158
|
+
|
1728
2159
|
# @!endgroup
|
1729
2160
|
|
1730
2161
|
# @param params ({})
|
@@ -1738,7 +2169,7 @@ module Aws::LookoutEquipment
|
|
1738
2169
|
params: params,
|
1739
2170
|
config: config)
|
1740
2171
|
context[:gem_name] = 'aws-sdk-lookoutequipment'
|
1741
|
-
context[:gem_version] = '1.
|
2172
|
+
context[:gem_version] = '1.13.0'
|
1742
2173
|
Seahorse::Client::Request.new(handlers, context)
|
1743
2174
|
end
|
1744
2175
|
|