aws-sdk-lookoutequipment 1.9.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abb3d9fcb95b796879eddf9e5bb8871ea5e44428140ddb2cb449406fdd1c87d0
-  data.tar.gz: b9250edb07f18a7975d9c3a30ed9aa82f20e64303c6860350bf1d9855132a1f5
+  metadata.gz: 7d1481ad469d0d57404ef55894a9ab7439fa8531c8203d582626391f23aaf134
+  data.tar.gz: 0c2fc65b3c64eb7bcc2da27570f6c0da8417c5d67bf94c90843296bbaef0369f
 SHA512:
-  metadata.gz: 0b24c2a67a280f4a7e370058636d06d228d33317177c2ad1ecf6f00380b9d5afd29e40791abc272cf56cc74b57d4a81e20bf4561148b8ad4748e3808bc707364
-  data.tar.gz: 6788fa7625bd6798e3a0e18176f74760e903913e67f521fba8f581c78760c6524a40a3a07e362b92df59a344dec7c3e1747869779c928d355483bb074b3c76e1
+  metadata.gz: 1a834900eff56b50f1e0a9132c897a8f97e37fbff210e649d2a30ee0b445f97e7d7c307b795efcfde5362a7b62a526e2ef3f80e0ad909c6ae9f861c4a69d4666
+  data.tar.gz: 2f181af26fd4624d17954ce172461ecbb2ca8f20252bc952ec5c918fe976327a6be3f7b2e56cc6254fe45e5b944dbb0579d72a7dddf7c49a57e2f011e82dc7a3

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 Unreleased Changes
 ------------------
 
+1.12.0 (2022-06-23)
+------------------
+
+* Feature - This release adds visualizations to the scheduled inference results. Users will be able to see interference results, including diagnostic results from their running inference schedulers.
+
+1.11.0 (2022-04-27)
+------------------
+
+* Feature - This release adds the following new features: 1) Introduces an option for automatic schema creation 2) Now allows for Ingestion of data containing most common errors and allows automatic data cleaning 3) Introduces new API ListSensorStatistics that gives further information about the ingested data
+
+1.10.0 (2022-02-24)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.9.0 (2022-02-03)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.12.0

data/lib/aws-sdk-lookoutequipment/client.rb

@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
+require 'aws-sdk-core/plugins/checksum_algorithm.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::LookoutEquipment
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::ChecksumAlgorithm)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
     add_plugin(Aws::Plugins::SignatureV4)
@@ -369,7 +371,7 @@ module Aws::LookoutEquipment
     # @option params [required, String] :dataset_name
     #   The name of the dataset being created.
     #
-    # @option params [required, Types::DatasetSchema] :dataset_schema
+    # @option params [Types::DatasetSchema] :dataset_schema
     #   A JSON description of the data that is in each time series dataset,
     #   including names, column names, and data types.
     #
@@ -397,7 +399,7 @@ module Aws::LookoutEquipment
     #
     #   resp = client.create_dataset({
     #     dataset_name: "DatasetName", # required
-    #     dataset_schema: { # required
+    #     dataset_schema: {
     #       inline_data_schema: "InlineDataSchema",
     #     },
     #     server_side_kms_key_id: "NameOrArn",
@@ -749,7 +751,7 @@ module Aws::LookoutEquipment
     end
 
     # Provides information on a specific data ingestion job such as creation
-    # time, dataset ARN, status, and so on.
+    # time, dataset ARN, and status.
     #
     # @option params [required, String] :job_id
     #   The job ID of the data ingestion job.
@@ -763,6 +765,12 @@ module Aws::LookoutEquipment
     #   * {Types::DescribeDataIngestionJobResponse#created_at #created_at} => Time
     #   * {Types::DescribeDataIngestionJobResponse#status #status} => String
     #   * {Types::DescribeDataIngestionJobResponse#failed_reason #failed_reason} => String
+    #   * {Types::DescribeDataIngestionJobResponse#data_quality_summary #data_quality_summary} => Types::DataQualitySummary
+    #   * {Types::DescribeDataIngestionJobResponse#ingested_files_summary #ingested_files_summary} => Types::IngestedFilesSummary
+    #   * {Types::DescribeDataIngestionJobResponse#status_detail #status_detail} => String
+    #   * {Types::DescribeDataIngestionJobResponse#ingested_data_size #ingested_data_size} => Integer
+    #   * {Types::DescribeDataIngestionJobResponse#data_start_time #data_start_time} => Time
+    #   * {Types::DescribeDataIngestionJobResponse#data_end_time #data_end_time} => Time
     #
     # @example Request syntax with placeholder values
     #
@@ -776,10 +784,28 @@ module Aws::LookoutEquipment
     #   resp.dataset_arn #=> String
     #   resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
     #   resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
+    #   resp.ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
     #   resp.role_arn #=> String
     #   resp.created_at #=> Time
     #   resp.status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
     #   resp.failed_reason #=> String
+    #   resp.data_quality_summary.insufficient_sensor_data.missing_complete_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.insufficient_sensor_data.sensors_with_short_date_range.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.missing_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.missing_sensor_data.total_number_of_missing_values #=> Integer
+    #   resp.data_quality_summary.invalid_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.invalid_sensor_data.total_number_of_invalid_values #=> Integer
+    #   resp.data_quality_summary.unsupported_timestamps.total_number_of_unsupported_timestamps #=> Integer
+    #   resp.data_quality_summary.duplicate_timestamps.total_number_of_duplicate_timestamps #=> Integer
+    #   resp.ingested_files_summary.total_number_of_files #=> Integer
+    #   resp.ingested_files_summary.ingested_number_of_files #=> Integer
+    #   resp.ingested_files_summary.discarded_files #=> Array
+    #   resp.ingested_files_summary.discarded_files[0].bucket #=> String
+    #   resp.ingested_files_summary.discarded_files[0].key #=> String
+    #   resp.status_detail #=> String
+    #   resp.ingested_data_size #=> Integer
+    #   resp.data_start_time #=> Time
+    #   resp.data_end_time #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataIngestionJob AWS API Documentation
     #
@@ -790,8 +816,8 @@ module Aws::LookoutEquipment
       req.send_request(options)
     end
 
-    # Provides a JSON description of the data that is in each time series
-    # dataset, including names, column names, and data types.
+    # Provides a JSON description of the data in each time series dataset,
+    # including names, column names, and data types.
     #
     # @option params [required, String] :dataset_name
     #   The name of the dataset to be described.
@@ -806,6 +832,11 @@ module Aws::LookoutEquipment
     #   * {Types::DescribeDatasetResponse#schema #schema} => String
     #   * {Types::DescribeDatasetResponse#server_side_kms_key_id #server_side_kms_key_id} => String
     #   * {Types::DescribeDatasetResponse#ingestion_input_configuration #ingestion_input_configuration} => Types::IngestionInputConfiguration
+    #   * {Types::DescribeDatasetResponse#data_quality_summary #data_quality_summary} => Types::DataQualitySummary
+    #   * {Types::DescribeDatasetResponse#ingested_files_summary #ingested_files_summary} => Types::IngestedFilesSummary
+    #   * {Types::DescribeDatasetResponse#role_arn #role_arn} => String
+    #   * {Types::DescribeDatasetResponse#data_start_time #data_start_time} => Time
+    #   * {Types::DescribeDatasetResponse#data_end_time #data_end_time} => Time
     #
     # @example Request syntax with placeholder values
     #
@@ -824,6 +855,23 @@ module Aws::LookoutEquipment
     #   resp.server_side_kms_key_id #=> String
     #   resp.ingestion_input_configuration.s3_input_configuration.bucket #=> String
     #   resp.ingestion_input_configuration.s3_input_configuration.prefix #=> String
+    #   resp.ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
+    #   resp.data_quality_summary.insufficient_sensor_data.missing_complete_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.insufficient_sensor_data.sensors_with_short_date_range.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.missing_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.missing_sensor_data.total_number_of_missing_values #=> Integer
+    #   resp.data_quality_summary.invalid_sensor_data.affected_sensor_count #=> Integer
+    #   resp.data_quality_summary.invalid_sensor_data.total_number_of_invalid_values #=> Integer
+    #   resp.data_quality_summary.unsupported_timestamps.total_number_of_unsupported_timestamps #=> Integer
+    #   resp.data_quality_summary.duplicate_timestamps.total_number_of_duplicate_timestamps #=> Integer
+    #   resp.ingested_files_summary.total_number_of_files #=> Integer
+    #   resp.ingested_files_summary.ingested_number_of_files #=> Integer
+    #   resp.ingested_files_summary.discarded_files #=> Array
+    #   resp.ingested_files_summary.discarded_files[0].bucket #=> String
+    #   resp.ingested_files_summary.discarded_files[0].key #=> String
+    #   resp.role_arn #=> String
+    #   resp.data_start_time #=> Time
+    #   resp.data_end_time #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeDataset AWS API Documentation
     #
@@ -1005,6 +1053,7 @@ module Aws::LookoutEquipment
     #   resp.data_ingestion_job_summaries[0].dataset_arn #=> String
     #   resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.bucket #=> String
     #   resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.prefix #=> String
+    #   resp.data_ingestion_job_summaries[0].ingestion_input_configuration.s3_input_configuration.key_pattern #=> String
     #   resp.data_ingestion_job_summaries[0].status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDataIngestionJobs AWS API Documentation
@@ -1062,6 +1111,64 @@ module Aws::LookoutEquipment
       req.send_request(options)
     end
 
+    # Lists all inference events that have been found for the specified
+    # inference scheduler.
+    #
+    # @option params [String] :next_token
+    #   An opaque pagination token indicating where to continue the listing of
+    #   inference events.
+    #
+    # @option params [Integer] :max_results
+    #   Specifies the maximum number of inference events to list.
+    #
+    # @option params [required, String] :inference_scheduler_name
+    #   The name of the inference scheduler for the inference events listed.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :interval_start_time
+    #   Lookout for Equipment will return all the inference events with start
+    #   time equal to or greater than the start time given.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :interval_end_time
+    #   Lookout for Equipment will return all the inference events with end
+    #   time equal to or less than the end time given.
+    #
+    # @return [Types::ListInferenceEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListInferenceEventsResponse#next_token #next_token} => String
+    #   * {Types::ListInferenceEventsResponse#inference_event_summaries #inference_event_summaries} => Array<Types::InferenceEventSummary>
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_inference_events({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     inference_scheduler_name: "InferenceSchedulerIdentifier", # required
+    #     interval_start_time: Time.now, # required
+    #     interval_end_time: Time.now, # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.inference_event_summaries #=> Array
+    #   resp.inference_event_summaries[0].inference_scheduler_arn #=> String
+    #   resp.inference_event_summaries[0].inference_scheduler_name #=> String
+    #   resp.inference_event_summaries[0].event_start_time #=> Time
+    #   resp.inference_event_summaries[0].event_end_time #=> Time
+    #   resp.inference_event_summaries[0].diagnostics #=> String
+    #   resp.inference_event_summaries[0].event_duration_in_seconds #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEvents AWS API Documentation
+    #
+    # @overload list_inference_events(params = {})
+    # @param [Hash] params ({})
+    def list_inference_events(params = {}, options = {})
+      req = build_request(:list_inference_events, params)
+      req.send_request(options)
+    end
+
     # Lists all inference executions that have been performed by the
     # specified inference scheduler.
     #
@@ -1248,6 +1355,77 @@ module Aws::LookoutEquipment
       req.send_request(options)
     end
 
+    # Lists statistics about the data collected for each of the sensors that
+    # have been successfully ingested in the particular dataset. Can also be
+    # used to retreive Sensor Statistics for a previous ingestion job.
+    #
+    # @option params [required, String] :dataset_name
+    #   The name of the dataset associated with the list of Sensor Statistics.
+    #
+    # @option params [String] :ingestion_job_id
+    #   The ingestion job id associated with the list of Sensor Statistics. To
+    #   get sensor statistics for a particular ingestion job id, both dataset
+    #   name and ingestion job id must be submitted as inputs.
+    #
+    # @option params [Integer] :max_results
+    #   Specifies the maximum number of sensors for which to retrieve
+    #   statistics.
+    #
+    # @option params [String] :next_token
+    #   An opaque pagination token indicating where to continue the listing of
+    #   sensor statistics.
+    #
+    # @return [Types::ListSensorStatisticsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListSensorStatisticsResponse#sensor_statistics_summaries #sensor_statistics_summaries} => Array<Types::SensorStatisticsSummary>
+    #   * {Types::ListSensorStatisticsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_sensor_statistics({
+    #     dataset_name: "DatasetName", # required
+    #     ingestion_job_id: "IngestionJobId",
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.sensor_statistics_summaries #=> Array
+    #   resp.sensor_statistics_summaries[0].component_name #=> String
+    #   resp.sensor_statistics_summaries[0].sensor_name #=> String
+    #   resp.sensor_statistics_summaries[0].data_exists #=> Boolean
+    #   resp.sensor_statistics_summaries[0].missing_values.count #=> Integer
+    #   resp.sensor_statistics_summaries[0].missing_values.percentage #=> Float
+    #   resp.sensor_statistics_summaries[0].invalid_values.count #=> Integer
+    #   resp.sensor_statistics_summaries[0].invalid_values.percentage #=> Float
+    #   resp.sensor_statistics_summaries[0].invalid_date_entries.count #=> Integer
+    #   resp.sensor_statistics_summaries[0].invalid_date_entries.percentage #=> Float
+    #   resp.sensor_statistics_summaries[0].duplicate_timestamps.count #=> Integer
+    #   resp.sensor_statistics_summaries[0].duplicate_timestamps.percentage #=> Float
+    #   resp.sensor_statistics_summaries[0].categorical_values.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
+    #   resp.sensor_statistics_summaries[0].categorical_values.number_of_category #=> Integer
+    #   resp.sensor_statistics_summaries[0].multiple_operating_modes.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
+    #   resp.sensor_statistics_summaries[0].large_timestamp_gaps.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
+    #   resp.sensor_statistics_summaries[0].large_timestamp_gaps.number_of_large_timestamp_gaps #=> Integer
+    #   resp.sensor_statistics_summaries[0].large_timestamp_gaps.max_timestamp_gap_in_days #=> Integer
+    #   resp.sensor_statistics_summaries[0].monotonic_values.status #=> String, one of "POTENTIAL_ISSUE_DETECTED", "NO_ISSUE_DETECTED"
+    #   resp.sensor_statistics_summaries[0].monotonic_values.monotonicity #=> String, one of "DECREASING", "INCREASING", "STATIC"
+    #   resp.sensor_statistics_summaries[0].data_start_time #=> Time
+    #   resp.sensor_statistics_summaries[0].data_end_time #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics AWS API Documentation
+    #
+    # @overload list_sensor_statistics(params = {})
+    # @param [Hash] params ({})
+    def list_sensor_statistics(params = {}, options = {})
+      req = build_request(:list_sensor_statistics, params)
+      req.send_request(options)
+    end
+
     # Lists all the tags for a specified resource, including key and value.
     #
     # @option params [required, String] :resource_arn
@@ -1313,6 +1491,7 @@ module Aws::LookoutEquipment
     #       s3_input_configuration: { # required
     #         bucket: "S3Bucket", # required
     #         prefix: "S3Prefix",
+    #         key_pattern: "KeyPattern",
     #       },
     #     },
     #     role_arn: "IamRoleArn", # required
@@ -1559,7 +1738,7 @@ module Aws::LookoutEquipment
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lookoutequipment'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end