aws-sdk-lookoutmetrics 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6290e8d5d5015dc16221c672578ced091a40ab384abe46033b4a7815f6884c16
-  data.tar.gz: a6a61c705a1cb02c9580e1f20572a0499511bca095a1479cd823c9e486b933ea
+  metadata.gz: 54af582d960a840ff27a5bfd1d2a6e4fe6b766940c910893842204af61a7ae20
+  data.tar.gz: 650924151b86c37bfa9c9b0d732863d8985532b27cc3647bb14c89af1c947dc5
 SHA512:
-  metadata.gz: bff3afae4a1edfc02f045580791c5312ba84e21edc15abda4f9d3c4c767b192f258260f6d2f0efefbf9ac27d969106958059c2c23fc1e8acd63864a7503c5dd9
-  data.tar.gz: 72d11fb9f7e57ee8e72d30749577e2f92f9b3da9e8adb7f0c6a18597e438e43247a89d1dea3f3db84ed6f9048c69744b1d7817fa4cbda72af3503919dfeaec0e
+  metadata.gz: 0b706a2b89b914074ec5f323c52859b263ca1b9f39dffa02c33c90bb82aa62faf885a5c1c627537e9a6624adcf7af4d64150370a4894627234dc8dea1d2a5114
+  data.tar.gz: 2d73ea54c988398dc7076b3c8cb3c1b68da58c5120bfcea7b07871854ccf039aba8bf1cb6ac55b6c9f5ec4588f4c350662cd1401856eb106949b702680ff7c9a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.11.0 (2021-12-21)
+------------------
+
+* Feature - This release adds support for Causal Relationships. Added new ListAnomalyGroupRelatedMetrics API operation and InterMetricImpactDetails API data type
+
 1.10.0 (2021-11-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

data/lib/aws-sdk-lookoutmetrics/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/defaults_mode.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
@@ -73,6 +74,7 @@ module Aws::LookoutMetrics
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
+    add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -175,6 +177,10 @@ module Aws::LookoutMetrics
     #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
     #     a clock skew correction and retry requests with skewed client clocks.
     #
+    #   @option options [String] :defaults_mode ("legacy")
+    #     See {Aws::DefaultsModeConfiguration} for a list of the
+    #     accepted modes and the configuration defaults that are included.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -297,7 +303,7 @@ module Aws::LookoutMetrics
     #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
-    #   @option options [Integer] :http_read_timeout (60) The default
+    #   @option options [Float] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
     #     safely be set per-request on the session.
     #
@@ -313,6 +319,9 @@ module Aws::LookoutMetrics
     #     disables this behaviour.  This value can safely be set per
     #     request on the session.
     #
+    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
+    #     in seconds.
+    #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
     #
@@ -1179,6 +1188,62 @@ module Aws::LookoutMetrics
       req.send_request(options)
     end
 
+    # Returns a list of measures that are potential causes or effects of an
+    # anomaly group.
+    #
+    # @option params [required, String] :anomaly_detector_arn
+    #   The Amazon Resource Name (ARN) of the anomaly detector.
+    #
+    # @option params [required, String] :anomaly_group_id
+    #   The ID of the anomaly group.
+    #
+    # @option params [String] :relationship_type_filter
+    #   Filter for potential causes (`CAUSE_OF_INPUT_ANOMALY_GROUP`) or
+    #   downstream effects (`EFFECT_OF_INPUT_ANOMALY_GROUP`) of the anomaly
+    #   group.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return.
+    #
+    # @option params [String] :next_token
+    #   Specify the pagination token that's returned by a previous request to
+    #   retrieve the next page of results.
+    #
+    # @return [Types::ListAnomalyGroupRelatedMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListAnomalyGroupRelatedMetricsResponse#inter_metric_impact_list #inter_metric_impact_list} => Array<Types::InterMetricImpactDetails>
+    #   * {Types::ListAnomalyGroupRelatedMetricsResponse#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_anomaly_group_related_metrics({
+    #     anomaly_detector_arn: "Arn", # required
+    #     anomaly_group_id: "UUID", # required
+    #     relationship_type_filter: "CAUSE_OF_INPUT_ANOMALY_GROUP", # accepts CAUSE_OF_INPUT_ANOMALY_GROUP, EFFECT_OF_INPUT_ANOMALY_GROUP
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.inter_metric_impact_list #=> Array
+    #   resp.inter_metric_impact_list[0].metric_name #=> String
+    #   resp.inter_metric_impact_list[0].anomaly_group_id #=> String
+    #   resp.inter_metric_impact_list[0].relationship_type #=> String, one of "CAUSE_OF_INPUT_ANOMALY_GROUP", "EFFECT_OF_INPUT_ANOMALY_GROUP"
+    #   resp.inter_metric_impact_list[0].contribution_percentage #=> Float
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupRelatedMetrics AWS API Documentation
+    #
+    # @overload list_anomaly_group_related_metrics(params = {})
+    # @param [Hash] params ({})
+    def list_anomaly_group_related_metrics(params = {}, options = {})
+      req = build_request(:list_anomaly_group_related_metrics, params)
+      req.send_request(options)
+    end
+
     # Returns a list of anomaly groups.
     #
     # @option params [required, String] :anomaly_detector_arn
@@ -1655,7 +1720,7 @@ module Aws::LookoutMetrics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-lookoutmetrics'
-      context[:gem_version] = '1.10.0'
+      context[:gem_version] = '1.11.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -102,6 +102,8 @@ module Aws::LookoutMetrics
     HistoricalDataPath = Shapes::StringShape.new(name: 'HistoricalDataPath')
     HistoricalDataPathList = Shapes::ListShape.new(name: 'HistoricalDataPathList')
     Integer = Shapes::IntegerShape.new(name: 'Integer')
+    InterMetricImpactDetails = Shapes::StructureShape.new(name: 'InterMetricImpactDetails')
+    InterMetricImpactList = Shapes::ListShape.new(name: 'InterMetricImpactList')
     InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     ItemizedMetricStats = Shapes::StructureShape.new(name: 'ItemizedMetricStats')
     ItemizedMetricStatsList = Shapes::ListShape.new(name: 'ItemizedMetricStatsList')
@@ -113,6 +115,8 @@ module Aws::LookoutMetrics
     ListAlertsResponse = Shapes::StructureShape.new(name: 'ListAlertsResponse')
     ListAnomalyDetectorsRequest = Shapes::StructureShape.new(name: 'ListAnomalyDetectorsRequest')
     ListAnomalyDetectorsResponse = Shapes::StructureShape.new(name: 'ListAnomalyDetectorsResponse')
+    ListAnomalyGroupRelatedMetricsRequest = Shapes::StructureShape.new(name: 'ListAnomalyGroupRelatedMetricsRequest')
+    ListAnomalyGroupRelatedMetricsResponse = Shapes::StructureShape.new(name: 'ListAnomalyGroupRelatedMetricsResponse')
     ListAnomalyGroupSummariesRequest = Shapes::StructureShape.new(name: 'ListAnomalyGroupSummariesRequest')
     ListAnomalyGroupSummariesResponse = Shapes::StructureShape.new(name: 'ListAnomalyGroupSummariesResponse')
     ListAnomalyGroupTimeSeriesRequest = Shapes::StructureShape.new(name: 'ListAnomalyGroupTimeSeriesRequest')
@@ -124,6 +128,7 @@ module Aws::LookoutMetrics
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     Message = Shapes::StringShape.new(name: 'Message')
     Metric = Shapes::StructureShape.new(name: 'Metric')
+    MetricChangePercentage = Shapes::FloatShape.new(name: 'MetricChangePercentage')
     MetricLevelImpact = Shapes::StructureShape.new(name: 'MetricLevelImpact')
     MetricLevelImpactList = Shapes::ListShape.new(name: 'MetricLevelImpactList')
     MetricList = Shapes::ListShape.new(name: 'MetricList')
@@ -149,6 +154,7 @@ module Aws::LookoutMetrics
     RedshiftClusterIdentifier = Shapes::StringShape.new(name: 'RedshiftClusterIdentifier')
     RedshiftDatabaseName = Shapes::StringShape.new(name: 'RedshiftDatabaseName')
     RedshiftSourceConfig = Shapes::StructureShape.new(name: 'RedshiftSourceConfig')
+    RelationshipType = Shapes::StringShape.new(name: 'RelationshipType')
     ResourceId = Shapes::StringShape.new(name: 'ResourceId')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceType = Shapes::StringShape.new(name: 'ResourceType')
@@ -467,6 +473,14 @@ module Aws::LookoutMetrics
 
     HistoricalDataPathList.member = Shapes::ShapeRef.new(shape: HistoricalDataPath)
 
+    InterMetricImpactDetails.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
+    InterMetricImpactDetails.add_member(:anomaly_group_id, Shapes::ShapeRef.new(shape: UUID, location_name: "AnomalyGroupId"))
+    InterMetricImpactDetails.add_member(:relationship_type, Shapes::ShapeRef.new(shape: RelationshipType, location_name: "RelationshipType"))
+    InterMetricImpactDetails.add_member(:contribution_percentage, Shapes::ShapeRef.new(shape: MetricChangePercentage, location_name: "ContributionPercentage"))
+    InterMetricImpactDetails.struct_class = Types::InterMetricImpactDetails
+
+    InterMetricImpactList.member = Shapes::ShapeRef.new(shape: InterMetricImpactDetails)
+
     InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
     InternalServerException.struct_class = Types::InternalServerException
 
@@ -501,6 +515,17 @@ module Aws::LookoutMetrics
     ListAnomalyDetectorsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListAnomalyDetectorsResponse.struct_class = Types::ListAnomalyDetectorsResponse
 
+    ListAnomalyGroupRelatedMetricsRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
+    ListAnomalyGroupRelatedMetricsRequest.add_member(:anomaly_group_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "AnomalyGroupId"))
+    ListAnomalyGroupRelatedMetricsRequest.add_member(:relationship_type_filter, Shapes::ShapeRef.new(shape: RelationshipType, location_name: "RelationshipTypeFilter"))
+    ListAnomalyGroupRelatedMetricsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
+    ListAnomalyGroupRelatedMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListAnomalyGroupRelatedMetricsRequest.struct_class = Types::ListAnomalyGroupRelatedMetricsRequest
+
+    ListAnomalyGroupRelatedMetricsResponse.add_member(:inter_metric_impact_list, Shapes::ShapeRef.new(shape: InterMetricImpactList, location_name: "InterMetricImpactList"))
+    ListAnomalyGroupRelatedMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListAnomalyGroupRelatedMetricsResponse.struct_class = Types::ListAnomalyGroupRelatedMetricsResponse
+
     ListAnomalyGroupSummariesRequest.add_member(:anomaly_detector_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "AnomalyDetectorArn"))
     ListAnomalyGroupSummariesRequest.add_member(:sensitivity_threshold, Shapes::ShapeRef.new(shape: SensitivityThreshold, required: true, location_name: "SensitivityThreshold"))
     ListAnomalyGroupSummariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults", metadata: {"box"=>true}))
@@ -974,6 +999,25 @@ module Aws::LookoutMetrics
         )
       end)
 
+      api.add_operation(:list_anomaly_group_related_metrics, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListAnomalyGroupRelatedMetrics"
+        o.http_method = "POST"
+        o.http_request_uri = "/ListAnomalyGroupRelatedMetrics"
+        o.input = Shapes::ShapeRef.new(shape: ListAnomalyGroupRelatedMetricsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListAnomalyGroupRelatedMetricsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_anomaly_group_summaries, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListAnomalyGroupSummaries"
         o.http_method = "POST"

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

@@ -1468,6 +1468,39 @@ module Aws::LookoutMetrics
       include Aws::Structure
     end
 
+    # Aggregated details about the measures contributing to the anomaly
+    # group, and the measures potentially impacted by the anomaly group.
+    #
+    # @!attribute [rw] metric_name
+    #   The name of the measure.
+    #   @return [String]
+    #
+    # @!attribute [rw] anomaly_group_id
+    #   The ID of the anomaly group.
+    #   @return [String]
+    #
+    # @!attribute [rw] relationship_type
+    #   Whether a measure is a potential cause of the anomaly group
+    #   (`CAUSE_OF_INPUT_ANOMALY_GROUP`), or whether the measure is impacted
+    #   by the anomaly group (`EFFECT_OF_INPUT_ANOMALY_GROUP`).
+    #   @return [String]
+    #
+    # @!attribute [rw] contribution_percentage
+    #   For potential causes (`CAUSE_OF_INPUT_ANOMALY_GROUP`), the
+    #   percentage contribution the measure has in causing the anomalies.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/InterMetricImpactDetails AWS API Documentation
+    #
+    class InterMetricImpactDetails < Struct.new(
+      :metric_name,
+      :anomaly_group_id,
+      :relationship_type,
+      :contribution_percentage)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The request processing has failed because of an unknown error,
     # exception, or failure.
     #
@@ -1654,6 +1687,70 @@ module Aws::LookoutMetrics
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListAnomalyGroupRelatedMetricsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         anomaly_detector_arn: "Arn", # required
+    #         anomaly_group_id: "UUID", # required
+    #         relationship_type_filter: "CAUSE_OF_INPUT_ANOMALY_GROUP", # accepts CAUSE_OF_INPUT_ANOMALY_GROUP, EFFECT_OF_INPUT_ANOMALY_GROUP
+    #         max_results: 1,
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] anomaly_detector_arn
+    #   The Amazon Resource Name (ARN) of the anomaly detector.
+    #   @return [String]
+    #
+    # @!attribute [rw] anomaly_group_id
+    #   The ID of the anomaly group.
+    #   @return [String]
+    #
+    # @!attribute [rw] relationship_type_filter
+    #   Filter for potential causes (`CAUSE_OF_INPUT_ANOMALY_GROUP`) or
+    #   downstream effects (`EFFECT_OF_INPUT_ANOMALY_GROUP`) of the anomaly
+    #   group.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   Specify the pagination token that's returned by a previous request
+    #   to retrieve the next page of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupRelatedMetricsRequest AWS API Documentation
+    #
+    class ListAnomalyGroupRelatedMetricsRequest < Struct.new(
+      :anomaly_detector_arn,
+      :anomaly_group_id,
+      :relationship_type_filter,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] inter_metric_impact_list
+    #   Aggregated details about the measures contributing to the anomaly
+    #   group, and the measures potentially impacted by the anomaly group.
+    #   @return [Array<Types::InterMetricImpactDetails>]
+    #
+    # @!attribute [rw] next_token
+    #   The pagination token that's included if more results are available.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupRelatedMetricsResponse AWS API Documentation
+    #
+    class ListAnomalyGroupRelatedMetricsResponse < Struct.new(
+      :inter_metric_impact_list,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListAnomalyGroupSummariesRequest
     #   data as a hash:
     #

data/lib/aws-sdk-lookoutmetrics.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-lookoutmetrics/customizations'
 # @!group service
 module Aws::LookoutMetrics
 
-  GEM_VERSION = '1.10.0'
+  GEM_VERSION = '1.11.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-lookoutmetrics
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.122.0
+        version: 3.125.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement