aws-sdk-cloudwatch 1.141.0 → 1.142.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +13 -0
- data/lib/aws-sdk-cloudwatch/client.rb +31 -1
- data/lib/aws-sdk-cloudwatch/client_api.rb +18 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +27 -0
- data/lib/aws-sdk-cloudwatch/types.rb +128 -0
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- data/sig/alarm.rbs +3 -0
- data/sig/client.rbs +7 -0
- data/sig/metric.rbs +7 -0
- data/sig/types.rbs +24 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8990c95d2a07080763d10b908545fac70c1df060e6792672116e3b8c88158119
|
|
4
|
+
data.tar.gz: a3ea5ad4e31d7c0bd14d6896f2275148b55bf94d6995d8b4e6513b7ce10ba844
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ef59b6f84e4fcd1e2332794305ce1b8788345babb41bfa0d78cf6227f90aa93a81a859cbfcf5a171ae044bc427f2158500a4d30ea7a613ca34351217c09b8864
|
|
7
|
+
data.tar.gz: 7bd7d6760fcfa0f2fb2ec1d882433e212431280bfae9425f34b4f28e1306778cadea52758f2084dc76fe09c15947e43c24fc37779d7a8418f8f3b93cabd89320
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.142.0 (2026-06-30)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Customers can configure alarms with wall-clock-aligned evaluation windows instead of sliding windows, with optional timezone support for daily or weekly periods
|
|
8
|
+
|
|
4
9
|
1.141.0 (2026-06-29)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.142.0
|
|
@@ -256,6 +256,19 @@ module Aws::CloudWatch
|
|
|
256
256
|
data[:state_transitioned_timestamp]
|
|
257
257
|
end
|
|
258
258
|
|
|
259
|
+
# The evaluation window that the alarm uses to select the range of
|
|
260
|
+
# metric data that it evaluates. This is either a sliding window or a
|
|
261
|
+
# wall clock window. For more information, see [Alarm evaluation
|
|
262
|
+
# windows][1] in the *CloudWatch User Guide*.
|
|
263
|
+
#
|
|
264
|
+
#
|
|
265
|
+
#
|
|
266
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
267
|
+
# @return [Types::EvaluationWindow]
|
|
268
|
+
def evaluation_window
|
|
269
|
+
data[:evaluation_window]
|
|
270
|
+
end
|
|
271
|
+
|
|
259
272
|
# The evaluation criteria for the alarm.
|
|
260
273
|
# @return [Types::EvaluationCriteria]
|
|
261
274
|
def evaluation_criteria
|
|
@@ -1212,6 +1212,7 @@ module Aws::CloudWatch
|
|
|
1212
1212
|
# resp.metric_alarms[0].threshold_metric_id #=> String
|
|
1213
1213
|
# resp.metric_alarms[0].evaluation_state #=> String, one of "PARTIAL_DATA", "EVALUATION_FAILURE", "EVALUATION_ERROR"
|
|
1214
1214
|
# resp.metric_alarms[0].state_transitioned_timestamp #=> Time
|
|
1215
|
+
# resp.metric_alarms[0].evaluation_window.wall_clock_window.timezone #=> String
|
|
1215
1216
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.query #=> String
|
|
1216
1217
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.pending_period #=> Integer
|
|
1217
1218
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.recovery_period #=> Integer
|
|
@@ -1376,6 +1377,7 @@ module Aws::CloudWatch
|
|
|
1376
1377
|
# resp.metric_alarms[0].threshold_metric_id #=> String
|
|
1377
1378
|
# resp.metric_alarms[0].evaluation_state #=> String, one of "PARTIAL_DATA", "EVALUATION_FAILURE", "EVALUATION_ERROR"
|
|
1378
1379
|
# resp.metric_alarms[0].state_transitioned_timestamp #=> Time
|
|
1380
|
+
# resp.metric_alarms[0].evaluation_window.wall_clock_window.timezone #=> String
|
|
1379
1381
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.query #=> String
|
|
1380
1382
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.pending_period #=> Integer
|
|
1381
1383
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.recovery_period #=> Integer
|
|
@@ -4521,6 +4523,27 @@ module Aws::CloudWatch
|
|
|
4521
4523
|
# If your alarm uses this parameter, it cannot have Auto Scaling
|
|
4522
4524
|
# actions.
|
|
4523
4525
|
#
|
|
4526
|
+
# @option params [Types::EvaluationWindow] :evaluation_window
|
|
4527
|
+
# The evaluation window that the alarm uses to select the range of
|
|
4528
|
+
# metric data that it evaluates. Specify either a sliding window or a
|
|
4529
|
+
# wall clock window. If you omit this parameter, the alarm uses a
|
|
4530
|
+
# sliding window.
|
|
4531
|
+
#
|
|
4532
|
+
# A sliding window advances each time the alarm is evaluated, forming a
|
|
4533
|
+
# rolling time window. A wall clock window aligns the evaluated range to
|
|
4534
|
+
# fixed clock boundaries, such as the top of the hour or the start of
|
|
4535
|
+
# the day.
|
|
4536
|
+
#
|
|
4537
|
+
# You can use `EvaluationWindow` with any type of metric alarm except
|
|
4538
|
+
# alarms that are based on a PromQL query.
|
|
4539
|
+
#
|
|
4540
|
+
# For more information, see [Alarm evaluation windows][1] in the
|
|
4541
|
+
# *CloudWatch User Guide*.
|
|
4542
|
+
#
|
|
4543
|
+
#
|
|
4544
|
+
#
|
|
4545
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
4546
|
+
#
|
|
4524
4547
|
# @option params [Types::EvaluationCriteria] :evaluation_criteria
|
|
4525
4548
|
# The evaluation criteria for the alarm. For each `PutMetricAlarm`
|
|
4526
4549
|
# operation, you must specify either `MetricName`, a `Metrics` array, or
|
|
@@ -4606,6 +4629,13 @@ module Aws::CloudWatch
|
|
|
4606
4629
|
# },
|
|
4607
4630
|
# ],
|
|
4608
4631
|
# threshold_metric_id: "MetricId",
|
|
4632
|
+
# evaluation_window: {
|
|
4633
|
+
# wall_clock_window: {
|
|
4634
|
+
# timezone: "Timezone",
|
|
4635
|
+
# },
|
|
4636
|
+
# sliding_window: {
|
|
4637
|
+
# },
|
|
4638
|
+
# },
|
|
4609
4639
|
# evaluation_criteria: {
|
|
4610
4640
|
# prom_ql_criteria: {
|
|
4611
4641
|
# query: "Query", # required
|
|
@@ -5320,7 +5350,7 @@ module Aws::CloudWatch
|
|
|
5320
5350
|
tracer: tracer
|
|
5321
5351
|
)
|
|
5322
5352
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
|
5323
|
-
context[:gem_version] = '1.
|
|
5353
|
+
context[:gem_version] = '1.142.0'
|
|
5324
5354
|
Seahorse::Client::Request.new(handlers, context)
|
|
5325
5355
|
end
|
|
5326
5356
|
|
|
@@ -139,6 +139,7 @@ module Aws::CloudWatch
|
|
|
139
139
|
EvaluationInterval = Shapes::IntegerShape.new(name: 'EvaluationInterval')
|
|
140
140
|
EvaluationPeriods = Shapes::IntegerShape.new(name: 'EvaluationPeriods')
|
|
141
141
|
EvaluationState = Shapes::StringShape.new(name: 'EvaluationState')
|
|
142
|
+
EvaluationWindow = Shapes::UnionShape.new(name: 'EvaluationWindow')
|
|
142
143
|
ExceptionType = Shapes::StringShape.new(name: 'ExceptionType')
|
|
143
144
|
Expression = Shapes::StringShape.new(name: 'Expression')
|
|
144
145
|
ExtendedStatistic = Shapes::StringShape.new(name: 'ExtendedStatistic')
|
|
@@ -327,6 +328,7 @@ module Aws::CloudWatch
|
|
|
327
328
|
SetAlarmStateInput = Shapes::StructureShape.new(name: 'SetAlarmStateInput')
|
|
328
329
|
SingleMetricAnomalyDetector = Shapes::StructureShape.new(name: 'SingleMetricAnomalyDetector')
|
|
329
330
|
Size = Shapes::IntegerShape.new(name: 'Size')
|
|
331
|
+
SlidingWindow = Shapes::StructureShape.new(name: 'SlidingWindow')
|
|
330
332
|
StandardUnit = Shapes::StringShape.new(name: 'StandardUnit')
|
|
331
333
|
StartMetricStreamsInput = Shapes::StructureShape.new(name: 'StartMetricStreamsInput')
|
|
332
334
|
StartMetricStreamsOutput = Shapes::StructureShape.new(name: 'StartMetricStreamsOutput')
|
|
@@ -365,6 +367,7 @@ module Aws::CloudWatch
|
|
|
365
367
|
UntagResourceInput = Shapes::StructureShape.new(name: 'UntagResourceInput')
|
|
366
368
|
UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput')
|
|
367
369
|
Values = Shapes::ListShape.new(name: 'Values')
|
|
370
|
+
WallClockWindow = Shapes::StructureShape.new(name: 'WallClockWindow')
|
|
368
371
|
|
|
369
372
|
AlarmContributor.add_member(:contributor_id, Shapes::ShapeRef.new(shape: ContributorId, required: true, location_name: "ContributorId"))
|
|
370
373
|
AlarmContributor.add_member(:contributor_attributes, Shapes::ShapeRef.new(shape: ContributorAttributes, required: true, location_name: "ContributorAttributes"))
|
|
@@ -669,6 +672,14 @@ module Aws::CloudWatch
|
|
|
669
672
|
EvaluationCriteria.add_member_subclass(:unknown, Types::EvaluationCriteria::Unknown)
|
|
670
673
|
EvaluationCriteria.struct_class = Types::EvaluationCriteria
|
|
671
674
|
|
|
675
|
+
EvaluationWindow.add_member(:wall_clock_window, Shapes::ShapeRef.new(shape: WallClockWindow, location_name: "WallClockWindow"))
|
|
676
|
+
EvaluationWindow.add_member(:sliding_window, Shapes::ShapeRef.new(shape: SlidingWindow, location_name: "SlidingWindow"))
|
|
677
|
+
EvaluationWindow.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
678
|
+
EvaluationWindow.add_member_subclass(:wall_clock_window, Types::EvaluationWindow::WallClockWindow)
|
|
679
|
+
EvaluationWindow.add_member_subclass(:sliding_window, Types::EvaluationWindow::SlidingWindow)
|
|
680
|
+
EvaluationWindow.add_member_subclass(:unknown, Types::EvaluationWindow::Unknown)
|
|
681
|
+
EvaluationWindow.struct_class = Types::EvaluationWindow
|
|
682
|
+
|
|
672
683
|
ExtendedStatistics.member = Shapes::ShapeRef.new(shape: ExtendedStatistic)
|
|
673
684
|
|
|
674
685
|
GetAlarmMuteRuleInput.add_member(:alarm_mute_rule_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "AlarmMuteRuleName"))
|
|
@@ -991,6 +1002,7 @@ module Aws::CloudWatch
|
|
|
991
1002
|
MetricAlarm.add_member(:threshold_metric_id, Shapes::ShapeRef.new(shape: MetricId, location_name: "ThresholdMetricId"))
|
|
992
1003
|
MetricAlarm.add_member(:evaluation_state, Shapes::ShapeRef.new(shape: EvaluationState, location_name: "EvaluationState"))
|
|
993
1004
|
MetricAlarm.add_member(:state_transitioned_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateTransitionedTimestamp"))
|
|
1005
|
+
MetricAlarm.add_member(:evaluation_window, Shapes::ShapeRef.new(shape: EvaluationWindow, location_name: "EvaluationWindow"))
|
|
994
1006
|
MetricAlarm.add_member(:evaluation_criteria, Shapes::ShapeRef.new(shape: EvaluationCriteria, location_name: "EvaluationCriteria"))
|
|
995
1007
|
MetricAlarm.add_member(:evaluation_interval, Shapes::ShapeRef.new(shape: EvaluationInterval, location_name: "EvaluationInterval"))
|
|
996
1008
|
MetricAlarm.struct_class = Types::MetricAlarm
|
|
@@ -1194,6 +1206,7 @@ module Aws::CloudWatch
|
|
|
1194
1206
|
PutMetricAlarmInput.add_member(:metrics, Shapes::ShapeRef.new(shape: MetricDataQueries, location_name: "Metrics"))
|
|
1195
1207
|
PutMetricAlarmInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
|
1196
1208
|
PutMetricAlarmInput.add_member(:threshold_metric_id, Shapes::ShapeRef.new(shape: MetricId, location_name: "ThresholdMetricId"))
|
|
1209
|
+
PutMetricAlarmInput.add_member(:evaluation_window, Shapes::ShapeRef.new(shape: EvaluationWindow, location_name: "EvaluationWindow"))
|
|
1197
1210
|
PutMetricAlarmInput.add_member(:evaluation_criteria, Shapes::ShapeRef.new(shape: EvaluationCriteria, location_name: "EvaluationCriteria"))
|
|
1198
1211
|
PutMetricAlarmInput.add_member(:evaluation_interval, Shapes::ShapeRef.new(shape: EvaluationInterval, location_name: "EvaluationInterval"))
|
|
1199
1212
|
PutMetricAlarmInput.struct_class = Types::PutMetricAlarmInput
|
|
@@ -1269,6 +1282,8 @@ module Aws::CloudWatch
|
|
|
1269
1282
|
SingleMetricAnomalyDetector.add_member(:stat, Shapes::ShapeRef.new(shape: AnomalyDetectorMetricStat, location_name: "Stat"))
|
|
1270
1283
|
SingleMetricAnomalyDetector.struct_class = Types::SingleMetricAnomalyDetector
|
|
1271
1284
|
|
|
1285
|
+
SlidingWindow.struct_class = Types::SlidingWindow
|
|
1286
|
+
|
|
1272
1287
|
StartMetricStreamsInput.add_member(:names, Shapes::ShapeRef.new(shape: MetricStreamNames, required: true, location_name: "Names"))
|
|
1273
1288
|
StartMetricStreamsInput.struct_class = Types::StartMetricStreamsInput
|
|
1274
1289
|
|
|
@@ -1319,6 +1334,9 @@ module Aws::CloudWatch
|
|
|
1319
1334
|
|
|
1320
1335
|
Values.member = Shapes::ShapeRef.new(shape: DatapointValue)
|
|
1321
1336
|
|
|
1337
|
+
WallClockWindow.add_member(:timezone, Shapes::ShapeRef.new(shape: Timezone, location_name: "Timezone"))
|
|
1338
|
+
WallClockWindow.struct_class = Types::WallClockWindow
|
|
1339
|
+
|
|
1322
1340
|
|
|
1323
1341
|
# @api private
|
|
1324
1342
|
API = Seahorse::Model::Api.new.tap do |api|
|
|
@@ -367,6 +367,13 @@ module Aws::CloudWatch
|
|
|
367
367
|
# },
|
|
368
368
|
# ],
|
|
369
369
|
# threshold_metric_id: "MetricId",
|
|
370
|
+
# evaluation_window: {
|
|
371
|
+
# wall_clock_window: {
|
|
372
|
+
# timezone: "Timezone",
|
|
373
|
+
# },
|
|
374
|
+
# sliding_window: {
|
|
375
|
+
# },
|
|
376
|
+
# },
|
|
370
377
|
# evaluation_criteria: {
|
|
371
378
|
# prom_ql_criteria: {
|
|
372
379
|
# query: "Query", # required
|
|
@@ -769,6 +776,26 @@ module Aws::CloudWatch
|
|
|
769
776
|
#
|
|
770
777
|
# If your alarm uses this parameter, it cannot have Auto Scaling
|
|
771
778
|
# actions.
|
|
779
|
+
# @option options [Types::EvaluationWindow] :evaluation_window
|
|
780
|
+
# The evaluation window that the alarm uses to select the range of
|
|
781
|
+
# metric data that it evaluates. Specify either a sliding window or a
|
|
782
|
+
# wall clock window. If you omit this parameter, the alarm uses a
|
|
783
|
+
# sliding window.
|
|
784
|
+
#
|
|
785
|
+
# A sliding window advances each time the alarm is evaluated, forming a
|
|
786
|
+
# rolling time window. A wall clock window aligns the evaluated range to
|
|
787
|
+
# fixed clock boundaries, such as the top of the hour or the start of
|
|
788
|
+
# the day.
|
|
789
|
+
#
|
|
790
|
+
# You can use `EvaluationWindow` with any type of metric alarm except
|
|
791
|
+
# alarms that are based on a PromQL query.
|
|
792
|
+
#
|
|
793
|
+
# For more information, see [Alarm evaluation windows][1] in the
|
|
794
|
+
# *CloudWatch User Guide*.
|
|
795
|
+
#
|
|
796
|
+
#
|
|
797
|
+
#
|
|
798
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
772
799
|
# @option options [Types::EvaluationCriteria] :evaluation_criteria
|
|
773
800
|
# The evaluation criteria for the alarm. For each `PutMetricAlarm`
|
|
774
801
|
# operation, you must specify either `MetricName`, a `Metrics` array, or
|
|
@@ -1414,6 +1414,50 @@ module Aws::CloudWatch
|
|
|
1414
1414
|
class Unknown < EvaluationCriteria; end
|
|
1415
1415
|
end
|
|
1416
1416
|
|
|
1417
|
+
# The evaluation window that an alarm uses to select the range of metric
|
|
1418
|
+
# data that it evaluates each time it runs. This is a union type. Set
|
|
1419
|
+
# exactly one of its members, `SlidingWindow` or `WallClockWindow`. If
|
|
1420
|
+
# you don't set `EvaluationWindow`, the alarm uses a `SlidingWindow` by
|
|
1421
|
+
# default.
|
|
1422
|
+
#
|
|
1423
|
+
# For more information, see [Alarm evaluation windows][1] in the
|
|
1424
|
+
# *CloudWatch User Guide*.
|
|
1425
|
+
#
|
|
1426
|
+
#
|
|
1427
|
+
#
|
|
1428
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
1429
|
+
#
|
|
1430
|
+
# @note EvaluationWindow is a union - when making an API calls you must set exactly one of the members.
|
|
1431
|
+
#
|
|
1432
|
+
# @note EvaluationWindow is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationWindow corresponding to the set member.
|
|
1433
|
+
#
|
|
1434
|
+
# @!attribute [rw] wall_clock_window
|
|
1435
|
+
# A wall clock window, which aligns the evaluated range to fixed clock
|
|
1436
|
+
# boundaries that match the alarm's period, such as the top of the
|
|
1437
|
+
# hour, midnight, or the start of the calendar week.
|
|
1438
|
+
# @return [Types::WallClockWindow]
|
|
1439
|
+
#
|
|
1440
|
+
# @!attribute [rw] sliding_window
|
|
1441
|
+
# A sliding window, which advances each time the alarm is evaluated,
|
|
1442
|
+
# forming a rolling time window. This is the default evaluation
|
|
1443
|
+
# window.
|
|
1444
|
+
# @return [Types::SlidingWindow]
|
|
1445
|
+
#
|
|
1446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EvaluationWindow AWS API Documentation
|
|
1447
|
+
#
|
|
1448
|
+
class EvaluationWindow < Struct.new(
|
|
1449
|
+
:wall_clock_window,
|
|
1450
|
+
:sliding_window,
|
|
1451
|
+
:unknown)
|
|
1452
|
+
SENSITIVE = []
|
|
1453
|
+
include Aws::Structure
|
|
1454
|
+
include Aws::Structure::Union
|
|
1455
|
+
|
|
1456
|
+
class WallClockWindow < EvaluationWindow; end
|
|
1457
|
+
class SlidingWindow < EvaluationWindow; end
|
|
1458
|
+
class Unknown < EvaluationWindow; end
|
|
1459
|
+
end
|
|
1460
|
+
|
|
1417
1461
|
# @!attribute [rw] alarm_mute_rule_name
|
|
1418
1462
|
# The name of the alarm mute rule to retrieve.
|
|
1419
1463
|
# @return [String]
|
|
@@ -3320,6 +3364,17 @@ module Aws::CloudWatch
|
|
|
3320
3364
|
# changed.
|
|
3321
3365
|
# @return [Time]
|
|
3322
3366
|
#
|
|
3367
|
+
# @!attribute [rw] evaluation_window
|
|
3368
|
+
# The evaluation window that the alarm uses to select the range of
|
|
3369
|
+
# metric data that it evaluates. This is either a sliding window or a
|
|
3370
|
+
# wall clock window. For more information, see [Alarm evaluation
|
|
3371
|
+
# windows][1] in the *CloudWatch User Guide*.
|
|
3372
|
+
#
|
|
3373
|
+
#
|
|
3374
|
+
#
|
|
3375
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
3376
|
+
# @return [Types::EvaluationWindow]
|
|
3377
|
+
#
|
|
3323
3378
|
# @!attribute [rw] evaluation_criteria
|
|
3324
3379
|
# The evaluation criteria for the alarm.
|
|
3325
3380
|
# @return [Types::EvaluationCriteria]
|
|
@@ -3360,6 +3415,7 @@ module Aws::CloudWatch
|
|
|
3360
3415
|
:threshold_metric_id,
|
|
3361
3416
|
:evaluation_state,
|
|
3362
3417
|
:state_transitioned_timestamp,
|
|
3418
|
+
:evaluation_window,
|
|
3363
3419
|
:evaluation_criteria,
|
|
3364
3420
|
:evaluation_interval)
|
|
3365
3421
|
SENSITIVE = []
|
|
@@ -5146,6 +5202,28 @@ module Aws::CloudWatch
|
|
|
5146
5202
|
# actions.
|
|
5147
5203
|
# @return [String]
|
|
5148
5204
|
#
|
|
5205
|
+
# @!attribute [rw] evaluation_window
|
|
5206
|
+
# The evaluation window that the alarm uses to select the range of
|
|
5207
|
+
# metric data that it evaluates. Specify either a sliding window or a
|
|
5208
|
+
# wall clock window. If you omit this parameter, the alarm uses a
|
|
5209
|
+
# sliding window.
|
|
5210
|
+
#
|
|
5211
|
+
# A sliding window advances each time the alarm is evaluated, forming
|
|
5212
|
+
# a rolling time window. A wall clock window aligns the evaluated
|
|
5213
|
+
# range to fixed clock boundaries, such as the top of the hour or the
|
|
5214
|
+
# start of the day.
|
|
5215
|
+
#
|
|
5216
|
+
# You can use `EvaluationWindow` with any type of metric alarm except
|
|
5217
|
+
# alarms that are based on a PromQL query.
|
|
5218
|
+
#
|
|
5219
|
+
# For more information, see [Alarm evaluation windows][1] in the
|
|
5220
|
+
# *CloudWatch User Guide*.
|
|
5221
|
+
#
|
|
5222
|
+
#
|
|
5223
|
+
#
|
|
5224
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html
|
|
5225
|
+
# @return [Types::EvaluationWindow]
|
|
5226
|
+
#
|
|
5149
5227
|
# @!attribute [rw] evaluation_criteria
|
|
5150
5228
|
# The evaluation criteria for the alarm. For each `PutMetricAlarm`
|
|
5151
5229
|
# operation, you must specify either `MetricName`, a `Metrics` array,
|
|
@@ -5197,6 +5275,7 @@ module Aws::CloudWatch
|
|
|
5197
5275
|
:metrics,
|
|
5198
5276
|
:tags,
|
|
5199
5277
|
:threshold_metric_id,
|
|
5278
|
+
:evaluation_window,
|
|
5200
5279
|
:evaluation_criteria,
|
|
5201
5280
|
:evaluation_interval)
|
|
5202
5281
|
SENSITIVE = []
|
|
@@ -5773,6 +5852,20 @@ module Aws::CloudWatch
|
|
|
5773
5852
|
include Aws::Structure
|
|
5774
5853
|
end
|
|
5775
5854
|
|
|
5855
|
+
# An evaluation window that advances each time the alarm is evaluated,
|
|
5856
|
+
# forming a rolling time window. This is the default evaluation window.
|
|
5857
|
+
# A sliding window has no additional configuration options.
|
|
5858
|
+
#
|
|
5859
|
+
# Choose a sliding window when you need the fastest detection and the
|
|
5860
|
+
# calendar boundaries of the data don't matter, such as for continuous
|
|
5861
|
+
# performance, latency, or resource-exhaustion monitoring.
|
|
5862
|
+
#
|
|
5863
|
+
# @api private
|
|
5864
|
+
#
|
|
5865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SlidingWindow AWS API Documentation
|
|
5866
|
+
#
|
|
5867
|
+
class SlidingWindow < Aws::EmptyStructure; end
|
|
5868
|
+
|
|
5776
5869
|
# @!attribute [rw] names
|
|
5777
5870
|
# The array of the names of metric streams to start streaming.
|
|
5778
5871
|
#
|
|
@@ -5970,6 +6063,41 @@ module Aws::CloudWatch
|
|
|
5970
6063
|
#
|
|
5971
6064
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
|
5972
6065
|
|
|
6066
|
+
# An evaluation window that aligns the evaluated range to fixed clock
|
|
6067
|
+
# boundaries that match the alarm's period, such as the top of the
|
|
6068
|
+
# hour, midnight, or the start of the calendar week, optionally in a
|
|
6069
|
+
# specific time zone.
|
|
6070
|
+
#
|
|
6071
|
+
# When you use a wall clock window, the alarm's period must be 1 minute
|
|
6072
|
+
# (60 seconds), 5 minutes (300 seconds), 1 hour (3,600 seconds), 1 day
|
|
6073
|
+
# (86,400 seconds), or 1 week (604,800 seconds). Other period values
|
|
6074
|
+
# aren't supported with a wall clock window.
|
|
6075
|
+
#
|
|
6076
|
+
# Choose a wall clock window when your monitoring is tied to a business
|
|
6077
|
+
# or calendar period, such as daily reports, batch jobs, or backups, or
|
|
6078
|
+
# when you want alarm evaluations to match the periods shown on a metric
|
|
6079
|
+
# dashboard.
|
|
6080
|
+
#
|
|
6081
|
+
# @!attribute [rw] timezone
|
|
6082
|
+
# The time zone to use when the alarm aligns the evaluation window to
|
|
6083
|
+
# clock boundaries. You can specify an IANA time zone name (for
|
|
6084
|
+
# example, `America/New_York`), a fixed UTC offset (for example,
|
|
6085
|
+
# `+05:30`), or an offset-prefixed identifier (for example,
|
|
6086
|
+
# `UTC+05:30`). The offset must be aligned to a multiple of 5 minutes.
|
|
6087
|
+
# If you don't specify a time zone, CloudWatch uses `UTC`.
|
|
6088
|
+
#
|
|
6089
|
+
# The time zone affects window alignment for all periods, including
|
|
6090
|
+
# periods of one hour or shorter.
|
|
6091
|
+
# @return [String]
|
|
6092
|
+
#
|
|
6093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/WallClockWindow AWS API Documentation
|
|
6094
|
+
#
|
|
6095
|
+
class WallClockWindow < Struct.new(
|
|
6096
|
+
:timezone)
|
|
6097
|
+
SENSITIVE = []
|
|
6098
|
+
include Aws::Structure
|
|
6099
|
+
end
|
|
6100
|
+
|
|
5973
6101
|
end
|
|
5974
6102
|
end
|
|
5975
6103
|
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
data/sig/alarm.rbs
CHANGED
|
@@ -102,6 +102,9 @@ module Aws
|
|
|
102
102
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatch/Alarm.html#state_transitioned_timestamp-instance_method
|
|
103
103
|
def state_transitioned_timestamp: () -> ::Time
|
|
104
104
|
|
|
105
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatch/Alarm.html#evaluation_window-instance_method
|
|
106
|
+
def evaluation_window: () -> Types::EvaluationWindow
|
|
107
|
+
|
|
105
108
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudWatch/Alarm.html#evaluation_criteria-instance_method
|
|
106
109
|
def evaluation_criteria: () -> Types::EvaluationCriteria
|
|
107
110
|
|
data/sig/client.rbs
CHANGED
|
@@ -741,6 +741,13 @@ module Aws
|
|
|
741
741
|
}
|
|
742
742
|
],
|
|
743
743
|
?threshold_metric_id: ::String,
|
|
744
|
+
?evaluation_window: {
|
|
745
|
+
wall_clock_window: {
|
|
746
|
+
timezone: ::String?
|
|
747
|
+
}?,
|
|
748
|
+
sliding_window: {
|
|
749
|
+
}?
|
|
750
|
+
},
|
|
744
751
|
?evaluation_criteria: {
|
|
745
752
|
prom_ql_criteria: {
|
|
746
753
|
query: ::String,
|
data/sig/metric.rbs
CHANGED
|
@@ -110,6 +110,13 @@ module Aws
|
|
|
110
110
|
}
|
|
111
111
|
],
|
|
112
112
|
?threshold_metric_id: ::String,
|
|
113
|
+
?evaluation_window: {
|
|
114
|
+
wall_clock_window: {
|
|
115
|
+
timezone: ::String?
|
|
116
|
+
}?,
|
|
117
|
+
sliding_window: {
|
|
118
|
+
}?
|
|
119
|
+
},
|
|
113
120
|
?evaluation_criteria: {
|
|
114
121
|
prom_ql_criteria: {
|
|
115
122
|
query: ::String,
|
data/sig/types.rbs
CHANGED
|
@@ -358,6 +358,20 @@ module Aws::CloudWatch
|
|
|
358
358
|
end
|
|
359
359
|
end
|
|
360
360
|
|
|
361
|
+
class EvaluationWindow
|
|
362
|
+
attr_accessor wall_clock_window: Types::WallClockWindow
|
|
363
|
+
attr_accessor sliding_window: Types::SlidingWindow
|
|
364
|
+
attr_accessor unknown: untyped
|
|
365
|
+
SENSITIVE: []
|
|
366
|
+
|
|
367
|
+
class WallClockWindow < EvaluationWindow
|
|
368
|
+
end
|
|
369
|
+
class SlidingWindow < EvaluationWindow
|
|
370
|
+
end
|
|
371
|
+
class Unknown < EvaluationWindow
|
|
372
|
+
end
|
|
373
|
+
end
|
|
374
|
+
|
|
361
375
|
class GetAlarmMuteRuleInput
|
|
362
376
|
attr_accessor alarm_mute_rule_name: ::String
|
|
363
377
|
SENSITIVE: []
|
|
@@ -755,6 +769,7 @@ module Aws::CloudWatch
|
|
|
755
769
|
attr_accessor threshold_metric_id: ::String
|
|
756
770
|
attr_accessor evaluation_state: ("PARTIAL_DATA" | "EVALUATION_FAILURE" | "EVALUATION_ERROR")
|
|
757
771
|
attr_accessor state_transitioned_timestamp: ::Time
|
|
772
|
+
attr_accessor evaluation_window: Types::EvaluationWindow
|
|
758
773
|
attr_accessor evaluation_criteria: Types::EvaluationCriteria
|
|
759
774
|
attr_accessor evaluation_interval: ::Integer
|
|
760
775
|
SENSITIVE: []
|
|
@@ -976,6 +991,7 @@ module Aws::CloudWatch
|
|
|
976
991
|
attr_accessor metrics: ::Array[Types::MetricDataQuery]
|
|
977
992
|
attr_accessor tags: ::Array[Types::Tag]
|
|
978
993
|
attr_accessor threshold_metric_id: ::String
|
|
994
|
+
attr_accessor evaluation_window: Types::EvaluationWindow
|
|
979
995
|
attr_accessor evaluation_criteria: Types::EvaluationCriteria
|
|
980
996
|
attr_accessor evaluation_interval: ::Integer
|
|
981
997
|
SENSITIVE: []
|
|
@@ -1076,6 +1092,9 @@ module Aws::CloudWatch
|
|
|
1076
1092
|
SENSITIVE: []
|
|
1077
1093
|
end
|
|
1078
1094
|
|
|
1095
|
+
class SlidingWindow < Aws::EmptyStructure
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1079
1098
|
class StartMetricStreamsInput
|
|
1080
1099
|
attr_accessor names: ::Array[::String]
|
|
1081
1100
|
SENSITIVE: []
|
|
@@ -1135,5 +1154,10 @@ module Aws::CloudWatch
|
|
|
1135
1154
|
|
|
1136
1155
|
class UntagResourceOutput < Aws::EmptyStructure
|
|
1137
1156
|
end
|
|
1157
|
+
|
|
1158
|
+
class WallClockWindow
|
|
1159
|
+
attr_accessor timezone: ::String
|
|
1160
|
+
SENSITIVE: []
|
|
1161
|
+
end
|
|
1138
1162
|
end
|
|
1139
1163
|
end
|