aws-sdk-cloudwatch 1.64.0 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 918f50d5e3f8d43f139fda5f9f3e5cd9b7e5dea0bb93ed7926df40c9d2a5156c
-  data.tar.gz: c992a354593a95ba169777d3a1b8e28e2136443796a808166dd8f8fcd2a599c0
+  metadata.gz: 9882292fa5689699f213f674aca54dfc40cd6dcc3233297a7a447993317fb386
+  data.tar.gz: d10daaa3174ea14a2667d4cf28c3758e38609fb0dc942ea5cb957da8d4fd9a7c
 SHA512:
-  metadata.gz: 3bd904fd9553fd6709653b1f2c4c9e835e8f0871a866871ae259f177fa0a4fe8faacf4385a2bd7e2a5e55b10aea598d986d280ac9ce695c394c75917734925e8
-  data.tar.gz: 06e82055db45c57c29cf0dff6a2468b40c887a7dd79b0a2abc89b23ced0b04906dd2f2616b6fad5505b66fbe251133045be966114b4ba30f4c954c0b8123623a
+  metadata.gz: 0704a30c53f1ba4a13826c8fa66c3b2a46c6268d877fe26b5f9438919f2bfb9f13e01bb7fabac24434c359fbcf798332d66be78e0cdd3156273f2a8e402245ae
+  data.tar.gz: f775047d967d586ece529236c894bf5ca0751b8de3cf29e14deeab0fe4cec346cb94d98f34aea73e9809e76e2a6ceb6aa5f61618e8af87c3087035765af581cd

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.65.0 (2022-07-21)
+------------------
+
+* Feature - Adding support for the suppression of Composite Alarm actions
+
 1.64.0 (2022-04-14)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.64.0
+1.65.0

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

@@ -809,6 +809,12 @@ module Aws::CloudWatch
     #   resp.composite_alarms[0].state_reason_data #=> String
     #   resp.composite_alarms[0].state_updated_timestamp #=> Time
     #   resp.composite_alarms[0].state_value #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
+    #   resp.composite_alarms[0].state_transitioned_timestamp #=> Time
+    #   resp.composite_alarms[0].actions_suppressed_by #=> String, one of "WaitPeriod", "ExtensionPeriod", "Alarm"
+    #   resp.composite_alarms[0].actions_suppressed_reason #=> String
+    #   resp.composite_alarms[0].actions_suppressor #=> String
+    #   resp.composite_alarms[0].actions_suppressor_wait_period #=> Integer
+    #   resp.composite_alarms[0].actions_suppressor_extension_period #=> Integer
     #   resp.metric_alarms #=> Array
     #   resp.metric_alarms[0].alarm_name #=> String
     #   resp.metric_alarms[0].alarm_arn #=> String
@@ -2550,6 +2556,26 @@ module Aws::CloudWatch
     #   use them to scope user permissions, by granting a user permission to
     #   access or change only resources with certain tag values.
     #
+    # @option params [String] :actions_suppressor
+    #   Actions will be suppressed if the suppressor alarm is in the `ALARM`
+    #   state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
+    #   Name (ARN) from an existing alarm.
+    #
+    # @option params [Integer] :actions_suppressor_wait_period
+    #   The maximum time in seconds that the composite alarm waits for the
+    #   suppressor alarm to go into the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `WaitPeriod` is required only when `ActionsSuppressor` is specified.
+    #
+    # @option params [Integer] :actions_suppressor_extension_period
+    #   The maximum time in seconds that the composite alarm waits after
+    #   suppressor alarm goes out of the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `ExtensionPeriod` is required only when `ActionsSuppressor` is
+    #   specified.
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -2568,6 +2594,9 @@ module Aws::CloudWatch
     #         value: "TagValue", # required
     #       },
     #     ],
+    #     actions_suppressor: "AlarmArn",
+    #     actions_suppressor_wait_period: 1,
+    #     actions_suppressor_extension_period: 1,
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm AWS API Documentation
@@ -3633,7 +3662,7 @@ module Aws::CloudWatch
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatch'
-      context[:gem_version] = '1.64.0'
+      context[:gem_version] = '1.65.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -16,6 +16,8 @@ module Aws::CloudWatch
     AccountId = Shapes::StringShape.new(name: 'AccountId')
     ActionPrefix = Shapes::StringShape.new(name: 'ActionPrefix')
     ActionsEnabled = Shapes::BooleanShape.new(name: 'ActionsEnabled')
+    ActionsSuppressedBy = Shapes::StringShape.new(name: 'ActionsSuppressedBy')
+    ActionsSuppressedReason = Shapes::StringShape.new(name: 'ActionsSuppressedReason')
     AlarmArn = Shapes::StringShape.new(name: 'AlarmArn')
     AlarmDescription = Shapes::StringShape.new(name: 'AlarmDescription')
     AlarmHistoryItem = Shapes::StructureShape.new(name: 'AlarmHistoryItem')
@@ -246,6 +248,7 @@ module Aws::CloudWatch
     StopMetricStreamsInput = Shapes::StructureShape.new(name: 'StopMetricStreamsInput')
     StopMetricStreamsOutput = Shapes::StructureShape.new(name: 'StopMetricStreamsOutput')
     StorageResolution = Shapes::IntegerShape.new(name: 'StorageResolution')
+    SuppressorPeriod = Shapes::IntegerShape.new(name: 'SuppressorPeriod')
     Tag = Shapes::StructureShape.new(name: 'Tag')
     TagKey = Shapes::StringShape.new(name: 'TagKey')
     TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
@@ -310,6 +313,12 @@ module Aws::CloudWatch
     CompositeAlarm.add_member(:state_reason_data, Shapes::ShapeRef.new(shape: StateReasonData, location_name: "StateReasonData"))
     CompositeAlarm.add_member(:state_updated_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateUpdatedTimestamp"))
     CompositeAlarm.add_member(:state_value, Shapes::ShapeRef.new(shape: StateValue, location_name: "StateValue"))
+    CompositeAlarm.add_member(:state_transitioned_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateTransitionedTimestamp"))
+    CompositeAlarm.add_member(:actions_suppressed_by, Shapes::ShapeRef.new(shape: ActionsSuppressedBy, location_name: "ActionsSuppressedBy"))
+    CompositeAlarm.add_member(:actions_suppressed_reason, Shapes::ShapeRef.new(shape: ActionsSuppressedReason, location_name: "ActionsSuppressedReason"))
+    CompositeAlarm.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
+    CompositeAlarm.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
+    CompositeAlarm.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
     CompositeAlarm.struct_class = Types::CompositeAlarm
 
     CompositeAlarms.member = Shapes::ShapeRef.new(shape: CompositeAlarm)
@@ -802,6 +811,9 @@ module Aws::CloudWatch
     PutCompositeAlarmInput.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions"))
     PutCompositeAlarmInput.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions"))
     PutCompositeAlarmInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+    PutCompositeAlarmInput.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
+    PutCompositeAlarmInput.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
+    PutCompositeAlarmInput.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
     PutCompositeAlarmInput.struct_class = Types::PutCompositeAlarmInput
 
     PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, required: true, location_name: "DashboardName"))

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

@@ -102,7 +102,8 @@ module Aws::CloudWatch
       data[:state_reason_data]
     end
 
-    # The time stamp of the last update to the alarm state.
+    # Tracks the timestamp of any state update, even if `StateValue`
+    # doesn't change.
     # @return [Time]
     def state_updated_timestamp
       data[:state_updated_timestamp]
@@ -114,6 +115,63 @@ module Aws::CloudWatch
       data[:state_value]
     end
 
+    # The timestamp of the last change to the alarm's `StateValue`.
+    # @return [Time]
+    def state_transitioned_timestamp
+      data[:state_transitioned_timestamp]
+    end
+
+    # When the value is `ALARM`, it means that the actions are suppressed
+    # because the suppressor alarm is in `ALARM` When the value is
+    # `WaitPeriod`, it means that the actions are suppressed because the
+    # composite alarm is waiting for the suppressor alarm to go into into
+    # the `ALARM` state. The maximum waiting time is as specified in
+    # `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
+    # performs its actions. When the value is `ExtensionPeriod`, it means
+    # that the actions are suppressed because the composite alarm is waiting
+    # after the suppressor alarm went out of the `ALARM` state. The maximum
+    # waiting time is as specified in `ActionsSuppressorExtensionPeriod`.
+    # After this time, the composite alarm performs its actions.
+    # @return [String]
+    def actions_suppressed_by
+      data[:actions_suppressed_by]
+    end
+
+    # Captures the reason for action suppression.
+    # @return [String]
+    def actions_suppressed_reason
+      data[:actions_suppressed_reason]
+    end
+
+    # Actions will be suppressed if the suppressor alarm is in the `ALARM`
+    # state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
+    # Name (ARN) from an existing alarm.
+    # @return [String]
+    def actions_suppressor
+      data[:actions_suppressor]
+    end
+
+    # The maximum time in seconds that the composite alarm waits for the
+    # suppressor alarm to go into the `ALARM` state. After this time, the
+    # composite alarm performs its actions.
+    #
+    # `WaitPeriod` is required only when `ActionsSuppressor` is specified.
+    # @return [Integer]
+    def actions_suppressor_wait_period
+      data[:actions_suppressor_wait_period]
+    end
+
+    # The maximum time in seconds that the composite alarm waits after
+    # suppressor alarm goes out of the `ALARM` state. After this time, the
+    # composite alarm performs its actions.
+    #
+    # `ExtensionPeriod` is required only when `ActionsSuppressor` is
+    # specified.
+    # @return [Integer]
+    def actions_suppressor_extension_period
+      data[:actions_suppressor_extension_period]
+    end
+
     # @!endgroup
 
     # @return [Client]

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

@@ -205,13 +205,60 @@ module Aws::CloudWatch
     #   @return [String]
     #
     # @!attribute [rw] state_updated_timestamp
-    #   The time stamp of the last update to the alarm state.
+    #   Tracks the timestamp of any state update, even if `StateValue`
+    #   doesn't change.
     #   @return [Time]
     #
     # @!attribute [rw] state_value
     #   The state value for the alarm.
     #   @return [String]
     #
+    # @!attribute [rw] state_transitioned_timestamp
+    #   The timestamp of the last change to the alarm's `StateValue`.
+    #   @return [Time]
+    #
+    # @!attribute [rw] actions_suppressed_by
+    #   When the value is `ALARM`, it means that the actions are suppressed
+    #   because the suppressor alarm is in `ALARM` When the value is
+    #   `WaitPeriod`, it means that the actions are suppressed because the
+    #   composite alarm is waiting for the suppressor alarm to go into into
+    #   the `ALARM` state. The maximum waiting time is as specified in
+    #   `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
+    #   performs its actions. When the value is `ExtensionPeriod`, it means
+    #   that the actions are suppressed because the composite alarm is
+    #   waiting after the suppressor alarm went out of the `ALARM` state.
+    #   The maximum waiting time is as specified in
+    #   `ActionsSuppressorExtensionPeriod`. After this time, the composite
+    #   alarm performs its actions.
+    #   @return [String]
+    #
+    # @!attribute [rw] actions_suppressed_reason
+    #   Captures the reason for action suppression.
+    #   @return [String]
+    #
+    # @!attribute [rw] actions_suppressor
+    #   Actions will be suppressed if the suppressor alarm is in the `ALARM`
+    #   state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
+    #   Name (ARN) from an existing alarm.
+    #   @return [String]
+    #
+    # @!attribute [rw] actions_suppressor_wait_period
+    #   The maximum time in seconds that the composite alarm waits for the
+    #   suppressor alarm to go into the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `WaitPeriod` is required only when `ActionsSuppressor` is specified.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] actions_suppressor_extension_period
+    #   The maximum time in seconds that the composite alarm waits after
+    #   suppressor alarm goes out of the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `ExtensionPeriod` is required only when `ActionsSuppressor` is
+    #   specified.
+    #   @return [Integer]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/CompositeAlarm AWS API Documentation
     #
     class CompositeAlarm < Struct.new(
@@ -227,7 +274,13 @@ module Aws::CloudWatch
       :state_reason,
       :state_reason_data,
       :state_updated_timestamp,
-      :state_value)
+      :state_value,
+      :state_transitioned_timestamp,
+      :actions_suppressed_by,
+      :actions_suppressed_reason,
+      :actions_suppressor,
+      :actions_suppressor_wait_period,
+      :actions_suppressor_extension_period)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3525,6 +3578,9 @@ module Aws::CloudWatch
     #             value: "TagValue", # required
     #           },
     #         ],
+    #         actions_suppressor: "AlarmArn",
+    #         actions_suppressor_wait_period: 1,
+    #         actions_suppressor_extension_period: 1,
     #       }
     #
     # @!attribute [rw] actions_enabled
@@ -3635,6 +3691,29 @@ module Aws::CloudWatch
     #   values.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] actions_suppressor
+    #   Actions will be suppressed if the suppressor alarm is in the `ALARM`
+    #   state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
+    #   Name (ARN) from an existing alarm.
+    #   @return [String]
+    #
+    # @!attribute [rw] actions_suppressor_wait_period
+    #   The maximum time in seconds that the composite alarm waits for the
+    #   suppressor alarm to go into the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `WaitPeriod` is required only when `ActionsSuppressor` is specified.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] actions_suppressor_extension_period
+    #   The maximum time in seconds that the composite alarm waits after
+    #   suppressor alarm goes out of the `ALARM` state. After this time, the
+    #   composite alarm performs its actions.
+    #
+    #   `ExtensionPeriod` is required only when `ActionsSuppressor` is
+    #   specified.
+    #   @return [Integer]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarmInput AWS API Documentation
     #
     class PutCompositeAlarmInput < Struct.new(
@@ -3645,7 +3724,10 @@ module Aws::CloudWatch
       :alarm_rule,
       :insufficient_data_actions,
       :ok_actions,
-      :tags)
+      :tags,
+      :actions_suppressor,
+      :actions_suppressor_wait_period,
+      :actions_suppressor_extension_period)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-cloudwatch.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-cloudwatch/customizations'
 # @!group service
 module Aws::CloudWatch
 
-  GEM_VERSION = '1.64.0'
+  GEM_VERSION = '1.65.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatch
 version: !ruby/object:Gem::Version
-  version: 1.64.0
+  version: 1.65.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core