aws-sdk-cloudwatch 1.140.0 → 1.141.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 +3 -3
- data/lib/aws-sdk-cloudwatch/client.rb +276 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +90 -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/resource.rb +18 -12
- data/lib/aws-sdk-cloudwatch/types.rb +446 -10
- data/lib/aws-sdk-cloudwatch/waiters.rb +37 -0
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- data/sig/alarm.rbs +1 -1
- data/sig/client.rbs +59 -4
- data/sig/composite_alarm.rbs +1 -1
- data/sig/errors.rbs +3 -0
- data/sig/resource.rbs +2 -2
- data/sig/types.rbs +72 -3
- data/sig/waiters.rbs +20 -2
- metadata +1 -1
|
@@ -360,7 +360,7 @@ module Aws::CloudWatch
|
|
|
360
360
|
#
|
|
361
361
|
# composite_alarm.describe_history({
|
|
362
362
|
# alarm_contributor_id: "ContributorId",
|
|
363
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
363
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
364
364
|
# history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action, AlarmContributorStateUpdate, AlarmContributorAction
|
|
365
365
|
# start_date: Time.now,
|
|
366
366
|
# end_date: Time.now,
|
|
@@ -374,8 +374,8 @@ module Aws::CloudWatch
|
|
|
374
374
|
# alarm history results.
|
|
375
375
|
# @option options [Array<String>] :alarm_types
|
|
376
376
|
# Use this parameter to specify whether you want the operation to return
|
|
377
|
-
# metric alarms or
|
|
378
|
-
# metric alarms are returned.
|
|
377
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
378
|
+
# parameter, only metric alarms are returned.
|
|
379
379
|
# @option options [String] :history_item_type
|
|
380
380
|
# The type of alarm histories to retrieve.
|
|
381
381
|
# @option options [Time,DateTime,Date,Integer,String] :start_date
|
|
@@ -50,6 +50,7 @@ module Aws::CloudWatch
|
|
|
50
50
|
# * This error class is not used. `LimitExceeded` is used during parsing instead.
|
|
51
51
|
# * {MissingRequiredParameterException}
|
|
52
52
|
# * This error class is not used. `MissingParameter` is used during parsing instead.
|
|
53
|
+
# * {ResourceConflict}
|
|
53
54
|
# * {ResourceNotFound}
|
|
54
55
|
# * {ResourceNotFoundException}
|
|
55
56
|
#
|
|
@@ -295,6 +296,21 @@ module Aws::CloudWatch
|
|
|
295
296
|
end
|
|
296
297
|
end
|
|
297
298
|
|
|
299
|
+
class ResourceConflict < ServiceError
|
|
300
|
+
|
|
301
|
+
# @param [Seahorse::Client::RequestContext] context
|
|
302
|
+
# @param [String] message
|
|
303
|
+
# @param [Aws::CloudWatch::Types::ResourceConflict] data
|
|
304
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
|
305
|
+
super(context, message, data)
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# @return [String]
|
|
309
|
+
def message
|
|
310
|
+
@message || @data[:message]
|
|
311
|
+
end
|
|
312
|
+
end
|
|
313
|
+
|
|
298
314
|
class ResourceNotFound < ServiceError
|
|
299
315
|
|
|
300
316
|
# @param [Seahorse::Client::RequestContext] context
|
|
@@ -49,7 +49,7 @@ module Aws::CloudWatch
|
|
|
49
49
|
# alarms = cloud_watch.alarms({
|
|
50
50
|
# alarm_names: ["AlarmName"],
|
|
51
51
|
# alarm_name_prefix: "AlarmNamePrefix",
|
|
52
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
52
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
53
53
|
# children_of_alarm_name: "AlarmName",
|
|
54
54
|
# parents_of_alarm_name: "AlarmName",
|
|
55
55
|
# state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
|
|
@@ -66,16 +66,19 @@ module Aws::CloudWatch
|
|
|
66
66
|
# If this parameter is specified, you cannot specify `AlarmNames`.
|
|
67
67
|
# @option options [Array<String>] :alarm_types
|
|
68
68
|
# Use this parameter to specify whether you want the operation to return
|
|
69
|
-
# metric alarms or
|
|
70
|
-
# metric alarms are returned, even if composite alarms
|
|
71
|
-
# account.
|
|
69
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
70
|
+
# parameter, only metric alarms are returned, even if composite alarms
|
|
71
|
+
# or log alarms exist in the account.
|
|
72
72
|
#
|
|
73
73
|
# For example, if you omit this parameter or specify `MetricAlarms`, the
|
|
74
74
|
# operation returns only a list of metric alarms. It does not return any
|
|
75
|
-
# composite alarms, even if
|
|
75
|
+
# composite alarms or log alarms, even if they exist in the account.
|
|
76
76
|
#
|
|
77
77
|
# If you specify `CompositeAlarms`, the operation returns only a list of
|
|
78
|
-
# composite alarms, and does not return any metric alarms.
|
|
78
|
+
# composite alarms, and does not return any metric alarms or log alarms.
|
|
79
|
+
#
|
|
80
|
+
# If you specify `LogAlarms`, the operation returns only a list of log
|
|
81
|
+
# alarms, and does not return any metric alarms or composite alarms.
|
|
79
82
|
# @option options [String] :children_of_alarm_name
|
|
80
83
|
# If you use this parameter and specify the name of a composite alarm,
|
|
81
84
|
# the operation returns information about the "children" alarms of the
|
|
@@ -157,7 +160,7 @@ module Aws::CloudWatch
|
|
|
157
160
|
# composite_alarms = cloud_watch.composite_alarms({
|
|
158
161
|
# alarm_names: ["AlarmName"],
|
|
159
162
|
# alarm_name_prefix: "AlarmNamePrefix",
|
|
160
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
|
163
|
+
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm, LogAlarm
|
|
161
164
|
# children_of_alarm_name: "AlarmName",
|
|
162
165
|
# parents_of_alarm_name: "AlarmName",
|
|
163
166
|
# state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
|
|
@@ -174,16 +177,19 @@ module Aws::CloudWatch
|
|
|
174
177
|
# If this parameter is specified, you cannot specify `AlarmNames`.
|
|
175
178
|
# @option options [Array<String>] :alarm_types
|
|
176
179
|
# Use this parameter to specify whether you want the operation to return
|
|
177
|
-
# metric alarms or
|
|
178
|
-
# metric alarms are returned, even if composite alarms
|
|
179
|
-
# account.
|
|
180
|
+
# metric alarms, composite alarms, or log alarms. If you omit this
|
|
181
|
+
# parameter, only metric alarms are returned, even if composite alarms
|
|
182
|
+
# or log alarms exist in the account.
|
|
180
183
|
#
|
|
181
184
|
# For example, if you omit this parameter or specify `MetricAlarms`, the
|
|
182
185
|
# operation returns only a list of metric alarms. It does not return any
|
|
183
|
-
# composite alarms, even if
|
|
186
|
+
# composite alarms or log alarms, even if they exist in the account.
|
|
184
187
|
#
|
|
185
188
|
# If you specify `CompositeAlarms`, the operation returns only a list of
|
|
186
|
-
# composite alarms, and does not return any metric alarms.
|
|
189
|
+
# composite alarms, and does not return any metric alarms or log alarms.
|
|
190
|
+
#
|
|
191
|
+
# If you specify `LogAlarms`, the operation returns only a list of log
|
|
192
|
+
# alarms, and does not return any metric alarms or composite alarms.
|
|
187
193
|
# @option options [String] :children_of_alarm_name
|
|
188
194
|
# If you use this parameter and specify the name of a composite alarm,
|
|
189
195
|
# the operation returns information about the "children" alarms of the
|
|
@@ -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
|
|
@@ -1502,7 +1511,7 @@ module Aws::CloudWatch
|
|
|
1502
1511
|
#
|
|
1503
1512
|
#
|
|
1504
1513
|
#
|
|
1505
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
1514
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
1506
1515
|
# @return [String]
|
|
1507
1516
|
#
|
|
1508
1517
|
# @!attribute [rw] dashboard_name
|
|
@@ -2080,7 +2089,7 @@ module Aws::CloudWatch
|
|
|
2080
2089
|
#
|
|
2081
2090
|
#
|
|
2082
2091
|
#
|
|
2083
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
2092
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Widget-Structure.html
|
|
2084
2093
|
# @return [String]
|
|
2085
2094
|
#
|
|
2086
2095
|
# @!attribute [rw] output_format
|
|
@@ -2849,6 +2858,159 @@ module Aws::CloudWatch
|
|
|
2849
2858
|
include Aws::Structure
|
|
2850
2859
|
end
|
|
2851
2860
|
|
|
2861
|
+
# The details about a log alarm.
|
|
2862
|
+
#
|
|
2863
|
+
# @!attribute [rw] alarm_name
|
|
2864
|
+
# The name of the alarm.
|
|
2865
|
+
# @return [String]
|
|
2866
|
+
#
|
|
2867
|
+
# @!attribute [rw] alarm_arn
|
|
2868
|
+
# The Amazon Resource Name (ARN) of the alarm.
|
|
2869
|
+
# @return [String]
|
|
2870
|
+
#
|
|
2871
|
+
# @!attribute [rw] alarm_description
|
|
2872
|
+
# The description of the alarm.
|
|
2873
|
+
# @return [String]
|
|
2874
|
+
#
|
|
2875
|
+
# @!attribute [rw] alarm_configuration_updated_timestamp
|
|
2876
|
+
# The time stamp of the last update to the alarm configuration.
|
|
2877
|
+
# @return [Time]
|
|
2878
|
+
#
|
|
2879
|
+
# @!attribute [rw] actions_enabled
|
|
2880
|
+
# Indicates whether actions should be executed during any changes to
|
|
2881
|
+
# the alarm state.
|
|
2882
|
+
# @return [Boolean]
|
|
2883
|
+
#
|
|
2884
|
+
# @!attribute [rw] ok_actions
|
|
2885
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
2886
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
2887
|
+
# Name (ARN).
|
|
2888
|
+
# @return [Array<String>]
|
|
2889
|
+
#
|
|
2890
|
+
# @!attribute [rw] alarm_actions
|
|
2891
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
2892
|
+
# state from any other state. Each action is specified as an Amazon
|
|
2893
|
+
# Resource Name (ARN).
|
|
2894
|
+
# @return [Array<String>]
|
|
2895
|
+
#
|
|
2896
|
+
# @!attribute [rw] insufficient_data_actions
|
|
2897
|
+
# The actions to execute when this alarm transitions to the
|
|
2898
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
2899
|
+
# specified as an Amazon Resource Name (ARN).
|
|
2900
|
+
# @return [Array<String>]
|
|
2901
|
+
#
|
|
2902
|
+
# @!attribute [rw] state_value
|
|
2903
|
+
# The state value for the alarm.
|
|
2904
|
+
# @return [String]
|
|
2905
|
+
#
|
|
2906
|
+
# @!attribute [rw] state_reason
|
|
2907
|
+
# An explanation for the alarm state, in text format.
|
|
2908
|
+
# @return [String]
|
|
2909
|
+
#
|
|
2910
|
+
# @!attribute [rw] state_reason_data
|
|
2911
|
+
# An explanation for the alarm state, in JSON format.
|
|
2912
|
+
# @return [String]
|
|
2913
|
+
#
|
|
2914
|
+
# @!attribute [rw] state_updated_timestamp
|
|
2915
|
+
# The time stamp of the last update to the value of either the
|
|
2916
|
+
# `StateValue` or `EvaluationState` parameters.
|
|
2917
|
+
# @return [Time]
|
|
2918
|
+
#
|
|
2919
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
2920
|
+
# The configuration of the underlying CloudWatch Logs scheduled query,
|
|
2921
|
+
# including the query string, log groups, schedule, aggregation
|
|
2922
|
+
# expression, and the ARN of the managed scheduled query.
|
|
2923
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
2924
|
+
#
|
|
2925
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
2926
|
+
# The number of most recent scheduled query results that the alarm
|
|
2927
|
+
# evaluates against the threshold (the N in M-of-N evaluation).
|
|
2928
|
+
# @return [Integer]
|
|
2929
|
+
#
|
|
2930
|
+
# @!attribute [rw] query_results_to_alarm
|
|
2931
|
+
# The number of query results, out of the most recent
|
|
2932
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
2933
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
2934
|
+
# evaluation).
|
|
2935
|
+
# @return [Integer]
|
|
2936
|
+
#
|
|
2937
|
+
# @!attribute [rw] threshold
|
|
2938
|
+
# The value to compare with the aggregated query result.
|
|
2939
|
+
# @return [Float]
|
|
2940
|
+
#
|
|
2941
|
+
# @!attribute [rw] comparison_operator
|
|
2942
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
2943
|
+
# result and the threshold. The aggregated query result is used as the
|
|
2944
|
+
# first operand.
|
|
2945
|
+
# @return [String]
|
|
2946
|
+
#
|
|
2947
|
+
# @!attribute [rw] treat_missing_data
|
|
2948
|
+
# How this alarm handles missing data points. Valid values are
|
|
2949
|
+
# `breaching`, `notBreaching`, `ignore`, and `missing`.
|
|
2950
|
+
# @return [String]
|
|
2951
|
+
#
|
|
2952
|
+
# @!attribute [rw] state_transitioned_timestamp
|
|
2953
|
+
# The date and time that the alarm's `StateValue` most recently
|
|
2954
|
+
# changed.
|
|
2955
|
+
# @return [Time]
|
|
2956
|
+
#
|
|
2957
|
+
# @!attribute [rw] evaluation_state
|
|
2958
|
+
# If the value of this field is `EVALUATION_ERROR`, it indicates
|
|
2959
|
+
# configuration errors in the alarm setup that require review and
|
|
2960
|
+
# correction. Refer to the `StateReason` field of the alarm for more
|
|
2961
|
+
# details.
|
|
2962
|
+
#
|
|
2963
|
+
# If the value of this field is `EVALUATION_FAILURE`, it indicates
|
|
2964
|
+
# temporary CloudWatch issues. We recommend manual monitoring until
|
|
2965
|
+
# the issue is resolved.
|
|
2966
|
+
#
|
|
2967
|
+
# If the value of this field is `PARTIAL_DATA`, it indicates that the
|
|
2968
|
+
# query returned the maximum 500 contributor groups but more matched.
|
|
2969
|
+
# The alarm evaluates the available contributors, but results might be
|
|
2970
|
+
# incomplete.
|
|
2971
|
+
# @return [String]
|
|
2972
|
+
#
|
|
2973
|
+
# @!attribute [rw] action_log_line_count
|
|
2974
|
+
# The number of log lines from the most recent scheduled query
|
|
2975
|
+
# execution that are included in alarm action notifications. Valid
|
|
2976
|
+
# range is 0 through 50. A value of 0 means no log lines are included.
|
|
2977
|
+
# @return [Integer]
|
|
2978
|
+
#
|
|
2979
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
2980
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
2981
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
2982
|
+
# notifications. Set when `ActionLogLineCount` is greater than 0.
|
|
2983
|
+
# @return [String]
|
|
2984
|
+
#
|
|
2985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/LogAlarm AWS API Documentation
|
|
2986
|
+
#
|
|
2987
|
+
class LogAlarm < Struct.new(
|
|
2988
|
+
:alarm_name,
|
|
2989
|
+
:alarm_arn,
|
|
2990
|
+
:alarm_description,
|
|
2991
|
+
:alarm_configuration_updated_timestamp,
|
|
2992
|
+
:actions_enabled,
|
|
2993
|
+
:ok_actions,
|
|
2994
|
+
:alarm_actions,
|
|
2995
|
+
:insufficient_data_actions,
|
|
2996
|
+
:state_value,
|
|
2997
|
+
:state_reason,
|
|
2998
|
+
:state_reason_data,
|
|
2999
|
+
:state_updated_timestamp,
|
|
3000
|
+
:scheduled_query_configuration,
|
|
3001
|
+
:query_results_to_evaluate,
|
|
3002
|
+
:query_results_to_alarm,
|
|
3003
|
+
:threshold,
|
|
3004
|
+
:comparison_operator,
|
|
3005
|
+
:treat_missing_data,
|
|
3006
|
+
:state_transitioned_timestamp,
|
|
3007
|
+
:evaluation_state,
|
|
3008
|
+
:action_log_line_count,
|
|
3009
|
+
:action_log_line_role_arn)
|
|
3010
|
+
SENSITIVE = []
|
|
3011
|
+
include Aws::Structure
|
|
3012
|
+
end
|
|
3013
|
+
|
|
2852
3014
|
# Contains the information that's required to enable a managed
|
|
2853
3015
|
# Contributor Insights rule for an Amazon Web Services resource.
|
|
2854
3016
|
#
|
|
@@ -4206,7 +4368,7 @@ module Aws::CloudWatch
|
|
|
4206
4368
|
#
|
|
4207
4369
|
#
|
|
4208
4370
|
#
|
|
4209
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
4371
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
4210
4372
|
# @return [String]
|
|
4211
4373
|
#
|
|
4212
4374
|
# @!attribute [rw] tags
|
|
@@ -4337,6 +4499,175 @@ module Aws::CloudWatch
|
|
|
4337
4499
|
#
|
|
4338
4500
|
class PutInsightRuleOutput < Aws::EmptyStructure; end
|
|
4339
4501
|
|
|
4502
|
+
# @!attribute [rw] alarm_name
|
|
4503
|
+
# The name for the alarm. This name must be unique within the Amazon
|
|
4504
|
+
# Web Services account and Region.
|
|
4505
|
+
# @return [String]
|
|
4506
|
+
#
|
|
4507
|
+
# @!attribute [rw] alarm_description
|
|
4508
|
+
# The description for the alarm.
|
|
4509
|
+
# @return [String]
|
|
4510
|
+
#
|
|
4511
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
4512
|
+
# The configuration of the underlying CloudWatch Logs scheduled query
|
|
4513
|
+
# that this alarm evaluates, including the query string, log groups,
|
|
4514
|
+
# schedule, and aggregation expression.
|
|
4515
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
4516
|
+
#
|
|
4517
|
+
# @!attribute [rw] action_log_line_count
|
|
4518
|
+
# The number of log lines from the most recent scheduled query
|
|
4519
|
+
# execution to include in alarm action notifications. Valid range is 0
|
|
4520
|
+
# through 50. The default is 0, which means no log lines are included.
|
|
4521
|
+
# @return [Integer]
|
|
4522
|
+
#
|
|
4523
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
4524
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudWatch
|
|
4525
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
4526
|
+
# notifications. Required when `ActionLogLineCount` is greater than 0.
|
|
4527
|
+
# @return [String]
|
|
4528
|
+
#
|
|
4529
|
+
# @!attribute [rw] actions_enabled
|
|
4530
|
+
# Indicates whether actions should be executed during any changes to
|
|
4531
|
+
# the alarm state. The default is `true`.
|
|
4532
|
+
# @return [Boolean]
|
|
4533
|
+
#
|
|
4534
|
+
# @!attribute [rw] ok_actions
|
|
4535
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
4536
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
4537
|
+
# Name (ARN).
|
|
4538
|
+
#
|
|
4539
|
+
# Valid Values:
|
|
4540
|
+
#
|
|
4541
|
+
# **Amazon SNS actions:**
|
|
4542
|
+
#
|
|
4543
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4544
|
+
#
|
|
4545
|
+
# **Lambda actions:**
|
|
4546
|
+
#
|
|
4547
|
+
# * Invoke the latest version of a Lambda function:
|
|
4548
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4549
|
+
#
|
|
4550
|
+
# * Invoke a specific version of a Lambda function:
|
|
4551
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4552
|
+
# `
|
|
4553
|
+
#
|
|
4554
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4555
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4556
|
+
# `
|
|
4557
|
+
# @return [Array<String>]
|
|
4558
|
+
#
|
|
4559
|
+
# @!attribute [rw] alarm_actions
|
|
4560
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
4561
|
+
# state from any other state. Each action is specified as an Amazon
|
|
4562
|
+
# Resource Name (ARN).
|
|
4563
|
+
#
|
|
4564
|
+
# Valid Values:
|
|
4565
|
+
#
|
|
4566
|
+
# **Amazon SNS actions:**
|
|
4567
|
+
#
|
|
4568
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4569
|
+
#
|
|
4570
|
+
# **Lambda actions:**
|
|
4571
|
+
#
|
|
4572
|
+
# * Invoke the latest version of a Lambda function:
|
|
4573
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4574
|
+
#
|
|
4575
|
+
# * Invoke a specific version of a Lambda function:
|
|
4576
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4577
|
+
# `
|
|
4578
|
+
#
|
|
4579
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4580
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4581
|
+
# `
|
|
4582
|
+
#
|
|
4583
|
+
# **Systems Manager actions:**
|
|
4584
|
+
#
|
|
4585
|
+
# `arn:aws:ssm:region:account-id:opsitem:severity `
|
|
4586
|
+
# @return [Array<String>]
|
|
4587
|
+
#
|
|
4588
|
+
# @!attribute [rw] insufficient_data_actions
|
|
4589
|
+
# The actions to execute when this alarm transitions to the
|
|
4590
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
4591
|
+
# specified as an Amazon Resource Name (ARN).
|
|
4592
|
+
#
|
|
4593
|
+
# Valid Values:
|
|
4594
|
+
#
|
|
4595
|
+
# **Amazon SNS actions:**
|
|
4596
|
+
#
|
|
4597
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4598
|
+
#
|
|
4599
|
+
# **Lambda actions:**
|
|
4600
|
+
#
|
|
4601
|
+
# * Invoke the latest version of a Lambda function:
|
|
4602
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4603
|
+
#
|
|
4604
|
+
# * Invoke a specific version of a Lambda function:
|
|
4605
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4606
|
+
# `
|
|
4607
|
+
#
|
|
4608
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4609
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4610
|
+
# `
|
|
4611
|
+
# @return [Array<String>]
|
|
4612
|
+
#
|
|
4613
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
4614
|
+
# The number of most recent scheduled query results to evaluate
|
|
4615
|
+
# against the threshold (the N in M-of-N evaluation). Valid range is 1
|
|
4616
|
+
# through 100.
|
|
4617
|
+
# @return [Integer]
|
|
4618
|
+
#
|
|
4619
|
+
# @!attribute [rw] query_results_to_alarm
|
|
4620
|
+
# The number of query results, out of the most recent
|
|
4621
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
4622
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
4623
|
+
# evaluation). Must be less than or equal to `QueryResultsToEvaluate`.
|
|
4624
|
+
# @return [Integer]
|
|
4625
|
+
#
|
|
4626
|
+
# @!attribute [rw] threshold
|
|
4627
|
+
# The value to compare with the aggregated query result.
|
|
4628
|
+
# @return [Float]
|
|
4629
|
+
#
|
|
4630
|
+
# @!attribute [rw] comparison_operator
|
|
4631
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
4632
|
+
# result and the threshold. The aggregated query result is used as the
|
|
4633
|
+
# first operand. Valid values are `GreaterThanThreshold`,
|
|
4634
|
+
# `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, and
|
|
4635
|
+
# `LessThanOrEqualToThreshold`.
|
|
4636
|
+
# @return [String]
|
|
4637
|
+
#
|
|
4638
|
+
# @!attribute [rw] treat_missing_data
|
|
4639
|
+
# Sets how this alarm is to handle missing data points. Valid values
|
|
4640
|
+
# are `breaching`, `notBreaching`, `ignore`, and `missing`. If this
|
|
4641
|
+
# parameter is omitted, the default behavior of `missing` is used.
|
|
4642
|
+
# @return [String]
|
|
4643
|
+
#
|
|
4644
|
+
# @!attribute [rw] tags
|
|
4645
|
+
# A list of key-value pairs to associate with the alarm. You can use
|
|
4646
|
+
# tags to categorize and manage your alarms.
|
|
4647
|
+
# @return [Array<Types::Tag>]
|
|
4648
|
+
#
|
|
4649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutLogAlarmInput AWS API Documentation
|
|
4650
|
+
#
|
|
4651
|
+
class PutLogAlarmInput < Struct.new(
|
|
4652
|
+
:alarm_name,
|
|
4653
|
+
:alarm_description,
|
|
4654
|
+
:scheduled_query_configuration,
|
|
4655
|
+
:action_log_line_count,
|
|
4656
|
+
:action_log_line_role_arn,
|
|
4657
|
+
:actions_enabled,
|
|
4658
|
+
:ok_actions,
|
|
4659
|
+
:alarm_actions,
|
|
4660
|
+
:insufficient_data_actions,
|
|
4661
|
+
:query_results_to_evaluate,
|
|
4662
|
+
:query_results_to_alarm,
|
|
4663
|
+
:threshold,
|
|
4664
|
+
:comparison_operator,
|
|
4665
|
+
:treat_missing_data,
|
|
4666
|
+
:tags)
|
|
4667
|
+
SENSITIVE = []
|
|
4668
|
+
include Aws::Structure
|
|
4669
|
+
end
|
|
4670
|
+
|
|
4340
4671
|
# @!attribute [rw] managed_rules
|
|
4341
4672
|
# A list of `ManagedRules` to enable.
|
|
4342
4673
|
# @return [Array<Types::ManagedRule>]
|
|
@@ -5108,6 +5439,21 @@ module Aws::CloudWatch
|
|
|
5108
5439
|
include Aws::Structure
|
|
5109
5440
|
end
|
|
5110
5441
|
|
|
5442
|
+
# The operation could not be completed because the request conflicts
|
|
5443
|
+
# with the current state of the alarm or its underlying scheduled query
|
|
5444
|
+
# resource.
|
|
5445
|
+
#
|
|
5446
|
+
# @!attribute [rw] message
|
|
5447
|
+
# @return [String]
|
|
5448
|
+
#
|
|
5449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ResourceConflict AWS API Documentation
|
|
5450
|
+
#
|
|
5451
|
+
class ResourceConflict < Struct.new(
|
|
5452
|
+
:message)
|
|
5453
|
+
SENSITIVE = []
|
|
5454
|
+
include Aws::Structure
|
|
5455
|
+
end
|
|
5456
|
+
|
|
5111
5457
|
# The named resource does not exist.
|
|
5112
5458
|
#
|
|
5113
5459
|
# @!attribute [rw] message
|
|
@@ -5262,6 +5608,96 @@ module Aws::CloudWatch
|
|
|
5262
5608
|
include Aws::Structure
|
|
5263
5609
|
end
|
|
5264
5610
|
|
|
5611
|
+
# Contains the schedule expression and time-range offsets that define
|
|
5612
|
+
# when a scheduled query runs and what time range each execution covers.
|
|
5613
|
+
#
|
|
5614
|
+
# @!attribute [rw] schedule_expression
|
|
5615
|
+
# The schedule expression that defines how often the underlying
|
|
5616
|
+
# CloudWatch Logs scheduled query runs. Specify a `rate()` expression,
|
|
5617
|
+
# for example `rate(5 minutes)`.
|
|
5618
|
+
# @return [String]
|
|
5619
|
+
#
|
|
5620
|
+
# @!attribute [rw] start_time_offset
|
|
5621
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5622
|
+
# the query time range begins. For example, an offset of 360 (6
|
|
5623
|
+
# minutes) on a query running at 12:05:00 starts the query time range
|
|
5624
|
+
# at 11:59:00.
|
|
5625
|
+
# @return [Integer]
|
|
5626
|
+
#
|
|
5627
|
+
# @!attribute [rw] end_time_offset
|
|
5628
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5629
|
+
# the query time range ends. Must be non-negative and less than
|
|
5630
|
+
# `StartTimeOffset`. The default is 0.
|
|
5631
|
+
# @return [Integer]
|
|
5632
|
+
#
|
|
5633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduleConfiguration AWS API Documentation
|
|
5634
|
+
#
|
|
5635
|
+
class ScheduleConfiguration < Struct.new(
|
|
5636
|
+
:schedule_expression,
|
|
5637
|
+
:start_time_offset,
|
|
5638
|
+
:end_time_offset)
|
|
5639
|
+
SENSITIVE = []
|
|
5640
|
+
include Aws::Structure
|
|
5641
|
+
end
|
|
5642
|
+
|
|
5643
|
+
# The configuration of the CloudWatch Logs scheduled query that backs a
|
|
5644
|
+
# log alarm.
|
|
5645
|
+
#
|
|
5646
|
+
# @!attribute [rw] query_string
|
|
5647
|
+
# The CloudWatch Logs query to execute on each scheduled run. Length
|
|
5648
|
+
# constraints: maximum of 10,000 characters.
|
|
5649
|
+
# @return [String]
|
|
5650
|
+
#
|
|
5651
|
+
# @!attribute [rw] log_group_identifiers
|
|
5652
|
+
# The log groups to query. Each entry can be a log group name or ARN.
|
|
5653
|
+
# Use the ARN form when querying log groups in a different account
|
|
5654
|
+
# (for example, when running cross-account queries from a monitoring
|
|
5655
|
+
# account). The list must contain between 1 and 50 entries.
|
|
5656
|
+
# @return [Array<String>]
|
|
5657
|
+
#
|
|
5658
|
+
# @!attribute [rw] query_arn
|
|
5659
|
+
# The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled
|
|
5660
|
+
# query that the alarm uses. This field is populated in
|
|
5661
|
+
# `DescribeAlarms` responses.
|
|
5662
|
+
# @return [String]
|
|
5663
|
+
#
|
|
5664
|
+
# @!attribute [rw] scheduled_query_role_arn
|
|
5665
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
5666
|
+
# assumes when executing the scheduled query against the configured
|
|
5667
|
+
# log groups.
|
|
5668
|
+
# @return [String]
|
|
5669
|
+
#
|
|
5670
|
+
# @!attribute [rw] schedule_configuration
|
|
5671
|
+
# The schedule and time-range offset configuration for the underlying
|
|
5672
|
+
# scheduled query.
|
|
5673
|
+
# @return [Types::ScheduleConfiguration]
|
|
5674
|
+
#
|
|
5675
|
+
# @!attribute [rw] aggregation_expression
|
|
5676
|
+
# The expression that defines how to aggregate query results into one
|
|
5677
|
+
# or more scalar values for alarm evaluation. For example, `count(*)`
|
|
5678
|
+
# or `avg(latency) by host | sort desc`. Length constraints: minimum 1
|
|
5679
|
+
# character, maximum 2048 characters.
|
|
5680
|
+
# @return [String]
|
|
5681
|
+
#
|
|
5682
|
+
# @!attribute [rw] tags
|
|
5683
|
+
# A list of key-value pairs to associate with the underlying scheduled
|
|
5684
|
+
# query resource.
|
|
5685
|
+
# @return [Array<Types::Tag>]
|
|
5686
|
+
#
|
|
5687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduledQueryConfiguration AWS API Documentation
|
|
5688
|
+
#
|
|
5689
|
+
class ScheduledQueryConfiguration < Struct.new(
|
|
5690
|
+
:query_string,
|
|
5691
|
+
:log_group_identifiers,
|
|
5692
|
+
:query_arn,
|
|
5693
|
+
:scheduled_query_role_arn,
|
|
5694
|
+
:schedule_configuration,
|
|
5695
|
+
:aggregation_expression,
|
|
5696
|
+
:tags)
|
|
5697
|
+
SENSITIVE = []
|
|
5698
|
+
include Aws::Structure
|
|
5699
|
+
end
|
|
5700
|
+
|
|
5265
5701
|
# @!attribute [rw] alarm_name
|
|
5266
5702
|
# The name of the alarm.
|
|
5267
5703
|
# @return [String]
|