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
|
@@ -799,8 +799,8 @@ module Aws::CloudWatch
|
|
|
799
799
|
#
|
|
800
800
|
# @!attribute [rw] alarm_types
|
|
801
801
|
# Use this parameter to specify whether you want the operation to
|
|
802
|
-
# return metric alarms or
|
|
803
|
-
# parameter, only metric alarms are returned.
|
|
802
|
+
# return metric alarms, composite alarms, or log alarms. If you omit
|
|
803
|
+
# this parameter, only metric alarms are returned.
|
|
804
804
|
# @return [Array<String>]
|
|
805
805
|
#
|
|
806
806
|
# @!attribute [rw] history_item_type
|
|
@@ -937,17 +937,21 @@ module Aws::CloudWatch
|
|
|
937
937
|
#
|
|
938
938
|
# @!attribute [rw] alarm_types
|
|
939
939
|
# Use this parameter to specify whether you want the operation to
|
|
940
|
-
# return metric alarms or
|
|
941
|
-
# parameter, only metric alarms are returned, even if composite
|
|
942
|
-
# exist in the account.
|
|
940
|
+
# return metric alarms, composite alarms, or log alarms. If you omit
|
|
941
|
+
# this parameter, only metric alarms are returned, even if composite
|
|
942
|
+
# alarms or log alarms exist in the account.
|
|
943
943
|
#
|
|
944
944
|
# For example, if you omit this parameter or specify `MetricAlarms`,
|
|
945
945
|
# the operation returns only a list of metric alarms. It does not
|
|
946
|
-
# return any composite alarms, even if
|
|
946
|
+
# return any composite alarms or log alarms, even if they exist in the
|
|
947
947
|
# account.
|
|
948
948
|
#
|
|
949
949
|
# If you specify `CompositeAlarms`, the operation returns only a list
|
|
950
|
-
# of composite alarms, and does not return any metric alarms
|
|
950
|
+
# of composite alarms, and does not return any metric alarms or log
|
|
951
|
+
# alarms.
|
|
952
|
+
#
|
|
953
|
+
# If you specify `LogAlarms`, the operation returns only a list of log
|
|
954
|
+
# alarms, and does not return any metric alarms or composite alarms.
|
|
951
955
|
# @return [Array<String>]
|
|
952
956
|
#
|
|
953
957
|
# @!attribute [rw] children_of_alarm_name
|
|
@@ -1039,6 +1043,10 @@ module Aws::CloudWatch
|
|
|
1039
1043
|
# The information about any metric alarms returned by the operation.
|
|
1040
1044
|
# @return [Array<Types::MetricAlarm>]
|
|
1041
1045
|
#
|
|
1046
|
+
# @!attribute [rw] log_alarms
|
|
1047
|
+
# The information about any log alarms returned by the operation.
|
|
1048
|
+
# @return [Array<Types::LogAlarm>]
|
|
1049
|
+
#
|
|
1042
1050
|
# @!attribute [rw] next_token
|
|
1043
1051
|
# The token that marks the start of the next batch of returned
|
|
1044
1052
|
# results.
|
|
@@ -1049,6 +1057,7 @@ module Aws::CloudWatch
|
|
|
1049
1057
|
class DescribeAlarmsOutput < Struct.new(
|
|
1050
1058
|
:composite_alarms,
|
|
1051
1059
|
:metric_alarms,
|
|
1060
|
+
:log_alarms,
|
|
1052
1061
|
:next_token)
|
|
1053
1062
|
SENSITIVE = []
|
|
1054
1063
|
include Aws::Structure
|
|
@@ -1405,6 +1414,50 @@ module Aws::CloudWatch
|
|
|
1405
1414
|
class Unknown < EvaluationCriteria; end
|
|
1406
1415
|
end
|
|
1407
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
|
+
|
|
1408
1461
|
# @!attribute [rw] alarm_mute_rule_name
|
|
1409
1462
|
# The name of the alarm mute rule to retrieve.
|
|
1410
1463
|
# @return [String]
|
|
@@ -1502,7 +1555,7 @@ module Aws::CloudWatch
|
|
|
1502
1555
|
#
|
|
1503
1556
|
#
|
|
1504
1557
|
#
|
|
1505
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
1558
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
1506
1559
|
# @return [String]
|
|
1507
1560
|
#
|
|
1508
1561
|
# @!attribute [rw] dashboard_name
|
|
@@ -2080,7 +2133,7 @@ module Aws::CloudWatch
|
|
|
2080
2133
|
#
|
|
2081
2134
|
#
|
|
2082
2135
|
#
|
|
2083
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
2136
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Widget-Structure.html
|
|
2084
2137
|
# @return [String]
|
|
2085
2138
|
#
|
|
2086
2139
|
# @!attribute [rw] output_format
|
|
@@ -2849,6 +2902,159 @@ module Aws::CloudWatch
|
|
|
2849
2902
|
include Aws::Structure
|
|
2850
2903
|
end
|
|
2851
2904
|
|
|
2905
|
+
# The details about a log alarm.
|
|
2906
|
+
#
|
|
2907
|
+
# @!attribute [rw] alarm_name
|
|
2908
|
+
# The name of the alarm.
|
|
2909
|
+
# @return [String]
|
|
2910
|
+
#
|
|
2911
|
+
# @!attribute [rw] alarm_arn
|
|
2912
|
+
# The Amazon Resource Name (ARN) of the alarm.
|
|
2913
|
+
# @return [String]
|
|
2914
|
+
#
|
|
2915
|
+
# @!attribute [rw] alarm_description
|
|
2916
|
+
# The description of the alarm.
|
|
2917
|
+
# @return [String]
|
|
2918
|
+
#
|
|
2919
|
+
# @!attribute [rw] alarm_configuration_updated_timestamp
|
|
2920
|
+
# The time stamp of the last update to the alarm configuration.
|
|
2921
|
+
# @return [Time]
|
|
2922
|
+
#
|
|
2923
|
+
# @!attribute [rw] actions_enabled
|
|
2924
|
+
# Indicates whether actions should be executed during any changes to
|
|
2925
|
+
# the alarm state.
|
|
2926
|
+
# @return [Boolean]
|
|
2927
|
+
#
|
|
2928
|
+
# @!attribute [rw] ok_actions
|
|
2929
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
2930
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
2931
|
+
# Name (ARN).
|
|
2932
|
+
# @return [Array<String>]
|
|
2933
|
+
#
|
|
2934
|
+
# @!attribute [rw] alarm_actions
|
|
2935
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
2936
|
+
# state from any other state. Each action is specified as an Amazon
|
|
2937
|
+
# Resource Name (ARN).
|
|
2938
|
+
# @return [Array<String>]
|
|
2939
|
+
#
|
|
2940
|
+
# @!attribute [rw] insufficient_data_actions
|
|
2941
|
+
# The actions to execute when this alarm transitions to the
|
|
2942
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
2943
|
+
# specified as an Amazon Resource Name (ARN).
|
|
2944
|
+
# @return [Array<String>]
|
|
2945
|
+
#
|
|
2946
|
+
# @!attribute [rw] state_value
|
|
2947
|
+
# The state value for the alarm.
|
|
2948
|
+
# @return [String]
|
|
2949
|
+
#
|
|
2950
|
+
# @!attribute [rw] state_reason
|
|
2951
|
+
# An explanation for the alarm state, in text format.
|
|
2952
|
+
# @return [String]
|
|
2953
|
+
#
|
|
2954
|
+
# @!attribute [rw] state_reason_data
|
|
2955
|
+
# An explanation for the alarm state, in JSON format.
|
|
2956
|
+
# @return [String]
|
|
2957
|
+
#
|
|
2958
|
+
# @!attribute [rw] state_updated_timestamp
|
|
2959
|
+
# The time stamp of the last update to the value of either the
|
|
2960
|
+
# `StateValue` or `EvaluationState` parameters.
|
|
2961
|
+
# @return [Time]
|
|
2962
|
+
#
|
|
2963
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
2964
|
+
# The configuration of the underlying CloudWatch Logs scheduled query,
|
|
2965
|
+
# including the query string, log groups, schedule, aggregation
|
|
2966
|
+
# expression, and the ARN of the managed scheduled query.
|
|
2967
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
2968
|
+
#
|
|
2969
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
2970
|
+
# The number of most recent scheduled query results that the alarm
|
|
2971
|
+
# evaluates against the threshold (the N in M-of-N evaluation).
|
|
2972
|
+
# @return [Integer]
|
|
2973
|
+
#
|
|
2974
|
+
# @!attribute [rw] query_results_to_alarm
|
|
2975
|
+
# The number of query results, out of the most recent
|
|
2976
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
2977
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
2978
|
+
# evaluation).
|
|
2979
|
+
# @return [Integer]
|
|
2980
|
+
#
|
|
2981
|
+
# @!attribute [rw] threshold
|
|
2982
|
+
# The value to compare with the aggregated query result.
|
|
2983
|
+
# @return [Float]
|
|
2984
|
+
#
|
|
2985
|
+
# @!attribute [rw] comparison_operator
|
|
2986
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
2987
|
+
# result and the threshold. The aggregated query result is used as the
|
|
2988
|
+
# first operand.
|
|
2989
|
+
# @return [String]
|
|
2990
|
+
#
|
|
2991
|
+
# @!attribute [rw] treat_missing_data
|
|
2992
|
+
# How this alarm handles missing data points. Valid values are
|
|
2993
|
+
# `breaching`, `notBreaching`, `ignore`, and `missing`.
|
|
2994
|
+
# @return [String]
|
|
2995
|
+
#
|
|
2996
|
+
# @!attribute [rw] state_transitioned_timestamp
|
|
2997
|
+
# The date and time that the alarm's `StateValue` most recently
|
|
2998
|
+
# changed.
|
|
2999
|
+
# @return [Time]
|
|
3000
|
+
#
|
|
3001
|
+
# @!attribute [rw] evaluation_state
|
|
3002
|
+
# If the value of this field is `EVALUATION_ERROR`, it indicates
|
|
3003
|
+
# configuration errors in the alarm setup that require review and
|
|
3004
|
+
# correction. Refer to the `StateReason` field of the alarm for more
|
|
3005
|
+
# details.
|
|
3006
|
+
#
|
|
3007
|
+
# If the value of this field is `EVALUATION_FAILURE`, it indicates
|
|
3008
|
+
# temporary CloudWatch issues. We recommend manual monitoring until
|
|
3009
|
+
# the issue is resolved.
|
|
3010
|
+
#
|
|
3011
|
+
# If the value of this field is `PARTIAL_DATA`, it indicates that the
|
|
3012
|
+
# query returned the maximum 500 contributor groups but more matched.
|
|
3013
|
+
# The alarm evaluates the available contributors, but results might be
|
|
3014
|
+
# incomplete.
|
|
3015
|
+
# @return [String]
|
|
3016
|
+
#
|
|
3017
|
+
# @!attribute [rw] action_log_line_count
|
|
3018
|
+
# The number of log lines from the most recent scheduled query
|
|
3019
|
+
# execution that are included in alarm action notifications. Valid
|
|
3020
|
+
# range is 0 through 50. A value of 0 means no log lines are included.
|
|
3021
|
+
# @return [Integer]
|
|
3022
|
+
#
|
|
3023
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
3024
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
3025
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
3026
|
+
# notifications. Set when `ActionLogLineCount` is greater than 0.
|
|
3027
|
+
# @return [String]
|
|
3028
|
+
#
|
|
3029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/LogAlarm AWS API Documentation
|
|
3030
|
+
#
|
|
3031
|
+
class LogAlarm < Struct.new(
|
|
3032
|
+
:alarm_name,
|
|
3033
|
+
:alarm_arn,
|
|
3034
|
+
:alarm_description,
|
|
3035
|
+
:alarm_configuration_updated_timestamp,
|
|
3036
|
+
:actions_enabled,
|
|
3037
|
+
:ok_actions,
|
|
3038
|
+
:alarm_actions,
|
|
3039
|
+
:insufficient_data_actions,
|
|
3040
|
+
:state_value,
|
|
3041
|
+
:state_reason,
|
|
3042
|
+
:state_reason_data,
|
|
3043
|
+
:state_updated_timestamp,
|
|
3044
|
+
:scheduled_query_configuration,
|
|
3045
|
+
:query_results_to_evaluate,
|
|
3046
|
+
:query_results_to_alarm,
|
|
3047
|
+
:threshold,
|
|
3048
|
+
:comparison_operator,
|
|
3049
|
+
:treat_missing_data,
|
|
3050
|
+
:state_transitioned_timestamp,
|
|
3051
|
+
:evaluation_state,
|
|
3052
|
+
:action_log_line_count,
|
|
3053
|
+
:action_log_line_role_arn)
|
|
3054
|
+
SENSITIVE = []
|
|
3055
|
+
include Aws::Structure
|
|
3056
|
+
end
|
|
3057
|
+
|
|
2852
3058
|
# Contains the information that's required to enable a managed
|
|
2853
3059
|
# Contributor Insights rule for an Amazon Web Services resource.
|
|
2854
3060
|
#
|
|
@@ -3158,6 +3364,17 @@ module Aws::CloudWatch
|
|
|
3158
3364
|
# changed.
|
|
3159
3365
|
# @return [Time]
|
|
3160
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
|
+
#
|
|
3161
3378
|
# @!attribute [rw] evaluation_criteria
|
|
3162
3379
|
# The evaluation criteria for the alarm.
|
|
3163
3380
|
# @return [Types::EvaluationCriteria]
|
|
@@ -3198,6 +3415,7 @@ module Aws::CloudWatch
|
|
|
3198
3415
|
:threshold_metric_id,
|
|
3199
3416
|
:evaluation_state,
|
|
3200
3417
|
:state_transitioned_timestamp,
|
|
3418
|
+
:evaluation_window,
|
|
3201
3419
|
:evaluation_criteria,
|
|
3202
3420
|
:evaluation_interval)
|
|
3203
3421
|
SENSITIVE = []
|
|
@@ -4206,7 +4424,7 @@ module Aws::CloudWatch
|
|
|
4206
4424
|
#
|
|
4207
4425
|
#
|
|
4208
4426
|
#
|
|
4209
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
4427
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
4210
4428
|
# @return [String]
|
|
4211
4429
|
#
|
|
4212
4430
|
# @!attribute [rw] tags
|
|
@@ -4337,6 +4555,175 @@ module Aws::CloudWatch
|
|
|
4337
4555
|
#
|
|
4338
4556
|
class PutInsightRuleOutput < Aws::EmptyStructure; end
|
|
4339
4557
|
|
|
4558
|
+
# @!attribute [rw] alarm_name
|
|
4559
|
+
# The name for the alarm. This name must be unique within the Amazon
|
|
4560
|
+
# Web Services account and Region.
|
|
4561
|
+
# @return [String]
|
|
4562
|
+
#
|
|
4563
|
+
# @!attribute [rw] alarm_description
|
|
4564
|
+
# The description for the alarm.
|
|
4565
|
+
# @return [String]
|
|
4566
|
+
#
|
|
4567
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
4568
|
+
# The configuration of the underlying CloudWatch Logs scheduled query
|
|
4569
|
+
# that this alarm evaluates, including the query string, log groups,
|
|
4570
|
+
# schedule, and aggregation expression.
|
|
4571
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
4572
|
+
#
|
|
4573
|
+
# @!attribute [rw] action_log_line_count
|
|
4574
|
+
# The number of log lines from the most recent scheduled query
|
|
4575
|
+
# execution to include in alarm action notifications. Valid range is 0
|
|
4576
|
+
# through 50. The default is 0, which means no log lines are included.
|
|
4577
|
+
# @return [Integer]
|
|
4578
|
+
#
|
|
4579
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
4580
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudWatch
|
|
4581
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
4582
|
+
# notifications. Required when `ActionLogLineCount` is greater than 0.
|
|
4583
|
+
# @return [String]
|
|
4584
|
+
#
|
|
4585
|
+
# @!attribute [rw] actions_enabled
|
|
4586
|
+
# Indicates whether actions should be executed during any changes to
|
|
4587
|
+
# the alarm state. The default is `true`.
|
|
4588
|
+
# @return [Boolean]
|
|
4589
|
+
#
|
|
4590
|
+
# @!attribute [rw] ok_actions
|
|
4591
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
4592
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
4593
|
+
# Name (ARN).
|
|
4594
|
+
#
|
|
4595
|
+
# Valid Values:
|
|
4596
|
+
#
|
|
4597
|
+
# **Amazon SNS actions:**
|
|
4598
|
+
#
|
|
4599
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4600
|
+
#
|
|
4601
|
+
# **Lambda actions:**
|
|
4602
|
+
#
|
|
4603
|
+
# * Invoke the latest version of a Lambda function:
|
|
4604
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4605
|
+
#
|
|
4606
|
+
# * Invoke a specific version of a Lambda function:
|
|
4607
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4608
|
+
# `
|
|
4609
|
+
#
|
|
4610
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4611
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4612
|
+
# `
|
|
4613
|
+
# @return [Array<String>]
|
|
4614
|
+
#
|
|
4615
|
+
# @!attribute [rw] alarm_actions
|
|
4616
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
4617
|
+
# state from any other state. Each action is specified as an Amazon
|
|
4618
|
+
# Resource Name (ARN).
|
|
4619
|
+
#
|
|
4620
|
+
# Valid Values:
|
|
4621
|
+
#
|
|
4622
|
+
# **Amazon SNS actions:**
|
|
4623
|
+
#
|
|
4624
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4625
|
+
#
|
|
4626
|
+
# **Lambda actions:**
|
|
4627
|
+
#
|
|
4628
|
+
# * Invoke the latest version of a Lambda function:
|
|
4629
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4630
|
+
#
|
|
4631
|
+
# * Invoke a specific version of a Lambda function:
|
|
4632
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4633
|
+
# `
|
|
4634
|
+
#
|
|
4635
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4636
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4637
|
+
# `
|
|
4638
|
+
#
|
|
4639
|
+
# **Systems Manager actions:**
|
|
4640
|
+
#
|
|
4641
|
+
# `arn:aws:ssm:region:account-id:opsitem:severity `
|
|
4642
|
+
# @return [Array<String>]
|
|
4643
|
+
#
|
|
4644
|
+
# @!attribute [rw] insufficient_data_actions
|
|
4645
|
+
# The actions to execute when this alarm transitions to the
|
|
4646
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
4647
|
+
# specified as an Amazon Resource Name (ARN).
|
|
4648
|
+
#
|
|
4649
|
+
# Valid Values:
|
|
4650
|
+
#
|
|
4651
|
+
# **Amazon SNS actions:**
|
|
4652
|
+
#
|
|
4653
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4654
|
+
#
|
|
4655
|
+
# **Lambda actions:**
|
|
4656
|
+
#
|
|
4657
|
+
# * Invoke the latest version of a Lambda function:
|
|
4658
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4659
|
+
#
|
|
4660
|
+
# * Invoke a specific version of a Lambda function:
|
|
4661
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4662
|
+
# `
|
|
4663
|
+
#
|
|
4664
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4665
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4666
|
+
# `
|
|
4667
|
+
# @return [Array<String>]
|
|
4668
|
+
#
|
|
4669
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
4670
|
+
# The number of most recent scheduled query results to evaluate
|
|
4671
|
+
# against the threshold (the N in M-of-N evaluation). Valid range is 1
|
|
4672
|
+
# through 100.
|
|
4673
|
+
# @return [Integer]
|
|
4674
|
+
#
|
|
4675
|
+
# @!attribute [rw] query_results_to_alarm
|
|
4676
|
+
# The number of query results, out of the most recent
|
|
4677
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
4678
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
4679
|
+
# evaluation). Must be less than or equal to `QueryResultsToEvaluate`.
|
|
4680
|
+
# @return [Integer]
|
|
4681
|
+
#
|
|
4682
|
+
# @!attribute [rw] threshold
|
|
4683
|
+
# The value to compare with the aggregated query result.
|
|
4684
|
+
# @return [Float]
|
|
4685
|
+
#
|
|
4686
|
+
# @!attribute [rw] comparison_operator
|
|
4687
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
4688
|
+
# result and the threshold. The aggregated query result is used as the
|
|
4689
|
+
# first operand. Valid values are `GreaterThanThreshold`,
|
|
4690
|
+
# `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, and
|
|
4691
|
+
# `LessThanOrEqualToThreshold`.
|
|
4692
|
+
# @return [String]
|
|
4693
|
+
#
|
|
4694
|
+
# @!attribute [rw] treat_missing_data
|
|
4695
|
+
# Sets how this alarm is to handle missing data points. Valid values
|
|
4696
|
+
# are `breaching`, `notBreaching`, `ignore`, and `missing`. If this
|
|
4697
|
+
# parameter is omitted, the default behavior of `missing` is used.
|
|
4698
|
+
# @return [String]
|
|
4699
|
+
#
|
|
4700
|
+
# @!attribute [rw] tags
|
|
4701
|
+
# A list of key-value pairs to associate with the alarm. You can use
|
|
4702
|
+
# tags to categorize and manage your alarms.
|
|
4703
|
+
# @return [Array<Types::Tag>]
|
|
4704
|
+
#
|
|
4705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutLogAlarmInput AWS API Documentation
|
|
4706
|
+
#
|
|
4707
|
+
class PutLogAlarmInput < Struct.new(
|
|
4708
|
+
:alarm_name,
|
|
4709
|
+
:alarm_description,
|
|
4710
|
+
:scheduled_query_configuration,
|
|
4711
|
+
:action_log_line_count,
|
|
4712
|
+
:action_log_line_role_arn,
|
|
4713
|
+
:actions_enabled,
|
|
4714
|
+
:ok_actions,
|
|
4715
|
+
:alarm_actions,
|
|
4716
|
+
:insufficient_data_actions,
|
|
4717
|
+
:query_results_to_evaluate,
|
|
4718
|
+
:query_results_to_alarm,
|
|
4719
|
+
:threshold,
|
|
4720
|
+
:comparison_operator,
|
|
4721
|
+
:treat_missing_data,
|
|
4722
|
+
:tags)
|
|
4723
|
+
SENSITIVE = []
|
|
4724
|
+
include Aws::Structure
|
|
4725
|
+
end
|
|
4726
|
+
|
|
4340
4727
|
# @!attribute [rw] managed_rules
|
|
4341
4728
|
# A list of `ManagedRules` to enable.
|
|
4342
4729
|
# @return [Array<Types::ManagedRule>]
|
|
@@ -4815,6 +5202,28 @@ module Aws::CloudWatch
|
|
|
4815
5202
|
# actions.
|
|
4816
5203
|
# @return [String]
|
|
4817
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
|
+
#
|
|
4818
5227
|
# @!attribute [rw] evaluation_criteria
|
|
4819
5228
|
# The evaluation criteria for the alarm. For each `PutMetricAlarm`
|
|
4820
5229
|
# operation, you must specify either `MetricName`, a `Metrics` array,
|
|
@@ -4866,6 +5275,7 @@ module Aws::CloudWatch
|
|
|
4866
5275
|
:metrics,
|
|
4867
5276
|
:tags,
|
|
4868
5277
|
:threshold_metric_id,
|
|
5278
|
+
:evaluation_window,
|
|
4869
5279
|
:evaluation_criteria,
|
|
4870
5280
|
:evaluation_interval)
|
|
4871
5281
|
SENSITIVE = []
|
|
@@ -5108,6 +5518,21 @@ module Aws::CloudWatch
|
|
|
5108
5518
|
include Aws::Structure
|
|
5109
5519
|
end
|
|
5110
5520
|
|
|
5521
|
+
# The operation could not be completed because the request conflicts
|
|
5522
|
+
# with the current state of the alarm or its underlying scheduled query
|
|
5523
|
+
# resource.
|
|
5524
|
+
#
|
|
5525
|
+
# @!attribute [rw] message
|
|
5526
|
+
# @return [String]
|
|
5527
|
+
#
|
|
5528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ResourceConflict AWS API Documentation
|
|
5529
|
+
#
|
|
5530
|
+
class ResourceConflict < Struct.new(
|
|
5531
|
+
:message)
|
|
5532
|
+
SENSITIVE = []
|
|
5533
|
+
include Aws::Structure
|
|
5534
|
+
end
|
|
5535
|
+
|
|
5111
5536
|
# The named resource does not exist.
|
|
5112
5537
|
#
|
|
5113
5538
|
# @!attribute [rw] message
|
|
@@ -5262,6 +5687,96 @@ module Aws::CloudWatch
|
|
|
5262
5687
|
include Aws::Structure
|
|
5263
5688
|
end
|
|
5264
5689
|
|
|
5690
|
+
# Contains the schedule expression and time-range offsets that define
|
|
5691
|
+
# when a scheduled query runs and what time range each execution covers.
|
|
5692
|
+
#
|
|
5693
|
+
# @!attribute [rw] schedule_expression
|
|
5694
|
+
# The schedule expression that defines how often the underlying
|
|
5695
|
+
# CloudWatch Logs scheduled query runs. Specify a `rate()` expression,
|
|
5696
|
+
# for example `rate(5 minutes)`.
|
|
5697
|
+
# @return [String]
|
|
5698
|
+
#
|
|
5699
|
+
# @!attribute [rw] start_time_offset
|
|
5700
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5701
|
+
# the query time range begins. For example, an offset of 360 (6
|
|
5702
|
+
# minutes) on a query running at 12:05:00 starts the query time range
|
|
5703
|
+
# at 11:59:00.
|
|
5704
|
+
# @return [Integer]
|
|
5705
|
+
#
|
|
5706
|
+
# @!attribute [rw] end_time_offset
|
|
5707
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5708
|
+
# the query time range ends. Must be non-negative and less than
|
|
5709
|
+
# `StartTimeOffset`. The default is 0.
|
|
5710
|
+
# @return [Integer]
|
|
5711
|
+
#
|
|
5712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduleConfiguration AWS API Documentation
|
|
5713
|
+
#
|
|
5714
|
+
class ScheduleConfiguration < Struct.new(
|
|
5715
|
+
:schedule_expression,
|
|
5716
|
+
:start_time_offset,
|
|
5717
|
+
:end_time_offset)
|
|
5718
|
+
SENSITIVE = []
|
|
5719
|
+
include Aws::Structure
|
|
5720
|
+
end
|
|
5721
|
+
|
|
5722
|
+
# The configuration of the CloudWatch Logs scheduled query that backs a
|
|
5723
|
+
# log alarm.
|
|
5724
|
+
#
|
|
5725
|
+
# @!attribute [rw] query_string
|
|
5726
|
+
# The CloudWatch Logs query to execute on each scheduled run. Length
|
|
5727
|
+
# constraints: maximum of 10,000 characters.
|
|
5728
|
+
# @return [String]
|
|
5729
|
+
#
|
|
5730
|
+
# @!attribute [rw] log_group_identifiers
|
|
5731
|
+
# The log groups to query. Each entry can be a log group name or ARN.
|
|
5732
|
+
# Use the ARN form when querying log groups in a different account
|
|
5733
|
+
# (for example, when running cross-account queries from a monitoring
|
|
5734
|
+
# account). The list must contain between 1 and 50 entries.
|
|
5735
|
+
# @return [Array<String>]
|
|
5736
|
+
#
|
|
5737
|
+
# @!attribute [rw] query_arn
|
|
5738
|
+
# The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled
|
|
5739
|
+
# query that the alarm uses. This field is populated in
|
|
5740
|
+
# `DescribeAlarms` responses.
|
|
5741
|
+
# @return [String]
|
|
5742
|
+
#
|
|
5743
|
+
# @!attribute [rw] scheduled_query_role_arn
|
|
5744
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
5745
|
+
# assumes when executing the scheduled query against the configured
|
|
5746
|
+
# log groups.
|
|
5747
|
+
# @return [String]
|
|
5748
|
+
#
|
|
5749
|
+
# @!attribute [rw] schedule_configuration
|
|
5750
|
+
# The schedule and time-range offset configuration for the underlying
|
|
5751
|
+
# scheduled query.
|
|
5752
|
+
# @return [Types::ScheduleConfiguration]
|
|
5753
|
+
#
|
|
5754
|
+
# @!attribute [rw] aggregation_expression
|
|
5755
|
+
# The expression that defines how to aggregate query results into one
|
|
5756
|
+
# or more scalar values for alarm evaluation. For example, `count(*)`
|
|
5757
|
+
# or `avg(latency) by host | sort desc`. Length constraints: minimum 1
|
|
5758
|
+
# character, maximum 2048 characters.
|
|
5759
|
+
# @return [String]
|
|
5760
|
+
#
|
|
5761
|
+
# @!attribute [rw] tags
|
|
5762
|
+
# A list of key-value pairs to associate with the underlying scheduled
|
|
5763
|
+
# query resource.
|
|
5764
|
+
# @return [Array<Types::Tag>]
|
|
5765
|
+
#
|
|
5766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduledQueryConfiguration AWS API Documentation
|
|
5767
|
+
#
|
|
5768
|
+
class ScheduledQueryConfiguration < Struct.new(
|
|
5769
|
+
:query_string,
|
|
5770
|
+
:log_group_identifiers,
|
|
5771
|
+
:query_arn,
|
|
5772
|
+
:scheduled_query_role_arn,
|
|
5773
|
+
:schedule_configuration,
|
|
5774
|
+
:aggregation_expression,
|
|
5775
|
+
:tags)
|
|
5776
|
+
SENSITIVE = []
|
|
5777
|
+
include Aws::Structure
|
|
5778
|
+
end
|
|
5779
|
+
|
|
5265
5780
|
# @!attribute [rw] alarm_name
|
|
5266
5781
|
# The name of the alarm.
|
|
5267
5782
|
# @return [String]
|
|
@@ -5337,6 +5852,20 @@ module Aws::CloudWatch
|
|
|
5337
5852
|
include Aws::Structure
|
|
5338
5853
|
end
|
|
5339
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
|
+
|
|
5340
5869
|
# @!attribute [rw] names
|
|
5341
5870
|
# The array of the names of metric streams to start streaming.
|
|
5342
5871
|
#
|
|
@@ -5534,6 +6063,41 @@ module Aws::CloudWatch
|
|
|
5534
6063
|
#
|
|
5535
6064
|
class UntagResourceOutput < Aws::EmptyStructure; end
|
|
5536
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
|
+
|
|
5537
6101
|
end
|
|
5538
6102
|
end
|
|
5539
6103
|
|