aws-sdk-cloudwatch 1.59.0 → 1.81.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +113 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +66 -14
- data/lib/aws-sdk-cloudwatch/client.rb +556 -114
- data/lib/aws-sdk-cloudwatch/client_api.rb +129 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +92 -12
- data/lib/aws-sdk-cloudwatch/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-cloudwatch/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-cloudwatch/endpoints.rb +548 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +188 -67
- data/lib/aws-sdk-cloudwatch/plugins/endpoints.rb +144 -0
- data/lib/aws-sdk-cloudwatch/resource.rb +39 -5
- data/lib/aws-sdk-cloudwatch/types.rb +690 -891
- data/lib/aws-sdk-cloudwatch.rb +5 -1
- metadata +8 -4
@@ -108,19 +108,6 @@ module Aws::CloudWatch
|
|
108
108
|
# model is to be trained, including time ranges to exclude from use for
|
109
109
|
# training the model and the time zone to use for the metric.
|
110
110
|
#
|
111
|
-
# @note When making an API call, you may pass AnomalyDetectorConfiguration
|
112
|
-
# data as a hash:
|
113
|
-
#
|
114
|
-
# {
|
115
|
-
# excluded_time_ranges: [
|
116
|
-
# {
|
117
|
-
# start_time: Time.now, # required
|
118
|
-
# end_time: Time.now, # required
|
119
|
-
# },
|
120
|
-
# ],
|
121
|
-
# metric_timezone: "AnomalyDetectorMetricTimezone",
|
122
|
-
# }
|
123
|
-
#
|
124
111
|
# @!attribute [rw] excluded_time_ranges
|
125
112
|
# An array of time ranges to exclude from use when the anomaly
|
126
113
|
# detection model is trained. Use this to make sure that events that
|
@@ -205,13 +192,60 @@ module Aws::CloudWatch
|
|
205
192
|
# @return [String]
|
206
193
|
#
|
207
194
|
# @!attribute [rw] state_updated_timestamp
|
208
|
-
#
|
195
|
+
# Tracks the timestamp of any state update, even if `StateValue`
|
196
|
+
# doesn't change.
|
209
197
|
# @return [Time]
|
210
198
|
#
|
211
199
|
# @!attribute [rw] state_value
|
212
200
|
# The state value for the alarm.
|
213
201
|
# @return [String]
|
214
202
|
#
|
203
|
+
# @!attribute [rw] state_transitioned_timestamp
|
204
|
+
# The timestamp of the last change to the alarm's `StateValue`.
|
205
|
+
# @return [Time]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] actions_suppressed_by
|
208
|
+
# When the value is `ALARM`, it means that the actions are suppressed
|
209
|
+
# because the suppressor alarm is in `ALARM` When the value is
|
210
|
+
# `WaitPeriod`, it means that the actions are suppressed because the
|
211
|
+
# composite alarm is waiting for the suppressor alarm to go into into
|
212
|
+
# the `ALARM` state. The maximum waiting time is as specified in
|
213
|
+
# `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
|
214
|
+
# performs its actions. When the value is `ExtensionPeriod`, it means
|
215
|
+
# that the actions are suppressed because the composite alarm is
|
216
|
+
# waiting after the suppressor alarm went out of the `ALARM` state.
|
217
|
+
# The maximum waiting time is as specified in
|
218
|
+
# `ActionsSuppressorExtensionPeriod`. After this time, the composite
|
219
|
+
# alarm performs its actions.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] actions_suppressed_reason
|
223
|
+
# Captures the reason for action suppression.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] actions_suppressor
|
227
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
228
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
229
|
+
# Name (ARN) from an existing alarm.
|
230
|
+
# @return [String]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
233
|
+
# The maximum time in seconds that the composite alarm waits for the
|
234
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
235
|
+
# composite alarm performs its actions.
|
236
|
+
#
|
237
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
238
|
+
# @return [Integer]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
241
|
+
# The maximum time in seconds that the composite alarm waits after
|
242
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
243
|
+
# composite alarm performs its actions.
|
244
|
+
#
|
245
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
246
|
+
# specified.
|
247
|
+
# @return [Integer]
|
248
|
+
#
|
215
249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/CompositeAlarm AWS API Documentation
|
216
250
|
#
|
217
251
|
class CompositeAlarm < Struct.new(
|
@@ -227,7 +261,13 @@ module Aws::CloudWatch
|
|
227
261
|
:state_reason,
|
228
262
|
:state_reason_data,
|
229
263
|
:state_updated_timestamp,
|
230
|
-
:state_value
|
264
|
+
:state_value,
|
265
|
+
:state_transitioned_timestamp,
|
266
|
+
:actions_suppressed_by,
|
267
|
+
:actions_suppressed_reason,
|
268
|
+
:actions_suppressor,
|
269
|
+
:actions_suppressor_wait_period,
|
270
|
+
:actions_suppressor_extension_period)
|
231
271
|
SENSITIVE = []
|
232
272
|
include Aws::Structure
|
233
273
|
end
|
@@ -369,15 +409,9 @@ module Aws::CloudWatch
|
|
369
409
|
include Aws::Structure
|
370
410
|
end
|
371
411
|
|
372
|
-
# @note When making an API call, you may pass DeleteAlarmsInput
|
373
|
-
# data as a hash:
|
374
|
-
#
|
375
|
-
# {
|
376
|
-
# alarm_names: ["AlarmName"], # required
|
377
|
-
# }
|
378
|
-
#
|
379
412
|
# @!attribute [rw] alarm_names
|
380
|
-
# The alarms to be deleted.
|
413
|
+
# The alarms to be deleted. Do not enclose the alarm names in quote
|
414
|
+
# marks.
|
381
415
|
# @return [Array<String>]
|
382
416
|
#
|
383
417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsInput AWS API Documentation
|
@@ -388,59 +422,6 @@ module Aws::CloudWatch
|
|
388
422
|
include Aws::Structure
|
389
423
|
end
|
390
424
|
|
391
|
-
# @note When making an API call, you may pass DeleteAnomalyDetectorInput
|
392
|
-
# data as a hash:
|
393
|
-
#
|
394
|
-
# {
|
395
|
-
# namespace: "Namespace",
|
396
|
-
# metric_name: "MetricName",
|
397
|
-
# dimensions: [
|
398
|
-
# {
|
399
|
-
# name: "DimensionName", # required
|
400
|
-
# value: "DimensionValue", # required
|
401
|
-
# },
|
402
|
-
# ],
|
403
|
-
# stat: "AnomalyDetectorMetricStat",
|
404
|
-
# single_metric_anomaly_detector: {
|
405
|
-
# namespace: "Namespace",
|
406
|
-
# metric_name: "MetricName",
|
407
|
-
# dimensions: [
|
408
|
-
# {
|
409
|
-
# name: "DimensionName", # required
|
410
|
-
# value: "DimensionValue", # required
|
411
|
-
# },
|
412
|
-
# ],
|
413
|
-
# stat: "AnomalyDetectorMetricStat",
|
414
|
-
# },
|
415
|
-
# metric_math_anomaly_detector: {
|
416
|
-
# metric_data_queries: [
|
417
|
-
# {
|
418
|
-
# id: "MetricId", # required
|
419
|
-
# metric_stat: {
|
420
|
-
# metric: { # required
|
421
|
-
# namespace: "Namespace",
|
422
|
-
# metric_name: "MetricName",
|
423
|
-
# dimensions: [
|
424
|
-
# {
|
425
|
-
# name: "DimensionName", # required
|
426
|
-
# value: "DimensionValue", # required
|
427
|
-
# },
|
428
|
-
# ],
|
429
|
-
# },
|
430
|
-
# period: 1, # required
|
431
|
-
# stat: "Stat", # required
|
432
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
433
|
-
# },
|
434
|
-
# expression: "MetricExpression",
|
435
|
-
# label: "MetricLabel",
|
436
|
-
# return_data: false,
|
437
|
-
# period: 1,
|
438
|
-
# account_id: "AccountId",
|
439
|
-
# },
|
440
|
-
# ],
|
441
|
-
# },
|
442
|
-
# }
|
443
|
-
#
|
444
425
|
# @!attribute [rw] namespace
|
445
426
|
# The namespace associated with the anomaly detection model to delete.
|
446
427
|
# @return [String]
|
@@ -518,13 +499,6 @@ module Aws::CloudWatch
|
|
518
499
|
#
|
519
500
|
class DeleteAnomalyDetectorOutput < Aws::EmptyStructure; end
|
520
501
|
|
521
|
-
# @note When making an API call, you may pass DeleteDashboardsInput
|
522
|
-
# data as a hash:
|
523
|
-
#
|
524
|
-
# {
|
525
|
-
# dashboard_names: ["DashboardName"], # required
|
526
|
-
# }
|
527
|
-
#
|
528
502
|
# @!attribute [rw] dashboard_names
|
529
503
|
# The dashboards to be deleted. This parameter is required.
|
530
504
|
# @return [Array<String>]
|
@@ -541,13 +515,6 @@ module Aws::CloudWatch
|
|
541
515
|
#
|
542
516
|
class DeleteDashboardsOutput < Aws::EmptyStructure; end
|
543
517
|
|
544
|
-
# @note When making an API call, you may pass DeleteInsightRulesInput
|
545
|
-
# data as a hash:
|
546
|
-
#
|
547
|
-
# {
|
548
|
-
# rule_names: ["InsightRuleName"], # required
|
549
|
-
# }
|
550
|
-
#
|
551
518
|
# @!attribute [rw] rule_names
|
552
519
|
# An array of the rule names to delete. If you need to find out the
|
553
520
|
# names of your rules, use [DescribeInsightRules][1].
|
@@ -578,13 +545,6 @@ module Aws::CloudWatch
|
|
578
545
|
include Aws::Structure
|
579
546
|
end
|
580
547
|
|
581
|
-
# @note When making an API call, you may pass DeleteMetricStreamInput
|
582
|
-
# data as a hash:
|
583
|
-
#
|
584
|
-
# {
|
585
|
-
# name: "MetricStreamName", # required
|
586
|
-
# }
|
587
|
-
#
|
588
548
|
# @!attribute [rw] name
|
589
549
|
# The name of the metric stream to delete.
|
590
550
|
# @return [String]
|
@@ -601,20 +561,6 @@ module Aws::CloudWatch
|
|
601
561
|
#
|
602
562
|
class DeleteMetricStreamOutput < Aws::EmptyStructure; end
|
603
563
|
|
604
|
-
# @note When making an API call, you may pass DescribeAlarmHistoryInput
|
605
|
-
# data as a hash:
|
606
|
-
#
|
607
|
-
# {
|
608
|
-
# alarm_name: "AlarmName",
|
609
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
610
|
-
# history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
|
611
|
-
# start_date: Time.now,
|
612
|
-
# end_date: Time.now,
|
613
|
-
# max_records: 1,
|
614
|
-
# next_token: "NextToken",
|
615
|
-
# scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
|
616
|
-
# }
|
617
|
-
#
|
618
564
|
# @!attribute [rw] alarm_name
|
619
565
|
# The name of the alarm.
|
620
566
|
# @return [String]
|
@@ -686,24 +632,6 @@ module Aws::CloudWatch
|
|
686
632
|
include Aws::Structure
|
687
633
|
end
|
688
634
|
|
689
|
-
# @note When making an API call, you may pass DescribeAlarmsForMetricInput
|
690
|
-
# data as a hash:
|
691
|
-
#
|
692
|
-
# {
|
693
|
-
# metric_name: "MetricName", # required
|
694
|
-
# namespace: "Namespace", # required
|
695
|
-
# statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
|
696
|
-
# extended_statistic: "ExtendedStatistic",
|
697
|
-
# dimensions: [
|
698
|
-
# {
|
699
|
-
# name: "DimensionName", # required
|
700
|
-
# value: "DimensionValue", # required
|
701
|
-
# },
|
702
|
-
# ],
|
703
|
-
# period: 1,
|
704
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
705
|
-
# }
|
706
|
-
#
|
707
635
|
# @!attribute [rw] metric_name
|
708
636
|
# The name of the metric.
|
709
637
|
# @return [String]
|
@@ -762,21 +690,6 @@ module Aws::CloudWatch
|
|
762
690
|
include Aws::Structure
|
763
691
|
end
|
764
692
|
|
765
|
-
# @note When making an API call, you may pass DescribeAlarmsInput
|
766
|
-
# data as a hash:
|
767
|
-
#
|
768
|
-
# {
|
769
|
-
# alarm_names: ["AlarmName"],
|
770
|
-
# alarm_name_prefix: "AlarmNamePrefix",
|
771
|
-
# alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
|
772
|
-
# children_of_alarm_name: "AlarmName",
|
773
|
-
# parents_of_alarm_name: "AlarmName",
|
774
|
-
# state_value: "OK", # accepts OK, ALARM, INSUFFICIENT_DATA
|
775
|
-
# action_prefix: "ActionPrefix",
|
776
|
-
# max_records: 1,
|
777
|
-
# next_token: "NextToken",
|
778
|
-
# }
|
779
|
-
#
|
780
693
|
# @!attribute [rw] alarm_names
|
781
694
|
# The names of the alarms to retrieve information about.
|
782
695
|
# @return [Array<String>]
|
@@ -792,7 +705,16 @@ module Aws::CloudWatch
|
|
792
705
|
# @!attribute [rw] alarm_types
|
793
706
|
# Use this parameter to specify whether you want the operation to
|
794
707
|
# return metric alarms or composite alarms. If you omit this
|
795
|
-
# parameter, only metric alarms are returned
|
708
|
+
# parameter, only metric alarms are returned, even if composite alarms
|
709
|
+
# exist in the account.
|
710
|
+
#
|
711
|
+
# For example, if you omit this parameter or specify `MetricAlarms`,
|
712
|
+
# the operation returns only a list of metric alarms. It does not
|
713
|
+
# return any composite alarms, even if composite alarms exist in the
|
714
|
+
# account.
|
715
|
+
#
|
716
|
+
# If you specify `CompositeAlarms`, the operation returns only a list
|
717
|
+
# of composite alarms, and does not return any metric alarms.
|
796
718
|
# @return [Array<String>]
|
797
719
|
#
|
798
720
|
# @!attribute [rw] children_of_alarm_name
|
@@ -899,23 +821,6 @@ module Aws::CloudWatch
|
|
899
821
|
include Aws::Structure
|
900
822
|
end
|
901
823
|
|
902
|
-
# @note When making an API call, you may pass DescribeAnomalyDetectorsInput
|
903
|
-
# data as a hash:
|
904
|
-
#
|
905
|
-
# {
|
906
|
-
# next_token: "NextToken",
|
907
|
-
# max_results: 1,
|
908
|
-
# namespace: "Namespace",
|
909
|
-
# metric_name: "MetricName",
|
910
|
-
# dimensions: [
|
911
|
-
# {
|
912
|
-
# name: "DimensionName", # required
|
913
|
-
# value: "DimensionValue", # required
|
914
|
-
# },
|
915
|
-
# ],
|
916
|
-
# anomaly_detector_types: ["SINGLE_METRIC"], # accepts SINGLE_METRIC, METRIC_MATH
|
917
|
-
# }
|
918
|
-
#
|
919
824
|
# @!attribute [rw] next_token
|
920
825
|
# Use the token returned by the previous operation to request the next
|
921
826
|
# page of results.
|
@@ -985,14 +890,6 @@ module Aws::CloudWatch
|
|
985
890
|
include Aws::Structure
|
986
891
|
end
|
987
892
|
|
988
|
-
# @note When making an API call, you may pass DescribeInsightRulesInput
|
989
|
-
# data as a hash:
|
990
|
-
#
|
991
|
-
# {
|
992
|
-
# next_token: "NextToken",
|
993
|
-
# max_results: 1,
|
994
|
-
# }
|
995
|
-
#
|
996
893
|
# @!attribute [rw] next_token
|
997
894
|
# Include this value, if it was returned by the previous operation, to
|
998
895
|
# get the next set of rules.
|
@@ -1031,27 +928,26 @@ module Aws::CloudWatch
|
|
1031
928
|
end
|
1032
929
|
|
1033
930
|
# A dimension is a name/value pair that is part of the identity of a
|
1034
|
-
# metric.
|
1035
|
-
#
|
1036
|
-
# you
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
# @note When making an API call, you may pass Dimension
|
1040
|
-
# data as a hash:
|
931
|
+
# metric. Because dimensions are part of the unique identifier for a
|
932
|
+
# metric, whenever you add a unique name/value pair to one of your
|
933
|
+
# metrics, you are creating a new variation of that metric. For example,
|
934
|
+
# many Amazon EC2 metrics publish `InstanceId` as a dimension name, and
|
935
|
+
# the actual instance ID as the value for that dimension.
|
1041
936
|
#
|
1042
|
-
#
|
1043
|
-
# name: "DimensionName", # required
|
1044
|
-
# value: "DimensionValue", # required
|
1045
|
-
# }
|
937
|
+
# You can assign up to 30 dimensions to a metric.
|
1046
938
|
#
|
1047
939
|
# @!attribute [rw] name
|
1048
940
|
# The name of the dimension. Dimension names must contain only ASCII
|
1049
|
-
# characters
|
941
|
+
# characters, must include at least one non-whitespace character, and
|
942
|
+
# cannot start with a colon (`:`). ASCII control characters are not
|
943
|
+
# supported as part of dimension names.
|
1050
944
|
# @return [String]
|
1051
945
|
#
|
1052
946
|
# @!attribute [rw] value
|
1053
947
|
# The value of the dimension. Dimension values must contain only ASCII
|
1054
948
|
# characters and must include at least one non-whitespace character.
|
949
|
+
# ASCII control characters are not supported as part of dimension
|
950
|
+
# values.
|
1055
951
|
# @return [String]
|
1056
952
|
#
|
1057
953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension AWS API Documentation
|
@@ -1065,14 +961,6 @@ module Aws::CloudWatch
|
|
1065
961
|
|
1066
962
|
# Represents filters for a dimension.
|
1067
963
|
#
|
1068
|
-
# @note When making an API call, you may pass DimensionFilter
|
1069
|
-
# data as a hash:
|
1070
|
-
#
|
1071
|
-
# {
|
1072
|
-
# name: "DimensionName", # required
|
1073
|
-
# value: "DimensionValue",
|
1074
|
-
# }
|
1075
|
-
#
|
1076
964
|
# @!attribute [rw] name
|
1077
965
|
# The dimension name to be matched.
|
1078
966
|
# @return [String]
|
@@ -1090,13 +978,6 @@ module Aws::CloudWatch
|
|
1090
978
|
include Aws::Structure
|
1091
979
|
end
|
1092
980
|
|
1093
|
-
# @note When making an API call, you may pass DisableAlarmActionsInput
|
1094
|
-
# data as a hash:
|
1095
|
-
#
|
1096
|
-
# {
|
1097
|
-
# alarm_names: ["AlarmName"], # required
|
1098
|
-
# }
|
1099
|
-
#
|
1100
981
|
# @!attribute [rw] alarm_names
|
1101
982
|
# The names of the alarms.
|
1102
983
|
# @return [Array<String>]
|
@@ -1109,13 +990,6 @@ module Aws::CloudWatch
|
|
1109
990
|
include Aws::Structure
|
1110
991
|
end
|
1111
992
|
|
1112
|
-
# @note When making an API call, you may pass DisableInsightRulesInput
|
1113
|
-
# data as a hash:
|
1114
|
-
#
|
1115
|
-
# {
|
1116
|
-
# rule_names: ["InsightRuleName"], # required
|
1117
|
-
# }
|
1118
|
-
#
|
1119
993
|
# @!attribute [rw] rule_names
|
1120
994
|
# An array of the rule names to disable. If you need to find out the
|
1121
995
|
# names of your rules, use [DescribeInsightRules][1].
|
@@ -1146,13 +1020,6 @@ module Aws::CloudWatch
|
|
1146
1020
|
include Aws::Structure
|
1147
1021
|
end
|
1148
1022
|
|
1149
|
-
# @note When making an API call, you may pass EnableAlarmActionsInput
|
1150
|
-
# data as a hash:
|
1151
|
-
#
|
1152
|
-
# {
|
1153
|
-
# alarm_names: ["AlarmName"], # required
|
1154
|
-
# }
|
1155
|
-
#
|
1156
1023
|
# @!attribute [rw] alarm_names
|
1157
1024
|
# The names of the alarms.
|
1158
1025
|
# @return [Array<String>]
|
@@ -1165,13 +1032,6 @@ module Aws::CloudWatch
|
|
1165
1032
|
include Aws::Structure
|
1166
1033
|
end
|
1167
1034
|
|
1168
|
-
# @note When making an API call, you may pass EnableInsightRulesInput
|
1169
|
-
# data as a hash:
|
1170
|
-
#
|
1171
|
-
# {
|
1172
|
-
# rule_names: ["InsightRuleName"], # required
|
1173
|
-
# }
|
1174
|
-
#
|
1175
1035
|
# @!attribute [rw] rule_names
|
1176
1036
|
# An array of the rule names to enable. If you need to find out the
|
1177
1037
|
# names of your rules, use [DescribeInsightRules][1].
|
@@ -1202,13 +1062,6 @@ module Aws::CloudWatch
|
|
1202
1062
|
include Aws::Structure
|
1203
1063
|
end
|
1204
1064
|
|
1205
|
-
# @note When making an API call, you may pass GetDashboardInput
|
1206
|
-
# data as a hash:
|
1207
|
-
#
|
1208
|
-
# {
|
1209
|
-
# dashboard_name: "DashboardName", # required
|
1210
|
-
# }
|
1211
|
-
#
|
1212
1065
|
# @!attribute [rw] dashboard_name
|
1213
1066
|
# The name of the dashboard to be described.
|
1214
1067
|
# @return [String]
|
@@ -1250,19 +1103,6 @@ module Aws::CloudWatch
|
|
1250
1103
|
include Aws::Structure
|
1251
1104
|
end
|
1252
1105
|
|
1253
|
-
# @note When making an API call, you may pass GetInsightRuleReportInput
|
1254
|
-
# data as a hash:
|
1255
|
-
#
|
1256
|
-
# {
|
1257
|
-
# rule_name: "InsightRuleName", # required
|
1258
|
-
# start_time: Time.now, # required
|
1259
|
-
# end_time: Time.now, # required
|
1260
|
-
# period: 1, # required
|
1261
|
-
# max_contributor_count: 1,
|
1262
|
-
# metrics: ["InsightRuleMetricName"],
|
1263
|
-
# order_by: "InsightRuleOrderBy",
|
1264
|
-
# }
|
1265
|
-
#
|
1266
1106
|
# @!attribute [rw] rule_name
|
1267
1107
|
# The name of the rule that you want to see data from.
|
1268
1108
|
# @return [String]
|
@@ -1324,7 +1164,7 @@ module Aws::CloudWatch
|
|
1324
1164
|
#
|
1325
1165
|
# @!attribute [rw] order_by
|
1326
1166
|
# Determines what statistic to use to rank the contributors. Valid
|
1327
|
-
# values are
|
1167
|
+
# values are `Sum` and `Maximum`.
|
1328
1168
|
# @return [String]
|
1329
1169
|
#
|
1330
1170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetInsightRuleReportInput AWS API Documentation
|
@@ -1387,50 +1227,11 @@ module Aws::CloudWatch
|
|
1387
1227
|
include Aws::Structure
|
1388
1228
|
end
|
1389
1229
|
|
1390
|
-
# @note When making an API call, you may pass GetMetricDataInput
|
1391
|
-
# data as a hash:
|
1392
|
-
#
|
1393
|
-
# {
|
1394
|
-
# metric_data_queries: [ # required
|
1395
|
-
# {
|
1396
|
-
# id: "MetricId", # required
|
1397
|
-
# metric_stat: {
|
1398
|
-
# metric: { # required
|
1399
|
-
# namespace: "Namespace",
|
1400
|
-
# metric_name: "MetricName",
|
1401
|
-
# dimensions: [
|
1402
|
-
# {
|
1403
|
-
# name: "DimensionName", # required
|
1404
|
-
# value: "DimensionValue", # required
|
1405
|
-
# },
|
1406
|
-
# ],
|
1407
|
-
# },
|
1408
|
-
# period: 1, # required
|
1409
|
-
# stat: "Stat", # required
|
1410
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1411
|
-
# },
|
1412
|
-
# expression: "MetricExpression",
|
1413
|
-
# label: "MetricLabel",
|
1414
|
-
# return_data: false,
|
1415
|
-
# period: 1,
|
1416
|
-
# account_id: "AccountId",
|
1417
|
-
# },
|
1418
|
-
# ],
|
1419
|
-
# start_time: Time.now, # required
|
1420
|
-
# end_time: Time.now, # required
|
1421
|
-
# next_token: "NextToken",
|
1422
|
-
# scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
|
1423
|
-
# max_datapoints: 1,
|
1424
|
-
# label_options: {
|
1425
|
-
# timezone: "GetMetricDataLabelTimezone",
|
1426
|
-
# },
|
1427
|
-
# }
|
1428
|
-
#
|
1429
1230
|
# @!attribute [rw] metric_data_queries
|
1430
1231
|
# The metric queries to be returned. A single `GetMetricData` call can
|
1431
1232
|
# include as many as 500 `MetricDataQuery` structures. Each of these
|
1432
|
-
# structures can specify either a metric to retrieve,
|
1433
|
-
# expression to perform on retrieved data.
|
1233
|
+
# structures can specify either a metric to retrieve, a Metrics
|
1234
|
+
# Insights query, or a math expression to perform on retrieved data.
|
1434
1235
|
# @return [Array<Types::MetricDataQuery>]
|
1435
1236
|
#
|
1436
1237
|
# @!attribute [rw] start_time
|
@@ -1553,26 +1354,6 @@ module Aws::CloudWatch
|
|
1553
1354
|
include Aws::Structure
|
1554
1355
|
end
|
1555
1356
|
|
1556
|
-
# @note When making an API call, you may pass GetMetricStatisticsInput
|
1557
|
-
# data as a hash:
|
1558
|
-
#
|
1559
|
-
# {
|
1560
|
-
# namespace: "Namespace", # required
|
1561
|
-
# metric_name: "MetricName", # required
|
1562
|
-
# dimensions: [
|
1563
|
-
# {
|
1564
|
-
# name: "DimensionName", # required
|
1565
|
-
# value: "DimensionValue", # required
|
1566
|
-
# },
|
1567
|
-
# ],
|
1568
|
-
# start_time: Time.now, # required
|
1569
|
-
# end_time: Time.now, # required
|
1570
|
-
# period: 1, # required
|
1571
|
-
# statistics: ["SampleCount"], # accepts SampleCount, Average, Sum, Minimum, Maximum
|
1572
|
-
# extended_statistics: ["ExtendedStatistic"],
|
1573
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1574
|
-
# }
|
1575
|
-
#
|
1576
1357
|
# @!attribute [rw] namespace
|
1577
1358
|
# The namespace of the metric, with or without spaces.
|
1578
1359
|
# @return [String]
|
@@ -1720,13 +1501,6 @@ module Aws::CloudWatch
|
|
1720
1501
|
include Aws::Structure
|
1721
1502
|
end
|
1722
1503
|
|
1723
|
-
# @note When making an API call, you may pass GetMetricStreamInput
|
1724
|
-
# data as a hash:
|
1725
|
-
#
|
1726
|
-
# {
|
1727
|
-
# name: "MetricStreamName", # required
|
1728
|
-
# }
|
1729
|
-
#
|
1730
1504
|
# @!attribute [rw] name
|
1731
1505
|
# The name of the metric stream to retrieve information about.
|
1732
1506
|
# @return [String]
|
@@ -1761,8 +1535,8 @@ module Aws::CloudWatch
|
|
1761
1535
|
# @return [Array<Types::MetricStreamFilter>]
|
1762
1536
|
#
|
1763
1537
|
# @!attribute [rw] firehose_arn
|
1764
|
-
# The ARN of the Amazon Kinesis Firehose delivery stream that is
|
1765
|
-
# by this metric stream.
|
1538
|
+
# The ARN of the Amazon Kinesis Data Firehose delivery stream that is
|
1539
|
+
# used by this metric stream.
|
1766
1540
|
# @return [String]
|
1767
1541
|
#
|
1768
1542
|
# @!attribute [rw] role_arn
|
@@ -1784,8 +1558,32 @@ module Aws::CloudWatch
|
|
1784
1558
|
# @return [Time]
|
1785
1559
|
#
|
1786
1560
|
# @!attribute [rw] output_format
|
1561
|
+
# The output format for the stream. Valid values are `json` and
|
1562
|
+
# `opentelemetry0.7`. For more information about metric stream output
|
1563
|
+
# formats, see [Metric streams output formats][1].
|
1564
|
+
#
|
1565
|
+
#
|
1566
|
+
#
|
1567
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html
|
1787
1568
|
# @return [String]
|
1788
1569
|
#
|
1570
|
+
# @!attribute [rw] statistics_configurations
|
1571
|
+
# Each entry in this array displays information about one or more
|
1572
|
+
# metrics that include additional statistics in the metric stream. For
|
1573
|
+
# more information about the additional statistics, see [ CloudWatch
|
1574
|
+
# statistics definitions][1].
|
1575
|
+
#
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
1579
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] include_linked_accounts_metrics
|
1582
|
+
# If this is `true` and this metric stream is in a monitoring account,
|
1583
|
+
# then the stream includes metrics from source accounts that the
|
1584
|
+
# monitoring account is linked to.
|
1585
|
+
# @return [Boolean]
|
1586
|
+
#
|
1789
1587
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStreamOutput AWS API Documentation
|
1790
1588
|
#
|
1791
1589
|
class GetMetricStreamOutput < Struct.new(
|
@@ -1798,19 +1596,13 @@ module Aws::CloudWatch
|
|
1798
1596
|
:state,
|
1799
1597
|
:creation_date,
|
1800
1598
|
:last_update_date,
|
1801
|
-
:output_format
|
1599
|
+
:output_format,
|
1600
|
+
:statistics_configurations,
|
1601
|
+
:include_linked_accounts_metrics)
|
1802
1602
|
SENSITIVE = []
|
1803
1603
|
include Aws::Structure
|
1804
1604
|
end
|
1805
1605
|
|
1806
|
-
# @note When making an API call, you may pass GetMetricWidgetImageInput
|
1807
|
-
# data as a hash:
|
1808
|
-
#
|
1809
|
-
# {
|
1810
|
-
# metric_widget: "MetricWidget", # required
|
1811
|
-
# output_format: "OutputFormat",
|
1812
|
-
# }
|
1813
|
-
#
|
1814
1606
|
# @!attribute [rw] metric_widget
|
1815
1607
|
# A JSON string that defines the bitmap graph to be retrieved. The
|
1816
1608
|
# string includes the metrics to include in the graph, statistics,
|
@@ -1920,13 +1712,18 @@ module Aws::CloudWatch
|
|
1920
1712
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html
|
1921
1713
|
# @return [String]
|
1922
1714
|
#
|
1715
|
+
# @!attribute [rw] managed_rule
|
1716
|
+
# An optional built-in rule that Amazon Web Services manages.
|
1717
|
+
# @return [Boolean]
|
1718
|
+
#
|
1923
1719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/InsightRule AWS API Documentation
|
1924
1720
|
#
|
1925
1721
|
class InsightRule < Struct.new(
|
1926
1722
|
:name,
|
1927
1723
|
:state,
|
1928
1724
|
:schema,
|
1929
|
-
:definition
|
1725
|
+
:definition,
|
1726
|
+
:managed_rule)
|
1930
1727
|
SENSITIVE = []
|
1931
1728
|
include Aws::Structure
|
1932
1729
|
end
|
@@ -2161,13 +1958,6 @@ module Aws::CloudWatch
|
|
2161
1958
|
#
|
2162
1959
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html
|
2163
1960
|
#
|
2164
|
-
# @note When making an API call, you may pass LabelOptions
|
2165
|
-
# data as a hash:
|
2166
|
-
#
|
2167
|
-
# {
|
2168
|
-
# timezone: "GetMetricDataLabelTimezone",
|
2169
|
-
# }
|
2170
|
-
#
|
2171
1961
|
# @!attribute [rw] timezone
|
2172
1962
|
# The time zone to use for metric data return in this operation. The
|
2173
1963
|
# format is `+` or `-` followed by four digits. The first two digits
|
@@ -2204,14 +1994,6 @@ module Aws::CloudWatch
|
|
2204
1994
|
include Aws::Structure
|
2205
1995
|
end
|
2206
1996
|
|
2207
|
-
# @note When making an API call, you may pass ListDashboardsInput
|
2208
|
-
# data as a hash:
|
2209
|
-
#
|
2210
|
-
# {
|
2211
|
-
# dashboard_name_prefix: "DashboardNamePrefix",
|
2212
|
-
# next_token: "NextToken",
|
2213
|
-
# }
|
2214
|
-
#
|
2215
1997
|
# @!attribute [rw] dashboard_name_prefix
|
2216
1998
|
# If you specify this parameter, only the dashboards with names
|
2217
1999
|
# starting with the specified string are listed. The maximum length is
|
@@ -2251,14 +2033,51 @@ module Aws::CloudWatch
|
|
2251
2033
|
include Aws::Structure
|
2252
2034
|
end
|
2253
2035
|
|
2254
|
-
#
|
2255
|
-
#
|
2036
|
+
# @!attribute [rw] resource_arn
|
2037
|
+
# The ARN of an Amazon Web Services resource that has managed
|
2038
|
+
# Contributor Insights rules.
|
2039
|
+
# @return [String]
|
2040
|
+
#
|
2041
|
+
# @!attribute [rw] next_token
|
2042
|
+
# Include this value to get the next set of rules if the value was
|
2043
|
+
# returned by the previous operation.
|
2044
|
+
# @return [String]
|
2045
|
+
#
|
2046
|
+
# @!attribute [rw] max_results
|
2047
|
+
# The maximum number of results to return in one operation. If you
|
2048
|
+
# omit this parameter, the default number is used. The default number
|
2049
|
+
# is `100`.
|
2050
|
+
# @return [Integer]
|
2051
|
+
#
|
2052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListManagedInsightRulesInput AWS API Documentation
|
2053
|
+
#
|
2054
|
+
class ListManagedInsightRulesInput < Struct.new(
|
2055
|
+
:resource_arn,
|
2056
|
+
:next_token,
|
2057
|
+
:max_results)
|
2058
|
+
SENSITIVE = []
|
2059
|
+
include Aws::Structure
|
2060
|
+
end
|
2061
|
+
|
2062
|
+
# @!attribute [rw] managed_rules
|
2063
|
+
# The managed rules that are available for the specified Amazon Web
|
2064
|
+
# Services resource.
|
2065
|
+
# @return [Array<Types::ManagedRuleDescription>]
|
2256
2066
|
#
|
2257
|
-
#
|
2258
|
-
#
|
2259
|
-
#
|
2260
|
-
#
|
2067
|
+
# @!attribute [rw] next_token
|
2068
|
+
# Include this value to get the next set of rules if the value was
|
2069
|
+
# returned by the previous operation.
|
2070
|
+
# @return [String]
|
2071
|
+
#
|
2072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListManagedInsightRulesOutput AWS API Documentation
|
2261
2073
|
#
|
2074
|
+
class ListManagedInsightRulesOutput < Struct.new(
|
2075
|
+
:managed_rules,
|
2076
|
+
:next_token)
|
2077
|
+
SENSITIVE = []
|
2078
|
+
include Aws::Structure
|
2079
|
+
end
|
2080
|
+
|
2262
2081
|
# @!attribute [rw] next_token
|
2263
2082
|
# Include this value, if it was returned by the previous call, to get
|
2264
2083
|
# the next set of metric streams.
|
@@ -2296,22 +2115,6 @@ module Aws::CloudWatch
|
|
2296
2115
|
include Aws::Structure
|
2297
2116
|
end
|
2298
2117
|
|
2299
|
-
# @note When making an API call, you may pass ListMetricsInput
|
2300
|
-
# data as a hash:
|
2301
|
-
#
|
2302
|
-
# {
|
2303
|
-
# namespace: "Namespace",
|
2304
|
-
# metric_name: "MetricName",
|
2305
|
-
# dimensions: [
|
2306
|
-
# {
|
2307
|
-
# name: "DimensionName", # required
|
2308
|
-
# value: "DimensionValue",
|
2309
|
-
# },
|
2310
|
-
# ],
|
2311
|
-
# next_token: "NextToken",
|
2312
|
-
# recently_active: "PT3H", # accepts PT3H
|
2313
|
-
# }
|
2314
|
-
#
|
2315
2118
|
# @!attribute [rw] namespace
|
2316
2119
|
# The metric namespace to filter against. Only the namespace that
|
2317
2120
|
# matches exactly will be returned.
|
@@ -2343,6 +2146,20 @@ module Aws::CloudWatch
|
|
2343
2146
|
# than the specified time interval.
|
2344
2147
|
# @return [String]
|
2345
2148
|
#
|
2149
|
+
# @!attribute [rw] include_linked_accounts
|
2150
|
+
# If you are using this operation in a monitoring account, specify
|
2151
|
+
# `true` to include metrics from source accounts in the returned data.
|
2152
|
+
#
|
2153
|
+
# The default is `false`.
|
2154
|
+
# @return [Boolean]
|
2155
|
+
#
|
2156
|
+
# @!attribute [rw] owning_account
|
2157
|
+
# When you use this operation in a monitoring account, use this field
|
2158
|
+
# to return metrics only from one source account. To do so, specify
|
2159
|
+
# that source account ID in this field, and also specify `true` for
|
2160
|
+
# `IncludeLinkedAccounts`.
|
2161
|
+
# @return [String]
|
2162
|
+
#
|
2346
2163
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput AWS API Documentation
|
2347
2164
|
#
|
2348
2165
|
class ListMetricsInput < Struct.new(
|
@@ -2350,7 +2167,9 @@ module Aws::CloudWatch
|
|
2350
2167
|
:metric_name,
|
2351
2168
|
:dimensions,
|
2352
2169
|
:next_token,
|
2353
|
-
:recently_active
|
2170
|
+
:recently_active,
|
2171
|
+
:include_linked_accounts,
|
2172
|
+
:owning_account)
|
2354
2173
|
SENSITIVE = []
|
2355
2174
|
include Aws::Structure
|
2356
2175
|
end
|
@@ -2364,22 +2183,25 @@ module Aws::CloudWatch
|
|
2364
2183
|
# results.
|
2365
2184
|
# @return [String]
|
2366
2185
|
#
|
2186
|
+
# @!attribute [rw] owning_accounts
|
2187
|
+
# If you are using this operation in a monitoring account, this array
|
2188
|
+
# contains the account IDs of the source accounts where the metrics in
|
2189
|
+
# the returned data are from.
|
2190
|
+
#
|
2191
|
+
# This field is a 1:1 mapping between each metric that is returned and
|
2192
|
+
# the ID of the owning account.
|
2193
|
+
# @return [Array<String>]
|
2194
|
+
#
|
2367
2195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsOutput AWS API Documentation
|
2368
2196
|
#
|
2369
2197
|
class ListMetricsOutput < Struct.new(
|
2370
2198
|
:metrics,
|
2371
|
-
:next_token
|
2199
|
+
:next_token,
|
2200
|
+
:owning_accounts)
|
2372
2201
|
SENSITIVE = []
|
2373
2202
|
include Aws::Structure
|
2374
2203
|
end
|
2375
2204
|
|
2376
|
-
# @note When making an API call, you may pass ListTagsForResourceInput
|
2377
|
-
# data as a hash:
|
2378
|
-
#
|
2379
|
-
# {
|
2380
|
-
# resource_arn: "AmazonResourceName", # required
|
2381
|
-
# }
|
2382
|
-
#
|
2383
2205
|
# @!attribute [rw] resource_arn
|
2384
2206
|
# The ARN of the CloudWatch resource that you want to view tags for.
|
2385
2207
|
#
|
@@ -2387,7 +2209,7 @@ module Aws::CloudWatch
|
|
2387
2209
|
# `arn:aws:cloudwatch:Region:account-id:alarm:alarm-name `
|
2388
2210
|
#
|
2389
2211
|
# The ARN format of a Contributor Insights rule is
|
2390
|
-
# `arn:aws:cloudwatch:Region:account-id:insight-rule
|
2212
|
+
# `arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
|
2391
2213
|
# `
|
2392
2214
|
#
|
2393
2215
|
# For more information about ARN format, see [ Resource Types Defined
|
@@ -2420,6 +2242,92 @@ module Aws::CloudWatch
|
|
2420
2242
|
include Aws::Structure
|
2421
2243
|
end
|
2422
2244
|
|
2245
|
+
# Contains the information that's required to enable a managed
|
2246
|
+
# Contributor Insights rule for an Amazon Web Services resource.
|
2247
|
+
#
|
2248
|
+
# @!attribute [rw] template_name
|
2249
|
+
# The template name for the managed Contributor Insights rule, as
|
2250
|
+
# returned by `ListManagedInsightRules`.
|
2251
|
+
# @return [String]
|
2252
|
+
#
|
2253
|
+
# @!attribute [rw] resource_arn
|
2254
|
+
# The ARN of an Amazon Web Services resource that has managed
|
2255
|
+
# Contributor Insights rules.
|
2256
|
+
# @return [String]
|
2257
|
+
#
|
2258
|
+
# @!attribute [rw] tags
|
2259
|
+
# A list of key-value pairs that you can associate with a managed
|
2260
|
+
# Contributor Insights rule. You can associate as many as 50 tags with
|
2261
|
+
# a rule. Tags can help you organize and categorize your resources.
|
2262
|
+
# You also can use them to scope user permissions by granting a user
|
2263
|
+
# permission to access or change only the resources that have certain
|
2264
|
+
# tag values. To associate tags with a rule, you must have the
|
2265
|
+
# `cloudwatch:TagResource` permission in addition to the
|
2266
|
+
# `cloudwatch:PutInsightRule` permission. If you are using this
|
2267
|
+
# operation to update an existing Contributor Insights rule, any tags
|
2268
|
+
# that you specify in this parameter are ignored. To change the tags
|
2269
|
+
# of an existing rule, use `TagResource`.
|
2270
|
+
# @return [Array<Types::Tag>]
|
2271
|
+
#
|
2272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ManagedRule AWS API Documentation
|
2273
|
+
#
|
2274
|
+
class ManagedRule < Struct.new(
|
2275
|
+
:template_name,
|
2276
|
+
:resource_arn,
|
2277
|
+
:tags)
|
2278
|
+
SENSITIVE = []
|
2279
|
+
include Aws::Structure
|
2280
|
+
end
|
2281
|
+
|
2282
|
+
# Contains information about managed Contributor Insights rules, as
|
2283
|
+
# returned by `ListManagedInsightRules`.
|
2284
|
+
#
|
2285
|
+
# @!attribute [rw] template_name
|
2286
|
+
# The template name for the managed rule. Used to enable managed rules
|
2287
|
+
# using `PutManagedInsightRules`.
|
2288
|
+
# @return [String]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] resource_arn
|
2291
|
+
# If a managed rule is enabled, this is the ARN for the related Amazon
|
2292
|
+
# Web Services resource.
|
2293
|
+
# @return [String]
|
2294
|
+
#
|
2295
|
+
# @!attribute [rw] rule_state
|
2296
|
+
# Describes the state of a managed rule. If present, it contains
|
2297
|
+
# information about the Contributor Insights rule that contains
|
2298
|
+
# information about the related Amazon Web Services resource.
|
2299
|
+
# @return [Types::ManagedRuleState]
|
2300
|
+
#
|
2301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ManagedRuleDescription AWS API Documentation
|
2302
|
+
#
|
2303
|
+
class ManagedRuleDescription < Struct.new(
|
2304
|
+
:template_name,
|
2305
|
+
:resource_arn,
|
2306
|
+
:rule_state)
|
2307
|
+
SENSITIVE = []
|
2308
|
+
include Aws::Structure
|
2309
|
+
end
|
2310
|
+
|
2311
|
+
# The status of a managed Contributor Insights rule.
|
2312
|
+
#
|
2313
|
+
# @!attribute [rw] rule_name
|
2314
|
+
# The name of the Contributor Insights rule that contains data for the
|
2315
|
+
# specified Amazon Web Services resource.
|
2316
|
+
# @return [String]
|
2317
|
+
#
|
2318
|
+
# @!attribute [rw] state
|
2319
|
+
# Indicates whether the rule is enabled or disabled.
|
2320
|
+
# @return [String]
|
2321
|
+
#
|
2322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ManagedRuleState AWS API Documentation
|
2323
|
+
#
|
2324
|
+
class ManagedRuleState < Struct.new(
|
2325
|
+
:rule_name,
|
2326
|
+
:state)
|
2327
|
+
SENSITIVE = []
|
2328
|
+
include Aws::Structure
|
2329
|
+
end
|
2330
|
+
|
2423
2331
|
# A message returned by the `GetMetricData`API, including a code and a
|
2424
2332
|
# description.
|
2425
2333
|
#
|
@@ -2447,20 +2355,6 @@ module Aws::CloudWatch
|
|
2447
2355
|
|
2448
2356
|
# Represents a specific metric.
|
2449
2357
|
#
|
2450
|
-
# @note When making an API call, you may pass Metric
|
2451
|
-
# data as a hash:
|
2452
|
-
#
|
2453
|
-
# {
|
2454
|
-
# namespace: "Namespace",
|
2455
|
-
# metric_name: "MetricName",
|
2456
|
-
# dimensions: [
|
2457
|
-
# {
|
2458
|
-
# name: "DimensionName", # required
|
2459
|
-
# value: "DimensionValue", # required
|
2460
|
-
# },
|
2461
|
-
# ],
|
2462
|
-
# }
|
2463
|
-
#
|
2464
2358
|
# @!attribute [rw] namespace
|
2465
2359
|
# The namespace of the metric.
|
2466
2360
|
# @return [String]
|
@@ -2537,7 +2431,8 @@ module Aws::CloudWatch
|
|
2537
2431
|
# @return [String]
|
2538
2432
|
#
|
2539
2433
|
# @!attribute [rw] state_updated_timestamp
|
2540
|
-
# The time stamp of the last update to the
|
2434
|
+
# The time stamp of the last update to the value of either the
|
2435
|
+
# `StateValue` or `EvaluationState` parameters.
|
2541
2436
|
# @return [Time]
|
2542
2437
|
#
|
2543
2438
|
# @!attribute [rw] metric_name
|
@@ -2592,8 +2487,17 @@ module Aws::CloudWatch
|
|
2592
2487
|
# @return [String]
|
2593
2488
|
#
|
2594
2489
|
# @!attribute [rw] treat_missing_data
|
2595
|
-
# Sets how this alarm is to handle missing data points.
|
2596
|
-
#
|
2490
|
+
# Sets how this alarm is to handle missing data points. The valid
|
2491
|
+
# values are `breaching`, `notBreaching`, `ignore`, and `missing`. For
|
2492
|
+
# more information, see [Configuring how CloudWatch alarms treat
|
2493
|
+
# missing data][1].
|
2494
|
+
#
|
2495
|
+
# If this parameter is omitted, the default behavior of `missing` is
|
2496
|
+
# used.
|
2497
|
+
#
|
2498
|
+
#
|
2499
|
+
#
|
2500
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
2597
2501
|
# @return [String]
|
2598
2502
|
#
|
2599
2503
|
# @!attribute [rw] evaluate_low_sample_count_percentile
|
@@ -2618,6 +2522,22 @@ module Aws::CloudWatch
|
|
2618
2522
|
# alarm.
|
2619
2523
|
# @return [String]
|
2620
2524
|
#
|
2525
|
+
# @!attribute [rw] evaluation_state
|
2526
|
+
# If the value of this field is `PARTIAL_DATA`, the alarm is being
|
2527
|
+
# evaluated based on only partial data. This happens if the query used
|
2528
|
+
# for the alarm returns more than 10,000 metrics. For more
|
2529
|
+
# information, see [Create alarms on Metrics Insights queries][1].
|
2530
|
+
#
|
2531
|
+
#
|
2532
|
+
#
|
2533
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html
|
2534
|
+
# @return [String]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] state_transitioned_timestamp
|
2537
|
+
# The date and time that the alarm's `StateValue` most recently
|
2538
|
+
# changed.
|
2539
|
+
# @return [Time]
|
2540
|
+
#
|
2621
2541
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm AWS API Documentation
|
2622
2542
|
#
|
2623
2543
|
class MetricAlarm < Struct.new(
|
@@ -2647,7 +2567,9 @@ module Aws::CloudWatch
|
|
2647
2567
|
:treat_missing_data,
|
2648
2568
|
:evaluate_low_sample_count_percentile,
|
2649
2569
|
:metrics,
|
2650
|
-
:threshold_metric_id
|
2570
|
+
:threshold_metric_id,
|
2571
|
+
:evaluation_state,
|
2572
|
+
:state_transitioned_timestamp)
|
2651
2573
|
SENSITIVE = []
|
2652
2574
|
include Aws::Structure
|
2653
2575
|
end
|
@@ -2658,9 +2580,9 @@ module Aws::CloudWatch
|
|
2658
2580
|
#
|
2659
2581
|
# When used in `GetMetricData`, it indicates the metric data to return,
|
2660
2582
|
# and whether this call is just retrieving a batch set of data for one
|
2661
|
-
# metric, or is performing a
|
2662
|
-
# `GetMetricData` call can include up to 500
|
2663
|
-
# structures.
|
2583
|
+
# metric, or is performing a Metrics Insights query or a math
|
2584
|
+
# expression. A single `GetMetricData` call can include up to 500
|
2585
|
+
# `MetricDataQuery` structures.
|
2664
2586
|
#
|
2665
2587
|
# When used in `PutMetricAlarm`, it enables you to create an alarm based
|
2666
2588
|
# on a metric math expression. Each `MetricDataQuery` in the array
|
@@ -2670,7 +2592,7 @@ module Aws::CloudWatch
|
|
2670
2592
|
# structures can include as many as 10 structures that contain a
|
2671
2593
|
# `MetricStat` parameter to retrieve a metric, and as many as 10
|
2672
2594
|
# structures that contain the `Expression` parameter to perform a math
|
2673
|
-
# expression. Of those `Expression` structures, one must have `
|
2595
|
+
# expression. Of those `Expression` structures, one must have `true` as
|
2674
2596
|
# the value for `ReturnData`. The result of this expression is the value
|
2675
2597
|
# the alarm watches.
|
2676
2598
|
#
|
@@ -2687,33 +2609,6 @@ module Aws::CloudWatch
|
|
2687
2609
|
#
|
2688
2610
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
2689
2611
|
#
|
2690
|
-
# @note When making an API call, you may pass MetricDataQuery
|
2691
|
-
# data as a hash:
|
2692
|
-
#
|
2693
|
-
# {
|
2694
|
-
# id: "MetricId", # required
|
2695
|
-
# metric_stat: {
|
2696
|
-
# metric: { # required
|
2697
|
-
# namespace: "Namespace",
|
2698
|
-
# metric_name: "MetricName",
|
2699
|
-
# dimensions: [
|
2700
|
-
# {
|
2701
|
-
# name: "DimensionName", # required
|
2702
|
-
# value: "DimensionValue", # required
|
2703
|
-
# },
|
2704
|
-
# ],
|
2705
|
-
# },
|
2706
|
-
# period: 1, # required
|
2707
|
-
# stat: "Stat", # required
|
2708
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
2709
|
-
# },
|
2710
|
-
# expression: "MetricExpression",
|
2711
|
-
# label: "MetricLabel",
|
2712
|
-
# return_data: false,
|
2713
|
-
# period: 1,
|
2714
|
-
# account_id: "AccountId",
|
2715
|
-
# }
|
2716
|
-
#
|
2717
2612
|
# @!attribute [rw] id
|
2718
2613
|
# A short name used to tie this object to the results in the response.
|
2719
2614
|
# This name must be unique within a single call to `GetMetricData`. If
|
@@ -2733,20 +2628,25 @@ module Aws::CloudWatch
|
|
2733
2628
|
# @return [Types::MetricStat]
|
2734
2629
|
#
|
2735
2630
|
# @!attribute [rw] expression
|
2736
|
-
#
|
2737
|
-
#
|
2738
|
-
#
|
2739
|
-
#
|
2740
|
-
# expressions. For more information about metric math expressions, see
|
2741
|
-
# [Metric Math Syntax and Functions][1] in the *Amazon CloudWatch User
|
2631
|
+
# This field can contain either a Metrics Insights query, or a metric
|
2632
|
+
# math expression to be performed on the returned data. For more
|
2633
|
+
# information about Metrics Insights queries, see [Metrics Insights
|
2634
|
+
# query components and syntax][1] in the *Amazon CloudWatch User
|
2742
2635
|
# Guide*.
|
2743
2636
|
#
|
2637
|
+
# A math expression can use the `Id` of the other metrics or queries
|
2638
|
+
# to refer to those metrics, and can also use the `Id` of other
|
2639
|
+
# expressions to use the result of those expressions. For more
|
2640
|
+
# information about metric math expressions, see [Metric Math Syntax
|
2641
|
+
# and Functions][2] in the *Amazon CloudWatch User Guide*.
|
2642
|
+
#
|
2744
2643
|
# Within each MetricDataQuery object, you must specify either
|
2745
2644
|
# `Expression` or `MetricStat` but not both.
|
2746
2645
|
#
|
2747
2646
|
#
|
2748
2647
|
#
|
2749
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/
|
2648
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage
|
2649
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
2750
2650
|
# @return [String]
|
2751
2651
|
#
|
2752
2652
|
# @!attribute [rw] label
|
@@ -2768,10 +2668,10 @@ module Aws::CloudWatch
|
|
2768
2668
|
# When used in `GetMetricData`, this option indicates whether to
|
2769
2669
|
# return the timestamps and raw data values of this metric. If you are
|
2770
2670
|
# performing this call just to do math expressions and do not also
|
2771
|
-
# need the raw data returned, you can specify `
|
2772
|
-
# this, the default of `
|
2671
|
+
# need the raw data returned, you can specify `false`. If you omit
|
2672
|
+
# this, the default of `true` is used.
|
2773
2673
|
#
|
2774
|
-
# When used in `PutMetricAlarm`, specify `
|
2674
|
+
# When used in `PutMetricAlarm`, specify `true` for the one expression
|
2775
2675
|
# result to use as the alarm. For all other metrics and expressions in
|
2776
2676
|
# the same `PutMetricAlarm` operation, specify `ReturnData` as False.
|
2777
2677
|
# @return [Boolean]
|
@@ -2788,11 +2688,15 @@ module Aws::CloudWatch
|
|
2788
2688
|
# @return [Integer]
|
2789
2689
|
#
|
2790
2690
|
# @!attribute [rw] account_id
|
2791
|
-
# The ID of the account where the metrics are located
|
2792
|
-
#
|
2691
|
+
# The ID of the account where the metrics are located.
|
2692
|
+
#
|
2693
|
+
# If you are performing a `GetMetricData` operation in a monitoring
|
2694
|
+
# account, use this to specify which account to retrieve this metric
|
2695
|
+
# from.
|
2793
2696
|
#
|
2794
|
-
#
|
2795
|
-
#
|
2697
|
+
# If you are performing a `PutMetricAlarm` operation, use this to
|
2698
|
+
# specify which account contains the metric that the alarm is
|
2699
|
+
# watching.
|
2796
2700
|
# @return [String]
|
2797
2701
|
#
|
2798
2702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation
|
@@ -2865,31 +2769,6 @@ module Aws::CloudWatch
|
|
2865
2769
|
# Encapsulates the information sent to either create a metric or add new
|
2866
2770
|
# values to be aggregated into an existing metric.
|
2867
2771
|
#
|
2868
|
-
# @note When making an API call, you may pass MetricDatum
|
2869
|
-
# data as a hash:
|
2870
|
-
#
|
2871
|
-
# {
|
2872
|
-
# metric_name: "MetricName", # required
|
2873
|
-
# dimensions: [
|
2874
|
-
# {
|
2875
|
-
# name: "DimensionName", # required
|
2876
|
-
# value: "DimensionValue", # required
|
2877
|
-
# },
|
2878
|
-
# ],
|
2879
|
-
# timestamp: Time.now,
|
2880
|
-
# value: 1.0,
|
2881
|
-
# statistic_values: {
|
2882
|
-
# sample_count: 1.0, # required
|
2883
|
-
# sum: 1.0, # required
|
2884
|
-
# minimum: 1.0, # required
|
2885
|
-
# maximum: 1.0, # required
|
2886
|
-
# },
|
2887
|
-
# values: [1.0],
|
2888
|
-
# counts: [1.0],
|
2889
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
2890
|
-
# storage_resolution: 1,
|
2891
|
-
# }
|
2892
|
-
#
|
2893
2772
|
# @!attribute [rw] metric_name
|
2894
2773
|
# The name of the metric.
|
2895
2774
|
# @return [String]
|
@@ -2986,46 +2865,15 @@ module Aws::CloudWatch
|
|
2986
2865
|
# the anomaly detector uses as input. The designated math expression
|
2987
2866
|
# must return a single time series.
|
2988
2867
|
#
|
2989
|
-
# @note When making an API call, you may pass MetricMathAnomalyDetector
|
2990
|
-
# data as a hash:
|
2991
|
-
#
|
2992
|
-
# {
|
2993
|
-
# metric_data_queries: [
|
2994
|
-
# {
|
2995
|
-
# id: "MetricId", # required
|
2996
|
-
# metric_stat: {
|
2997
|
-
# metric: { # required
|
2998
|
-
# namespace: "Namespace",
|
2999
|
-
# metric_name: "MetricName",
|
3000
|
-
# dimensions: [
|
3001
|
-
# {
|
3002
|
-
# name: "DimensionName", # required
|
3003
|
-
# value: "DimensionValue", # required
|
3004
|
-
# },
|
3005
|
-
# ],
|
3006
|
-
# },
|
3007
|
-
# period: 1, # required
|
3008
|
-
# stat: "Stat", # required
|
3009
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3010
|
-
# },
|
3011
|
-
# expression: "MetricExpression",
|
3012
|
-
# label: "MetricLabel",
|
3013
|
-
# return_data: false,
|
3014
|
-
# period: 1,
|
3015
|
-
# account_id: "AccountId",
|
3016
|
-
# },
|
3017
|
-
# ],
|
3018
|
-
# }
|
3019
|
-
#
|
3020
2868
|
# @!attribute [rw] metric_data_queries
|
3021
2869
|
# An array of metric data query structures that enables you to create
|
3022
2870
|
# an anomaly detector based on the result of a metric math expression.
|
3023
2871
|
# Each item in `MetricDataQueries` gets a metric or performs a math
|
3024
2872
|
# expression. One item in `MetricDataQueries` is the expression that
|
3025
2873
|
# provides the time series that the anomaly detector uses as input.
|
3026
|
-
# Designate the expression by setting `ReturnData` to `
|
2874
|
+
# Designate the expression by setting `ReturnData` to `true` for this
|
3027
2875
|
# object in the array. For all other expressions and metrics, set
|
3028
|
-
# `ReturnData` to `
|
2876
|
+
# `ReturnData` to `false`. The designated expression must return a
|
3029
2877
|
# single time series.
|
3030
2878
|
# @return [Array<Types::MetricDataQuery>]
|
3031
2879
|
#
|
@@ -3040,25 +2888,6 @@ module Aws::CloudWatch
|
|
3040
2888
|
# This structure defines the metric to be returned, along with the
|
3041
2889
|
# statistics, period, and units.
|
3042
2890
|
#
|
3043
|
-
# @note When making an API call, you may pass MetricStat
|
3044
|
-
# data as a hash:
|
3045
|
-
#
|
3046
|
-
# {
|
3047
|
-
# metric: { # required
|
3048
|
-
# namespace: "Namespace",
|
3049
|
-
# metric_name: "MetricName",
|
3050
|
-
# dimensions: [
|
3051
|
-
# {
|
3052
|
-
# name: "DimensionName", # required
|
3053
|
-
# value: "DimensionValue", # required
|
3054
|
-
# },
|
3055
|
-
# ],
|
3056
|
-
# },
|
3057
|
-
# period: 1, # required
|
3058
|
-
# stat: "Stat", # required
|
3059
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3060
|
-
# }
|
3061
|
-
#
|
3062
2891
|
# @!attribute [rw] metric
|
3063
2892
|
# The metric to return, including the metric name, namespace, and
|
3064
2893
|
# dimensions.
|
@@ -3166,24 +2995,111 @@ module Aws::CloudWatch
|
|
3166
2995
|
include Aws::Structure
|
3167
2996
|
end
|
3168
2997
|
|
3169
|
-
# This structure contains
|
3170
|
-
#
|
3171
|
-
#
|
3172
|
-
# @note When making an API call, you may pass MetricStreamFilter
|
3173
|
-
# data as a hash:
|
2998
|
+
# This structure contains a metric namespace and optionally, a list of
|
2999
|
+
# metric names, to either include in a metric stream or exclude from a
|
3000
|
+
# metric stream.
|
3174
3001
|
#
|
3175
|
-
#
|
3176
|
-
#
|
3177
|
-
#
|
3002
|
+
# A metric stream's filters can include up to 1000 total names. This
|
3003
|
+
# limit applies to the sum of namespace names and metric names in the
|
3004
|
+
# filters. For example, this could include 10 metric namespace filters
|
3005
|
+
# with 99 metrics each, or 20 namespace filters with 49 metrics
|
3006
|
+
# specified in each filter.
|
3178
3007
|
#
|
3179
3008
|
# @!attribute [rw] namespace
|
3180
|
-
# The name of the metric namespace
|
3009
|
+
# The name of the metric namespace for this filter.
|
3010
|
+
#
|
3011
|
+
# The namespace can contain only ASCII printable characters (ASCII
|
3012
|
+
# range 32 through 126). It must contain at least one non-whitespace
|
3013
|
+
# character.
|
3181
3014
|
# @return [String]
|
3182
3015
|
#
|
3016
|
+
# @!attribute [rw] metric_names
|
3017
|
+
# The names of the metrics to either include or exclude from the
|
3018
|
+
# metric stream.
|
3019
|
+
#
|
3020
|
+
# If you omit this parameter, all metrics in the namespace are
|
3021
|
+
# included or excluded, depending on whether this filter is specified
|
3022
|
+
# as an exclude filter or an include filter.
|
3023
|
+
#
|
3024
|
+
# Each metric name can contain only ASCII printable characters (ASCII
|
3025
|
+
# range 32 through 126). Each metric name must contain at least one
|
3026
|
+
# non-whitespace character.
|
3027
|
+
# @return [Array<String>]
|
3028
|
+
#
|
3183
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamFilter AWS API Documentation
|
3184
3030
|
#
|
3185
3031
|
class MetricStreamFilter < Struct.new(
|
3186
|
-
:namespace
|
3032
|
+
:namespace,
|
3033
|
+
:metric_names)
|
3034
|
+
SENSITIVE = []
|
3035
|
+
include Aws::Structure
|
3036
|
+
end
|
3037
|
+
|
3038
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3039
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. This
|
3040
|
+
# structure contains information for one metric that includes additional
|
3041
|
+
# statistics in the stream. For more information about statistics, see
|
3042
|
+
# CloudWatch, listed in [ CloudWatch statistics definitions][1].
|
3043
|
+
#
|
3044
|
+
#
|
3045
|
+
#
|
3046
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3047
|
+
#
|
3048
|
+
# @!attribute [rw] include_metrics
|
3049
|
+
# An array of metric name and namespace pairs that stream the
|
3050
|
+
# additional statistics listed in the value of the
|
3051
|
+
# `AdditionalStatistics` parameter. There can be as many as 100 pairs
|
3052
|
+
# in the array.
|
3053
|
+
#
|
3054
|
+
# All metrics that match the combination of metric name and namespace
|
3055
|
+
# will be streamed with the additional statistics, no matter their
|
3056
|
+
# dimensions.
|
3057
|
+
# @return [Array<Types::MetricStreamStatisticsMetric>]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] additional_statistics
|
3060
|
+
# The list of additional statistics that are to be streamed for the
|
3061
|
+
# metrics listed in the `IncludeMetrics` array in this structure. This
|
3062
|
+
# list can include as many as 20 statistics.
|
3063
|
+
#
|
3064
|
+
# If the `OutputFormat` for the stream is `opentelemetry0.7`, the only
|
3065
|
+
# valid values are `p?? ` percentile statistics such as `p90`, `p99`
|
3066
|
+
# and so on.
|
3067
|
+
#
|
3068
|
+
# If the `OutputFormat` for the stream is `json`, the valid values
|
3069
|
+
# include the abbreviations for all of the statistics listed in [
|
3070
|
+
# CloudWatch statistics definitions][1]. For example, this includes
|
3071
|
+
# `tm98, ` `wm90`, `PR(:300)`, and so on.
|
3072
|
+
#
|
3073
|
+
#
|
3074
|
+
#
|
3075
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3076
|
+
# @return [Array<String>]
|
3077
|
+
#
|
3078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsConfiguration AWS API Documentation
|
3079
|
+
#
|
3080
|
+
class MetricStreamStatisticsConfiguration < Struct.new(
|
3081
|
+
:include_metrics,
|
3082
|
+
:additional_statistics)
|
3083
|
+
SENSITIVE = []
|
3084
|
+
include Aws::Structure
|
3085
|
+
end
|
3086
|
+
|
3087
|
+
# This object contains the information for one metric that is to be
|
3088
|
+
# streamed with additional statistics.
|
3089
|
+
#
|
3090
|
+
# @!attribute [rw] namespace
|
3091
|
+
# The namespace of the metric.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] metric_name
|
3095
|
+
# The name of the metric.
|
3096
|
+
# @return [String]
|
3097
|
+
#
|
3098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsMetric AWS API Documentation
|
3099
|
+
#
|
3100
|
+
class MetricStreamStatisticsMetric < Struct.new(
|
3101
|
+
:namespace,
|
3102
|
+
:metric_name)
|
3187
3103
|
SENSITIVE = []
|
3188
3104
|
include Aws::Structure
|
3189
3105
|
end
|
@@ -3232,68 +3148,6 @@ module Aws::CloudWatch
|
|
3232
3148
|
include Aws::Structure
|
3233
3149
|
end
|
3234
3150
|
|
3235
|
-
# @note When making an API call, you may pass PutAnomalyDetectorInput
|
3236
|
-
# data as a hash:
|
3237
|
-
#
|
3238
|
-
# {
|
3239
|
-
# namespace: "Namespace",
|
3240
|
-
# metric_name: "MetricName",
|
3241
|
-
# dimensions: [
|
3242
|
-
# {
|
3243
|
-
# name: "DimensionName", # required
|
3244
|
-
# value: "DimensionValue", # required
|
3245
|
-
# },
|
3246
|
-
# ],
|
3247
|
-
# stat: "AnomalyDetectorMetricStat",
|
3248
|
-
# configuration: {
|
3249
|
-
# excluded_time_ranges: [
|
3250
|
-
# {
|
3251
|
-
# start_time: Time.now, # required
|
3252
|
-
# end_time: Time.now, # required
|
3253
|
-
# },
|
3254
|
-
# ],
|
3255
|
-
# metric_timezone: "AnomalyDetectorMetricTimezone",
|
3256
|
-
# },
|
3257
|
-
# single_metric_anomaly_detector: {
|
3258
|
-
# namespace: "Namespace",
|
3259
|
-
# metric_name: "MetricName",
|
3260
|
-
# dimensions: [
|
3261
|
-
# {
|
3262
|
-
# name: "DimensionName", # required
|
3263
|
-
# value: "DimensionValue", # required
|
3264
|
-
# },
|
3265
|
-
# ],
|
3266
|
-
# stat: "AnomalyDetectorMetricStat",
|
3267
|
-
# },
|
3268
|
-
# metric_math_anomaly_detector: {
|
3269
|
-
# metric_data_queries: [
|
3270
|
-
# {
|
3271
|
-
# id: "MetricId", # required
|
3272
|
-
# metric_stat: {
|
3273
|
-
# metric: { # required
|
3274
|
-
# namespace: "Namespace",
|
3275
|
-
# metric_name: "MetricName",
|
3276
|
-
# dimensions: [
|
3277
|
-
# {
|
3278
|
-
# name: "DimensionName", # required
|
3279
|
-
# value: "DimensionValue", # required
|
3280
|
-
# },
|
3281
|
-
# ],
|
3282
|
-
# },
|
3283
|
-
# period: 1, # required
|
3284
|
-
# stat: "Stat", # required
|
3285
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3286
|
-
# },
|
3287
|
-
# expression: "MetricExpression",
|
3288
|
-
# label: "MetricLabel",
|
3289
|
-
# return_data: false,
|
3290
|
-
# period: 1,
|
3291
|
-
# account_id: "AccountId",
|
3292
|
-
# },
|
3293
|
-
# ],
|
3294
|
-
# },
|
3295
|
-
# }
|
3296
|
-
#
|
3297
3151
|
# @!attribute [rw] namespace
|
3298
3152
|
# The namespace of the metric to create the anomaly detection model
|
3299
3153
|
# for.
|
@@ -3381,25 +3235,6 @@ module Aws::CloudWatch
|
|
3381
3235
|
#
|
3382
3236
|
class PutAnomalyDetectorOutput < Aws::EmptyStructure; end
|
3383
3237
|
|
3384
|
-
# @note When making an API call, you may pass PutCompositeAlarmInput
|
3385
|
-
# data as a hash:
|
3386
|
-
#
|
3387
|
-
# {
|
3388
|
-
# actions_enabled: false,
|
3389
|
-
# alarm_actions: ["ResourceName"],
|
3390
|
-
# alarm_description: "AlarmDescription",
|
3391
|
-
# alarm_name: "AlarmName", # required
|
3392
|
-
# alarm_rule: "AlarmRule", # required
|
3393
|
-
# insufficient_data_actions: ["ResourceName"],
|
3394
|
-
# ok_actions: ["ResourceName"],
|
3395
|
-
# tags: [
|
3396
|
-
# {
|
3397
|
-
# key: "TagKey", # required
|
3398
|
-
# value: "TagValue", # required
|
3399
|
-
# },
|
3400
|
-
# ],
|
3401
|
-
# }
|
3402
|
-
#
|
3403
3238
|
# @!attribute [rw] actions_enabled
|
3404
3239
|
# Indicates whether actions should be executed during any changes to
|
3405
3240
|
# the alarm state of the composite alarm. The default is `TRUE`.
|
@@ -3456,7 +3291,7 @@ module Aws::CloudWatch
|
|
3456
3291
|
# Alarm names specified in `AlarmRule` can be surrounded with
|
3457
3292
|
# double-quotes ("), but do not have to be.
|
3458
3293
|
#
|
3459
|
-
# The following are some examples of `AlarmRule
|
3294
|
+
# The following are some examples of `AlarmRule`:
|
3460
3295
|
#
|
3461
3296
|
# * `ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)`
|
3462
3297
|
# specifies that the composite alarm goes into ALARM state only if
|
@@ -3508,6 +3343,29 @@ module Aws::CloudWatch
|
|
3508
3343
|
# values.
|
3509
3344
|
# @return [Array<Types::Tag>]
|
3510
3345
|
#
|
3346
|
+
# @!attribute [rw] actions_suppressor
|
3347
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
3348
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
3349
|
+
# Name (ARN) from an existing alarm.
|
3350
|
+
# @return [String]
|
3351
|
+
#
|
3352
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
3353
|
+
# The maximum time in seconds that the composite alarm waits for the
|
3354
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
3355
|
+
# composite alarm performs its actions.
|
3356
|
+
#
|
3357
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
3358
|
+
# @return [Integer]
|
3359
|
+
#
|
3360
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
3361
|
+
# The maximum time in seconds that the composite alarm waits after
|
3362
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
3363
|
+
# composite alarm performs its actions.
|
3364
|
+
#
|
3365
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
3366
|
+
# specified.
|
3367
|
+
# @return [Integer]
|
3368
|
+
#
|
3511
3369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarmInput AWS API Documentation
|
3512
3370
|
#
|
3513
3371
|
class PutCompositeAlarmInput < Struct.new(
|
@@ -3518,19 +3376,14 @@ module Aws::CloudWatch
|
|
3518
3376
|
:alarm_rule,
|
3519
3377
|
:insufficient_data_actions,
|
3520
3378
|
:ok_actions,
|
3521
|
-
:tags
|
3379
|
+
:tags,
|
3380
|
+
:actions_suppressor,
|
3381
|
+
:actions_suppressor_wait_period,
|
3382
|
+
:actions_suppressor_extension_period)
|
3522
3383
|
SENSITIVE = []
|
3523
3384
|
include Aws::Structure
|
3524
3385
|
end
|
3525
3386
|
|
3526
|
-
# @note When making an API call, you may pass PutDashboardInput
|
3527
|
-
# data as a hash:
|
3528
|
-
#
|
3529
|
-
# {
|
3530
|
-
# dashboard_name: "DashboardName", # required
|
3531
|
-
# dashboard_body: "DashboardBody", # required
|
3532
|
-
# }
|
3533
|
-
#
|
3534
3387
|
# @!attribute [rw] dashboard_name
|
3535
3388
|
# The name of the dashboard. If a dashboard with this name already
|
3536
3389
|
# exists, this call modifies that dashboard, replacing its current
|
@@ -3581,21 +3434,6 @@ module Aws::CloudWatch
|
|
3581
3434
|
include Aws::Structure
|
3582
3435
|
end
|
3583
3436
|
|
3584
|
-
# @note When making an API call, you may pass PutInsightRuleInput
|
3585
|
-
# data as a hash:
|
3586
|
-
#
|
3587
|
-
# {
|
3588
|
-
# rule_name: "InsightRuleName", # required
|
3589
|
-
# rule_state: "InsightRuleState",
|
3590
|
-
# rule_definition: "InsightRuleDefinition", # required
|
3591
|
-
# tags: [
|
3592
|
-
# {
|
3593
|
-
# key: "TagKey", # required
|
3594
|
-
# value: "TagValue", # required
|
3595
|
-
# },
|
3596
|
-
# ],
|
3597
|
-
# }
|
3598
|
-
#
|
3599
3437
|
# @!attribute [rw] rule_name
|
3600
3438
|
# A unique name for the rule.
|
3601
3439
|
# @return [String]
|
@@ -3650,70 +3488,35 @@ module Aws::CloudWatch
|
|
3650
3488
|
#
|
3651
3489
|
class PutInsightRuleOutput < Aws::EmptyStructure; end
|
3652
3490
|
|
3653
|
-
#
|
3654
|
-
#
|
3655
|
-
#
|
3656
|
-
#
|
3657
|
-
#
|
3658
|
-
#
|
3659
|
-
|
3660
|
-
|
3661
|
-
|
3662
|
-
|
3663
|
-
|
3664
|
-
|
3665
|
-
#
|
3666
|
-
#
|
3667
|
-
#
|
3668
|
-
# {
|
3669
|
-
# name: "DimensionName", # required
|
3670
|
-
# value: "DimensionValue", # required
|
3671
|
-
# },
|
3672
|
-
# ],
|
3673
|
-
# period: 1,
|
3674
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3675
|
-
# evaluation_periods: 1, # required
|
3676
|
-
# datapoints_to_alarm: 1,
|
3677
|
-
# threshold: 1.0,
|
3678
|
-
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold, LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, GreaterThanUpperThreshold
|
3679
|
-
# treat_missing_data: "TreatMissingData",
|
3680
|
-
# evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
|
3681
|
-
# metrics: [
|
3682
|
-
# {
|
3683
|
-
# id: "MetricId", # required
|
3684
|
-
# metric_stat: {
|
3685
|
-
# metric: { # required
|
3686
|
-
# namespace: "Namespace",
|
3687
|
-
# metric_name: "MetricName",
|
3688
|
-
# dimensions: [
|
3689
|
-
# {
|
3690
|
-
# name: "DimensionName", # required
|
3691
|
-
# value: "DimensionValue", # required
|
3692
|
-
# },
|
3693
|
-
# ],
|
3694
|
-
# },
|
3695
|
-
# period: 1, # required
|
3696
|
-
# stat: "Stat", # required
|
3697
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
3698
|
-
# },
|
3699
|
-
# expression: "MetricExpression",
|
3700
|
-
# label: "MetricLabel",
|
3701
|
-
# return_data: false,
|
3702
|
-
# period: 1,
|
3703
|
-
# account_id: "AccountId",
|
3704
|
-
# },
|
3705
|
-
# ],
|
3706
|
-
# tags: [
|
3707
|
-
# {
|
3708
|
-
# key: "TagKey", # required
|
3709
|
-
# value: "TagValue", # required
|
3710
|
-
# },
|
3711
|
-
# ],
|
3712
|
-
# threshold_metric_id: "MetricId",
|
3713
|
-
# }
|
3491
|
+
# @!attribute [rw] managed_rules
|
3492
|
+
# A list of `ManagedRules` to enable.
|
3493
|
+
# @return [Array<Types::ManagedRule>]
|
3494
|
+
#
|
3495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutManagedInsightRulesInput AWS API Documentation
|
3496
|
+
#
|
3497
|
+
class PutManagedInsightRulesInput < Struct.new(
|
3498
|
+
:managed_rules)
|
3499
|
+
SENSITIVE = []
|
3500
|
+
include Aws::Structure
|
3501
|
+
end
|
3502
|
+
|
3503
|
+
# @!attribute [rw] failures
|
3504
|
+
# An array that lists the rules that could not be enabled.
|
3505
|
+
# @return [Array<Types::PartialFailure>]
|
3714
3506
|
#
|
3507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutManagedInsightRulesOutput AWS API Documentation
|
3508
|
+
#
|
3509
|
+
class PutManagedInsightRulesOutput < Struct.new(
|
3510
|
+
:failures)
|
3511
|
+
SENSITIVE = []
|
3512
|
+
include Aws::Structure
|
3513
|
+
end
|
3514
|
+
|
3715
3515
|
# @!attribute [rw] alarm_name
|
3716
3516
|
# The name for the alarm. This name must be unique within the Region.
|
3517
|
+
#
|
3518
|
+
# The name must contain only UTF-8 characters, and can't contain
|
3519
|
+
# ASCII control characters
|
3717
3520
|
# @return [String]
|
3718
3521
|
#
|
3719
3522
|
# @!attribute [rw] alarm_description
|
@@ -3728,70 +3531,139 @@ module Aws::CloudWatch
|
|
3728
3531
|
# @!attribute [rw] ok_actions
|
3729
3532
|
# The actions to execute when this alarm transitions to an `OK` state
|
3730
3533
|
# from any other state. Each action is specified as an Amazon Resource
|
3731
|
-
# Name (ARN).
|
3534
|
+
# Name (ARN). Valid values:
|
3732
3535
|
#
|
3733
|
-
#
|
3734
|
-
#
|
3735
|
-
# `arn:aws:automate:region:ec2:
|
3736
|
-
#
|
3737
|
-
# `arn:aws:
|
3738
|
-
#
|
3739
|
-
# `
|
3536
|
+
# **EC2 actions:**
|
3537
|
+
#
|
3538
|
+
# * `arn:aws:automate:region:ec2:stop`
|
3539
|
+
#
|
3540
|
+
# * `arn:aws:automate:region:ec2:terminate`
|
3541
|
+
#
|
3542
|
+
# * `arn:aws:automate:region:ec2:reboot`
|
3543
|
+
#
|
3544
|
+
# * `arn:aws:automate:region:ec2:recover`
|
3545
|
+
#
|
3546
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
|
3547
|
+
#
|
3548
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
|
3549
|
+
#
|
3550
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
3551
|
+
#
|
3552
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
|
3553
|
+
#
|
3554
|
+
# **Autoscaling action:**
|
3555
|
+
#
|
3556
|
+
# * `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3557
|
+
# `
|
3740
3558
|
#
|
3741
|
-
#
|
3742
|
-
#
|
3743
|
-
#
|
3744
|
-
#
|
3745
|
-
#
|
3746
|
-
#
|
3747
|
-
#
|
3748
|
-
#
|
3559
|
+
# ^
|
3560
|
+
#
|
3561
|
+
# **SNS notification action:**
|
3562
|
+
#
|
3563
|
+
# * `arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3564
|
+
# `
|
3565
|
+
#
|
3566
|
+
# ^
|
3567
|
+
#
|
3568
|
+
# **SSM integration actions:**
|
3569
|
+
#
|
3570
|
+
# * `arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
|
3571
|
+
# `
|
3572
|
+
#
|
3573
|
+
# * `arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
|
3574
|
+
# `
|
3749
3575
|
# @return [Array<String>]
|
3750
3576
|
#
|
3751
3577
|
# @!attribute [rw] alarm_actions
|
3752
3578
|
# The actions to execute when this alarm transitions to the `ALARM`
|
3753
3579
|
# state from any other state. Each action is specified as an Amazon
|
3754
|
-
# Resource Name (ARN).
|
3580
|
+
# Resource Name (ARN). Valid values:
|
3755
3581
|
#
|
3756
|
-
#
|
3757
|
-
#
|
3758
|
-
# `arn:aws:automate:region:ec2:
|
3759
|
-
#
|
3760
|
-
# `arn:aws:
|
3761
|
-
#
|
3762
|
-
#
|
3763
|
-
#
|
3764
|
-
# `
|
3582
|
+
# **EC2 actions:**
|
3583
|
+
#
|
3584
|
+
# * `arn:aws:automate:region:ec2:stop`
|
3585
|
+
#
|
3586
|
+
# * `arn:aws:automate:region:ec2:terminate`
|
3587
|
+
#
|
3588
|
+
# * `arn:aws:automate:region:ec2:reboot`
|
3589
|
+
#
|
3590
|
+
# * `arn:aws:automate:region:ec2:recover`
|
3591
|
+
#
|
3592
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
|
3593
|
+
#
|
3594
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
|
3595
|
+
#
|
3596
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
3597
|
+
#
|
3598
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
|
3599
|
+
#
|
3600
|
+
# **Autoscaling action:**
|
3601
|
+
#
|
3602
|
+
# * `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3603
|
+
# `
|
3604
|
+
#
|
3605
|
+
# ^
|
3606
|
+
#
|
3607
|
+
# **SNS notification action:**
|
3608
|
+
#
|
3609
|
+
# * `arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3610
|
+
# `
|
3611
|
+
#
|
3612
|
+
# ^
|
3613
|
+
#
|
3614
|
+
# **SSM integration actions:**
|
3765
3615
|
#
|
3766
|
-
#
|
3767
|
-
#
|
3768
|
-
#
|
3769
|
-
# `arn:aws:
|
3770
|
-
#
|
3771
|
-
# `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
3772
|
-
# \|
|
3773
|
-
# `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
|
3616
|
+
# * `arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
|
3617
|
+
# `
|
3618
|
+
#
|
3619
|
+
# * `arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
|
3620
|
+
# `
|
3774
3621
|
# @return [Array<String>]
|
3775
3622
|
#
|
3776
3623
|
# @!attribute [rw] insufficient_data_actions
|
3777
3624
|
# The actions to execute when this alarm transitions to the
|
3778
3625
|
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
3779
|
-
# specified as an Amazon Resource Name (ARN).
|
3626
|
+
# specified as an Amazon Resource Name (ARN). Valid values:
|
3780
3627
|
#
|
3781
|
-
#
|
3782
|
-
#
|
3783
|
-
# `arn:aws:automate:region:ec2:
|
3784
|
-
#
|
3785
|
-
# `arn:aws:
|
3786
|
-
#
|
3787
|
-
# `
|
3628
|
+
# **EC2 actions:**
|
3629
|
+
#
|
3630
|
+
# * `arn:aws:automate:region:ec2:stop`
|
3631
|
+
#
|
3632
|
+
# * `arn:aws:automate:region:ec2:terminate`
|
3633
|
+
#
|
3634
|
+
# * `arn:aws:automate:region:ec2:reboot`
|
3635
|
+
#
|
3636
|
+
# * `arn:aws:automate:region:ec2:recover`
|
3637
|
+
#
|
3638
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0`
|
3639
|
+
#
|
3640
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0`
|
3641
|
+
#
|
3642
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
3643
|
+
#
|
3644
|
+
# * `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0`
|
3788
3645
|
#
|
3789
|
-
#
|
3790
|
-
#
|
3791
|
-
#
|
3792
|
-
#
|
3793
|
-
#
|
3794
|
-
#
|
3646
|
+
# **Autoscaling action:**
|
3647
|
+
#
|
3648
|
+
# * `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3649
|
+
# `
|
3650
|
+
#
|
3651
|
+
# ^
|
3652
|
+
#
|
3653
|
+
# **SNS notification action:**
|
3654
|
+
#
|
3655
|
+
# * `arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
3656
|
+
# `
|
3657
|
+
#
|
3658
|
+
# ^
|
3659
|
+
#
|
3660
|
+
# **SSM integration actions:**
|
3661
|
+
#
|
3662
|
+
# * `arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
|
3663
|
+
# `
|
3664
|
+
#
|
3665
|
+
# * `arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
|
3666
|
+
# `
|
3795
3667
|
# @return [Array<String>]
|
3796
3668
|
#
|
3797
3669
|
# @!attribute [rw] metric_name
|
@@ -3817,10 +3689,40 @@ module Aws::CloudWatch
|
|
3817
3689
|
# @return [String]
|
3818
3690
|
#
|
3819
3691
|
# @!attribute [rw] extended_statistic
|
3820
|
-
# The
|
3821
|
-
#
|
3822
|
-
# `
|
3823
|
-
#
|
3692
|
+
# The extended statistic for the metric specified in `MetricName`.
|
3693
|
+
# When you call `PutMetricAlarm` and specify a `MetricName`, you must
|
3694
|
+
# specify either `Statistic` or `ExtendedStatistic` but not both.
|
3695
|
+
#
|
3696
|
+
# If you specify `ExtendedStatistic`, the following are valid values:
|
3697
|
+
#
|
3698
|
+
# * `p90`
|
3699
|
+
#
|
3700
|
+
# * `tm90`
|
3701
|
+
#
|
3702
|
+
# * `tc90`
|
3703
|
+
#
|
3704
|
+
# * `ts90`
|
3705
|
+
#
|
3706
|
+
# * `wm90`
|
3707
|
+
#
|
3708
|
+
# * `IQM`
|
3709
|
+
#
|
3710
|
+
# * `PR(n:m)` where n and m are values of the metric
|
3711
|
+
#
|
3712
|
+
# * `TC(X%:X%)` where X is between 10 and 90 inclusive.
|
3713
|
+
#
|
3714
|
+
# * `TM(X%:X%)` where X is between 10 and 90 inclusive.
|
3715
|
+
#
|
3716
|
+
# * `TS(X%:X%)` where X is between 10 and 90 inclusive.
|
3717
|
+
#
|
3718
|
+
# * `WM(X%:X%)` where X is between 10 and 90 inclusive.
|
3719
|
+
#
|
3720
|
+
# For more information about these extended statistics, see
|
3721
|
+
# [CloudWatch statistics definitions][1].
|
3722
|
+
#
|
3723
|
+
#
|
3724
|
+
#
|
3725
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html
|
3824
3726
|
# @return [String]
|
3825
3727
|
#
|
3826
3728
|
# @!attribute [rw] dimensions
|
@@ -3873,7 +3775,7 @@ module Aws::CloudWatch
|
|
3873
3775
|
#
|
3874
3776
|
# However, if the metric is published with multiple types of units and
|
3875
3777
|
# you don't specify a unit, the alarm's behavior is not defined and
|
3876
|
-
# it behaves
|
3778
|
+
# it behaves unpredictably.
|
3877
3779
|
#
|
3878
3780
|
# We recommend omitting `Unit` so that you don't inadvertently
|
3879
3781
|
# specify an incorrect unit that is not published for this metric.
|
@@ -3929,6 +3831,13 @@ module Aws::CloudWatch
|
|
3929
3831
|
#
|
3930
3832
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
3931
3833
|
#
|
3834
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
3835
|
+
# `ignore` missing data even if you choose a different option for
|
3836
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
3837
|
+
# alarms that evaluate that metric remain in their current state.
|
3838
|
+
#
|
3839
|
+
# </note>
|
3840
|
+
#
|
3932
3841
|
#
|
3933
3842
|
#
|
3934
3843
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -3977,7 +3886,9 @@ module Aws::CloudWatch
|
|
3977
3886
|
#
|
3978
3887
|
# @!attribute [rw] tags
|
3979
3888
|
# A list of key-value pairs to associate with the alarm. You can
|
3980
|
-
# associate as many as 50 tags with an alarm.
|
3889
|
+
# associate as many as 50 tags with an alarm. To be able to associate
|
3890
|
+
# tags with the alarm when you create the alarm, you must have the
|
3891
|
+
# `cloudwatch:TagResource` permission.
|
3981
3892
|
#
|
3982
3893
|
# Tags can help you organize and categorize your resources. You can
|
3983
3894
|
# also use them to scope user permissions by granting a user
|
@@ -4034,45 +3945,17 @@ module Aws::CloudWatch
|
|
4034
3945
|
include Aws::Structure
|
4035
3946
|
end
|
4036
3947
|
|
4037
|
-
# @note When making an API call, you may pass PutMetricDataInput
|
4038
|
-
# data as a hash:
|
4039
|
-
#
|
4040
|
-
# {
|
4041
|
-
# namespace: "Namespace", # required
|
4042
|
-
# metric_data: [ # required
|
4043
|
-
# {
|
4044
|
-
# metric_name: "MetricName", # required
|
4045
|
-
# dimensions: [
|
4046
|
-
# {
|
4047
|
-
# name: "DimensionName", # required
|
4048
|
-
# value: "DimensionValue", # required
|
4049
|
-
# },
|
4050
|
-
# ],
|
4051
|
-
# timestamp: Time.now,
|
4052
|
-
# value: 1.0,
|
4053
|
-
# statistic_values: {
|
4054
|
-
# sample_count: 1.0, # required
|
4055
|
-
# sum: 1.0, # required
|
4056
|
-
# minimum: 1.0, # required
|
4057
|
-
# maximum: 1.0, # required
|
4058
|
-
# },
|
4059
|
-
# values: [1.0],
|
4060
|
-
# counts: [1.0],
|
4061
|
-
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
4062
|
-
# storage_resolution: 1,
|
4063
|
-
# },
|
4064
|
-
# ],
|
4065
|
-
# }
|
4066
|
-
#
|
4067
3948
|
# @!attribute [rw] namespace
|
4068
|
-
# The namespace for the metric data.
|
3949
|
+
# The namespace for the metric data. You can use ASCII characters for
|
3950
|
+
# the namespace, except for control characters which are not
|
3951
|
+
# supported.
|
4069
3952
|
#
|
4070
3953
|
# To avoid conflicts with Amazon Web Services service namespaces, you
|
4071
3954
|
# should not specify a namespace that begins with `AWS/`
|
4072
3955
|
# @return [String]
|
4073
3956
|
#
|
4074
3957
|
# @!attribute [rw] metric_data
|
4075
|
-
# The data for the metric. The array can include no more than
|
3958
|
+
# The data for the metric. The array can include no more than 1000
|
4076
3959
|
# metrics per call.
|
4077
3960
|
# @return [Array<Types::MetricDatum>]
|
4078
3961
|
#
|
@@ -4085,32 +3968,6 @@ module Aws::CloudWatch
|
|
4085
3968
|
include Aws::Structure
|
4086
3969
|
end
|
4087
3970
|
|
4088
|
-
# @note When making an API call, you may pass PutMetricStreamInput
|
4089
|
-
# data as a hash:
|
4090
|
-
#
|
4091
|
-
# {
|
4092
|
-
# name: "MetricStreamName", # required
|
4093
|
-
# include_filters: [
|
4094
|
-
# {
|
4095
|
-
# namespace: "Namespace",
|
4096
|
-
# },
|
4097
|
-
# ],
|
4098
|
-
# exclude_filters: [
|
4099
|
-
# {
|
4100
|
-
# namespace: "Namespace",
|
4101
|
-
# },
|
4102
|
-
# ],
|
4103
|
-
# firehose_arn: "AmazonResourceName", # required
|
4104
|
-
# role_arn: "AmazonResourceName", # required
|
4105
|
-
# output_format: "json", # required, accepts json, opentelemetry0.7
|
4106
|
-
# tags: [
|
4107
|
-
# {
|
4108
|
-
# key: "TagKey", # required
|
4109
|
-
# value: "TagValue", # required
|
4110
|
-
# },
|
4111
|
-
# ],
|
4112
|
-
# }
|
4113
|
-
#
|
4114
3971
|
# @!attribute [rw] name
|
4115
3972
|
# If you are creating a new metric stream, this is the name for the
|
4116
3973
|
# new stream. The name must be different than the names of other
|
@@ -4139,17 +3996,17 @@ module Aws::CloudWatch
|
|
4139
3996
|
# @return [Array<Types::MetricStreamFilter>]
|
4140
3997
|
#
|
4141
3998
|
# @!attribute [rw] firehose_arn
|
4142
|
-
# The ARN of the Amazon Kinesis Firehose delivery stream to use
|
4143
|
-
# this metric stream. This Amazon Kinesis Firehose delivery
|
4144
|
-
# must already exist and must be in the same account as the
|
4145
|
-
# stream.
|
3999
|
+
# The ARN of the Amazon Kinesis Data Firehose delivery stream to use
|
4000
|
+
# for this metric stream. This Amazon Kinesis Data Firehose delivery
|
4001
|
+
# stream must already exist and must be in the same account as the
|
4002
|
+
# metric stream.
|
4146
4003
|
# @return [String]
|
4147
4004
|
#
|
4148
4005
|
# @!attribute [rw] role_arn
|
4149
4006
|
# The ARN of an IAM role that this metric stream will use to access
|
4150
|
-
# Amazon Kinesis Firehose resources. This IAM role must already
|
4151
|
-
# and must be in the same account as the metric stream. This IAM
|
4152
|
-
# must include the following permissions:
|
4007
|
+
# Amazon Kinesis Data Firehose resources. This IAM role must already
|
4008
|
+
# exist and must be in the same account as the metric stream. This IAM
|
4009
|
+
# role must include the following permissions:
|
4153
4010
|
#
|
4154
4011
|
# * firehose:PutRecord
|
4155
4012
|
#
|
@@ -4187,6 +4044,32 @@ module Aws::CloudWatch
|
|
4187
4044
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
4188
4045
|
# @return [Array<Types::Tag>]
|
4189
4046
|
#
|
4047
|
+
# @!attribute [rw] statistics_configurations
|
4048
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`,
|
4049
|
+
# and `SAMPLECOUNT` statistics for each metric that is streamed. You
|
4050
|
+
# can use this parameter to have the metric stream also send
|
4051
|
+
# additional statistics in the stream. This array can have up to 100
|
4052
|
+
# members.
|
4053
|
+
#
|
4054
|
+
# For each entry in this array, you specify one or more metrics and
|
4055
|
+
# the list of additional statistics to stream for those metrics. The
|
4056
|
+
# additional statistics that you can stream depend on the stream's
|
4057
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
4058
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
4059
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
4060
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as
|
4061
|
+
# p95, p99.9, and so on.
|
4062
|
+
#
|
4063
|
+
#
|
4064
|
+
#
|
4065
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
4066
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
4067
|
+
#
|
4068
|
+
# @!attribute [rw] include_linked_accounts_metrics
|
4069
|
+
# If you are creating a metric stream in a monitoring account, specify
|
4070
|
+
# `true` to include metrics from source accounts in the metric stream.
|
4071
|
+
# @return [Boolean]
|
4072
|
+
#
|
4190
4073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation
|
4191
4074
|
#
|
4192
4075
|
class PutMetricStreamInput < Struct.new(
|
@@ -4196,7 +4079,9 @@ module Aws::CloudWatch
|
|
4196
4079
|
:firehose_arn,
|
4197
4080
|
:role_arn,
|
4198
4081
|
:output_format,
|
4199
|
-
:tags
|
4082
|
+
:tags,
|
4083
|
+
:statistics_configurations,
|
4084
|
+
:include_linked_accounts_metrics)
|
4200
4085
|
SENSITIVE = []
|
4201
4086
|
include Aws::Structure
|
4202
4087
|
end
|
@@ -4216,14 +4101,6 @@ module Aws::CloudWatch
|
|
4216
4101
|
# Specifies one range of days or times to exclude from use for training
|
4217
4102
|
# an anomaly detection model.
|
4218
4103
|
#
|
4219
|
-
# @note When making an API call, you may pass Range
|
4220
|
-
# data as a hash:
|
4221
|
-
#
|
4222
|
-
# {
|
4223
|
-
# start_time: Time.now, # required
|
4224
|
-
# end_time: Time.now, # required
|
4225
|
-
# }
|
4226
|
-
#
|
4227
4104
|
# @!attribute [rw] start_time
|
4228
4105
|
# The start time of the range to exclude. The format is
|
4229
4106
|
# `yyyy-MM-dd'T'HH:mm:ss`. For example, `2019-07-01T23:59:59`.
|
@@ -4273,16 +4150,6 @@ module Aws::CloudWatch
|
|
4273
4150
|
include Aws::Structure
|
4274
4151
|
end
|
4275
4152
|
|
4276
|
-
# @note When making an API call, you may pass SetAlarmStateInput
|
4277
|
-
# data as a hash:
|
4278
|
-
#
|
4279
|
-
# {
|
4280
|
-
# alarm_name: "AlarmName", # required
|
4281
|
-
# state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
|
4282
|
-
# state_reason: "StateReason", # required
|
4283
|
-
# state_reason_data: "StateReasonData",
|
4284
|
-
# }
|
4285
|
-
#
|
4286
4153
|
# @!attribute [rw] alarm_name
|
4287
4154
|
# The name of the alarm.
|
4288
4155
|
# @return [String]
|
@@ -4320,21 +4187,6 @@ module Aws::CloudWatch
|
|
4320
4187
|
# Designates the CloudWatch metric and statistic that provides the time
|
4321
4188
|
# series the anomaly detector uses as input.
|
4322
4189
|
#
|
4323
|
-
# @note When making an API call, you may pass SingleMetricAnomalyDetector
|
4324
|
-
# data as a hash:
|
4325
|
-
#
|
4326
|
-
# {
|
4327
|
-
# namespace: "Namespace",
|
4328
|
-
# metric_name: "MetricName",
|
4329
|
-
# dimensions: [
|
4330
|
-
# {
|
4331
|
-
# name: "DimensionName", # required
|
4332
|
-
# value: "DimensionValue", # required
|
4333
|
-
# },
|
4334
|
-
# ],
|
4335
|
-
# stat: "AnomalyDetectorMetricStat",
|
4336
|
-
# }
|
4337
|
-
#
|
4338
4190
|
# @!attribute [rw] namespace
|
4339
4191
|
# The namespace of the metric to create the anomaly detection model
|
4340
4192
|
# for.
|
@@ -4363,13 +4215,6 @@ module Aws::CloudWatch
|
|
4363
4215
|
include Aws::Structure
|
4364
4216
|
end
|
4365
4217
|
|
4366
|
-
# @note When making an API call, you may pass StartMetricStreamsInput
|
4367
|
-
# data as a hash:
|
4368
|
-
#
|
4369
|
-
# {
|
4370
|
-
# names: ["MetricStreamName"], # required
|
4371
|
-
# }
|
4372
|
-
#
|
4373
4218
|
# @!attribute [rw] names
|
4374
4219
|
# The array of the names of metric streams to start streaming.
|
4375
4220
|
#
|
@@ -4393,16 +4238,6 @@ module Aws::CloudWatch
|
|
4393
4238
|
|
4394
4239
|
# Represents a set of statistics that describes a specific metric.
|
4395
4240
|
#
|
4396
|
-
# @note When making an API call, you may pass StatisticSet
|
4397
|
-
# data as a hash:
|
4398
|
-
#
|
4399
|
-
# {
|
4400
|
-
# sample_count: 1.0, # required
|
4401
|
-
# sum: 1.0, # required
|
4402
|
-
# minimum: 1.0, # required
|
4403
|
-
# maximum: 1.0, # required
|
4404
|
-
# }
|
4405
|
-
#
|
4406
4241
|
# @!attribute [rw] sample_count
|
4407
4242
|
# The number of samples used for the statistic set.
|
4408
4243
|
# @return [Float]
|
@@ -4430,13 +4265,6 @@ module Aws::CloudWatch
|
|
4430
4265
|
include Aws::Structure
|
4431
4266
|
end
|
4432
4267
|
|
4433
|
-
# @note When making an API call, you may pass StopMetricStreamsInput
|
4434
|
-
# data as a hash:
|
4435
|
-
#
|
4436
|
-
# {
|
4437
|
-
# names: ["MetricStreamName"], # required
|
4438
|
-
# }
|
4439
|
-
#
|
4440
4268
|
# @!attribute [rw] names
|
4441
4269
|
# The array of the names of metric streams to stop streaming.
|
4442
4270
|
#
|
@@ -4460,14 +4288,6 @@ module Aws::CloudWatch
|
|
4460
4288
|
|
4461
4289
|
# A key-value pair associated with a CloudWatch resource.
|
4462
4290
|
#
|
4463
|
-
# @note When making an API call, you may pass Tag
|
4464
|
-
# data as a hash:
|
4465
|
-
#
|
4466
|
-
# {
|
4467
|
-
# key: "TagKey", # required
|
4468
|
-
# value: "TagValue", # required
|
4469
|
-
# }
|
4470
|
-
#
|
4471
4291
|
# @!attribute [rw] key
|
4472
4292
|
# A string that you can use to assign a value. The combination of tag
|
4473
4293
|
# keys and values can help you organize and categorize your resources.
|
@@ -4486,19 +4306,6 @@ module Aws::CloudWatch
|
|
4486
4306
|
include Aws::Structure
|
4487
4307
|
end
|
4488
4308
|
|
4489
|
-
# @note When making an API call, you may pass TagResourceInput
|
4490
|
-
# data as a hash:
|
4491
|
-
#
|
4492
|
-
# {
|
4493
|
-
# resource_arn: "AmazonResourceName", # required
|
4494
|
-
# tags: [ # required
|
4495
|
-
# {
|
4496
|
-
# key: "TagKey", # required
|
4497
|
-
# value: "TagValue", # required
|
4498
|
-
# },
|
4499
|
-
# ],
|
4500
|
-
# }
|
4501
|
-
#
|
4502
4309
|
# @!attribute [rw] resource_arn
|
4503
4310
|
# The ARN of the CloudWatch resource that you're adding tags to.
|
4504
4311
|
#
|
@@ -4506,7 +4313,7 @@ module Aws::CloudWatch
|
|
4506
4313
|
# `arn:aws:cloudwatch:Region:account-id:alarm:alarm-name `
|
4507
4314
|
#
|
4508
4315
|
# The ARN format of a Contributor Insights rule is
|
4509
|
-
# `arn:aws:cloudwatch:Region:account-id:insight-rule
|
4316
|
+
# `arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
|
4510
4317
|
# `
|
4511
4318
|
#
|
4512
4319
|
# For more information about ARN format, see [ Resource Types Defined
|
@@ -4535,14 +4342,6 @@ module Aws::CloudWatch
|
|
4535
4342
|
#
|
4536
4343
|
class TagResourceOutput < Aws::EmptyStructure; end
|
4537
4344
|
|
4538
|
-
# @note When making an API call, you may pass UntagResourceInput
|
4539
|
-
# data as a hash:
|
4540
|
-
#
|
4541
|
-
# {
|
4542
|
-
# resource_arn: "AmazonResourceName", # required
|
4543
|
-
# tag_keys: ["TagKey"], # required
|
4544
|
-
# }
|
4545
|
-
#
|
4546
4345
|
# @!attribute [rw] resource_arn
|
4547
4346
|
# The ARN of the CloudWatch resource that you're removing tags from.
|
4548
4347
|
#
|
@@ -4550,7 +4349,7 @@ module Aws::CloudWatch
|
|
4550
4349
|
# `arn:aws:cloudwatch:Region:account-id:alarm:alarm-name `
|
4551
4350
|
#
|
4552
4351
|
# The ARN format of a Contributor Insights rule is
|
4553
|
-
# `arn:aws:cloudwatch:Region:account-id:insight-rule
|
4352
|
+
# `arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
|
4554
4353
|
# `
|
4555
4354
|
#
|
4556
4355
|
# For more information about ARN format, see [ Resource Types Defined
|