aws-sdk-lookoutequipment 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc182835e28c205da9454e54f9314253a030b4b5288632ad1af77c8560d85987
-  data.tar.gz: 352422b517ecb6360b0a11ae988b153ea0dcd39ddae8fe48471c0f8d49f004cc
+  metadata.gz: 7d1481ad469d0d57404ef55894a9ab7439fa8531c8203d582626391f23aaf134
+  data.tar.gz: 0c2fc65b3c64eb7bcc2da27570f6c0da8417c5d67bf94c90843296bbaef0369f
 SHA512:
-  metadata.gz: 6f4e339025f9906e13379a033da2c44c55d01f55c8f92c5fce378e9e6b5645be4747073d23138e9869c4fcced257947e7c2f6ff173b740ec6375c9902961e750
-  data.tar.gz: 73c90cd03ec85c83b5a243f17de47bfb943e4d1b1fb8986db8622002e19432007977a1c4b90d3200ed4d8dfeb16f0623bd4b2f647c4fd209749ebc7e4d0f772b
+  metadata.gz: 1a834900eff56b50f1e0a9132c897a8f97e37fbff210e649d2a30ee0b445f97e7d7c307b795efcfde5362a7b62a526e2ef3f80e0ad909c6ae9f861c4a69d4666
+  data.tar.gz: 2f181af26fd4624d17954ce172461ecbb2ca8f20252bc952ec5c918fe976327a6be3f7b2e56cc6254fe45e5b944dbb0579d72a7dddf7c49a57e2f011e82dc7a3

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 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)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.11.0
+1.12.0

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

@@ -1111,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.
     #
@@ -1680,7 +1738,7 @@ module Aws::LookoutEquipment
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lookoutequipment'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -54,10 +54,13 @@ module Aws::LookoutEquipment
     DescribeModelRequest = Shapes::StructureShape.new(name: 'DescribeModelRequest')
     DescribeModelResponse = Shapes::StructureShape.new(name: 'DescribeModelResponse')
     DuplicateTimestamps = Shapes::StructureShape.new(name: 'DuplicateTimestamps')
+    EventDurationInSeconds = Shapes::IntegerShape.new(name: 'EventDurationInSeconds')
     FileNameTimestampFormat = Shapes::StringShape.new(name: 'FileNameTimestampFormat')
     Float = Shapes::FloatShape.new(name: 'Float')
     IamRoleArn = Shapes::StringShape.new(name: 'IamRoleArn')
     IdempotenceToken = Shapes::StringShape.new(name: 'IdempotenceToken')
+    InferenceEventSummaries = Shapes::ListShape.new(name: 'InferenceEventSummaries')
+    InferenceEventSummary = Shapes::StructureShape.new(name: 'InferenceEventSummary')
     InferenceExecutionStatus = Shapes::StringShape.new(name: 'InferenceExecutionStatus')
     InferenceExecutionSummaries = Shapes::ListShape.new(name: 'InferenceExecutionSummaries')
     InferenceExecutionSummary = Shapes::StructureShape.new(name: 'InferenceExecutionSummary')
@@ -91,6 +94,8 @@ module Aws::LookoutEquipment
     ListDataIngestionJobsResponse = Shapes::StructureShape.new(name: 'ListDataIngestionJobsResponse')
     ListDatasetsRequest = Shapes::StructureShape.new(name: 'ListDatasetsRequest')
     ListDatasetsResponse = Shapes::StructureShape.new(name: 'ListDatasetsResponse')
+    ListInferenceEventsRequest = Shapes::StructureShape.new(name: 'ListInferenceEventsRequest')
+    ListInferenceEventsResponse = Shapes::StructureShape.new(name: 'ListInferenceEventsResponse')
     ListInferenceExecutionsRequest = Shapes::StructureShape.new(name: 'ListInferenceExecutionsRequest')
     ListInferenceExecutionsResponse = Shapes::StructureShape.new(name: 'ListInferenceExecutionsResponse')
     ListInferenceSchedulersRequest = Shapes::StructureShape.new(name: 'ListInferenceSchedulersRequest')
@@ -336,6 +341,16 @@ module Aws::LookoutEquipment
     DuplicateTimestamps.add_member(:total_number_of_duplicate_timestamps, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "TotalNumberOfDuplicateTimestamps"))
     DuplicateTimestamps.struct_class = Types::DuplicateTimestamps
 
+    InferenceEventSummaries.member = Shapes::ShapeRef.new(shape: InferenceEventSummary)
+
+    InferenceEventSummary.add_member(:inference_scheduler_arn, Shapes::ShapeRef.new(shape: InferenceSchedulerArn, location_name: "InferenceSchedulerArn"))
+    InferenceEventSummary.add_member(:inference_scheduler_name, Shapes::ShapeRef.new(shape: InferenceSchedulerName, location_name: "InferenceSchedulerName"))
+    InferenceEventSummary.add_member(:event_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EventStartTime"))
+    InferenceEventSummary.add_member(:event_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EventEndTime"))
+    InferenceEventSummary.add_member(:diagnostics, Shapes::ShapeRef.new(shape: ModelMetrics, location_name: "Diagnostics"))
+    InferenceEventSummary.add_member(:event_duration_in_seconds, Shapes::ShapeRef.new(shape: EventDurationInSeconds, location_name: "EventDurationInSeconds"))
+    InferenceEventSummary.struct_class = Types::InferenceEventSummary
+
     InferenceExecutionSummaries.member = Shapes::ShapeRef.new(shape: InferenceExecutionSummary)
 
     InferenceExecutionSummary.add_member(:model_name, Shapes::ShapeRef.new(shape: ModelName, location_name: "ModelName"))
@@ -439,6 +454,17 @@ module Aws::LookoutEquipment
     ListDatasetsResponse.add_member(:dataset_summaries, Shapes::ShapeRef.new(shape: DatasetSummaries, location_name: "DatasetSummaries"))
     ListDatasetsResponse.struct_class = Types::ListDatasetsResponse
 
+    ListInferenceEventsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListInferenceEventsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    ListInferenceEventsRequest.add_member(:inference_scheduler_name, Shapes::ShapeRef.new(shape: InferenceSchedulerIdentifier, required: true, location_name: "InferenceSchedulerName"))
+    ListInferenceEventsRequest.add_member(:interval_start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "IntervalStartTime"))
+    ListInferenceEventsRequest.add_member(:interval_end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "IntervalEndTime"))
+    ListInferenceEventsRequest.struct_class = Types::ListInferenceEventsRequest
+
+    ListInferenceEventsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListInferenceEventsResponse.add_member(:inference_event_summaries, Shapes::ShapeRef.new(shape: InferenceEventSummaries, location_name: "InferenceEventSummaries"))
+    ListInferenceEventsResponse.struct_class = Types::ListInferenceEventsResponse
+
     ListInferenceExecutionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListInferenceExecutionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
     ListInferenceExecutionsRequest.add_member(:inference_scheduler_name, Shapes::ShapeRef.new(shape: InferenceSchedulerIdentifier, required: true, location_name: "InferenceSchedulerName"))
@@ -802,6 +828,25 @@ module Aws::LookoutEquipment
         )
       end)
 
+      api.add_operation(:list_inference_events, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListInferenceEvents"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListInferenceEventsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListInferenceEventsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_inference_executions, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListInferenceExecutions"
         o.http_method = "POST"

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

@@ -807,8 +807,7 @@ module Aws::LookoutEquipment
     #   @return [String]
     #
     # @!attribute [rw] created_at
-    #   Specifies the time the dataset was created in Amazon Lookout for
-    #   Equipment.
+    #   Specifies the time the dataset was created in Lookout for Equipment.
     #   @return [Time]
     #
     # @!attribute [rw] last_updated_at
@@ -1171,6 +1170,49 @@ module Aws::LookoutEquipment
       include Aws::Structure
     end
 
+    # Contains information about the specific inference event, including
+    # start and end time, diagnostics information, event duration and so on.
+    #
+    # @!attribute [rw] inference_scheduler_arn
+    #   The Amazon Resource Name (ARN) of the inference scheduler being used
+    #   for the inference event.
+    #   @return [String]
+    #
+    # @!attribute [rw] inference_scheduler_name
+    #   The name of the inference scheduler being used for the inference
+    #   events.
+    #   @return [String]
+    #
+    # @!attribute [rw] event_start_time
+    #   Indicates the starting time of an inference event.
+    #   @return [Time]
+    #
+    # @!attribute [rw] event_end_time
+    #   Indicates the ending time of an inference event.
+    #   @return [Time]
+    #
+    # @!attribute [rw] diagnostics
+    #   An array which specifies the names and values of all sensors
+    #   contributing to an inference event.
+    #   @return [String]
+    #
+    # @!attribute [rw] event_duration_in_seconds
+    #   Indicates the size of an inference event in seconds.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/InferenceEventSummary AWS API Documentation
+    #
+    class InferenceEventSummary < Struct.new(
+      :inference_scheduler_arn,
+      :inference_scheduler_name,
+      :event_start_time,
+      :event_end_time,
+      :diagnostics,
+      :event_duration_in_seconds)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains information about the specific inference execution, including
     # input and output data configuration, inference scheduling information,
     # status, and so on.
@@ -1813,6 +1855,73 @@ module Aws::LookoutEquipment
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListInferenceEventsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         inference_scheduler_name: "InferenceSchedulerIdentifier", # required
+    #         interval_start_time: Time.now, # required
+    #         interval_end_time: Time.now, # required
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   An opaque pagination token indicating where to continue the listing
+    #   of inference events.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   Specifies the maximum number of inference events to list.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] inference_scheduler_name
+    #   The name of the inference scheduler for the inference events listed.
+    #   @return [String]
+    #
+    # @!attribute [rw] interval_start_time
+    #   Lookout for Equipment will return all the inference events with
+    #   start time equal to or greater than the start time given.
+    #   @return [Time]
+    #
+    # @!attribute [rw] 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 [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsRequest AWS API Documentation
+    #
+    class ListInferenceEventsRequest < Struct.new(
+      :next_token,
+      :max_results,
+      :inference_scheduler_name,
+      :interval_start_time,
+      :interval_end_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   An opaque pagination token indicating where to continue the listing
+    #   of inference executions.
+    #   @return [String]
+    #
+    # @!attribute [rw] inference_event_summaries
+    #   Provides an array of information about the individual inference
+    #   events returned from the `ListInferenceEvents` operation, including
+    #   scheduler used, event start time, event end time, diagnostics, and
+    #   so on.
+    #   @return [Array<Types::InferenceEventSummary>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListInferenceEventsResponse AWS API Documentation
+    #
+    class ListInferenceEventsResponse < Struct.new(
+      :next_token,
+      :inference_event_summaries)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListInferenceExecutionsRequest
     #   data as a hash:
     #

data/lib/aws-sdk-lookoutequipment.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-lookoutequipment/customizations'
 # @!group service
 module Aws::LookoutEquipment
 
-  GEM_VERSION = '1.11.0'
+  GEM_VERSION = '1.12.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-lookoutequipment
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core