aws-sdk-cloudwatch 1.140.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +16 -3
- data/lib/aws-sdk-cloudwatch/client.rb +306 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +108 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +3 -3
- data/lib/aws-sdk-cloudwatch/errors.rb +16 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +27 -0
- data/lib/aws-sdk-cloudwatch/resource.rb +18 -12
- data/lib/aws-sdk-cloudwatch/types.rb +574 -10
- data/lib/aws-sdk-cloudwatch/waiters.rb +37 -0
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- data/sig/alarm.rbs +4 -1
- data/sig/client.rbs +66 -4
- data/sig/composite_alarm.rbs +1 -1
- data/sig/errors.rbs +3 -0
- data/sig/metric.rbs +7 -0
- data/sig/resource.rbs +2 -2
- data/sig/types.rbs +96 -3
- data/sig/waiters.rbs +20 -2
- 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,16 @@
|
|
|
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
|
+
|
|
9
|
+
1.141.0 (2026-06-29)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - This release adds the API (PutLogAlarm) to manage a new CloudWatch resource, Log Based Alarms. Log Based Alarms allows customers to alarm directly on CloudWatch Logs query results.
|
|
13
|
+
|
|
4
14
|
1.140.0 (2026-06-09)
|
|
5
15
|
------------------
|
|
6
16
|
|
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
|
|
@@ -456,7 +469,7 @@ module Aws::CloudWatch
|
|
|
456
469
|
#
|
|
457
470
|
# alarm.describe_history({
|
|
458
471
|
# alarm_contributor_id: "ContributorId",
|
|
459
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
472
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
460
473
|
# history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action, AlarmContributorStateUpdate, AlarmContributorAction
|
|
461
474
|
# start_date: Time.now,
|
|
462
475
|
# end_date: Time.now,
|
|
@@ -470,8 +483,8 @@ module Aws::CloudWatch
|
|
|
470
483
|
# alarm history results.
|
|
471
484
|
# @option options [Array<String>] :alarm_types
|
|
472
485
|
# Use this parameter to specify whether you want the operation to return
|
|
473
|
-
# metric alarms or
|
|
474
|
-
# metric alarms are returned.
|
|
486
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
487
|
+
# parameter, only metric alarms are returned.
|
|
475
488
|
# @option options [String] :history_item_type
|
|
476
489
|
# The type of alarm histories to retrieve.
|
|
477
490
|
# @option options [Time,DateTime,Date,Integer,String] :start_date
|
|
@@ -623,7 +623,8 @@ module Aws::CloudWatch
|
|
|
623
623
|
# operation. However, this total can include no more than one composite
|
|
624
624
|
# alarm. For example, you could delete 99 metric alarms and one
|
|
625
625
|
# composite alarms with one operation, but you can't delete two
|
|
626
|
-
# composite alarms with one operation.
|
|
626
|
+
# composite alarms with one operation. Log alarms cannot be batch
|
|
627
|
+
# deleted.
|
|
627
628
|
#
|
|
628
629
|
# If you specify any incorrect alarm names, the alarms you specify with
|
|
629
630
|
# correct names are still deleted. Other syntax errors might result in
|
|
@@ -952,8 +953,8 @@ module Aws::CloudWatch
|
|
|
952
953
|
#
|
|
953
954
|
# @option params [Array<String>] :alarm_types
|
|
954
955
|
# Use this parameter to specify whether you want the operation to return
|
|
955
|
-
# metric alarms or
|
|
956
|
-
# metric alarms are returned.
|
|
956
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
957
|
+
# parameter, only metric alarms are returned.
|
|
957
958
|
#
|
|
958
959
|
# @option params [String] :history_item_type
|
|
959
960
|
# The type of alarm histories to retrieve.
|
|
@@ -989,7 +990,7 @@ module Aws::CloudWatch
|
|
|
989
990
|
# resp = client.describe_alarm_history({
|
|
990
991
|
# alarm_name: "AlarmName",
|
|
991
992
|
# alarm_contributor_id: "ContributorId",
|
|
992
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
993
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
993
994
|
# history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action, AlarmContributorStateUpdate, AlarmContributorAction
|
|
994
995
|
# start_date: Time.now,
|
|
995
996
|
# end_date: Time.now,
|
|
@@ -1003,7 +1004,7 @@ module Aws::CloudWatch
|
|
|
1003
1004
|
# resp.alarm_history_items #=> Array
|
|
1004
1005
|
# resp.alarm_history_items[0].alarm_name #=> String
|
|
1005
1006
|
# resp.alarm_history_items[0].alarm_contributor_id #=> String
|
|
1006
|
-
# resp.alarm_history_items[0].alarm_type #=> String, one of "CompositeAlarm", "MetricAlarm"
|
|
1007
|
+
# resp.alarm_history_items[0].alarm_type #=> String, one of "CompositeAlarm", "MetricAlarm", "LogAlarm"
|
|
1007
1008
|
# resp.alarm_history_items[0].timestamp #=> Time
|
|
1008
1009
|
# resp.alarm_history_items[0].history_item_type #=> String, one of "ConfigurationUpdate", "StateUpdate", "Action", "AlarmContributorStateUpdate", "AlarmContributorAction"
|
|
1009
1010
|
# resp.alarm_history_items[0].history_summary #=> String
|
|
@@ -1043,16 +1044,19 @@ module Aws::CloudWatch
|
|
|
1043
1044
|
#
|
|
1044
1045
|
# @option params [Array<String>] :alarm_types
|
|
1045
1046
|
# Use this parameter to specify whether you want the operation to return
|
|
1046
|
-
# metric alarms or
|
|
1047
|
-
# metric alarms are returned, even if composite alarms
|
|
1048
|
-
# account.
|
|
1047
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
1048
|
+
# parameter, only metric alarms are returned, even if composite alarms
|
|
1049
|
+
# or log alarms exist in the account.
|
|
1049
1050
|
#
|
|
1050
1051
|
# For example, if you omit this parameter or specify `MetricAlarms`, the
|
|
1051
1052
|
# operation returns only a list of metric alarms. It does not return any
|
|
1052
|
-
# composite alarms, even if
|
|
1053
|
+
# composite alarms or log alarms, even if they exist in the account.
|
|
1053
1054
|
#
|
|
1054
1055
|
# If you specify `CompositeAlarms`, the operation returns only a list of
|
|
1055
|
-
# composite alarms, and does not return any metric alarms.
|
|
1056
|
+
# composite alarms, and does not return any metric alarms or log alarms.
|
|
1057
|
+
#
|
|
1058
|
+
# If you specify `LogAlarms`, the operation returns only a list of log
|
|
1059
|
+
# alarms, and does not return any metric alarms or composite alarms.
|
|
1056
1060
|
#
|
|
1057
1061
|
# @option params [String] :children_of_alarm_name
|
|
1058
1062
|
# If you use this parameter and specify the name of a composite alarm,
|
|
@@ -1115,6 +1119,7 @@ module Aws::CloudWatch
|
|
|
1115
1119
|
#
|
|
1116
1120
|
# * {Types::DescribeAlarmsOutput#composite_alarms #composite_alarms} => Array<Types::CompositeAlarm>
|
|
1117
1121
|
# * {Types::DescribeAlarmsOutput#metric_alarms #metric_alarms} => Array<Types::MetricAlarm>
|
|
1122
|
+
# * {Types::DescribeAlarmsOutput#log_alarms #log_alarms} => Array<Types::LogAlarm>
|
|
1118
1123
|
# * {Types::DescribeAlarmsOutput#next_token #next_token} => String
|
|
1119
1124
|
#
|
|
1120
1125
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
@@ -1124,7 +1129,7 @@ module Aws::CloudWatch
|
|
|
1124
1129
|
# resp = client.describe_alarms({
|
|
1125
1130
|
# alarm_names: ["AlarmName"],
|
|
1126
1131
|
# alarm_name_prefix: "AlarmNamePrefix",
|
|
1127
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
1132
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
1128
1133
|
# children_of_alarm_name: "AlarmName",
|
|
1129
1134
|
# parents_of_alarm_name: "AlarmName",
|
|
1130
1135
|
# state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
|
|
@@ -1207,10 +1212,48 @@ module Aws::CloudWatch
|
|
|
1207
1212
|
# resp.metric_alarms[0].threshold_metric_id #=> String
|
|
1208
1213
|
# resp.metric_alarms[0].evaluation_state #=> String, one of "PARTIAL_DATA", "EVALUATION_FAILURE", "EVALUATION_ERROR"
|
|
1209
1214
|
# resp.metric_alarms[0].state_transitioned_timestamp #=> Time
|
|
1215
|
+
# resp.metric_alarms[0].evaluation_window.wall_clock_window.timezone #=> String
|
|
1210
1216
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.query #=> String
|
|
1211
1217
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.pending_period #=> Integer
|
|
1212
1218
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.recovery_period #=> Integer
|
|
1213
1219
|
# resp.metric_alarms[0].evaluation_interval #=> Integer
|
|
1220
|
+
# resp.log_alarms #=> Array
|
|
1221
|
+
# resp.log_alarms[0].alarm_name #=> String
|
|
1222
|
+
# resp.log_alarms[0].alarm_arn #=> String
|
|
1223
|
+
# resp.log_alarms[0].alarm_description #=> String
|
|
1224
|
+
# resp.log_alarms[0].alarm_configuration_updated_timestamp #=> Time
|
|
1225
|
+
# resp.log_alarms[0].actions_enabled #=> Boolean
|
|
1226
|
+
# resp.log_alarms[0].ok_actions #=> Array
|
|
1227
|
+
# resp.log_alarms[0].ok_actions[0] #=> String
|
|
1228
|
+
# resp.log_alarms[0].alarm_actions #=> Array
|
|
1229
|
+
# resp.log_alarms[0].alarm_actions[0] #=> String
|
|
1230
|
+
# resp.log_alarms[0].insufficient_data_actions #=> Array
|
|
1231
|
+
# resp.log_alarms[0].insufficient_data_actions[0] #=> String
|
|
1232
|
+
# resp.log_alarms[0].state_value #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
|
|
1233
|
+
# resp.log_alarms[0].state_reason #=> String
|
|
1234
|
+
# resp.log_alarms[0].state_reason_data #=> String
|
|
1235
|
+
# resp.log_alarms[0].state_updated_timestamp #=> Time
|
|
1236
|
+
# resp.log_alarms[0].scheduled_query_configuration.query_string #=> String
|
|
1237
|
+
# resp.log_alarms[0].scheduled_query_configuration.log_group_identifiers #=> Array
|
|
1238
|
+
# resp.log_alarms[0].scheduled_query_configuration.log_group_identifiers[0] #=> String
|
|
1239
|
+
# resp.log_alarms[0].scheduled_query_configuration.query_arn #=> String
|
|
1240
|
+
# resp.log_alarms[0].scheduled_query_configuration.scheduled_query_role_arn #=> String
|
|
1241
|
+
# resp.log_alarms[0].scheduled_query_configuration.schedule_configuration.schedule_expression #=> String
|
|
1242
|
+
# resp.log_alarms[0].scheduled_query_configuration.schedule_configuration.start_time_offset #=> Integer
|
|
1243
|
+
# resp.log_alarms[0].scheduled_query_configuration.schedule_configuration.end_time_offset #=> Integer
|
|
1244
|
+
# resp.log_alarms[0].scheduled_query_configuration.aggregation_expression #=> String
|
|
1245
|
+
# resp.log_alarms[0].scheduled_query_configuration.tags #=> Array
|
|
1246
|
+
# resp.log_alarms[0].scheduled_query_configuration.tags[0].key #=> String
|
|
1247
|
+
# resp.log_alarms[0].scheduled_query_configuration.tags[0].value #=> String
|
|
1248
|
+
# resp.log_alarms[0].query_results_to_evaluate #=> Integer
|
|
1249
|
+
# resp.log_alarms[0].query_results_to_alarm #=> Integer
|
|
1250
|
+
# resp.log_alarms[0].threshold #=> Float
|
|
1251
|
+
# resp.log_alarms[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold", "LessThanLowerOrGreaterThanUpperThreshold", "LessThanLowerThreshold", "GreaterThanUpperThreshold"
|
|
1252
|
+
# resp.log_alarms[0].treat_missing_data #=> String
|
|
1253
|
+
# resp.log_alarms[0].state_transitioned_timestamp #=> Time
|
|
1254
|
+
# resp.log_alarms[0].evaluation_state #=> String, one of "PARTIAL_DATA", "EVALUATION_FAILURE", "EVALUATION_ERROR"
|
|
1255
|
+
# resp.log_alarms[0].action_log_line_count #=> Integer
|
|
1256
|
+
# resp.log_alarms[0].action_log_line_role_arn #=> String
|
|
1214
1257
|
# resp.next_token #=> String
|
|
1215
1258
|
#
|
|
1216
1259
|
#
|
|
@@ -1218,6 +1261,7 @@ module Aws::CloudWatch
|
|
|
1218
1261
|
#
|
|
1219
1262
|
# * alarm_exists
|
|
1220
1263
|
# * composite_alarm_exists
|
|
1264
|
+
# * log_alarm_exists
|
|
1221
1265
|
#
|
|
1222
1266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms AWS API Documentation
|
|
1223
1267
|
#
|
|
@@ -1333,6 +1377,7 @@ module Aws::CloudWatch
|
|
|
1333
1377
|
# resp.metric_alarms[0].threshold_metric_id #=> String
|
|
1334
1378
|
# resp.metric_alarms[0].evaluation_state #=> String, one of "PARTIAL_DATA", "EVALUATION_FAILURE", "EVALUATION_ERROR"
|
|
1335
1379
|
# resp.metric_alarms[0].state_transitioned_timestamp #=> Time
|
|
1380
|
+
# resp.metric_alarms[0].evaluation_window.wall_clock_window.timezone #=> String
|
|
1336
1381
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.query #=> String
|
|
1337
1382
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.pending_period #=> Integer
|
|
1338
1383
|
# resp.metric_alarms[0].evaluation_criteria.prom_ql_criteria.recovery_period #=> Integer
|
|
@@ -2527,7 +2572,7 @@ module Aws::CloudWatch
|
|
|
2527
2572
|
#
|
|
2528
2573
|
#
|
|
2529
2574
|
#
|
|
2530
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
2575
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Widget-Structure.html
|
|
2531
2576
|
#
|
|
2532
2577
|
# @option params [String] :output_format
|
|
2533
2578
|
# The format of the resulting image. Only PNG images are supported.
|
|
@@ -3573,7 +3618,7 @@ module Aws::CloudWatch
|
|
|
3573
3618
|
#
|
|
3574
3619
|
#
|
|
3575
3620
|
#
|
|
3576
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
3621
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
3577
3622
|
#
|
|
3578
3623
|
# @option params [Array<Types::Tag>] :tags
|
|
3579
3624
|
# A list of key-value pairs to associate with the dashboard. You can
|
|
@@ -3720,6 +3765,222 @@ module Aws::CloudWatch
|
|
|
3720
3765
|
req.send_request(options)
|
|
3721
3766
|
end
|
|
3722
3767
|
|
|
3768
|
+
# Creates or updates a log alarm. A log alarm evaluates the results of a
|
|
3769
|
+
# CloudWatch Logs scheduled query against the configured threshold and
|
|
3770
|
+
# comparison operator to determine its state.
|
|
3771
|
+
#
|
|
3772
|
+
# When you create a log alarm, the operation creates a service-managed
|
|
3773
|
+
# CloudWatch Logs scheduled query that runs the query string you provide
|
|
3774
|
+
# on the schedule you configure. Each scheduled query execution returns
|
|
3775
|
+
# one or more aggregated values determined by the
|
|
3776
|
+
# `AggregationExpression`, and each aggregated value is compared against
|
|
3777
|
+
# the alarm `Threshold` to determine the alarm state. The alarm uses
|
|
3778
|
+
# M-out-of-N evaluation: if `QueryResultsToAlarm` out of the most recent
|
|
3779
|
+
# `QueryResultsToEvaluate` query results breach the threshold, the alarm
|
|
3780
|
+
# transitions to `ALARM`.
|
|
3781
|
+
#
|
|
3782
|
+
# Log alarms support the alarm states (`OK`, `ALARM`,
|
|
3783
|
+
# `INSUFFICIENT_DATA`). Configure transition actions using `OKActions`,
|
|
3784
|
+
# `AlarmActions`, and `InsufficientDataActions`.
|
|
3785
|
+
#
|
|
3786
|
+
# If you call this operation with the name of an existing log alarm, the
|
|
3787
|
+
# operation replaces the previous configuration of that alarm.
|
|
3788
|
+
#
|
|
3789
|
+
# **Permissions**
|
|
3790
|
+
#
|
|
3791
|
+
# To create or update a log alarm, you must have the
|
|
3792
|
+
# `cloudwatch:PutLogAlarm` permission. The IAM role specified in
|
|
3793
|
+
# `ScheduledQueryRoleARN` must grant the CloudWatch Alarms service
|
|
3794
|
+
# permission to execute scheduled queries on the specified log groups.
|
|
3795
|
+
# If you set `ActionLogLineCount`, the role specified in
|
|
3796
|
+
# `ActionLogLineRoleArn` must grant permission to retrieve log events
|
|
3797
|
+
# for inclusion in alarm notifications.
|
|
3798
|
+
#
|
|
3799
|
+
# @option params [required, String] :alarm_name
|
|
3800
|
+
# The name for the alarm. This name must be unique within the Amazon Web
|
|
3801
|
+
# Services account and Region.
|
|
3802
|
+
#
|
|
3803
|
+
# @option params [String] :alarm_description
|
|
3804
|
+
# The description for the alarm.
|
|
3805
|
+
#
|
|
3806
|
+
# @option params [required, Types::ScheduledQueryConfiguration] :scheduled_query_configuration
|
|
3807
|
+
# The configuration of the underlying CloudWatch Logs scheduled query
|
|
3808
|
+
# that this alarm evaluates, including the query string, log groups,
|
|
3809
|
+
# schedule, and aggregation expression.
|
|
3810
|
+
#
|
|
3811
|
+
# @option params [Integer] :action_log_line_count
|
|
3812
|
+
# The number of log lines from the most recent scheduled query execution
|
|
3813
|
+
# to include in alarm action notifications. Valid range is 0 through 50.
|
|
3814
|
+
# The default is 0, which means no log lines are included.
|
|
3815
|
+
#
|
|
3816
|
+
# @option params [String] :action_log_line_role_arn
|
|
3817
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudWatch assumes
|
|
3818
|
+
# to retrieve log events for inclusion in alarm action notifications.
|
|
3819
|
+
# Required when `ActionLogLineCount` is greater than 0.
|
|
3820
|
+
#
|
|
3821
|
+
# @option params [Boolean] :actions_enabled
|
|
3822
|
+
# Indicates whether actions should be executed during any changes to the
|
|
3823
|
+
# alarm state. The default is `true`.
|
|
3824
|
+
#
|
|
3825
|
+
# @option params [Array<String>] :ok_actions
|
|
3826
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
3827
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
3828
|
+
# Name (ARN).
|
|
3829
|
+
#
|
|
3830
|
+
# Valid Values:
|
|
3831
|
+
#
|
|
3832
|
+
# **Amazon SNS actions:**
|
|
3833
|
+
#
|
|
3834
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
3835
|
+
#
|
|
3836
|
+
# **Lambda actions:**
|
|
3837
|
+
#
|
|
3838
|
+
# * Invoke the latest version of a Lambda function:
|
|
3839
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
3840
|
+
#
|
|
3841
|
+
# * Invoke a specific version of a Lambda function:
|
|
3842
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
3843
|
+
# `
|
|
3844
|
+
#
|
|
3845
|
+
# * Invoke a function by using an alias Lambda function:
|
|
3846
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
3847
|
+
# `
|
|
3848
|
+
#
|
|
3849
|
+
# @option params [Array<String>] :alarm_actions
|
|
3850
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
3851
|
+
# state from any other state. Each action is specified as an Amazon
|
|
3852
|
+
# Resource Name (ARN).
|
|
3853
|
+
#
|
|
3854
|
+
# Valid Values:
|
|
3855
|
+
#
|
|
3856
|
+
# **Amazon SNS actions:**
|
|
3857
|
+
#
|
|
3858
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
3859
|
+
#
|
|
3860
|
+
# **Lambda actions:**
|
|
3861
|
+
#
|
|
3862
|
+
# * Invoke the latest version of a Lambda function:
|
|
3863
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
3864
|
+
#
|
|
3865
|
+
# * Invoke a specific version of a Lambda function:
|
|
3866
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
3867
|
+
# `
|
|
3868
|
+
#
|
|
3869
|
+
# * Invoke a function by using an alias Lambda function:
|
|
3870
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
3871
|
+
# `
|
|
3872
|
+
#
|
|
3873
|
+
# **Systems Manager actions:**
|
|
3874
|
+
#
|
|
3875
|
+
# `arn:aws:ssm:region:account-id:opsitem:severity `
|
|
3876
|
+
#
|
|
3877
|
+
# @option params [Array<String>] :insufficient_data_actions
|
|
3878
|
+
# The actions to execute when this alarm transitions to the
|
|
3879
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
3880
|
+
# specified as an Amazon Resource Name (ARN).
|
|
3881
|
+
#
|
|
3882
|
+
# Valid Values:
|
|
3883
|
+
#
|
|
3884
|
+
# **Amazon SNS actions:**
|
|
3885
|
+
#
|
|
3886
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
3887
|
+
#
|
|
3888
|
+
# **Lambda actions:**
|
|
3889
|
+
#
|
|
3890
|
+
# * Invoke the latest version of a Lambda function:
|
|
3891
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
3892
|
+
#
|
|
3893
|
+
# * Invoke a specific version of a Lambda function:
|
|
3894
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
3895
|
+
# `
|
|
3896
|
+
#
|
|
3897
|
+
# * Invoke a function by using an alias Lambda function:
|
|
3898
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
3899
|
+
# `
|
|
3900
|
+
#
|
|
3901
|
+
# @option params [required, Integer] :query_results_to_evaluate
|
|
3902
|
+
# The number of most recent scheduled query results to evaluate against
|
|
3903
|
+
# the threshold (the N in M-of-N evaluation). Valid range is 1 through
|
|
3904
|
+
# 100.
|
|
3905
|
+
#
|
|
3906
|
+
# @option params [required, Integer] :query_results_to_alarm
|
|
3907
|
+
# The number of query results, out of the most recent
|
|
3908
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
3909
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
3910
|
+
# evaluation). Must be less than or equal to `QueryResultsToEvaluate`.
|
|
3911
|
+
#
|
|
3912
|
+
# @option params [required, Float] :threshold
|
|
3913
|
+
# The value to compare with the aggregated query result.
|
|
3914
|
+
#
|
|
3915
|
+
# @option params [required, String] :comparison_operator
|
|
3916
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
3917
|
+
# result and the threshold. The aggregated query result is used as the
|
|
3918
|
+
# first operand. Valid values are `GreaterThanThreshold`,
|
|
3919
|
+
# `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, and
|
|
3920
|
+
# `LessThanOrEqualToThreshold`.
|
|
3921
|
+
#
|
|
3922
|
+
# @option params [String] :treat_missing_data
|
|
3923
|
+
# Sets how this alarm is to handle missing data points. Valid values are
|
|
3924
|
+
# `breaching`, `notBreaching`, `ignore`, and `missing`. If this
|
|
3925
|
+
# parameter is omitted, the default behavior of `missing` is used.
|
|
3926
|
+
#
|
|
3927
|
+
# @option params [Array<Types::Tag>] :tags
|
|
3928
|
+
# A list of key-value pairs to associate with the alarm. You can use
|
|
3929
|
+
# tags to categorize and manage your alarms.
|
|
3930
|
+
#
|
|
3931
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
3932
|
+
#
|
|
3933
|
+
# @example Request syntax with placeholder values
|
|
3934
|
+
#
|
|
3935
|
+
# resp = client.put_log_alarm({
|
|
3936
|
+
# alarm_name: "AlarmName", # required
|
|
3937
|
+
# alarm_description: "AlarmDescription",
|
|
3938
|
+
# scheduled_query_configuration: { # required
|
|
3939
|
+
# query_string: "QueryString", # required
|
|
3940
|
+
# log_group_identifiers: ["AmazonResourceName"],
|
|
3941
|
+
# query_arn: "AmazonResourceName",
|
|
3942
|
+
# scheduled_query_role_arn: "AmazonResourceName", # required
|
|
3943
|
+
# schedule_configuration: { # required
|
|
3944
|
+
# schedule_expression: "ScheduleExpression", # required
|
|
3945
|
+
# start_time_offset: 1,
|
|
3946
|
+
# end_time_offset: 1,
|
|
3947
|
+
# },
|
|
3948
|
+
# aggregation_expression: "AggregationExpression", # required
|
|
3949
|
+
# tags: [
|
|
3950
|
+
# {
|
|
3951
|
+
# key: "TagKey", # required
|
|
3952
|
+
# value: "TagValue", # required
|
|
3953
|
+
# },
|
|
3954
|
+
# ],
|
|
3955
|
+
# },
|
|
3956
|
+
# action_log_line_count: 1,
|
|
3957
|
+
# action_log_line_role_arn: "ActionLogLineRoleArn",
|
|
3958
|
+
# actions_enabled: false,
|
|
3959
|
+
# ok_actions: ["ResourceName"],
|
|
3960
|
+
# alarm_actions: ["ResourceName"],
|
|
3961
|
+
# insufficient_data_actions: ["ResourceName"],
|
|
3962
|
+
# query_results_to_evaluate: 1, # required
|
|
3963
|
+
# query_results_to_alarm: 1, # required
|
|
3964
|
+
# threshold: 1.0, # required
|
|
3965
|
+
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold, LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, GreaterThanUpperThreshold
|
|
3966
|
+
# treat_missing_data: "TreatMissingData",
|
|
3967
|
+
# tags: [
|
|
3968
|
+
# {
|
|
3969
|
+
# key: "TagKey", # required
|
|
3970
|
+
# value: "TagValue", # required
|
|
3971
|
+
# },
|
|
3972
|
+
# ],
|
|
3973
|
+
# })
|
|
3974
|
+
#
|
|
3975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutLogAlarm AWS API Documentation
|
|
3976
|
+
#
|
|
3977
|
+
# @overload put_log_alarm(params = {})
|
|
3978
|
+
# @param [Hash] params ({})
|
|
3979
|
+
def put_log_alarm(params = {}, options = {})
|
|
3980
|
+
req = build_request(:put_log_alarm, params)
|
|
3981
|
+
req.send_request(options)
|
|
3982
|
+
end
|
|
3983
|
+
|
|
3723
3984
|
# Creates a managed Contributor Insights rule for a specified Amazon Web
|
|
3724
3985
|
# Services resource. When you enable a managed rule, you create a
|
|
3725
3986
|
# Contributor Insights rule that collects data from Amazon Web Services
|
|
@@ -4262,6 +4523,27 @@ module Aws::CloudWatch
|
|
|
4262
4523
|
# If your alarm uses this parameter, it cannot have Auto Scaling
|
|
4263
4524
|
# actions.
|
|
4264
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
|
+
#
|
|
4265
4547
|
# @option params [Types::EvaluationCriteria] :evaluation_criteria
|
|
4266
4548
|
# The evaluation criteria for the alarm. For each `PutMetricAlarm`
|
|
4267
4549
|
# operation, you must specify either `MetricName`, a `Metrics` array, or
|
|
@@ -4347,6 +4629,13 @@ module Aws::CloudWatch
|
|
|
4347
4629
|
# },
|
|
4348
4630
|
# ],
|
|
4349
4631
|
# threshold_metric_id: "MetricId",
|
|
4632
|
+
# evaluation_window: {
|
|
4633
|
+
# wall_clock_window: {
|
|
4634
|
+
# timezone: "Timezone",
|
|
4635
|
+
# },
|
|
4636
|
+
# sliding_window: {
|
|
4637
|
+
# },
|
|
4638
|
+
# },
|
|
4350
4639
|
# evaluation_criteria: {
|
|
4351
4640
|
# prom_ql_criteria: {
|
|
4352
4641
|
# query: "Query", # required
|
|
@@ -5061,7 +5350,7 @@ module Aws::CloudWatch
|
|
|
5061
5350
|
tracer: tracer
|
|
5062
5351
|
)
|
|
5063
5352
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
|
5064
|
-
context[:gem_version] = '1.
|
|
5353
|
+
context[:gem_version] = '1.142.0'
|
|
5065
5354
|
Seahorse::Client::Request.new(handlers, context)
|
|
5066
5355
|
end
|
|
5067
5356
|
|
|
@@ -5132,6 +5421,7 @@ module Aws::CloudWatch
|
|
|
5132
5421
|
# | alarm_exists | {Client#describe_alarms} | 5 | 40 |
|
|
5133
5422
|
# | alarm_mute_rule_exists | {Client#get_alarm_mute_rule} | 5 | 40 |
|
|
5134
5423
|
# | composite_alarm_exists | {Client#describe_alarms} | 5 | 40 |
|
|
5424
|
+
# | log_alarm_exists | {Client#describe_alarms} | 5 | 40 |
|
|
5135
5425
|
#
|
|
5136
5426
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
|
5137
5427
|
# because the waiter has entered a state that it will not transition
|
|
@@ -5184,7 +5474,8 @@ module Aws::CloudWatch
|
|
|
5184
5474
|
{
|
|
5185
5475
|
alarm_exists: Waiters::AlarmExists,
|
|
5186
5476
|
alarm_mute_rule_exists: Waiters::AlarmMuteRuleExists,
|
|
5187
|
-
composite_alarm_exists: Waiters::CompositeAlarmExists
|
|
5477
|
+
composite_alarm_exists: Waiters::CompositeAlarmExists,
|
|
5478
|
+
log_alarm_exists: Waiters::LogAlarmExists
|
|
5188
5479
|
}
|
|
5189
5480
|
end
|
|
5190
5481
|
|