aws-sdk-lookoutequipment 1.10.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -371,7 +371,7 @@ module Aws::LookoutEquipment
371
371
  # @option params [required, String] :dataset_name
372
372
  # The name of the dataset being created.
373
373
  #
374
- # @option params [required, Types::DatasetSchema] :dataset_schema
374
+ # @option params [Types::DatasetSchema] :dataset_schema
375
375
  # A JSON description of the data that is in each time series dataset,
376
376
  # including names, column names, and data types.
377
377
  #
@@ -399,7 +399,7 @@ module Aws::LookoutEquipment
399
399
  #
400
400
  # resp = client.create_dataset({
401
401
  # dataset_name: "DatasetName", # required
402
- # dataset_schema: { # required
402
+ # dataset_schema: {
403
403
  # inline_data_schema: "InlineDataSchema",
404
404
  # },
405
405
  # server_side_kms_key_id: "NameOrArn",
@@ -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
- # 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.
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 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.
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: { # required
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.
@@ -751,7 +949,7 @@ module Aws::LookoutEquipment
751
949
  end
752
950
 
753
951
  # Provides information on a specific data ingestion job such as creation
754
- # time, dataset ARN, status, and so on.
952
+ # time, dataset ARN, and status.
755
953
  #
756
954
  # @option params [required, String] :job_id
757
955
  # The job ID of the data ingestion job.
@@ -765,6 +963,12 @@ module Aws::LookoutEquipment
765
963
  # * {Types::DescribeDataIngestionJobResponse#created_at #created_at} => Time
766
964
  # * {Types::DescribeDataIngestionJobResponse#status #status} => String
767
965
  # * {Types::DescribeDataIngestionJobResponse#failed_reason #failed_reason} => String
966
+ # * {Types::DescribeDataIngestionJobResponse#data_quality_summary #data_quality_summary} => Types::DataQualitySummary
967
+ # * {Types::DescribeDataIngestionJobResponse#ingested_files_summary #ingested_files_summary} => Types::IngestedFilesSummary
968
+ # * {Types::DescribeDataIngestionJobResponse#status_detail #status_detail} => String
969
+ # * {Types::DescribeDataIngestionJobResponse#ingested_data_size #ingested_data_size} => Integer
970
+ # * {Types::DescribeDataIngestionJobResponse#data_start_time #data_start_time} => Time
971
+ # * {Types::DescribeDataIngestionJobResponse#data_end_time #data_end_time} => Time
768
972
  #
769
973
  # @example Request syntax with placeholder values
770
974
  #
@@ -778,10 +982,28 @@ module Aws::LookoutEquipment
778
982
  # resp.dataset_arn #=> String
779
983
  # resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
780
984
  # resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
985
+ # resp.ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
781
986
  # resp.role_arn #=> String
782
987
  # resp.created_at #=> Time
783
988
  # resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
784
989
  # resp.failed_reason #=> String
990
+ # resp.data_quality_summary.insufficient_sensor_data.missing_complete_sensor_data.affected_sensor_count #=> Integer
991
+ # resp.data_quality_summary.insufficient_sensor_data.sensors_with_short_date_range.affected_sensor_count #=> Integer
992
+ # resp.data_quality_summary.missing_sensor_data.affected_sensor_count #=> Integer
993
+ # resp.data_quality_summary.missing_sensor_data.total_number_of_missing_values #=> Integer
994
+ # resp.data_quality_summary.invalid_sensor_data.affected_sensor_count #=> Integer
995
+ # resp.data_quality_summary.invalid_sensor_data.total_number_of_invalid_values #=> Integer
996
+ # resp.data_quality_summary.unsupported_timestamps.total_number_of_unsupported_timestamps #=> Integer
997
+ # resp.data_quality_summary.duplicate_timestamps.total_number_of_duplicate_timestamps #=> Integer
998
+ # resp.ingested_files_summary.total_number_of_files #=> Integer
999
+ # resp.ingested_files_summary.ingested_number_of_files #=> Integer
1000
+ # resp.ingested_files_summary.discarded_files #=> Array
1001
+ # resp.ingested_files_summary.discarded_files[0].bucket #=> String
1002
+ # resp.ingested_files_summary.discarded_files[0].key #=> String
1003
+ # resp.status_detail #=> String
1004
+ # resp.ingested_data_size #=> Integer
1005
+ # resp.data_start_time #=> Time
1006
+ # resp.data_end_time #=> Time
785
1007
  #
786
1008
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJob AWS API Documentation
787
1009
  #
@@ -792,8 +1014,8 @@ module Aws::LookoutEquipment
792
1014
  req.send_request(options)
793
1015
  end
794
1016
 
795
- # Provides a JSON description of the data that is in each time series
796
- # dataset, including names, column names, and data types.
1017
+ # Provides a JSON description of the data in each time series dataset,
1018
+ # including names, column names, and data types.
797
1019
  #
798
1020
  # @option params [required, String] :dataset_name
799
1021
  # The name of the dataset to be described.
@@ -808,6 +1030,11 @@ module Aws::LookoutEquipment
808
1030
  # * {Types::DescribeDatasetResponse#schema #schema} => String
809
1031
  # * {Types::DescribeDatasetResponse#server_side_kms_key_id #server_side_kms_key_id} => String
810
1032
  # * {Types::DescribeDatasetResponse#ingestion_input_configuration #ingestion_input_configuration} => Types::IngestionInputConfiguration
1033
+ # * {Types::DescribeDatasetResponse#data_quality_summary #data_quality_summary} => Types::DataQualitySummary
1034
+ # * {Types::DescribeDatasetResponse#ingested_files_summary #ingested_files_summary} => Types::IngestedFilesSummary
1035
+ # * {Types::DescribeDatasetResponse#role_arn #role_arn} => String
1036
+ # * {Types::DescribeDatasetResponse#data_start_time #data_start_time} => Time
1037
+ # * {Types::DescribeDatasetResponse#data_end_time #data_end_time} => Time
811
1038
  #
812
1039
  # @example Request syntax with placeholder values
813
1040
  #
@@ -826,6 +1053,23 @@ module Aws::LookoutEquipment
826
1053
  # resp.server_side_kms_key_id #=> String
827
1054
  # resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
828
1055
  # resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
1056
+ # resp.ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
1057
+ # resp.data_quality_summary.insufficient_sensor_data.missing_complete_sensor_data.affected_sensor_count #=> Integer
1058
+ # resp.data_quality_summary.insufficient_sensor_data.sensors_with_short_date_range.affected_sensor_count #=> Integer
1059
+ # resp.data_quality_summary.missing_sensor_data.affected_sensor_count #=> Integer
1060
+ # resp.data_quality_summary.missing_sensor_data.total_number_of_missing_values #=> Integer
1061
+ # resp.data_quality_summary.invalid_sensor_data.affected_sensor_count #=> Integer
1062
+ # resp.data_quality_summary.invalid_sensor_data.total_number_of_invalid_values #=> Integer
1063
+ # resp.data_quality_summary.unsupported_timestamps.total_number_of_unsupported_timestamps #=> Integer
1064
+ # resp.data_quality_summary.duplicate_timestamps.total_number_of_duplicate_timestamps #=> Integer
1065
+ # resp.ingested_files_summary.total_number_of_files #=> Integer
1066
+ # resp.ingested_files_summary.ingested_number_of_files #=> Integer
1067
+ # resp.ingested_files_summary.discarded_files #=> Array
1068
+ # resp.ingested_files_summary.discarded_files[0].bucket #=> String
1069
+ # resp.ingested_files_summary.discarded_files[0].key #=> String
1070
+ # resp.role_arn #=> String
1071
+ # resp.data_start_time #=> Time
1072
+ # resp.data_end_time #=> Time
829
1073
  #
830
1074
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataset AWS API Documentation
831
1075
  #
@@ -857,6 +1101,7 @@ module Aws::LookoutEquipment
857
1101
  # * {Types::DescribeInferenceSchedulerResponse#data_output_configuration #data_output_configuration} => Types::InferenceOutputConfiguration
858
1102
  # * {Types::DescribeInferenceSchedulerResponse#role_arn #role_arn} => String
859
1103
  # * {Types::DescribeInferenceSchedulerResponse#server_side_kms_key_id #server_side_kms_key_id} => String
1104
+ # * {Types::DescribeInferenceSchedulerResponse#latest_inference_result #latest_inference_result} => String
860
1105
  #
861
1106
  # @example Request syntax with placeholder values
862
1107
  #
@@ -885,6 +1130,7 @@ module Aws::LookoutEquipment
885
1130
  # resp.data_output_configuration.kms_key_id #=> String
886
1131
  # resp.role_arn #=> String
887
1132
  # resp.server_side_kms_key_id #=> String
1133
+ # resp.latest_inference_result #=> String, one of "ANOMALOUS", "NORMAL"
888
1134
  #
889
1135
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeInferenceScheduler AWS API Documentation
890
1136
  #
@@ -895,6 +1141,93 @@ module Aws::LookoutEquipment
895
1141
  req.send_request(options)
896
1142
  end
897
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&lt;String&gt;
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
+
898
1231
  # Provides a JSON containing the overall information about a specific ML
899
1232
  # model, including model name and ARN, dataset, training and evaluation
900
1233
  # information, status, and so on.
@@ -941,6 +1274,7 @@ module Aws::LookoutEquipment
941
1274
  # resp.schema #=> String
942
1275
  # resp.labels_input_configuration.s3_input_configuration.bucket #=> String
943
1276
  # resp.labels_input_configuration.s3_input_configuration.prefix #=> String
1277
+ # resp.labels_input_configuration.label_group_name #=> String
944
1278
  # resp.training_data_start_time #=> Time
945
1279
  # resp.training_data_end_time #=> Time
946
1280
  # resp.evaluation_data_start_time #=> Time
@@ -1007,6 +1341,7 @@ module Aws::LookoutEquipment
1007
1341
  # resp.data_ingestion_job_summaries[0].dataset_arn #=> String
1008
1342
  # resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.bucket #=> String
1009
1343
  # resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.prefix #=> String
1344
+ # resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
1010
1345
  # resp.data_ingestion_job_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
1011
1346
  #
1012
1347
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDataIngestionJobs AWS API Documentation
@@ -1064,6 +1399,64 @@ module Aws::LookoutEquipment
1064
1399
  req.send_request(options)
1065
1400
  end
1066
1401
 
1402
+ # Lists all inference events that have been found for the specified
1403
+ # inference scheduler.
1404
+ #
1405
+ # @option params [String] :next_token
1406
+ # An opaque pagination token indicating where to continue the listing of
1407
+ # inference events.
1408
+ #
1409
+ # @option params [Integer] :max_results
1410
+ # Specifies the maximum number of inference events to list.
1411
+ #
1412
+ # @option params [required, String] :inference_scheduler_name
1413
+ # The name of the inference scheduler for the inference events listed.
1414
+ #
1415
+ # @option params [required, Time,DateTime,Date,Integer,String] :interval_start_time
1416
+ # Lookout for Equipment will return all the inference events with an end
1417
+ # time equal to or greater than the start time given.
1418
+ #
1419
+ # @option params [required, Time,DateTime,Date,Integer,String] :interval_end_time
1420
+ # Returns all the inference events with an end start time equal to or
1421
+ # greater than less than the end time given
1422
+ #
1423
+ # @return [Types::ListInferenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1424
+ #
1425
+ # * {Types::ListInferenceEventsResponse#next_token #next_token} => String
1426
+ # * {Types::ListInferenceEventsResponse#inference_event_summaries #inference_event_summaries} => Array&lt;Types::InferenceEventSummary&gt;
1427
+ #
1428
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1429
+ #
1430
+ # @example Request syntax with placeholder values
1431
+ #
1432
+ # resp = client.list_inference_events({
1433
+ # next_token: "NextToken",
1434
+ # max_results: 1,
1435
+ # inference_scheduler_name: "InferenceSchedulerIdentifier", # required
1436
+ # interval_start_time: Time.now, # required
1437
+ # interval_end_time: Time.now, # required
1438
+ # })
1439
+ #
1440
+ # @example Response structure
1441
+ #
1442
+ # resp.next_token #=> String
1443
+ # resp.inference_event_summaries #=> Array
1444
+ # resp.inference_event_summaries[0].inference_scheduler_arn #=> String
1445
+ # resp.inference_event_summaries[0].inference_scheduler_name #=> String
1446
+ # resp.inference_event_summaries[0].event_start_time #=> Time
1447
+ # resp.inference_event_summaries[0].event_end_time #=> Time
1448
+ # resp.inference_event_summaries[0].diagnostics #=> String
1449
+ # resp.inference_event_summaries[0].event_duration_in_seconds #=> Integer
1450
+ #
1451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEvents AWS API Documentation
1452
+ #
1453
+ # @overload list_inference_events(params = {})
1454
+ # @param [Hash] params ({})
1455
+ def list_inference_events(params = {}, options = {})
1456
+ req = build_request(:list_inference_events, params)
1457
+ req.send_request(options)
1458
+ end
1459
+
1067
1460
  # Lists all inference executions that have been performed by the
1068
1461
  # specified inference scheduler.
1069
1462
  #
@@ -1183,6 +1576,7 @@ module Aws::LookoutEquipment
1183
1576
  # resp.inference_scheduler_summaries[0].status #=> String, one of "PENDING", "RUNNING", "STOPPING", "STOPPED"
1184
1577
  # resp.inference_scheduler_summaries[0].data_delay_offset_in_minutes #=> Integer
1185
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"
1186
1580
  #
1187
1581
  # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceSchedulers AWS API Documentation
1188
1582
  #
@@ -1193,6 +1587,118 @@ module Aws::LookoutEquipment
1193
1587
  req.send_request(options)
1194
1588
  end
1195
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&lt;Types::LabelGroupSummary&gt;
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&lt;Types::LabelSummary&gt;
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
+
1196
1702
  # Generates a list of all models in the account, including model name
1197
1703
  # and ARN, dataset, and status.
1198
1704
  #
@@ -1250,6 +1756,77 @@ module Aws::LookoutEquipment
1250
1756
  req.send_request(options)
1251
1757
  end
1252
1758
 
1759
+ # Lists statistics about the data collected for each of the sensors that
1760
+ # have been successfully ingested in the particular dataset. Can also be
1761
+ # used to retreive Sensor Statistics for a previous ingestion job.
1762
+ #
1763
+ # @option params [required, String] :dataset_name
1764
+ # The name of the dataset associated with the list of Sensor Statistics.
1765
+ #
1766
+ # @option params [String] :ingestion_job_id
1767
+ # The ingestion job id associated with the list of Sensor Statistics. To
1768
+ # get sensor statistics for a particular ingestion job id, both dataset
1769
+ # name and ingestion job id must be submitted as inputs.
1770
+ #
1771
+ # @option params [Integer] :max_results
1772
+ # Specifies the maximum number of sensors for which to retrieve
1773
+ # statistics.
1774
+ #
1775
+ # @option params [String] :next_token
1776
+ # An opaque pagination token indicating where to continue the listing of
1777
+ # sensor statistics.
1778
+ #
1779
+ # @return [Types::ListSensorStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1780
+ #
1781
+ # * {Types::ListSensorStatisticsResponse#sensor_statistics_summaries #sensor_statistics_summaries} => Array&lt;Types::SensorStatisticsSummary&gt;
1782
+ # * {Types::ListSensorStatisticsResponse#next_token #next_token} => String
1783
+ #
1784
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1785
+ #
1786
+ # @example Request syntax with placeholder values
1787
+ #
1788
+ # resp = client.list_sensor_statistics({
1789
+ # dataset_name: "DatasetName", # required
1790
+ # ingestion_job_id: "IngestionJobId",
1791
+ # max_results: 1,
1792
+ # next_token: "NextToken",
1793
+ # })
1794
+ #
1795
+ # @example Response structure
1796
+ #
1797
+ # resp.sensor_statistics_summaries #=> Array
1798
+ # resp.sensor_statistics_summaries[0].component_name #=> String
1799
+ # resp.sensor_statistics_summaries[0].sensor_name #=> String
1800
+ # resp.sensor_statistics_summaries[0].data_exists #=> Boolean
1801
+ # resp.sensor_statistics_summaries[0].missing_values.count #=> Integer
1802
+ # resp.sensor_statistics_summaries[0].missing_values.percentage #=> Float
1803
+ # resp.sensor_statistics_summaries[0].invalid_values.count #=> Integer
1804
+ # resp.sensor_statistics_summaries[0].invalid_values.percentage #=> Float
1805
+ # resp.sensor_statistics_summaries[0].invalid_date_entries.count #=> Integer
1806
+ # resp.sensor_statistics_summaries[0].invalid_date_entries.percentage #=> Float
1807
+ # resp.sensor_statistics_summaries[0].duplicate_timestamps.count #=> Integer
1808
+ # resp.sensor_statistics_summaries[0].duplicate_timestamps.percentage #=> Float
1809
+ # resp.sensor_statistics_summaries[0].categorical_values.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
1810
+ # resp.sensor_statistics_summaries[0].categorical_values.number_of_category #=> Integer
1811
+ # resp.sensor_statistics_summaries[0].multiple_operating_modes.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
1812
+ # resp.sensor_statistics_summaries[0].large_timestamp_gaps.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
1813
+ # resp.sensor_statistics_summaries[0].large_timestamp_gaps.number_of_large_timestamp_gaps #=> Integer
1814
+ # resp.sensor_statistics_summaries[0].large_timestamp_gaps.max_timestamp_gap_in_days #=> Integer
1815
+ # resp.sensor_statistics_summaries[0].monotonic_values.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
1816
+ # resp.sensor_statistics_summaries[0].monotonic_values.monotonicity #=> String, one of "DECREASING", "INCREASING", "STATIC"
1817
+ # resp.sensor_statistics_summaries[0].data_start_time #=> Time
1818
+ # resp.sensor_statistics_summaries[0].data_end_time #=> Time
1819
+ # resp.next_token #=> String
1820
+ #
1821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics AWS API Documentation
1822
+ #
1823
+ # @overload list_sensor_statistics(params = {})
1824
+ # @param [Hash] params ({})
1825
+ def list_sensor_statistics(params = {}, options = {})
1826
+ req = build_request(:list_sensor_statistics, params)
1827
+ req.send_request(options)
1828
+ end
1829
+
1253
1830
  # Lists all the tags for a specified resource, including key and value.
1254
1831
  #
1255
1832
  # @option params [required, String] :resource_arn
@@ -1315,6 +1892,7 @@ module Aws::LookoutEquipment
1315
1892
  # s3_input_configuration: { # required
1316
1893
  # bucket: "S3Bucket", # required
1317
1894
  # prefix: "S3Prefix",
1895
+ # key_pattern: "KeyPattern",
1318
1896
  # },
1319
1897
  # },
1320
1898
  # role_arn: "IamRoleArn", # required
@@ -1548,6 +2126,36 @@ module Aws::LookoutEquipment
1548
2126
  req.send_request(options)
1549
2127
  end
1550
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
+
1551
2159
  # @!endgroup
1552
2160
 
1553
2161
  # @param params ({})
@@ -1561,7 +2169,7 @@ module Aws::LookoutEquipment
1561
2169
  params: params,
1562
2170
  config: config)
1563
2171
  context[:gem_name] = 'aws-sdk-lookoutequipment'
1564
- context[:gem_version] = '1.10.0'
2172
+ context[:gem_version] = '1.13.0'
1565
2173
  Seahorse::Client::Request.new(handlers, context)
1566
2174
  end
1567
2175