1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
import json
from collections.abc import Iterable
from moto.core.responses import ActionResult, BaseResponse, EmptyResult
from .exceptions import (
DashboardInvalidInputError,
InvalidParameterCombination,
InvalidParameterValue,
ResourceNotFound,
ValidationError,
)
from .models import (
Alarm,
CloudWatchBackend,
Dimension,
Metric,
MetricDataQuery,
MetricStat,
cloudwatch_backends,
)
class CloudWatchResponse(BaseResponse):
def __init__(self) -> None:
super().__init__(service_name="cloudwatch")
self.automated_parameter_parsing = True
@property
def cloudwatch_backend(self) -> CloudWatchBackend:
return cloudwatch_backends[self.current_account][self.region]
def put_metric_alarm(self) -> ActionResult:
name = self._get_param("AlarmName")
namespace = self._get_param("Namespace")
metric_name = self._get_param("MetricName")
metrics = self._get_param("Metrics", [])
metric_data_queries = None
if metrics:
metric_data_queries = []
for metric in metrics:
metric_dimensions = []
dims = (
metric.get("MetricStat", {}).get("Metric", {}).get("Dimensions", [])
)
for dim in dims:
metric_dimensions.append(
Dimension(name=dim.get("Name"), value=dim.get("Value"))
)
metric_stat = None
stat_metric_name = (
metric.get("MetricStat", {}).get("Metric", {}).get("MetricName")
)
if stat_metric_name:
stat_details = metric.get("MetricStat", {})
stat_metric_ns = stat_details.get("Metric", {}).get("Namespace")
metric_stat = MetricStat(
metric=Metric(
metric_name=stat_metric_name,
namespace=stat_metric_ns,
dimensions=metric_dimensions,
),
period=stat_details.get("Period"),
stat=stat_details.get("Stat"),
unit=stat_details.get("Unit"),
)
metric_data_queries.append(
MetricDataQuery(
query_id=metric.get("Id"),
label=metric.get("Label"),
period=metric.get("Period"),
return_data=metric.get("ReturnData"),
expression=metric.get("Expression"),
metric_stat=metric_stat,
)
)
comparison_operator = self._get_param("ComparisonOperator")
evaluation_periods = self._get_param("EvaluationPeriods")
datapoints_to_alarm = self._get_param("DatapointsToAlarm")
period = self._get_param("Period")
threshold = self._get_param("Threshold")
statistic = self._get_param("Statistic")
extended_statistic = self._get_param("ExtendedStatistic")
description = self._get_param("AlarmDescription")
dimensions = self._get_param("Dimensions", [])
alarm_actions = self._get_param("AlarmActions", [])
ok_actions = self._get_param("OKActions", [])
actions_enabled = self._get_bool_param("ActionsEnabled")
insufficient_data_actions = self._get_param("InsufficientDataActions", [])
unit = self._get_param("Unit")
treat_missing_data = self._get_param("TreatMissingData")
evaluate_low_sample_count_percentile = self._get_param(
"EvaluateLowSampleCountPercentile"
)
threshold_metric_id = self._get_param("ThresholdMetricId")
# fetch AlarmRule to re-use this method for composite alarms as well
rule = self._get_param("AlarmRule")
tags = self._get_param("Tags", [])
self.cloudwatch_backend.put_metric_alarm(
name=name,
namespace=namespace,
metric_name=metric_name,
metric_data_queries=metric_data_queries,
comparison_operator=comparison_operator,
evaluation_periods=evaluation_periods,
datapoints_to_alarm=datapoints_to_alarm,
period=period,
threshold=threshold,
statistic=statistic,
extended_statistic=extended_statistic,
description=description,
dimensions=dimensions,
alarm_actions=alarm_actions,
ok_actions=ok_actions,
insufficient_data_actions=insufficient_data_actions,
unit=unit,
actions_enabled=actions_enabled,
treat_missing_data=treat_missing_data,
evaluate_low_sample_count_percentile=evaluate_low_sample_count_percentile,
threshold_metric_id=threshold_metric_id,
rule=rule,
tags=tags,
)
return EmptyResult()
def describe_alarms(self) -> ActionResult:
action_prefix = self._get_param("ActionPrefix")
alarm_name_prefix = self._get_param("AlarmNamePrefix")
alarm_names = self._get_param("AlarmNames", [])
state_value = self._get_param("StateValue")
if action_prefix:
alarms = self.cloudwatch_backend.get_alarms_by_action_prefix(action_prefix)
elif alarm_name_prefix:
alarms = self.cloudwatch_backend.get_alarms_by_alarm_name_prefix(
alarm_name_prefix
)
elif alarm_names:
alarms = self.cloudwatch_backend.get_alarms_by_alarm_names(alarm_names)
elif state_value:
alarms = self.cloudwatch_backend.get_alarms_by_state_value(state_value)
else:
alarms = self.cloudwatch_backend.describe_alarms()
metric_alarms = [a for a in alarms if a.rule is None]
composite_alarms = [a for a in alarms if a.rule is not None]
result = {"MetricAlarms": metric_alarms, "CompositeAlarms": composite_alarms}
return ActionResult(result)
def delete_alarms(self) -> ActionResult:
alarm_names = self._get_param("AlarmNames", [])
self.cloudwatch_backend.delete_alarms(alarm_names)
return EmptyResult()
def put_metric_data(self) -> ActionResult:
namespace = self._get_param("Namespace")
metric_data = self._get_param("MetricData", [])
self.cloudwatch_backend.put_metric_data(namespace, metric_data)
return EmptyResult()
def get_metric_data(self) -> ActionResult:
params = self._get_params()
start = params["StartTime"]
end = params["EndTime"]
scan_by = params.get("ScanBy") or "TimestampDescending"
queries = params.get("MetricDataQueries", [])
for query in queries:
if "MetricStat" not in query and "Expression" not in query:
# AWS also returns the empty line
raise ValidationError(
"The parameter MetricDataQueries.member.1.MetricStat is required.\n"
)
results = self.cloudwatch_backend.get_metric_data(
start_time=start, end_time=end, queries=queries, scan_by=scan_by
)
result = {"MetricDataResults": results}
return ActionResult(result)
def get_metric_statistics(self) -> ActionResult:
namespace = self._get_param("Namespace")
metric_name = self._get_param("MetricName")
start_time = self._get_param("StartTime")
end_time = self._get_param("EndTime")
period = self._get_int_param("Period")
statistics = self._get_param("Statistics", [])
dimensions = self._get_param("Dimensions", [])
# Unsupported Parameters (To Be Implemented)
unit = self._get_param("Unit")
extended_statistics = self._get_param("ExtendedStatistics")
if not statistics and not extended_statistics:
raise InvalidParameterCombination(
"Must specify either Statistics or ExtendedStatistics"
)
datapoints = self.cloudwatch_backend.get_metric_statistics(
namespace,
metric_name,
start_time,
end_time,
period,
statistics,
unit=unit,
dimensions=dimensions,
)
result = {"Label": metric_name, "Datapoints": datapoints}
return ActionResult(result)
def list_metrics(self) -> ActionResult:
namespace = self._get_param("Namespace")
metric_name = self._get_param("MetricName")
dimensions = self._get_params().get("Dimensions", [])
next_token = self._get_param("NextToken")
next_token, metrics = self.cloudwatch_backend.list_metrics(
next_token, namespace, metric_name, dimensions
)
result = {"Metrics": metrics, "NextToken": next_token}
return ActionResult(result)
def delete_dashboards(self) -> ActionResult:
dashboards = self._get_param("DashboardNames", [])
if not dashboards:
raise InvalidParameterValue("Need at least 1 dashboard")
error = self.cloudwatch_backend.delete_dashboards(dashboards)
if error is not None:
raise ResourceNotFound(error)
return EmptyResult()
@staticmethod
def filter_alarms(
alarms: Iterable[Alarm], metric_name: str, namespace: str
) -> list[Alarm]:
metric_filtered_alarms = []
for alarm in alarms:
if alarm.metric_name == metric_name and alarm.namespace == namespace:
metric_filtered_alarms.append(alarm)
return metric_filtered_alarms
def describe_alarms_for_metric(self) -> ActionResult:
alarms = self.cloudwatch_backend.describe_alarms()
namespace = self._get_param("Namespace")
metric_name = self._get_param("MetricName")
filtered_alarms = self.filter_alarms(alarms, metric_name, namespace)
result = {"MetricAlarms": filtered_alarms}
return ActionResult(result)
def disable_alarm_actions(self) -> str:
raise NotImplementedError()
def enable_alarm_actions(self) -> str:
raise NotImplementedError()
def get_dashboard(self) -> ActionResult:
dashboard_name = self._get_param("DashboardName")
dashboard = self.cloudwatch_backend.get_dashboard(dashboard_name)
if dashboard is None:
raise ResourceNotFound("Dashboard does not exist")
return ActionResult(dashboard)
def list_dashboards(self) -> ActionResult:
prefix = self._get_param("DashboardNamePrefix", "")
dashboards = self.cloudwatch_backend.list_dashboards(prefix)
result = {"DashboardEntries": dashboards}
return ActionResult(result)
def put_dashboard(self) -> ActionResult:
name = self._get_param("DashboardName")
body = self._get_param("DashboardBody")
try:
json.loads(body)
except ValueError:
raise DashboardInvalidInputError("Body is invalid JSON")
self.cloudwatch_backend.put_dashboard(name, body)
result = {"DashboardValidationMessages": []} # type: ignore[var-annotated]
return ActionResult(result)
def set_alarm_state(self) -> ActionResult:
alarm_name = self._get_param("AlarmName")
reason = self._get_param("StateReason")
reason_data = self._get_param("StateReasonData")
state_value = self._get_param("StateValue")
self.cloudwatch_backend.set_alarm_state(
alarm_name, reason, reason_data, state_value
)
return EmptyResult()
def list_tags_for_resource(self) -> ActionResult:
resource_arn = self._get_param("ResourceARN")
tags = self.cloudwatch_backend.list_tags_for_resource(resource_arn)
result = {"Tags": [{"Key": k, "Value": v} for k, v in tags.items()]}
return ActionResult(result)
def tag_resource(self) -> ActionResult:
resource_arn = self._get_param("ResourceARN")
tags = self._get_param("Tags", [])
self.cloudwatch_backend.tag_resource(resource_arn, tags)
return EmptyResult()
def untag_resource(self) -> ActionResult:
resource_arn = self._get_param("ResourceARN")
tag_keys = self._get_param("TagKeys", [])
self.cloudwatch_backend.untag_resource(resource_arn, tag_keys)
return EmptyResult()
def put_insight_rule(self) -> ActionResult:
name = self._get_param("RuleName")
state = self._get_param("RuleState")
definition = self._get_param("RuleDefinition")
tags = self._get_param("Tags", [])
self.cloudwatch_backend.put_insight_rule(
name=name,
state=state,
definition=definition,
tags=tags,
)
return EmptyResult()
def describe_insight_rules(self) -> ActionResult:
rules = self.cloudwatch_backend.describe_insight_rules()
result = {"InsightRules": rules}
return ActionResult(result)
def delete_insight_rules(self) -> ActionResult:
names = self._get_param("RuleNames", [])
failures = self.cloudwatch_backend.delete_insight_rules(rule_names=names)
result = {"Failures": failures}
return ActionResult(result)
def disable_insight_rules(self) -> ActionResult:
names = self._get_param("RuleNames", [])
failures = self.cloudwatch_backend.disable_insight_rules(rule_names=names)
result = {"Failures": failures}
return ActionResult(result)
def enable_insight_rules(self) -> ActionResult:
names = self._get_param("RuleNames", [])
failures = self.cloudwatch_backend.enable_insight_rules(rule_names=names)
result = {"Failures": failures}
return ActionResult(result)
|
