aws-sdk-cloudwatch 1.63.0 → 1.66.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/client.rb +61 -17
- data/lib/aws-sdk-cloudwatch/client_api.rb +12 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +59 -1
- data/lib/aws-sdk-cloudwatch/metric.rb +10 -3
- data/lib/aws-sdk-cloudwatch/types.rb +122 -31
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0fdecccc7a87d85d7e125b738ee02963887bc94956dbe93e7f05d104657c89ab
|
4
|
+
data.tar.gz: 3bb4035b961405e80ba140b665a2b8c3499e99fe342fc46ec8673331960511ba
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1fd910c0471f2717f9571cf7058ce32bc1d0eab985a95bcd76e1a53036ca5e733519b68dfad394a3d091a4c28822640ef45eca47c91a5d2e780b59f608a8eee7
|
7
|
+
data.tar.gz: 9ec9f4f4c62249d07b9bd2e5b7a0ba9f5c90db057a4b38e14062e86ed65861b09c5db71a5755cb435a58469a084921ae366716da5101d741557c594875aefb5c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.66.0 (2022-08-09)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Various quota increases related to dimensions and custom metrics
|
8
|
+
|
9
|
+
1.65.0 (2022-07-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adding support for the suppression of Composite Alarm actions
|
13
|
+
|
14
|
+
1.64.0 (2022-04-14)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Updates documentation for additional statistics in CloudWatch Metric Streams.
|
18
|
+
|
4
19
|
1.63.0 (2022-04-13)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.66.0
|
@@ -397,7 +397,14 @@ module Aws::CloudWatch
|
|
397
397
|
req.send_request(options)
|
398
398
|
end
|
399
399
|
|
400
|
-
# Deletes the specified anomaly detection model from your account.
|
400
|
+
# Deletes the specified anomaly detection model from your account. For
|
401
|
+
# more information about how to delete an anomaly detection model, see
|
402
|
+
# [Deleting an anomaly detection model][1] in the *CloudWatch User
|
403
|
+
# Guide*.
|
404
|
+
#
|
405
|
+
#
|
406
|
+
#
|
407
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model
|
401
408
|
#
|
402
409
|
# @option params [String] :namespace
|
403
410
|
# The namespace associated with the anomaly detection model to delete.
|
@@ -809,6 +816,12 @@ module Aws::CloudWatch
|
|
809
816
|
# resp.composite_alarms[0].state_reason_data #=> String
|
810
817
|
# resp.composite_alarms[0].state_updated_timestamp #=> Time
|
811
818
|
# resp.composite_alarms[0].state_value #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
|
819
|
+
# resp.composite_alarms[0].state_transitioned_timestamp #=> Time
|
820
|
+
# resp.composite_alarms[0].actions_suppressed_by #=> String, one of "WaitPeriod", "ExtensionPeriod", "Alarm"
|
821
|
+
# resp.composite_alarms[0].actions_suppressed_reason #=> String
|
822
|
+
# resp.composite_alarms[0].actions_suppressor #=> String
|
823
|
+
# resp.composite_alarms[0].actions_suppressor_wait_period #=> Integer
|
824
|
+
# resp.composite_alarms[0].actions_suppressor_extension_period #=> Integer
|
812
825
|
# resp.metric_alarms #=> Array
|
813
826
|
# resp.metric_alarms[0].alarm_name #=> String
|
814
827
|
# resp.metric_alarms[0].alarm_arn #=> String
|
@@ -2550,6 +2563,26 @@ module Aws::CloudWatch
|
|
2550
2563
|
# use them to scope user permissions, by granting a user permission to
|
2551
2564
|
# access or change only resources with certain tag values.
|
2552
2565
|
#
|
2566
|
+
# @option params [String] :actions_suppressor
|
2567
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
2568
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
2569
|
+
# Name (ARN) from an existing alarm.
|
2570
|
+
#
|
2571
|
+
# @option params [Integer] :actions_suppressor_wait_period
|
2572
|
+
# The maximum time in seconds that the composite alarm waits for the
|
2573
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
2574
|
+
# composite alarm performs its actions.
|
2575
|
+
#
|
2576
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
2577
|
+
#
|
2578
|
+
# @option params [Integer] :actions_suppressor_extension_period
|
2579
|
+
# The maximum time in seconds that the composite alarm waits after
|
2580
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
2581
|
+
# composite alarm performs its actions.
|
2582
|
+
#
|
2583
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
2584
|
+
# specified.
|
2585
|
+
#
|
2553
2586
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2554
2587
|
#
|
2555
2588
|
# @example Request syntax with placeholder values
|
@@ -2568,6 +2601,9 @@ module Aws::CloudWatch
|
|
2568
2601
|
# value: "TagValue", # required
|
2569
2602
|
# },
|
2570
2603
|
# ],
|
2604
|
+
# actions_suppressor: "AlarmArn",
|
2605
|
+
# actions_suppressor_wait_period: 1,
|
2606
|
+
# actions_suppressor_extension_period: 1,
|
2571
2607
|
# })
|
2572
2608
|
#
|
2573
2609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm AWS API Documentation
|
@@ -2920,7 +2956,7 @@ module Aws::CloudWatch
|
|
2920
2956
|
#
|
2921
2957
|
# However, if the metric is published with multiple types of units and
|
2922
2958
|
# you don't specify a unit, the alarm's behavior is not defined and it
|
2923
|
-
# behaves
|
2959
|
+
# behaves unpredictably.
|
2924
2960
|
#
|
2925
2961
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
2926
2962
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -2970,6 +3006,13 @@ module Aws::CloudWatch
|
|
2970
3006
|
#
|
2971
3007
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
2972
3008
|
#
|
3009
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
3010
|
+
# `ignore` missing data even if you choose a different option for
|
3011
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
3012
|
+
# alarms that evaluate that metric remain in their current state.
|
3013
|
+
#
|
3014
|
+
# </note>
|
3015
|
+
#
|
2973
3016
|
#
|
2974
3017
|
#
|
2975
3018
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -3126,16 +3169,16 @@ module Aws::CloudWatch
|
|
3126
3169
|
# `PutMetricData` request, and supports retrieving percentile statistics
|
3127
3170
|
# on this data.
|
3128
3171
|
#
|
3129
|
-
# Each `PutMetricData` request is limited to
|
3172
|
+
# Each `PutMetricData` request is limited to 1 MB in size for HTTP POST
|
3130
3173
|
# requests. You can send a payload compressed by gzip. Each request is
|
3131
|
-
# also limited to no more than
|
3174
|
+
# also limited to no more than 1000 different metrics.
|
3132
3175
|
#
|
3133
3176
|
# Although the `Value` parameter accepts numbers of type `Double`,
|
3134
3177
|
# CloudWatch rejects values that are either too small or too large.
|
3135
3178
|
# Values must be in the range of -2^360 to 2^360. In addition, special
|
3136
3179
|
# values (for example, NaN, +Infinity, -Infinity) are not supported.
|
3137
3180
|
#
|
3138
|
-
# You can use up to
|
3181
|
+
# You can use up to 30 dimensions per metric to further clarify what
|
3139
3182
|
# data the metric collects. Each dimension consists of a Name and Value
|
3140
3183
|
# pair. For more information about specifying dimensions, see
|
3141
3184
|
# [Publishing Metrics][2] in the *Amazon CloudWatch User Guide*.
|
@@ -3176,8 +3219,8 @@ module Aws::CloudWatch
|
|
3176
3219
|
# should not specify a namespace that begins with `AWS/`
|
3177
3220
|
#
|
3178
3221
|
# @option params [required, Array<Types::MetricDatum>] :metric_data
|
3179
|
-
# The data for the metric. The array can include no more than
|
3180
|
-
# per call.
|
3222
|
+
# The data for the metric. The array can include no more than 1000
|
3223
|
+
# metrics per call.
|
3181
3224
|
#
|
3182
3225
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3183
3226
|
#
|
@@ -3244,7 +3287,7 @@ module Aws::CloudWatch
|
|
3244
3287
|
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3245
3288
|
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3246
3289
|
# the `StatisticsConfigurations` parameter to have the metric stream
|
3247
|
-
# also send
|
3290
|
+
# also send additional statistics in the stream. Streaming additional
|
3248
3291
|
# statistics incurs additional costs. For more information, see [Amazon
|
3249
3292
|
# CloudWatch Pricing][2].
|
3250
3293
|
#
|
@@ -3327,16 +3370,17 @@ module Aws::CloudWatch
|
|
3327
3370
|
# @option params [Array<Types::MetricStreamStatisticsConfiguration>] :statistics_configurations
|
3328
3371
|
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3329
3372
|
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3330
|
-
# this parameter to have the metric stream also send
|
3331
|
-
# in the stream. This array can have up to 100 members.
|
3373
|
+
# this parameter to have the metric stream also send additional
|
3374
|
+
# statistics in the stream. This array can have up to 100 members.
|
3332
3375
|
#
|
3333
3376
|
# For each entry in this array, you specify one or more metrics and the
|
3334
|
-
# list of
|
3335
|
-
# statistics that you can stream depend on the stream's
|
3336
|
-
# If the `OutputFormat` is `json`, you can stream any
|
3337
|
-
# that is supported by CloudWatch, listed in [
|
3338
|
-
# definitions][1]. If the `OutputFormat` is
|
3339
|
-
# stream percentile statistics
|
3377
|
+
# list of additional statistics to stream for those metrics. The
|
3378
|
+
# additional statistics that you can stream depend on the stream's
|
3379
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
3380
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
3381
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
3382
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as p95,
|
3383
|
+
# p99.9 and so on.
|
3340
3384
|
#
|
3341
3385
|
#
|
3342
3386
|
#
|
@@ -3625,7 +3669,7 @@ module Aws::CloudWatch
|
|
3625
3669
|
params: params,
|
3626
3670
|
config: config)
|
3627
3671
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
3628
|
-
context[:gem_version] = '1.
|
3672
|
+
context[:gem_version] = '1.66.0'
|
3629
3673
|
Seahorse::Client::Request.new(handlers, context)
|
3630
3674
|
end
|
3631
3675
|
|
@@ -16,6 +16,8 @@ module Aws::CloudWatch
|
|
16
16
|
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
17
17
|
ActionPrefix = Shapes::StringShape.new(name: 'ActionPrefix')
|
18
18
|
ActionsEnabled = Shapes::BooleanShape.new(name: 'ActionsEnabled')
|
19
|
+
ActionsSuppressedBy = Shapes::StringShape.new(name: 'ActionsSuppressedBy')
|
20
|
+
ActionsSuppressedReason = Shapes::StringShape.new(name: 'ActionsSuppressedReason')
|
19
21
|
AlarmArn = Shapes::StringShape.new(name: 'AlarmArn')
|
20
22
|
AlarmDescription = Shapes::StringShape.new(name: 'AlarmDescription')
|
21
23
|
AlarmHistoryItem = Shapes::StructureShape.new(name: 'AlarmHistoryItem')
|
@@ -246,6 +248,7 @@ module Aws::CloudWatch
|
|
246
248
|
StopMetricStreamsInput = Shapes::StructureShape.new(name: 'StopMetricStreamsInput')
|
247
249
|
StopMetricStreamsOutput = Shapes::StructureShape.new(name: 'StopMetricStreamsOutput')
|
248
250
|
StorageResolution = Shapes::IntegerShape.new(name: 'StorageResolution')
|
251
|
+
SuppressorPeriod = Shapes::IntegerShape.new(name: 'SuppressorPeriod')
|
249
252
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
250
253
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
251
254
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
@@ -310,6 +313,12 @@ module Aws::CloudWatch
|
|
310
313
|
CompositeAlarm.add_member(:state_reason_data, Shapes::ShapeRef.new(shape: StateReasonData, location_name: "StateReasonData"))
|
311
314
|
CompositeAlarm.add_member(:state_updated_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateUpdatedTimestamp"))
|
312
315
|
CompositeAlarm.add_member(:state_value, Shapes::ShapeRef.new(shape: StateValue, location_name: "StateValue"))
|
316
|
+
CompositeAlarm.add_member(:state_transitioned_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateTransitionedTimestamp"))
|
317
|
+
CompositeAlarm.add_member(:actions_suppressed_by, Shapes::ShapeRef.new(shape: ActionsSuppressedBy, location_name: "ActionsSuppressedBy"))
|
318
|
+
CompositeAlarm.add_member(:actions_suppressed_reason, Shapes::ShapeRef.new(shape: ActionsSuppressedReason, location_name: "ActionsSuppressedReason"))
|
319
|
+
CompositeAlarm.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
|
320
|
+
CompositeAlarm.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
|
321
|
+
CompositeAlarm.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
|
313
322
|
CompositeAlarm.struct_class = Types::CompositeAlarm
|
314
323
|
|
315
324
|
CompositeAlarms.member = Shapes::ShapeRef.new(shape: CompositeAlarm)
|
@@ -802,6 +811,9 @@ module Aws::CloudWatch
|
|
802
811
|
PutCompositeAlarmInput.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions"))
|
803
812
|
PutCompositeAlarmInput.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions"))
|
804
813
|
PutCompositeAlarmInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
814
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
|
815
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
|
816
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
|
805
817
|
PutCompositeAlarmInput.struct_class = Types::PutCompositeAlarmInput
|
806
818
|
|
807
819
|
PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, required: true, location_name: "DashboardName"))
|
@@ -102,7 +102,8 @@ module Aws::CloudWatch
|
|
102
102
|
data[:state_reason_data]
|
103
103
|
end
|
104
104
|
|
105
|
-
#
|
105
|
+
# Tracks the timestamp of any state update, even if `StateValue`
|
106
|
+
# doesn't change.
|
106
107
|
# @return [Time]
|
107
108
|
def state_updated_timestamp
|
108
109
|
data[:state_updated_timestamp]
|
@@ -114,6 +115,63 @@ module Aws::CloudWatch
|
|
114
115
|
data[:state_value]
|
115
116
|
end
|
116
117
|
|
118
|
+
# The timestamp of the last change to the alarm's `StateValue`.
|
119
|
+
# @return [Time]
|
120
|
+
def state_transitioned_timestamp
|
121
|
+
data[:state_transitioned_timestamp]
|
122
|
+
end
|
123
|
+
|
124
|
+
# When the value is `ALARM`, it means that the actions are suppressed
|
125
|
+
# because the suppressor alarm is in `ALARM` When the value is
|
126
|
+
# `WaitPeriod`, it means that the actions are suppressed because the
|
127
|
+
# composite alarm is waiting for the suppressor alarm to go into into
|
128
|
+
# the `ALARM` state. The maximum waiting time is as specified in
|
129
|
+
# `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
|
130
|
+
# performs its actions. When the value is `ExtensionPeriod`, it means
|
131
|
+
# that the actions are suppressed because the composite alarm is waiting
|
132
|
+
# after the suppressor alarm went out of the `ALARM` state. The maximum
|
133
|
+
# waiting time is as specified in `ActionsSuppressorExtensionPeriod`.
|
134
|
+
# After this time, the composite alarm performs its actions.
|
135
|
+
# @return [String]
|
136
|
+
def actions_suppressed_by
|
137
|
+
data[:actions_suppressed_by]
|
138
|
+
end
|
139
|
+
|
140
|
+
# Captures the reason for action suppression.
|
141
|
+
# @return [String]
|
142
|
+
def actions_suppressed_reason
|
143
|
+
data[:actions_suppressed_reason]
|
144
|
+
end
|
145
|
+
|
146
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
147
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
148
|
+
# Name (ARN) from an existing alarm.
|
149
|
+
# @return [String]
|
150
|
+
def actions_suppressor
|
151
|
+
data[:actions_suppressor]
|
152
|
+
end
|
153
|
+
|
154
|
+
# The maximum time in seconds that the composite alarm waits for the
|
155
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
156
|
+
# composite alarm performs its actions.
|
157
|
+
#
|
158
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
159
|
+
# @return [Integer]
|
160
|
+
def actions_suppressor_wait_period
|
161
|
+
data[:actions_suppressor_wait_period]
|
162
|
+
end
|
163
|
+
|
164
|
+
# The maximum time in seconds that the composite alarm waits after
|
165
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
166
|
+
# composite alarm performs its actions.
|
167
|
+
#
|
168
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
169
|
+
# specified.
|
170
|
+
# @return [Integer]
|
171
|
+
def actions_suppressor_extension_period
|
172
|
+
data[:actions_suppressor_extension_period]
|
173
|
+
end
|
174
|
+
|
117
175
|
# @!endgroup
|
118
176
|
|
119
177
|
# @return [Client]
|
@@ -486,7 +486,7 @@ module Aws::CloudWatch
|
|
486
486
|
#
|
487
487
|
# However, if the metric is published with multiple types of units and
|
488
488
|
# you don't specify a unit, the alarm's behavior is not defined and it
|
489
|
-
# behaves
|
489
|
+
# behaves unpredictably.
|
490
490
|
#
|
491
491
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
492
492
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -531,6 +531,13 @@ module Aws::CloudWatch
|
|
531
531
|
#
|
532
532
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
533
533
|
#
|
534
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
535
|
+
# `ignore` missing data even if you choose a different option for
|
536
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
537
|
+
# alarms that evaluate that metric remain in their current state.
|
538
|
+
#
|
539
|
+
# </note>
|
540
|
+
#
|
534
541
|
#
|
535
542
|
#
|
536
543
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -638,8 +645,8 @@ module Aws::CloudWatch
|
|
638
645
|
# })
|
639
646
|
# @param [Hash] options ({})
|
640
647
|
# @option options [required, Array<Types::MetricDatum>] :metric_data
|
641
|
-
# The data for the metric. The array can include no more than
|
642
|
-
# per call.
|
648
|
+
# The data for the metric. The array can include no more than 1000
|
649
|
+
# metrics per call.
|
643
650
|
# @return [EmptyStructure]
|
644
651
|
def put_data(options = {})
|
645
652
|
options = Aws::Util.deep_merge(options,
|
@@ -205,13 +205,60 @@ module Aws::CloudWatch
|
|
205
205
|
# @return [String]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] state_updated_timestamp
|
208
|
-
#
|
208
|
+
# Tracks the timestamp of any state update, even if `StateValue`
|
209
|
+
# doesn't change.
|
209
210
|
# @return [Time]
|
210
211
|
#
|
211
212
|
# @!attribute [rw] state_value
|
212
213
|
# The state value for the alarm.
|
213
214
|
# @return [String]
|
214
215
|
#
|
216
|
+
# @!attribute [rw] state_transitioned_timestamp
|
217
|
+
# The timestamp of the last change to the alarm's `StateValue`.
|
218
|
+
# @return [Time]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] actions_suppressed_by
|
221
|
+
# When the value is `ALARM`, it means that the actions are suppressed
|
222
|
+
# because the suppressor alarm is in `ALARM` When the value is
|
223
|
+
# `WaitPeriod`, it means that the actions are suppressed because the
|
224
|
+
# composite alarm is waiting for the suppressor alarm to go into into
|
225
|
+
# the `ALARM` state. The maximum waiting time is as specified in
|
226
|
+
# `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
|
227
|
+
# performs its actions. When the value is `ExtensionPeriod`, it means
|
228
|
+
# that the actions are suppressed because the composite alarm is
|
229
|
+
# waiting after the suppressor alarm went out of the `ALARM` state.
|
230
|
+
# The maximum waiting time is as specified in
|
231
|
+
# `ActionsSuppressorExtensionPeriod`. After this time, the composite
|
232
|
+
# alarm performs its actions.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @!attribute [rw] actions_suppressed_reason
|
236
|
+
# Captures the reason for action suppression.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] actions_suppressor
|
240
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
241
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
242
|
+
# Name (ARN) from an existing alarm.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
246
|
+
# The maximum time in seconds that the composite alarm waits for the
|
247
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
248
|
+
# composite alarm performs its actions.
|
249
|
+
#
|
250
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
251
|
+
# @return [Integer]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
254
|
+
# The maximum time in seconds that the composite alarm waits after
|
255
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
256
|
+
# composite alarm performs its actions.
|
257
|
+
#
|
258
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
259
|
+
# specified.
|
260
|
+
# @return [Integer]
|
261
|
+
#
|
215
262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/CompositeAlarm AWS API Documentation
|
216
263
|
#
|
217
264
|
class CompositeAlarm < Struct.new(
|
@@ -227,7 +274,13 @@ module Aws::CloudWatch
|
|
227
274
|
:state_reason,
|
228
275
|
:state_reason_data,
|
229
276
|
:state_updated_timestamp,
|
230
|
-
:state_value
|
277
|
+
:state_value,
|
278
|
+
:state_transitioned_timestamp,
|
279
|
+
:actions_suppressed_by,
|
280
|
+
:actions_suppressed_reason,
|
281
|
+
:actions_suppressor,
|
282
|
+
:actions_suppressor_wait_period,
|
283
|
+
:actions_suppressor_extension_period)
|
231
284
|
SENSITIVE = []
|
232
285
|
include Aws::Structure
|
233
286
|
end
|
@@ -1037,7 +1090,7 @@ module Aws::CloudWatch
|
|
1037
1090
|
# many Amazon EC2 metrics publish `InstanceId` as a dimension name, and
|
1038
1091
|
# the actual instance ID as the value for that dimension.
|
1039
1092
|
#
|
1040
|
-
# You can assign up to
|
1093
|
+
# You can assign up to 30 dimensions to a metric.
|
1041
1094
|
#
|
1042
1095
|
# @note When making an API call, you may pass Dimension
|
1043
1096
|
# data as a hash:
|
@@ -1799,8 +1852,8 @@ module Aws::CloudWatch
|
|
1799
1852
|
#
|
1800
1853
|
# @!attribute [rw] statistics_configurations
|
1801
1854
|
# Each entry in this array displays information about one or more
|
1802
|
-
# metrics that include
|
1803
|
-
# more information about
|
1855
|
+
# metrics that include additional statistics in the metric stream. For
|
1856
|
+
# more information about the additional statistics, see [ CloudWatch
|
1804
1857
|
# statistics definitions][1].
|
1805
1858
|
#
|
1806
1859
|
#
|
@@ -2958,7 +3011,7 @@ module Aws::CloudWatch
|
|
2958
3011
|
# period. Each unique value is listed just once in this array, and the
|
2959
3012
|
# corresponding number in the `Counts` array specifies the number of
|
2960
3013
|
# times that value occurred during the period. You can include up to
|
2961
|
-
#
|
3014
|
+
# 500 unique values in each `PutMetricData` action that specifies a
|
2962
3015
|
# `Values` array.
|
2963
3016
|
#
|
2964
3017
|
# Although the `Values` array accepts numbers of type `Double`,
|
@@ -3227,10 +3280,9 @@ module Aws::CloudWatch
|
|
3227
3280
|
|
3228
3281
|
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3229
3282
|
# `SAMPLECOUNT` statistics for each metric that is streamed. This
|
3230
|
-
# structure contains information for one metric that includes
|
3231
|
-
# statistics in the stream. For more information about
|
3232
|
-
#
|
3233
|
-
# definitions][1].
|
3283
|
+
# structure contains information for one metric that includes additional
|
3284
|
+
# statistics in the stream. For more information about statistics, see
|
3285
|
+
# CloudWatch, listed in [ CloudWatch statistics definitions][1].
|
3234
3286
|
#
|
3235
3287
|
#
|
3236
3288
|
#
|
@@ -3250,17 +3302,18 @@ module Aws::CloudWatch
|
|
3250
3302
|
# }
|
3251
3303
|
#
|
3252
3304
|
# @!attribute [rw] include_metrics
|
3253
|
-
# An array of metric name and namespace pairs that stream the
|
3254
|
-
# statistics listed in the value of the
|
3255
|
-
# parameter. There can be as many as 100 pairs
|
3305
|
+
# An array of metric name and namespace pairs that stream the
|
3306
|
+
# additional statistics listed in the value of the
|
3307
|
+
# `AdditionalStatistics` parameter. There can be as many as 100 pairs
|
3308
|
+
# in the array.
|
3256
3309
|
#
|
3257
3310
|
# All metrics that match the combination of metric name and namespace
|
3258
|
-
# will be streamed with the
|
3311
|
+
# will be streamed with the additional statistics, no matter their
|
3259
3312
|
# dimensions.
|
3260
3313
|
# @return [Array<Types::MetricStreamStatisticsMetric>]
|
3261
3314
|
#
|
3262
3315
|
# @!attribute [rw] additional_statistics
|
3263
|
-
# The list of
|
3316
|
+
# The list of additional statistics that are to be streamed for the
|
3264
3317
|
# metrics listed in the `IncludeMetrics` array in this structure. This
|
3265
3318
|
# list can include as many as 20 statistics.
|
3266
3319
|
#
|
@@ -3268,10 +3321,10 @@ module Aws::CloudWatch
|
|
3268
3321
|
# valid values are `p?? ` percentile statistics such as `p90`, `p99`
|
3269
3322
|
# and so on.
|
3270
3323
|
#
|
3271
|
-
# If the `OutputFormat` for the stream is `json`, the valid values
|
3272
|
-
# include the abbreviations for all of the
|
3273
|
-
#
|
3274
|
-
#
|
3324
|
+
# If the `OutputFormat` for the stream is `json`, the valid values
|
3325
|
+
# include the abbreviations for all of the statistics listed in [
|
3326
|
+
# CloudWatch statistics definitions][1]. For example, this includes
|
3327
|
+
# `tm98, ` `wm90`, `PR(:300)`, and so on.
|
3275
3328
|
#
|
3276
3329
|
#
|
3277
3330
|
#
|
@@ -3287,8 +3340,8 @@ module Aws::CloudWatch
|
|
3287
3340
|
include Aws::Structure
|
3288
3341
|
end
|
3289
3342
|
|
3290
|
-
# This object contains the information for one metric that is to
|
3291
|
-
# streamed with
|
3343
|
+
# This object contains the information for one metric that is to be
|
3344
|
+
# streamed with additional statistics.
|
3292
3345
|
#
|
3293
3346
|
# @note When making an API call, you may pass MetricStreamStatisticsMetric
|
3294
3347
|
# data as a hash:
|
@@ -3299,7 +3352,7 @@ module Aws::CloudWatch
|
|
3299
3352
|
# }
|
3300
3353
|
#
|
3301
3354
|
# @!attribute [rw] namespace
|
3302
|
-
# The
|
3355
|
+
# The namespace of the metric.
|
3303
3356
|
# @return [String]
|
3304
3357
|
#
|
3305
3358
|
# @!attribute [rw] metric_name
|
@@ -3525,6 +3578,9 @@ module Aws::CloudWatch
|
|
3525
3578
|
# value: "TagValue", # required
|
3526
3579
|
# },
|
3527
3580
|
# ],
|
3581
|
+
# actions_suppressor: "AlarmArn",
|
3582
|
+
# actions_suppressor_wait_period: 1,
|
3583
|
+
# actions_suppressor_extension_period: 1,
|
3528
3584
|
# }
|
3529
3585
|
#
|
3530
3586
|
# @!attribute [rw] actions_enabled
|
@@ -3635,6 +3691,29 @@ module Aws::CloudWatch
|
|
3635
3691
|
# values.
|
3636
3692
|
# @return [Array<Types::Tag>]
|
3637
3693
|
#
|
3694
|
+
# @!attribute [rw] actions_suppressor
|
3695
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
3696
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
3697
|
+
# Name (ARN) from an existing alarm.
|
3698
|
+
# @return [String]
|
3699
|
+
#
|
3700
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
3701
|
+
# The maximum time in seconds that the composite alarm waits for the
|
3702
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
3703
|
+
# composite alarm performs its actions.
|
3704
|
+
#
|
3705
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
3706
|
+
# @return [Integer]
|
3707
|
+
#
|
3708
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
3709
|
+
# The maximum time in seconds that the composite alarm waits after
|
3710
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
3711
|
+
# composite alarm performs its actions.
|
3712
|
+
#
|
3713
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
3714
|
+
# specified.
|
3715
|
+
# @return [Integer]
|
3716
|
+
#
|
3638
3717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarmInput AWS API Documentation
|
3639
3718
|
#
|
3640
3719
|
class PutCompositeAlarmInput < Struct.new(
|
@@ -3645,7 +3724,10 @@ module Aws::CloudWatch
|
|
3645
3724
|
:alarm_rule,
|
3646
3725
|
:insufficient_data_actions,
|
3647
3726
|
:ok_actions,
|
3648
|
-
:tags
|
3727
|
+
:tags,
|
3728
|
+
:actions_suppressor,
|
3729
|
+
:actions_suppressor_wait_period,
|
3730
|
+
:actions_suppressor_extension_period)
|
3649
3731
|
SENSITIVE = []
|
3650
3732
|
include Aws::Structure
|
3651
3733
|
end
|
@@ -4000,7 +4082,7 @@ module Aws::CloudWatch
|
|
4000
4082
|
#
|
4001
4083
|
# However, if the metric is published with multiple types of units and
|
4002
4084
|
# you don't specify a unit, the alarm's behavior is not defined and
|
4003
|
-
# it behaves
|
4085
|
+
# it behaves unpredictably.
|
4004
4086
|
#
|
4005
4087
|
# We recommend omitting `Unit` so that you don't inadvertently
|
4006
4088
|
# specify an incorrect unit that is not published for this metric.
|
@@ -4056,6 +4138,13 @@ module Aws::CloudWatch
|
|
4056
4138
|
#
|
4057
4139
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
4058
4140
|
#
|
4141
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
4142
|
+
# `ignore` missing data even if you choose a different option for
|
4143
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
4144
|
+
# alarms that evaluate that metric remain in their current state.
|
4145
|
+
#
|
4146
|
+
# </note>
|
4147
|
+
#
|
4059
4148
|
#
|
4060
4149
|
#
|
4061
4150
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -4199,7 +4288,7 @@ module Aws::CloudWatch
|
|
4199
4288
|
# @return [String]
|
4200
4289
|
#
|
4201
4290
|
# @!attribute [rw] metric_data
|
4202
|
-
# The data for the metric. The array can include no more than
|
4291
|
+
# The data for the metric. The array can include no more than 1000
|
4203
4292
|
# metrics per call.
|
4204
4293
|
# @return [Array<Types::MetricDatum>]
|
4205
4294
|
#
|
@@ -4328,16 +4417,18 @@ module Aws::CloudWatch
|
|
4328
4417
|
# @!attribute [rw] statistics_configurations
|
4329
4418
|
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`,
|
4330
4419
|
# and `SAMPLECOUNT` statistics for each metric that is streamed. You
|
4331
|
-
# can use this parameter to have the metric stream also send
|
4332
|
-
# statistics in the stream. This array can have up to 100
|
4420
|
+
# can use this parameter to have the metric stream also send
|
4421
|
+
# additional statistics in the stream. This array can have up to 100
|
4422
|
+
# members.
|
4333
4423
|
#
|
4334
4424
|
# For each entry in this array, you specify one or more metrics and
|
4335
|
-
# the list of
|
4336
|
-
#
|
4425
|
+
# the list of additional statistics to stream for those metrics. The
|
4426
|
+
# additional statistics that you can stream depend on the stream's
|
4337
4427
|
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
4338
|
-
#
|
4428
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
4339
4429
|
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
4340
|
-
# `opentelemetry0.7`, you can stream percentile statistics
|
4430
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as
|
4431
|
+
# p95, p99.9 and so on.
|
4341
4432
|
#
|
4342
4433
|
#
|
4343
4434
|
#
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudwatch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.66.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|