aws-sdk-lookoutequipment 1.12.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7d1481ad469d0d57404ef55894a9ab7439fa8531c8203d582626391f23aaf134
4
- data.tar.gz: 0c2fc65b3c64eb7bcc2da27570f6c0da8417c5d67bf94c90843296bbaef0369f
3
+ metadata.gz: 79df21eb51a166f5663ebb7adee54f1bb5645b69b7f1a350abffc275b3a54e9f
4
+ data.tar.gz: 140ef735a8fe446484ba3fefb03daace865b3782f87db5937233a15bcfbde1cf
5
5
  SHA512:
6
- metadata.gz: 1a834900eff56b50f1e0a9132c897a8f97e37fbff210e649d2a30ee0b445f97e7d7c307b795efcfde5362a7b62a526e2ef3f80e0ad909c6ae9f861c4a69d4666
7
- data.tar.gz: 2f181af26fd4624d17954ce172461ecbb2ca8f20252bc952ec5c918fe976327a6be3f7b2e56cc6254fe45e5b944dbb0579d72a7dddf7c49a57e2f011e82dc7a3
6
+ metadata.gz: 18e8881d193d5487c520b90bb553fc4ba740f30c890b77ecd426724d0588067613e8f74fdd5e2cc3464c4f949483002ec440989917dbed56d9ce9f212345957e
7
+ data.tar.gz: 4445318b614d47f1f1202de15dd5ca3b7532740899e33ecb13999bea221526a2ca3a920b5fcbc640c2ce15d8b74176e845e8ad47f6e1215c22233b1e6ecdc2ef
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.14.0 (2022-10-25)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.13.0 (2022-08-30)
10
+ ------------------
11
+
12
+ * Feature - This release adds new apis for providing labels.
13
+
4
14
  1.12.0 (2022-06-23)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.12.0
1
+ 1.14.0
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
30
30
  require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
33
- require 'aws-sdk-core/plugins/signature_v4.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
34
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
35
35
 
36
36
  Aws::Plugins::GlobalConfiguration.add_identifier(:lookoutequipment)
@@ -79,8 +79,9 @@ module Aws::LookoutEquipment
79
79
  add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
80
  add_plugin(Aws::Plugins::DefaultsMode)
81
81
  add_plugin(Aws::Plugins::RecursionDetection)
82
- add_plugin(Aws::Plugins::SignatureV4)
82
+ add_plugin(Aws::Plugins::Sign)
83
83
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
84
+ add_plugin(Aws::LookoutEquipment::Plugins::Endpoints)
84
85
 
85
86
  # @overload initialize(options)
86
87
  # @param [Hash] options
@@ -297,6 +298,19 @@ module Aws::LookoutEquipment
297
298
  # ** Please note ** When response stubbing is enabled, no HTTP
298
299
  # requests are made, and retries are disabled.
299
300
  #
301
+ # @option options [Aws::TokenProvider] :token_provider
302
+ # A Bearer Token Provider. This can be an instance of any one of the
303
+ # following classes:
304
+ #
305
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
306
+ # tokens.
307
+ #
308
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
309
+ # access token generated from `aws login`.
310
+ #
311
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
312
+ # will be used to search for tokens configured for your profile in shared configuration files.
313
+ #
300
314
  # @option options [Boolean] :use_dualstack_endpoint
301
315
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
302
316
  # will be used if available.
@@ -310,6 +324,9 @@ module Aws::LookoutEquipment
310
324
  # When `true`, request parameters are validated before
311
325
  # sending the request.
312
326
  #
327
+ # @option options [Aws::LookoutEquipment::EndpointProvider] :endpoint_provider
328
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::LookoutEquipment::EndpointParameters`
329
+ #
313
330
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
314
331
  # requests through. Formatted like 'http://proxy.com:123'.
315
332
  #
@@ -443,24 +460,35 @@ module Aws::LookoutEquipment
443
460
  # The name of the inference scheduler being created.
444
461
  #
445
462
  # @option params [Integer] :data_delay_offset_in_minutes
446
- # A period of time (in minutes) by which inference on the data is
447
- # delayed after the data starts. For instance, if you select an offset
448
- # delay time of five minutes, inference will not begin on the data until
449
- # the first data measurement after the five minute mark. For example, if
450
- # five minutes is selected, the inference scheduler will wake up at the
451
- # configured frequency with the additional five minute delay time to
452
- # check the customer S3 bucket. The customer can upload data at the same
453
- # frequency and they don't need to stop and restart the scheduler when
454
- # uploading new data.
463
+ # The interval (in minutes) of planned delay at the start of each
464
+ # inference segment. For example, if inference is set to run every ten
465
+ # minutes, the delay is set to five minutes and the time is 09:08. The
466
+ # inference scheduler will wake up at the configured interval (which,
467
+ # without a delay configured, would be 09:10) plus the additional five
468
+ # minute delay time (so 09:15) to check your Amazon S3 bucket. The delay
469
+ # provides a buffer for you to upload data at the same frequency, so
470
+ # that you don't have to stop and restart the scheduler when uploading
471
+ # new data.
472
+ #
473
+ # For more information, see [Understanding the inference process][1].
474
+ #
475
+ #
476
+ #
477
+ # [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
455
478
  #
456
479
  # @option params [required, String] :data_upload_frequency
457
- # How often data is uploaded to the source S3 bucket for the input data.
458
- # The value chosen is the length of time between data uploads. For
459
- # instance, if you select 5 minutes, Amazon Lookout for Equipment will
460
- # upload the real-time data to the source bucket once every 5 minutes.
461
- # This frequency also determines how often Amazon Lookout for Equipment
462
- # starts a scheduled inference on your data. In this example, it starts
463
- # once every 5 minutes.
480
+ # How often data is uploaded to the source Amazon S3 bucket for the
481
+ # input data. The value chosen is the length of time between data
482
+ # uploads. For instance, if you select 5 minutes, Amazon Lookout for
483
+ # Equipment will upload the real-time data to the source bucket once
484
+ # every 5 minutes. This frequency also determines how often Amazon
485
+ # Lookout for Equipment runs inference on your data.
486
+ #
487
+ # For more information, see [Understanding the inference process][1].
488
+ #
489
+ #
490
+ #
491
+ # [1]: https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html
464
492
  #
465
493
  # @option params [required, Types::InferenceInputConfiguration] :data_input_configuration
466
494
  # Specifies configuration information for the input data for the
@@ -546,6 +574,140 @@ module Aws::LookoutEquipment
546
574
  req.send_request(options)
547
575
  end
548
576
 
577
+ # Creates a label for an event.
578
+ #
579
+ # @option params [required, String] :label_group_name
580
+ # The name of a group of labels.
581
+ #
582
+ # Data in this field will be retained for service usage. Follow best
583
+ # practices for the security of your data.
584
+ #
585
+ # @option params [required, Time,DateTime,Date,Integer,String] :start_time
586
+ # The start time of the labeled event.
587
+ #
588
+ # @option params [required, Time,DateTime,Date,Integer,String] :end_time
589
+ # The end time of the labeled event.
590
+ #
591
+ # @option params [required, String] :rating
592
+ # Indicates whether a labeled event represents an anomaly.
593
+ #
594
+ # @option params [String] :fault_code
595
+ # Provides additional information about the label. The fault code must
596
+ # be defined in the FaultCodes attribute of the label group.
597
+ #
598
+ # Data in this field will be retained for service usage. Follow best
599
+ # practices for the security of your data.
600
+ #
601
+ # @option params [String] :notes
602
+ # Metadata providing additional information about the label.
603
+ #
604
+ # Data in this field will be retained for service usage. Follow best
605
+ # practices for the security of your data.
606
+ #
607
+ # @option params [String] :equipment
608
+ # Indicates that a label pertains to a particular piece of equipment.
609
+ #
610
+ # Data in this field will be retained for service usage. Follow best
611
+ # practices for the security of your data.
612
+ #
613
+ # @option params [required, String] :client_token
614
+ # A unique identifier for the request to create a label. If you do not
615
+ # set the client request token, Lookout for Equipment generates one.
616
+ #
617
+ # **A suitable default value is auto-generated.** You should normally
618
+ # not need to pass this option.**
619
+ #
620
+ # @return [Types::CreateLabelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
621
+ #
622
+ # * {Types::CreateLabelResponse#label_id #label_id} => String
623
+ #
624
+ # @example Request syntax with placeholder values
625
+ #
626
+ # resp = client.create_label({
627
+ # label_group_name: "LabelGroupName", # required
628
+ # start_time: Time.now, # required
629
+ # end_time: Time.now, # required
630
+ # rating: "ANOMALY", # required, accepts ANOMALY, NO_ANOMALY, NEUTRAL
631
+ # fault_code: "FaultCode",
632
+ # notes: "Comments",
633
+ # equipment: "Equipment",
634
+ # client_token: "IdempotenceToken", # required
635
+ # })
636
+ #
637
+ # @example Response structure
638
+ #
639
+ # resp.label_id #=> String
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabel AWS API Documentation
642
+ #
643
+ # @overload create_label(params = {})
644
+ # @param [Hash] params ({})
645
+ def create_label(params = {}, options = {})
646
+ req = build_request(:create_label, params)
647
+ req.send_request(options)
648
+ end
649
+
650
+ # Creates a group of labels.
651
+ #
652
+ # @option params [required, String] :label_group_name
653
+ # Names a group of labels.
654
+ #
655
+ # Data in this field will be retained for service usage. Follow best
656
+ # practices for the security of your data.
657
+ #
658
+ # @option params [Array<String>] :fault_codes
659
+ # The acceptable fault codes (indicating the type of anomaly associated
660
+ # with the label) that can be used with this label group.
661
+ #
662
+ # Data in this field will be retained for service usage. Follow best
663
+ # practices for the security of your data.
664
+ #
665
+ # @option params [required, String] :client_token
666
+ # A unique identifier for the request to create a label group. If you do
667
+ # not set the client request token, Lookout for Equipment generates one.
668
+ #
669
+ # **A suitable default value is auto-generated.** You should normally
670
+ # not need to pass this option.**
671
+ #
672
+ # @option params [Array<Types::Tag>] :tags
673
+ # Tags that provide metadata about the label group you are creating.
674
+ #
675
+ # Data in this field will be retained for service usage. Follow best
676
+ # practices for the security of your data.
677
+ #
678
+ # @return [Types::CreateLabelGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
679
+ #
680
+ # * {Types::CreateLabelGroupResponse#label_group_name #label_group_name} => String
681
+ # * {Types::CreateLabelGroupResponse#label_group_arn #label_group_arn} => String
682
+ #
683
+ # @example Request syntax with placeholder values
684
+ #
685
+ # resp = client.create_label_group({
686
+ # label_group_name: "LabelGroupName", # required
687
+ # fault_codes: ["FaultCode"],
688
+ # client_token: "IdempotenceToken", # required
689
+ # tags: [
690
+ # {
691
+ # key: "TagKey", # required
692
+ # value: "TagValue", # required
693
+ # },
694
+ # ],
695
+ # })
696
+ #
697
+ # @example Response structure
698
+ #
699
+ # resp.label_group_name #=> String
700
+ # resp.label_group_arn #=> String
701
+ #
702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/CreateLabelGroup AWS API Documentation
703
+ #
704
+ # @overload create_label_group(params = {})
705
+ # @param [Hash] params ({})
706
+ def create_label_group(params = {}, options = {})
707
+ req = build_request(:create_label_group, params)
708
+ req.send_request(options)
709
+ end
710
+
549
711
  # Creates an ML model for data inference.
550
712
  #
551
713
  # A machine-learning (ML) model is a mathematical model that finds
@@ -638,10 +800,11 @@ module Aws::LookoutEquipment
638
800
  # inline_data_schema: "InlineDataSchema",
639
801
  # },
640
802
  # labels_input_configuration: {
641
- # s3_input_configuration: { # required
803
+ # s3_input_configuration: {
642
804
  # bucket: "S3Bucket", # required
643
805
  # prefix: "S3Prefix",
644
806
  # },
807
+ # label_group_name: "LabelGroupName",
645
808
  # },
646
809
  # client_token: "IdempotenceToken", # required
647
810
  # training_data_start_time: Time.now,
@@ -726,6 +889,58 @@ module Aws::LookoutEquipment
726
889
  req.send_request(options)
727
890
  end
728
891
 
892
+ # Deletes a label.
893
+ #
894
+ # @option params [required, String] :label_group_name
895
+ # The name of the label group that contains the label that you want to
896
+ # delete. Data in this field will be retained for service usage. Follow
897
+ # best practices for the security of your data.
898
+ #
899
+ # @option params [required, String] :label_id
900
+ # The ID of the label that you want to delete.
901
+ #
902
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
903
+ #
904
+ # @example Request syntax with placeholder values
905
+ #
906
+ # resp = client.delete_label({
907
+ # label_group_name: "LabelGroupName", # required
908
+ # label_id: "LabelId", # required
909
+ # })
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabel AWS API Documentation
912
+ #
913
+ # @overload delete_label(params = {})
914
+ # @param [Hash] params ({})
915
+ def delete_label(params = {}, options = {})
916
+ req = build_request(:delete_label, params)
917
+ req.send_request(options)
918
+ end
919
+
920
+ # Deletes a group of labels.
921
+ #
922
+ # @option params [required, String] :label_group_name
923
+ # The name of the label group that you want to delete. Data in this
924
+ # field will be retained for service usage. Follow best practices for
925
+ # the security of your data.
926
+ #
927
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
928
+ #
929
+ # @example Request syntax with placeholder values
930
+ #
931
+ # resp = client.delete_label_group({
932
+ # label_group_name: "LabelGroupName", # required
933
+ # })
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DeleteLabelGroup AWS API Documentation
936
+ #
937
+ # @overload delete_label_group(params = {})
938
+ # @param [Hash] params ({})
939
+ def delete_label_group(params = {}, options = {})
940
+ req = build_request(:delete_label_group, params)
941
+ req.send_request(options)
942
+ end
943
+
729
944
  # Deletes an ML model currently available for Amazon Lookout for
730
945
  # Equipment. This will prevent it from being used with an inference
731
946
  # scheduler, even one that is already set up.
@@ -903,6 +1118,7 @@ module Aws::LookoutEquipment
903
1118
  # * {Types::DescribeInferenceSchedulerResponse#data_output_configuration #data_output_configuration} => Types::InferenceOutputConfiguration
904
1119
  # * {Types::DescribeInferenceSchedulerResponse#role_arn #role_arn} => String
905
1120
  # * {Types::DescribeInferenceSchedulerResponse#server_side_kms_key_id #server_side_kms_key_id} => String
1121
+ # * {Types::DescribeInferenceSchedulerResponse#latest_inference_result #latest_inference_result} => String
906
1122
  #
907
1123
  # @example Request syntax with placeholder values
908
1124
  #
@@ -931,6 +1147,7 @@ module Aws::LookoutEquipment
931
1147
  # resp.data_output_configuration.kms_key_id #=> String
932
1148
  # resp.role_arn #=> String
933
1149
  # resp.server_side_kms_key_id #=> String
1150
+ # resp.latest_inference_result #=> String, one of "ANOMALOUS", "NORMAL"
934
1151
  #
935
1152
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceScheduler AWS API Documentation
936
1153
  #
@@ -941,6 +1158,93 @@ module Aws::LookoutEquipment
941
1158
  req.send_request(options)
942
1159
  end
943
1160
 
1161
+ # Returns the name of the label.
1162
+ #
1163
+ # @option params [required, String] :label_group_name
1164
+ # Returns the name of the group containing the label.
1165
+ #
1166
+ # @option params [required, String] :label_id
1167
+ # Returns the ID of the label.
1168
+ #
1169
+ # @return [Types::DescribeLabelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1170
+ #
1171
+ # * {Types::DescribeLabelResponse#label_group_name #label_group_name} => String
1172
+ # * {Types::DescribeLabelResponse#label_group_arn #label_group_arn} => String
1173
+ # * {Types::DescribeLabelResponse#label_id #label_id} => String
1174
+ # * {Types::DescribeLabelResponse#start_time #start_time} => Time
1175
+ # * {Types::DescribeLabelResponse#end_time #end_time} => Time
1176
+ # * {Types::DescribeLabelResponse#rating #rating} => String
1177
+ # * {Types::DescribeLabelResponse#fault_code #fault_code} => String
1178
+ # * {Types::DescribeLabelResponse#notes #notes} => String
1179
+ # * {Types::DescribeLabelResponse#equipment #equipment} => String
1180
+ # * {Types::DescribeLabelResponse#created_at #created_at} => Time
1181
+ #
1182
+ # @example Request syntax with placeholder values
1183
+ #
1184
+ # resp = client.describe_label({
1185
+ # label_group_name: "LabelGroupName", # required
1186
+ # label_id: "LabelId", # required
1187
+ # })
1188
+ #
1189
+ # @example Response structure
1190
+ #
1191
+ # resp.label_group_name #=> String
1192
+ # resp.label_group_arn #=> String
1193
+ # resp.label_id #=> String
1194
+ # resp.start_time #=> Time
1195
+ # resp.end_time #=> Time
1196
+ # resp.rating #=> String, one of "ANOMALY", "NO_ANOMALY", "NEUTRAL"
1197
+ # resp.fault_code #=> String
1198
+ # resp.notes #=> String
1199
+ # resp.equipment #=> String
1200
+ # resp.created_at #=> Time
1201
+ #
1202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabel AWS API Documentation
1203
+ #
1204
+ # @overload describe_label(params = {})
1205
+ # @param [Hash] params ({})
1206
+ def describe_label(params = {}, options = {})
1207
+ req = build_request(:describe_label, params)
1208
+ req.send_request(options)
1209
+ end
1210
+
1211
+ # Returns information about the label group.
1212
+ #
1213
+ # @option params [required, String] :label_group_name
1214
+ # Returns the name of the label group.
1215
+ #
1216
+ # @return [Types::DescribeLabelGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1217
+ #
1218
+ # * {Types::DescribeLabelGroupResponse#label_group_name #label_group_name} => String
1219
+ # * {Types::DescribeLabelGroupResponse#label_group_arn #label_group_arn} => String
1220
+ # * {Types::DescribeLabelGroupResponse#fault_codes #fault_codes} => Array&lt;String&gt;
1221
+ # * {Types::DescribeLabelGroupResponse#created_at #created_at} => Time
1222
+ # * {Types::DescribeLabelGroupResponse#updated_at #updated_at} => Time
1223
+ #
1224
+ # @example Request syntax with placeholder values
1225
+ #
1226
+ # resp = client.describe_label_group({
1227
+ # label_group_name: "LabelGroupName", # required
1228
+ # })
1229
+ #
1230
+ # @example Response structure
1231
+ #
1232
+ # resp.label_group_name #=> String
1233
+ # resp.label_group_arn #=> String
1234
+ # resp.fault_codes #=> Array
1235
+ # resp.fault_codes[0] #=> String
1236
+ # resp.created_at #=> Time
1237
+ # resp.updated_at #=> Time
1238
+ #
1239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabelGroup AWS API Documentation
1240
+ #
1241
+ # @overload describe_label_group(params = {})
1242
+ # @param [Hash] params ({})
1243
+ def describe_label_group(params = {}, options = {})
1244
+ req = build_request(:describe_label_group, params)
1245
+ req.send_request(options)
1246
+ end
1247
+
944
1248
  # Provides a JSON containing the overall information about a specific ML
945
1249
  # model, including model name and ARN, dataset, training and evaluation
946
1250
  # information, status, and so on.
@@ -987,6 +1291,7 @@ module Aws::LookoutEquipment
987
1291
  # resp.schema #=> String
988
1292
  # resp.labels_input_configuration.s3_input_configuration.bucket #=> String
989
1293
  # resp.labels_input_configuration.s3_input_configuration.prefix #=> String
1294
+ # resp.labels_input_configuration.label_group_name #=> String
990
1295
  # resp.training_data_start_time #=> Time
991
1296
  # resp.training_data_end_time #=> Time
992
1297
  # resp.evaluation_data_start_time #=> Time
@@ -1125,12 +1430,12 @@ module Aws::LookoutEquipment
1125
1430
  # The name of the inference scheduler for the inference events listed.
1126
1431
  #
1127
1432
  # @option params [required, Time,DateTime,Date,Integer,String] :interval_start_time
1128
- # Lookout for Equipment will return all the inference events with start
1433
+ # Lookout for Equipment will return all the inference events with an end
1129
1434
  # time equal to or greater than the start time given.
1130
1435
  #
1131
1436
  # @option params [required, Time,DateTime,Date,Integer,String] :interval_end_time
1132
- # Lookout for Equipment will return all the inference events with end
1133
- # time equal to or less than the end time given.
1437
+ # Returns all the inference events with an end start time equal to or
1438
+ # greater than less than the end time given
1134
1439
  #
1135
1440
  # @return [Types::ListInferenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1136
1441
  #
@@ -1288,6 +1593,7 @@ module Aws::LookoutEquipment
1288
1593
  # resp.inference_scheduler_summaries[0].status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
1289
1594
  # resp.inference_scheduler_summaries[0].data_delay_offset_in_minutes #=> Integer
1290
1595
  # resp.inference_scheduler_summaries[0].data_upload_frequency #=> String, one of "PT5M", "PT10M", "PT15M", "PT30M", "PT1H"
1596
+ # resp.inference_scheduler_summaries[0].latest_inference_result #=> String, one of "ANOMALOUS", "NORMAL"
1291
1597
  #
1292
1598
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceSchedulers AWS API Documentation
1293
1599
  #
@@ -1298,6 +1604,118 @@ module Aws::LookoutEquipment
1298
1604
  req.send_request(options)
1299
1605
  end
1300
1606
 
1607
+ # Returns a list of the label groups.
1608
+ #
1609
+ # @option params [String] :label_group_name_begins_with
1610
+ # The beginning of the name of the label groups to be listed.
1611
+ #
1612
+ # @option params [String] :next_token
1613
+ # An opaque pagination token indicating where to continue the listing of
1614
+ # label groups.
1615
+ #
1616
+ # @option params [Integer] :max_results
1617
+ # Specifies the maximum number of label groups to list.
1618
+ #
1619
+ # @return [Types::ListLabelGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1620
+ #
1621
+ # * {Types::ListLabelGroupsResponse#next_token #next_token} => String
1622
+ # * {Types::ListLabelGroupsResponse#label_group_summaries #label_group_summaries} => Array&lt;Types::LabelGroupSummary&gt;
1623
+ #
1624
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1625
+ #
1626
+ # @example Request syntax with placeholder values
1627
+ #
1628
+ # resp = client.list_label_groups({
1629
+ # label_group_name_begins_with: "LabelGroupName",
1630
+ # next_token: "NextToken",
1631
+ # max_results: 1,
1632
+ # })
1633
+ #
1634
+ # @example Response structure
1635
+ #
1636
+ # resp.next_token #=> String
1637
+ # resp.label_group_summaries #=> Array
1638
+ # resp.label_group_summaries[0].label_group_name #=> String
1639
+ # resp.label_group_summaries[0].label_group_arn #=> String
1640
+ # resp.label_group_summaries[0].created_at #=> Time
1641
+ # resp.label_group_summaries[0].updated_at #=> Time
1642
+ #
1643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelGroups AWS API Documentation
1644
+ #
1645
+ # @overload list_label_groups(params = {})
1646
+ # @param [Hash] params ({})
1647
+ def list_label_groups(params = {}, options = {})
1648
+ req = build_request(:list_label_groups, params)
1649
+ req.send_request(options)
1650
+ end
1651
+
1652
+ # Provides a list of labels.
1653
+ #
1654
+ # @option params [required, String] :label_group_name
1655
+ # Retruns the name of the label group.
1656
+ #
1657
+ # @option params [Time,DateTime,Date,Integer,String] :interval_start_time
1658
+ # Returns all the labels with a end time equal to or later than the
1659
+ # start time given.
1660
+ #
1661
+ # @option params [Time,DateTime,Date,Integer,String] :interval_end_time
1662
+ # Returns all labels with a start time earlier than the end time given.
1663
+ #
1664
+ # @option params [String] :fault_code
1665
+ # Returns labels with a particular fault code.
1666
+ #
1667
+ # @option params [String] :equipment
1668
+ # Lists the labels that pertain to a particular piece of equipment.
1669
+ #
1670
+ # @option params [String] :next_token
1671
+ # An opaque pagination token indicating where to continue the listing of
1672
+ # label groups.
1673
+ #
1674
+ # @option params [Integer] :max_results
1675
+ # Specifies the maximum number of labels to list.
1676
+ #
1677
+ # @return [Types::ListLabelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1678
+ #
1679
+ # * {Types::ListLabelsResponse#next_token #next_token} => String
1680
+ # * {Types::ListLabelsResponse#label_summaries #label_summaries} => Array&lt;Types::LabelSummary&gt;
1681
+ #
1682
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1683
+ #
1684
+ # @example Request syntax with placeholder values
1685
+ #
1686
+ # resp = client.list_labels({
1687
+ # label_group_name: "LabelGroupName", # required
1688
+ # interval_start_time: Time.now,
1689
+ # interval_end_time: Time.now,
1690
+ # fault_code: "FaultCode",
1691
+ # equipment: "Equipment",
1692
+ # next_token: "NextToken",
1693
+ # max_results: 1,
1694
+ # })
1695
+ #
1696
+ # @example Response structure
1697
+ #
1698
+ # resp.next_token #=> String
1699
+ # resp.label_summaries #=> Array
1700
+ # resp.label_summaries[0].label_group_name #=> String
1701
+ # resp.label_summaries[0].label_id #=> String
1702
+ # resp.label_summaries[0].label_group_arn #=> String
1703
+ # resp.label_summaries[0].start_time #=> Time
1704
+ # resp.label_summaries[0].end_time #=> Time
1705
+ # resp.label_summaries[0].rating #=> String, one of "ANOMALY", "NO_ANOMALY", "NEUTRAL"
1706
+ # resp.label_summaries[0].fault_code #=> String
1707
+ # resp.label_summaries[0].equipment #=> String
1708
+ # resp.label_summaries[0].created_at #=> Time
1709
+ #
1710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabels AWS API Documentation
1711
+ #
1712
+ # @overload list_labels(params = {})
1713
+ # @param [Hash] params ({})
1714
+ def list_labels(params = {}, options = {})
1715
+ req = build_request(:list_labels, params)
1716
+ req.send_request(options)
1717
+ end
1718
+
1301
1719
  # Generates a list of all models in the account, including model name
1302
1720
  # and ARN, dataset, and status.
1303
1721
  #
@@ -1725,6 +2143,36 @@ module Aws::LookoutEquipment
1725
2143
  req.send_request(options)
1726
2144
  end
1727
2145
 
2146
+ # Updates the label group.
2147
+ #
2148
+ # @option params [required, String] :label_group_name
2149
+ # The name of the label group to be updated.
2150
+ #
2151
+ # @option params [Array<String>] :fault_codes
2152
+ # Updates the code indicating the type of anomaly associated with the
2153
+ # label.
2154
+ #
2155
+ # Data in this field will be retained for service usage. Follow best
2156
+ # practices for the security of your data.
2157
+ #
2158
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2159
+ #
2160
+ # @example Request syntax with placeholder values
2161
+ #
2162
+ # resp = client.update_label_group({
2163
+ # label_group_name: "LabelGroupName", # required
2164
+ # fault_codes: ["FaultCode"],
2165
+ # })
2166
+ #
2167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/UpdateLabelGroup AWS API Documentation
2168
+ #
2169
+ # @overload update_label_group(params = {})
2170
+ # @param [Hash] params ({})
2171
+ def update_label_group(params = {}, options = {})
2172
+ req = build_request(:update_label_group, params)
2173
+ req.send_request(options)
2174
+ end
2175
+
1728
2176
  # @!endgroup
1729
2177
 
1730
2178
  # @param params ({})
@@ -1738,7 +2186,7 @@ module Aws::LookoutEquipment
1738
2186
  params: params,
1739
2187
  config: config)
1740
2188
  context[:gem_name] = 'aws-sdk-lookoutequipment'
1741
- context[:gem_version] = '1.12.0'
2189
+ context[:gem_version] = '1.14.0'
1742
2190
  Seahorse::Client::Request.new(handlers, context)
1743
2191
  end
1744
2192