aws-sdk-cloudwatch 1.87.0 → 1.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d30f1437dc948ab87ef7eb2e7521dd307fa097062b21c63a0f8c43446845f2
-  data.tar.gz: 0df867de74254246b59792c815b772fb3a7f3ac8f1b1fa01685e585b4a272107
+  metadata.gz: 503ae029db1cabd915c02f93be1ff57273b3cb65ad17c5e3d1040a6997665df1
+  data.tar.gz: 9b2bd2a6620f559a2fa0cb080eb9c8e3314a486537ce11d745eb777ff9c6d03c
 SHA512:
-  metadata.gz: 51436d044d0109e6133cd71f72165a54c6d153c4e5c38cab8601862600ea46dffd6a4f464cbdede913321d8ee2ad9cff42ba5aa4e8f819d90123b228ed1ded5c
-  data.tar.gz: a0a729ef3fd8f6a3bda0e8b61e342f3664df9be501efc4fe7391a03c2a6027a3bdfc83f851c534fbd1056ad47e19f92f4683a2126c12db6690a1d27980c98b5c
+  metadata.gz: 962c4b2c2e9a794dab9a05ce56ef0beca5279a5d31ce8dc1eecf67bcdf0c5746f444e4a23bde2ad27ba3b30a67c8818935bf20a7c53e3214a6c93e0ac5f16352
+  data.tar.gz: de41f911c570f190206b25f61a24c25feb2c9caf5891d7dc10e0cf8c7dfd1460f75acb79b0e0d9f8dc90ed5c0a8c8323e670123356b0de843893a50337904f9d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.88.0 (2024-04-11)
+------------------
+
+* Feature - This release adds support for Metric Characteristics for CloudWatch Anomaly Detection. Anomaly Detector now takes Metric Characteristics object with Periodic Spikes boolean field that tells Anomaly Detection that spikes that repeat at the same time every week are part of the expected pattern.
+
 1.87.0 (2024-04-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.87.0
+1.88.0

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

@@ -1134,6 +1134,7 @@ module Aws::CloudWatch
     #   resp.anomaly_detectors[0].configuration.excluded_time_ranges[0].end_time #=> Time
     #   resp.anomaly_detectors[0].configuration.metric_timezone #=> String
     #   resp.anomaly_detectors[0].state_value #=> String, one of "PENDING_TRAINING", "TRAINED_INSUFFICIENT_DATA", "TRAINED"
+    #   resp.anomaly_detectors[0].metric_characteristics.periodic_spikes #=> Boolean
     #   resp.anomaly_detectors[0].single_metric_anomaly_detector.account_id #=> String
     #   resp.anomaly_detectors[0].single_metric_anomaly_detector.namespace #=> String
     #   resp.anomaly_detectors[0].single_metric_anomaly_detector.metric_name #=> String
@@ -2443,6 +2444,12 @@ module Aws::CloudWatch
     #   The configuration can also include the time zone to use for the
     #   metric.
     #
+    # @option params [Types::MetricCharacteristics] :metric_characteristics
+    #   Use this object to include parameters to provide information about
+    #   your metric to CloudWatch to help it build more accurate anomaly
+    #   detection models. Currently, it includes the `PeriodicSpikes`
+    #   parameter.
+    #
     # @option params [Types::SingleMetricAnomalyDetector] :single_metric_anomaly_detector
     #   A single metric anomaly detector to be created.
     #
@@ -2506,6 +2513,9 @@ module Aws::CloudWatch
     #       ],
     #       metric_timezone: "AnomalyDetectorMetricTimezone",
     #     },
+    #     metric_characteristics: {
+    #       periodic_spikes: false,
+    #     },
     #     single_metric_anomaly_detector: {
     #       account_id: "AccountId",
     #       namespace: "Namespace",
@@ -4104,7 +4114,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.87.0'
+      context[:gem_version] = '1.88.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -185,6 +185,7 @@ module Aws::CloudWatch
     Metric = Shapes::StructureShape.new(name: 'Metric')
     MetricAlarm = Shapes::StructureShape.new(name: 'MetricAlarm')
     MetricAlarms = Shapes::ListShape.new(name: 'MetricAlarms')
+    MetricCharacteristics = Shapes::StructureShape.new(name: 'MetricCharacteristics')
     MetricData = Shapes::ListShape.new(name: 'MetricData')
     MetricDataQueries = Shapes::ListShape.new(name: 'MetricDataQueries')
     MetricDataQuery = Shapes::StructureShape.new(name: 'MetricDataQuery')
@@ -223,6 +224,7 @@ module Aws::CloudWatch
     OwningAccounts = Shapes::ListShape.new(name: 'OwningAccounts')
     PartialFailure = Shapes::StructureShape.new(name: 'PartialFailure')
     Period = Shapes::IntegerShape.new(name: 'Period')
+    PeriodicSpikes = Shapes::BooleanShape.new(name: 'PeriodicSpikes')
     PutAnomalyDetectorInput = Shapes::StructureShape.new(name: 'PutAnomalyDetectorInput')
     PutAnomalyDetectorOutput = Shapes::StructureShape.new(name: 'PutAnomalyDetectorOutput')
     PutCompositeAlarmInput = Shapes::StructureShape.new(name: 'PutCompositeAlarmInput')
@@ -300,6 +302,7 @@ module Aws::CloudWatch
     AnomalyDetector.add_member(:stat, Shapes::ShapeRef.new(shape: AnomalyDetectorMetricStat, deprecated: true, location_name: "Stat", metadata: {"deprecatedMessage"=>"Use SingleMetricAnomalyDetector.Stat property."}))
     AnomalyDetector.add_member(:configuration, Shapes::ShapeRef.new(shape: AnomalyDetectorConfiguration, location_name: "Configuration"))
     AnomalyDetector.add_member(:state_value, Shapes::ShapeRef.new(shape: AnomalyDetectorStateValue, location_name: "StateValue"))
+    AnomalyDetector.add_member(:metric_characteristics, Shapes::ShapeRef.new(shape: MetricCharacteristics, location_name: "MetricCharacteristics"))
     AnomalyDetector.add_member(:single_metric_anomaly_detector, Shapes::ShapeRef.new(shape: SingleMetricAnomalyDetector, location_name: "SingleMetricAnomalyDetector"))
     AnomalyDetector.add_member(:metric_math_anomaly_detector, Shapes::ShapeRef.new(shape: MetricMathAnomalyDetector, location_name: "MetricMathAnomalyDetector"))
     AnomalyDetector.struct_class = Types::AnomalyDetector
@@ -754,6 +757,9 @@ module Aws::CloudWatch
 
     MetricAlarms.member = Shapes::ShapeRef.new(shape: MetricAlarm)
 
+    MetricCharacteristics.add_member(:periodic_spikes, Shapes::ShapeRef.new(shape: PeriodicSpikes, location_name: "PeriodicSpikes"))
+    MetricCharacteristics.struct_class = Types::MetricCharacteristics
+
     MetricData.member = Shapes::ShapeRef.new(shape: MetricDatum)
 
     MetricDataQueries.member = Shapes::ShapeRef.new(shape: MetricDataQuery)
@@ -852,6 +858,7 @@ module Aws::CloudWatch
     PutAnomalyDetectorInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, deprecated: true, location_name: "Dimensions", metadata: {"deprecatedMessage"=>"Use SingleMetricAnomalyDetector."}))
     PutAnomalyDetectorInput.add_member(:stat, Shapes::ShapeRef.new(shape: AnomalyDetectorMetricStat, deprecated: true, location_name: "Stat", metadata: {"deprecatedMessage"=>"Use SingleMetricAnomalyDetector."}))
     PutAnomalyDetectorInput.add_member(:configuration, Shapes::ShapeRef.new(shape: AnomalyDetectorConfiguration, location_name: "Configuration"))
+    PutAnomalyDetectorInput.add_member(:metric_characteristics, Shapes::ShapeRef.new(shape: MetricCharacteristics, location_name: "MetricCharacteristics"))
     PutAnomalyDetectorInput.add_member(:single_metric_anomaly_detector, Shapes::ShapeRef.new(shape: SingleMetricAnomalyDetector, location_name: "SingleMetricAnomalyDetector"))
     PutAnomalyDetectorInput.add_member(:metric_math_anomaly_detector, Shapes::ShapeRef.new(shape: MetricMathAnomalyDetector, location_name: "MetricMathAnomalyDetector"))
     PutAnomalyDetectorInput.struct_class = Types::PutAnomalyDetectorInput

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

@@ -81,10 +81,16 @@ module Aws::CloudWatch
     #   @return [Types::AnomalyDetectorConfiguration]
     #
     # @!attribute [rw] state_value
-    #   The current status of the anomaly detector's training. The possible
-    #   values are `TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA`
+    #   The current status of the anomaly detector's training.
     #   @return [String]
     #
+    # @!attribute [rw] metric_characteristics
+    #   This object includes parameters that you can use to provide
+    #   information about your metric to CloudWatch to help it build more
+    #   accurate anomaly detection models. Currently, it includes the
+    #   `PeriodicSpikes` parameter.
+    #   @return [Types::MetricCharacteristics]
+    #
     # @!attribute [rw] single_metric_anomaly_detector
     #   The CloudWatch metric and statistic for this anomaly detector.
     #   @return [Types::SingleMetricAnomalyDetector]
@@ -102,6 +108,7 @@ module Aws::CloudWatch
       :stat,
       :configuration,
       :state_value,
+      :metric_characteristics,
       :single_metric_anomaly_detector,
       :metric_math_anomaly_detector)
       SENSITIVE = []
@@ -2582,6 +2589,26 @@ module Aws::CloudWatch
       include Aws::Structure
     end
 
+    # This object includes parameters that you can use to provide
+    # information to CloudWatch to help it build more accurate anomaly
+    # detection models.
+    #
+    # @!attribute [rw] periodic_spikes
+    #   Set this parameter to `true` if values for this metric consistently
+    #   include spikes that should not be considered to be anomalies. With
+    #   this set to `true`, CloudWatch will expect to see spikes that
+    #   occurred consistently during the model training period, and won't
+    #   flag future similar spikes as anomalies.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricCharacteristics AWS API Documentation
+    #
+    class MetricCharacteristics < Struct.new(
+      :periodic_spikes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This structure is used in both `GetMetricData` and `PutMetricAlarm`.
     # The supported use of this structure is different for those two
     # operations.
@@ -3183,6 +3210,13 @@ module Aws::CloudWatch
     #   metric.
     #   @return [Types::AnomalyDetectorConfiguration]
     #
+    # @!attribute [rw] metric_characteristics
+    #   Use this object to include parameters to provide information about
+    #   your metric to CloudWatch to help it build more accurate anomaly
+    #   detection models. Currently, it includes the `PeriodicSpikes`
+    #   parameter.
+    #   @return [Types::MetricCharacteristics]
+    #
     # @!attribute [rw] single_metric_anomaly_detector
     #   A single metric anomaly detector to be created.
     #
@@ -3233,6 +3267,7 @@ module Aws::CloudWatch
       :dimensions,
       :stat,
       :configuration,
+      :metric_characteristics,
       :single_metric_anomaly_detector,
       :metric_math_anomaly_detector)
       SENSITIVE = []

data/lib/aws-sdk-cloudwatch.rb

@@ -56,6 +56,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @!group service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.87.0'
+  GEM_VERSION = '1.88.0'
 
 end

data/sig/client.rbs

@@ -512,6 +512,9 @@ module Aws
                                     ]?,
                                     metric_timezone: ::String?
                                   },
+                                  ?metric_characteristics: {
+                                    periodic_spikes: bool?
+                                  },
                                   ?single_metric_anomaly_detector: {
                                     account_id: ::String?,
                                     namespace: ::String?,

data/sig/types.rbs

@@ -25,6 +25,7 @@ module Aws::CloudWatch
       attr_accessor stat: ::String
       attr_accessor configuration: Types::AnomalyDetectorConfiguration
       attr_accessor state_value: ("PENDING_TRAINING" | "TRAINED_INSUFFICIENT_DATA" | "TRAINED")
+      attr_accessor metric_characteristics: Types::MetricCharacteristics
       attr_accessor single_metric_anomaly_detector: Types::SingleMetricAnomalyDetector
       attr_accessor metric_math_anomaly_detector: Types::MetricMathAnomalyDetector
       SENSITIVE: []
@@ -572,6 +573,11 @@ module Aws::CloudWatch
       SENSITIVE: []
     end
 
+    class MetricCharacteristics
+      attr_accessor periodic_spikes: bool
+      SENSITIVE: []
+    end
+
     class MetricDataQuery
       attr_accessor id: ::String
       attr_accessor metric_stat: Types::MetricStat
@@ -667,6 +673,7 @@ module Aws::CloudWatch
       attr_accessor dimensions: ::Array[Types::Dimension]
       attr_accessor stat: ::String
       attr_accessor configuration: Types::AnomalyDetectorConfiguration
+      attr_accessor metric_characteristics: Types::MetricCharacteristics
       attr_accessor single_metric_anomaly_detector: Types::SingleMetricAnomalyDetector
       attr_accessor metric_math_anomaly_detector: Types::MetricMathAnomalyDetector
       SENSITIVE: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.87.0
+  version: 1.88.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core