aws-sdk-cloudwatch 1.41.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- data/lib/aws-sdk-cloudwatch/client.rb +56 -43
- data/lib/aws-sdk-cloudwatch/client_api.rb +2 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +12 -13
- data/lib/aws-sdk-cloudwatch/resource.rb +14 -4
- data/lib/aws-sdk-cloudwatch/types.rb +48 -31
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b2e13bb14c0f93943bf34ddb2339a3b5849c93e4d15da5ab298158fd587e2a07
|
4
|
+
data.tar.gz: 102fd2ca487d29f9bb0f54fb24182a0f6ac8617e0f17ae9d8e3b00695a465bce
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 35ac2a9d2a1bc9102ce7ea866e48d91eee7d1cd52723619decdb9c2a97f69d9ce73b64f1f0cb01e12adee1264fd8d244c99f4ca355005ecf4b8fd680c2df3690
|
7
|
+
data.tar.gz: 6796036aaceca780b0675122cf729bbfed1dc9c057dde3205b15d0e0d657d36ecc2ca97da28420a7cadd2eb57495df1864da15cd8580c2457876ba65e6779fb9
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
@@ -398,7 +398,7 @@ module Aws::CloudWatch
|
|
398
398
|
req.send_request(options)
|
399
399
|
end
|
400
400
|
|
401
|
-
# Deletes all dashboards that you specify. You
|
401
|
+
# Deletes all dashboards that you specify. You can specify up to 100
|
402
402
|
# dashboards to delete. If there is an error during this call, no
|
403
403
|
# dashboards are deleted.
|
404
404
|
#
|
@@ -425,8 +425,8 @@ module Aws::CloudWatch
|
|
425
425
|
# Permanently deletes the specified Contributor Insights rules.
|
426
426
|
#
|
427
427
|
# If you create a rule, delete it, and then re-create it with the same
|
428
|
-
# name, historical data from the first time the rule was created
|
429
|
-
#
|
428
|
+
# name, historical data from the first time the rule was created might
|
429
|
+
# not be available.
|
430
430
|
#
|
431
431
|
# @option params [required, Array<String>] :rule_names
|
432
432
|
# An array of the rule names to delete. If you need to find out the
|
@@ -570,7 +570,7 @@ module Aws::CloudWatch
|
|
570
570
|
#
|
571
571
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
572
572
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
573
|
-
# you do so, you
|
573
|
+
# you do so, you receive a validation error.
|
574
574
|
#
|
575
575
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
576
576
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information
|
@@ -591,7 +591,7 @@ module Aws::CloudWatch
|
|
591
591
|
#
|
592
592
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
593
593
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
594
|
-
# you do so, you
|
594
|
+
# you do so, you receive a validation error.
|
595
595
|
#
|
596
596
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
597
597
|
# use this parameter. To get complete information about these alarms,
|
@@ -920,7 +920,7 @@ module Aws::CloudWatch
|
|
920
920
|
#
|
921
921
|
# @option params [Integer] :max_results
|
922
922
|
# This parameter is not currently used. Reserved for future use. If it
|
923
|
-
# is used in the future, the maximum value
|
923
|
+
# is used in the future, the maximum value might be different.
|
924
924
|
#
|
925
925
|
# @return [Types::DescribeInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
926
926
|
#
|
@@ -1123,8 +1123,8 @@ module Aws::CloudWatch
|
|
1123
1123
|
# data point.
|
1124
1124
|
#
|
1125
1125
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1126
|
-
# data point. The identity of the contributor
|
1127
|
-
# point in the graph.
|
1126
|
+
# data point. The identity of the contributor might change for each
|
1127
|
+
# data point in the graph.
|
1128
1128
|
#
|
1129
1129
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1130
1130
|
# point is the contributor with the most occurrences in that period.
|
@@ -1175,8 +1175,8 @@ module Aws::CloudWatch
|
|
1175
1175
|
# data point.
|
1176
1176
|
#
|
1177
1177
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1178
|
-
# data point. The identity of the contributor
|
1179
|
-
# point in the graph.
|
1178
|
+
# data point. The identity of the contributor might change for each
|
1179
|
+
# data point in the graph.
|
1180
1180
|
#
|
1181
1181
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1182
1182
|
# point is the contributor with the most occurrences in that period.
|
@@ -1297,10 +1297,10 @@ module Aws::CloudWatch
|
|
1297
1297
|
# If you omit `Unit` in your request, all data that was collected with
|
1298
1298
|
# any unit is returned, along with the corresponding units that were
|
1299
1299
|
# specified when the data was reported to CloudWatch. If you specify a
|
1300
|
-
# unit, the operation returns only data
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1300
|
+
# unit, the operation returns only data that was collected with that
|
1301
|
+
# unit specified. If you specify a unit that does not match the data
|
1302
|
+
# collected, the results of the operation are null. CloudWatch does not
|
1303
|
+
# perform unit conversions.
|
1304
1304
|
#
|
1305
1305
|
#
|
1306
1306
|
#
|
@@ -1606,10 +1606,10 @@ module Aws::CloudWatch
|
|
1606
1606
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
1607
1607
|
# collected with any unit is returned, along with the corresponding
|
1608
1608
|
# units that were specified when the data was reported to CloudWatch. If
|
1609
|
-
# you specify a unit, the operation returns only data
|
1610
|
-
#
|
1611
|
-
#
|
1612
|
-
#
|
1609
|
+
# you specify a unit, the operation returns only data that was collected
|
1610
|
+
# with that unit specified. If you specify a unit that does not match
|
1611
|
+
# the data collected, the results of the operation are null. CloudWatch
|
1612
|
+
# does not perform unit conversions.
|
1613
1613
|
#
|
1614
1614
|
# @return [Types::GetMetricStatisticsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1615
1615
|
#
|
@@ -1808,9 +1808,13 @@ module Aws::CloudWatch
|
|
1808
1808
|
# Up to 500 results are returned for any one call. To retrieve
|
1809
1809
|
# additional results, use the returned token with subsequent calls.
|
1810
1810
|
#
|
1811
|
-
# After you create a metric, allow up to
|
1812
|
-
#
|
1813
|
-
#
|
1811
|
+
# After you create a metric, allow up to 15 minutes before the metric
|
1812
|
+
# appears. You can see statistics about the metric sooner by using
|
1813
|
+
# [GetMetricData][1] or [GetMetricStatistics][2].
|
1814
|
+
#
|
1815
|
+
# `ListMetrics` doesn't return information about metrics if those
|
1816
|
+
# metrics haven't reported data in the past two weeks. To retrieve
|
1817
|
+
# those metrics, use [GetMetricData][1] or [GetMetricStatistics][2].
|
1814
1818
|
#
|
1815
1819
|
#
|
1816
1820
|
#
|
@@ -1830,6 +1834,16 @@ module Aws::CloudWatch
|
|
1830
1834
|
# The token returned by a previous call to indicate that there is more
|
1831
1835
|
# data available.
|
1832
1836
|
#
|
1837
|
+
# @option params [String] :recently_active
|
1838
|
+
# To filter the results to show only metrics that have had data points
|
1839
|
+
# published in the past three hours, specify this parameter with a value
|
1840
|
+
# of `PT3H`. This is the only valid value for this parameter.
|
1841
|
+
#
|
1842
|
+
# The results that are returned are an approximation of the value you
|
1843
|
+
# specify. There is a low probability that the returned results include
|
1844
|
+
# metrics with last published data as much as 40 minutes more than the
|
1845
|
+
# specified time interval.
|
1846
|
+
#
|
1833
1847
|
# @return [Types::ListMetricsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1834
1848
|
#
|
1835
1849
|
# * {Types::ListMetricsOutput#metrics #metrics} => Array<Types::Metric>
|
@@ -1849,6 +1863,7 @@ module Aws::CloudWatch
|
|
1849
1863
|
# },
|
1850
1864
|
# ],
|
1851
1865
|
# next_token: "NextToken",
|
1866
|
+
# recently_active: "PT3H", # accepts PT3H
|
1852
1867
|
# })
|
1853
1868
|
#
|
1854
1869
|
# @example Response structure
|
@@ -1882,7 +1897,7 @@ module Aws::CloudWatch
|
|
1882
1897
|
# The ARN format of a Contributor Insights rule is
|
1883
1898
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
1884
1899
|
#
|
1885
|
-
# For more information
|
1900
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
1886
1901
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
1887
1902
|
#
|
1888
1903
|
#
|
@@ -2041,8 +2056,8 @@ module Aws::CloudWatch
|
|
2041
2056
|
# The description for the composite alarm.
|
2042
2057
|
#
|
2043
2058
|
# @option params [required, String] :alarm_name
|
2044
|
-
# The name for the composite alarm. This name must be unique within
|
2045
|
-
#
|
2059
|
+
# The name for the composite alarm. This name must be unique within the
|
2060
|
+
# Region.
|
2046
2061
|
#
|
2047
2062
|
# @option params [required, String] :alarm_rule
|
2048
2063
|
# An expression that specifies which other alarms are to be evaluated to
|
@@ -2225,8 +2240,8 @@ module Aws::CloudWatch
|
|
2225
2240
|
# Contributor Insights to Analyze High-Cardinality Data][1].
|
2226
2241
|
#
|
2227
2242
|
# If you create a rule, delete it, and then re-create it with the same
|
2228
|
-
# name, historical data from the first time the rule was created
|
2229
|
-
#
|
2243
|
+
# name, historical data from the first time the rule was created might
|
2244
|
+
# not be available.
|
2230
2245
|
#
|
2231
2246
|
#
|
2232
2247
|
#
|
@@ -2345,8 +2360,7 @@ module Aws::CloudWatch
|
|
2345
2360
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
|
2346
2361
|
#
|
2347
2362
|
# @option params [required, String] :alarm_name
|
2348
|
-
# The name for the alarm. This name must be unique within
|
2349
|
-
# account.
|
2363
|
+
# The name for the alarm. This name must be unique within the Region.
|
2350
2364
|
#
|
2351
2365
|
# @option params [String] :alarm_description
|
2352
2366
|
# The description for the alarm.
|
@@ -2458,8 +2472,8 @@ module Aws::CloudWatch
|
|
2458
2472
|
# resolution, the alarm still attempts to gather data at the period rate
|
2459
2473
|
# that you specify. In this case, it does not receive data for the
|
2460
2474
|
# attempts that do not correspond to a one-minute data resolution, and
|
2461
|
-
# the alarm
|
2462
|
-
# or 30 also sets this alarm as a high-resolution alarm, which has a
|
2475
|
+
# the alarm might often lapse into INSUFFICENT\_DATA status. Specifying
|
2476
|
+
# 10 or 30 also sets this alarm as a high-resolution alarm, which has a
|
2463
2477
|
# higher charge than other alarms. For more information about pricing,
|
2464
2478
|
# see [Amazon CloudWatch Pricing][1].
|
2465
2479
|
#
|
@@ -2481,12 +2495,12 @@ module Aws::CloudWatch
|
|
2481
2495
|
#
|
2482
2496
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types that
|
2483
2497
|
# have been published for the metric and attempts to evaluate the alarm.
|
2484
|
-
# Usually metrics are published with only one unit, so the alarm
|
2485
|
-
#
|
2498
|
+
# Usually, metrics are published with only one unit, so the alarm works
|
2499
|
+
# as intended.
|
2486
2500
|
#
|
2487
2501
|
# However, if the metric is published with multiple types of units and
|
2488
|
-
# you don't specify a unit, the alarm's behavior is not defined and
|
2489
|
-
#
|
2502
|
+
# you don't specify a unit, the alarm's behavior is not defined and it
|
2503
|
+
# behaves predictably.
|
2490
2504
|
#
|
2491
2505
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
2492
2506
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -2584,7 +2598,7 @@ module Aws::CloudWatch
|
|
2584
2598
|
# associate as many as 50 tags with an alarm.
|
2585
2599
|
#
|
2586
2600
|
# Tags can help you organize and categorize your resources. You can also
|
2587
|
-
# use them to scope user permissions
|
2601
|
+
# use them to scope user permissions by granting a user permission to
|
2588
2602
|
# access or change only resources with certain tag values.
|
2589
2603
|
#
|
2590
2604
|
# @option params [String] :threshold_metric_id
|
@@ -2783,9 +2797,9 @@ module Aws::CloudWatch
|
|
2783
2797
|
# CloudWatch console or through [DescribeAlarmHistory][1].
|
2784
2798
|
#
|
2785
2799
|
# If you use `SetAlarmState` on a composite alarm, the composite alarm
|
2786
|
-
# is not guaranteed to return to its actual state. It
|
2800
|
+
# is not guaranteed to return to its actual state. It returns to its
|
2787
2801
|
# actual state only once any of its children alarms change state. It is
|
2788
|
-
# also
|
2802
|
+
# also reevaluated if you update its configuration.
|
2789
2803
|
#
|
2790
2804
|
# If an alarm triggers EC2 Auto Scaling policies or application Auto
|
2791
2805
|
# Scaling policies, you must include information in the
|
@@ -2797,8 +2811,7 @@ module Aws::CloudWatch
|
|
2797
2811
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html
|
2798
2812
|
#
|
2799
2813
|
# @option params [required, String] :alarm_name
|
2800
|
-
# The name
|
2801
|
-
# account. The maximum length is 255 characters.
|
2814
|
+
# The name of the alarm.
|
2802
2815
|
#
|
2803
2816
|
# @option params [required, String] :state_value
|
2804
2817
|
# The value of the state.
|
@@ -2841,7 +2854,7 @@ module Aws::CloudWatch
|
|
2841
2854
|
# are alarms and Contributor Insights rules.
|
2842
2855
|
#
|
2843
2856
|
# Tags can help you organize and categorize your resources. You can also
|
2844
|
-
# use them to scope user permissions
|
2857
|
+
# use them to scope user permissions by granting a user permission to
|
2845
2858
|
# access or change only resources with certain tag values.
|
2846
2859
|
#
|
2847
2860
|
# Tags don't have any semantic meaning to AWS and are interpreted
|
@@ -2864,7 +2877,7 @@ module Aws::CloudWatch
|
|
2864
2877
|
# The ARN format of a Contributor Insights rule is
|
2865
2878
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2866
2879
|
#
|
2867
|
-
# For more information
|
2880
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2868
2881
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2869
2882
|
#
|
2870
2883
|
#
|
@@ -2908,7 +2921,7 @@ module Aws::CloudWatch
|
|
2908
2921
|
# The ARN format of a Contributor Insights rule is
|
2909
2922
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2910
2923
|
#
|
2911
|
-
# For more information
|
2924
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2912
2925
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2913
2926
|
#
|
2914
2927
|
#
|
@@ -2949,7 +2962,7 @@ module Aws::CloudWatch
|
|
2949
2962
|
params: params,
|
2950
2963
|
config: config)
|
2951
2964
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
2952
|
-
context[:gem_version] = '1.
|
2965
|
+
context[:gem_version] = '1.42.0'
|
2953
2966
|
Seahorse::Client::Request.new(handlers, context)
|
2954
2967
|
end
|
2955
2968
|
|
@@ -191,6 +191,7 @@ module Aws::CloudWatch
|
|
191
191
|
PutMetricAlarmInput = Shapes::StructureShape.new(name: 'PutMetricAlarmInput')
|
192
192
|
PutMetricDataInput = Shapes::StructureShape.new(name: 'PutMetricDataInput')
|
193
193
|
Range = Shapes::StructureShape.new(name: 'Range')
|
194
|
+
RecentlyActive = Shapes::StringShape.new(name: 'RecentlyActive')
|
194
195
|
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
195
196
|
ResourceList = Shapes::ListShape.new(name: 'ResourceList')
|
196
197
|
ResourceName = Shapes::StringShape.new(name: 'ResourceName')
|
@@ -567,6 +568,7 @@ module Aws::CloudWatch
|
|
567
568
|
ListMetricsInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
|
568
569
|
ListMetricsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionFilters, location_name: "Dimensions"))
|
569
570
|
ListMetricsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
571
|
+
ListMetricsInput.add_member(:recently_active, Shapes::ShapeRef.new(shape: RecentlyActive, location_name: "RecentlyActive"))
|
570
572
|
ListMetricsInput.struct_class = Types::ListMetricsInput
|
571
573
|
|
572
574
|
ListMetricsOutput.add_member(:metrics, Shapes::ShapeRef.new(shape: Metrics, location_name: "Metrics"))
|
@@ -290,10 +290,10 @@ module Aws::CloudWatch
|
|
290
290
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
291
291
|
# collected with any unit is returned, along with the corresponding
|
292
292
|
# units that were specified when the data was reported to CloudWatch. If
|
293
|
-
# you specify a unit, the operation returns only data
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
293
|
+
# you specify a unit, the operation returns only data that was collected
|
294
|
+
# with that unit specified. If you specify a unit that does not match
|
295
|
+
# the data collected, the results of the operation are null. CloudWatch
|
296
|
+
# does not perform unit conversions.
|
297
297
|
# @return [Types::GetMetricStatisticsOutput]
|
298
298
|
def get_statistics(options = {})
|
299
299
|
options = options.merge(
|
@@ -363,8 +363,7 @@ module Aws::CloudWatch
|
|
363
363
|
# })
|
364
364
|
# @param [Hash] options ({})
|
365
365
|
# @option options [required, String] :alarm_name
|
366
|
-
# The name for the alarm. This name must be unique within
|
367
|
-
# account.
|
366
|
+
# The name for the alarm. This name must be unique within the Region.
|
368
367
|
# @option options [String] :alarm_description
|
369
368
|
# The description for the alarm.
|
370
369
|
# @option options [Boolean] :actions_enabled
|
@@ -454,8 +453,8 @@ module Aws::CloudWatch
|
|
454
453
|
# resolution, the alarm still attempts to gather data at the period rate
|
455
454
|
# that you specify. In this case, it does not receive data for the
|
456
455
|
# attempts that do not correspond to a one-minute data resolution, and
|
457
|
-
# the alarm
|
458
|
-
# or 30 also sets this alarm as a high-resolution alarm, which has a
|
456
|
+
# the alarm might often lapse into INSUFFICENT\_DATA status. Specifying
|
457
|
+
# 10 or 30 also sets this alarm as a high-resolution alarm, which has a
|
459
458
|
# higher charge than other alarms. For more information about pricing,
|
460
459
|
# see [Amazon CloudWatch Pricing][1].
|
461
460
|
#
|
@@ -476,12 +475,12 @@ module Aws::CloudWatch
|
|
476
475
|
#
|
477
476
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types that
|
478
477
|
# have been published for the metric and attempts to evaluate the alarm.
|
479
|
-
# Usually metrics are published with only one unit, so the alarm
|
480
|
-
#
|
478
|
+
# Usually, metrics are published with only one unit, so the alarm works
|
479
|
+
# as intended.
|
481
480
|
#
|
482
481
|
# However, if the metric is published with multiple types of units and
|
483
|
-
# you don't specify a unit, the alarm's behavior is not defined and
|
484
|
-
#
|
482
|
+
# you don't specify a unit, the alarm's behavior is not defined and it
|
483
|
+
# behaves predictably.
|
485
484
|
#
|
486
485
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
487
486
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -571,7 +570,7 @@ module Aws::CloudWatch
|
|
571
570
|
# associate as many as 50 tags with an alarm.
|
572
571
|
#
|
573
572
|
# Tags can help you organize and categorize your resources. You can also
|
574
|
-
# use them to scope user permissions
|
573
|
+
# use them to scope user permissions by granting a user permission to
|
575
574
|
# access or change only resources with certain tag values.
|
576
575
|
# @option options [String] :threshold_metric_id
|
577
576
|
# If this is an alarm based on an anomaly detection model, make this
|
@@ -78,7 +78,7 @@ module Aws::CloudWatch
|
|
78
78
|
#
|
79
79
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
80
80
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
81
|
-
# you do so, you
|
81
|
+
# you do so, you receive a validation error.
|
82
82
|
#
|
83
83
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
84
84
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information
|
@@ -98,7 +98,7 @@ module Aws::CloudWatch
|
|
98
98
|
#
|
99
99
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
100
100
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
101
|
-
# you do so, you
|
101
|
+
# you do so, you receive a validation error.
|
102
102
|
#
|
103
103
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
104
104
|
# use this parameter. To get complete information about these alarms,
|
@@ -176,7 +176,7 @@ module Aws::CloudWatch
|
|
176
176
|
#
|
177
177
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
178
178
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
179
|
-
# you do so, you
|
179
|
+
# you do so, you receive a validation error.
|
180
180
|
#
|
181
181
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
182
182
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information
|
@@ -196,7 +196,7 @@ module Aws::CloudWatch
|
|
196
196
|
#
|
197
197
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
198
198
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
199
|
-
# you do so, you
|
199
|
+
# you do so, you receive a validation error.
|
200
200
|
#
|
201
201
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
202
202
|
# use this parameter. To get complete information about these alarms,
|
@@ -253,6 +253,7 @@ module Aws::CloudWatch
|
|
253
253
|
# value: "DimensionValue",
|
254
254
|
# },
|
255
255
|
# ],
|
256
|
+
# recently_active: "PT3H", # accepts PT3H
|
256
257
|
# })
|
257
258
|
# @param [Hash] options ({})
|
258
259
|
# @option options [String] :namespace
|
@@ -261,6 +262,15 @@ module Aws::CloudWatch
|
|
261
262
|
# The name of the metric to filter against.
|
262
263
|
# @option options [Array<Types::DimensionFilter>] :dimensions
|
263
264
|
# The dimensions to filter against.
|
265
|
+
# @option options [String] :recently_active
|
266
|
+
# To filter the results to show only metrics that have had data points
|
267
|
+
# published in the past three hours, specify this parameter with a value
|
268
|
+
# of `PT3H`. This is the only valid value for this parameter.
|
269
|
+
#
|
270
|
+
# The results that are returned are an approximation of the value you
|
271
|
+
# specify. There is a low probability that the returned results include
|
272
|
+
# metrics with last published data as much as 40 minutes more than the
|
273
|
+
# specified time interval.
|
264
274
|
# @return [Metric::Collection]
|
265
275
|
def metrics(options = {})
|
266
276
|
batches = Enumerator.new do |y|
|
@@ -691,7 +691,7 @@ module Aws::CloudWatch
|
|
691
691
|
#
|
692
692
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
693
693
|
# parameters in the request except for `MaxRecords` and `NextToken`.
|
694
|
-
# If you do so, you
|
694
|
+
# If you do so, you receive a validation error.
|
695
695
|
#
|
696
696
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
697
697
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp`
|
@@ -713,7 +713,7 @@ module Aws::CloudWatch
|
|
713
713
|
#
|
714
714
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
715
715
|
# parameters in the request except for `MaxRecords` and `NextToken`.
|
716
|
-
# If you do so, you
|
716
|
+
# If you do so, you receive a validation error.
|
717
717
|
#
|
718
718
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
719
719
|
# use this parameter. To get complete information about these alarms,
|
@@ -876,7 +876,7 @@ module Aws::CloudWatch
|
|
876
876
|
#
|
877
877
|
# @!attribute [rw] max_results
|
878
878
|
# This parameter is not currently used. Reserved for future use. If it
|
879
|
-
# is used in the future, the maximum value
|
879
|
+
# is used in the future, the maximum value might be different.
|
880
880
|
# @return [Integer]
|
881
881
|
#
|
882
882
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeInsightRulesInput AWS API Documentation
|
@@ -905,7 +905,11 @@ module Aws::CloudWatch
|
|
905
905
|
include Aws::Structure
|
906
906
|
end
|
907
907
|
|
908
|
-
#
|
908
|
+
# A dimension is a name/value pair that is part of the identity of a
|
909
|
+
# metric. You can assign up to 10 dimensions to a metric. Because
|
910
|
+
# dimensions are part of the unique identifier for a metric, whenever
|
911
|
+
# you add a unique name/value pair to one of your metrics, you are
|
912
|
+
# creating a new variation of that metric.
|
909
913
|
#
|
910
914
|
# @note When making an API call, you may pass Dimension
|
911
915
|
# data as a hash:
|
@@ -916,11 +920,12 @@ module Aws::CloudWatch
|
|
916
920
|
# }
|
917
921
|
#
|
918
922
|
# @!attribute [rw] name
|
919
|
-
# The name of the dimension.
|
923
|
+
# The name of the dimension. Dimension names cannot contain blank
|
924
|
+
# spaces or non-ASCII characters.
|
920
925
|
# @return [String]
|
921
926
|
#
|
922
927
|
# @!attribute [rw] value
|
923
|
-
# The value
|
928
|
+
# The value of the dimension.
|
924
929
|
# @return [String]
|
925
930
|
#
|
926
931
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension AWS API Documentation
|
@@ -1167,7 +1172,7 @@ module Aws::CloudWatch
|
|
1167
1172
|
# data point.
|
1168
1173
|
#
|
1169
1174
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1170
|
-
# data point. The identity of the contributor
|
1175
|
+
# data point. The identity of the contributor might change for each
|
1171
1176
|
# data point in the graph.
|
1172
1177
|
#
|
1173
1178
|
# If this rule aggregates by COUNT, the top contributor for each
|
@@ -1391,8 +1396,8 @@ module Aws::CloudWatch
|
|
1391
1396
|
# @!attribute [rw] messages
|
1392
1397
|
# Contains a message about this `GetMetricData` operation, if the
|
1393
1398
|
# operation results in such a message. An example of a message that
|
1394
|
-
#
|
1395
|
-
# there is a message, as much of the operation as possible is still
|
1399
|
+
# might be returned is `Maximum number of allowed metrics exceeded`.
|
1400
|
+
# If there is a message, as much of the operation as possible is still
|
1396
1401
|
# executed.
|
1397
1402
|
#
|
1398
1403
|
# A message appears here only if it is related to the global
|
@@ -1539,7 +1544,7 @@ module Aws::CloudWatch
|
|
1539
1544
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
1540
1545
|
# collected with any unit is returned, along with the corresponding
|
1541
1546
|
# units that were specified when the data was reported to CloudWatch.
|
1542
|
-
# If you specify a unit, the operation returns only data
|
1547
|
+
# If you specify a unit, the operation returns only data that was
|
1543
1548
|
# collected with that unit specified. If you specify a unit that does
|
1544
1549
|
# not match the data collected, the results of the operation are null.
|
1545
1550
|
# CloudWatch does not perform unit conversions.
|
@@ -1648,7 +1653,8 @@ module Aws::CloudWatch
|
|
1648
1653
|
end
|
1649
1654
|
|
1650
1655
|
# @!attribute [rw] metric_widget_image
|
1651
|
-
# The image of the graph, in the output format specified.
|
1656
|
+
# The image of the graph, in the output format specified. The output
|
1657
|
+
# is base64-encoded.
|
1652
1658
|
# @return [String]
|
1653
1659
|
#
|
1654
1660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImageOutput AWS API Documentation
|
@@ -1996,6 +2002,7 @@ module Aws::CloudWatch
|
|
1996
2002
|
# },
|
1997
2003
|
# ],
|
1998
2004
|
# next_token: "NextToken",
|
2005
|
+
# recently_active: "PT3H", # accepts PT3H
|
1999
2006
|
# }
|
2000
2007
|
#
|
2001
2008
|
# @!attribute [rw] namespace
|
@@ -2015,19 +2022,31 @@ module Aws::CloudWatch
|
|
2015
2022
|
# data available.
|
2016
2023
|
# @return [String]
|
2017
2024
|
#
|
2025
|
+
# @!attribute [rw] recently_active
|
2026
|
+
# To filter the results to show only metrics that have had data points
|
2027
|
+
# published in the past three hours, specify this parameter with a
|
2028
|
+
# value of `PT3H`. This is the only valid value for this parameter.
|
2029
|
+
#
|
2030
|
+
# The results that are returned are an approximation of the value you
|
2031
|
+
# specify. There is a low probability that the returned results
|
2032
|
+
# include metrics with last published data as much as 40 minutes more
|
2033
|
+
# than the specified time interval.
|
2034
|
+
# @return [String]
|
2035
|
+
#
|
2018
2036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput AWS API Documentation
|
2019
2037
|
#
|
2020
2038
|
class ListMetricsInput < Struct.new(
|
2021
2039
|
:namespace,
|
2022
2040
|
:metric_name,
|
2023
2041
|
:dimensions,
|
2024
|
-
:next_token
|
2042
|
+
:next_token,
|
2043
|
+
:recently_active)
|
2025
2044
|
SENSITIVE = []
|
2026
2045
|
include Aws::Structure
|
2027
2046
|
end
|
2028
2047
|
|
2029
2048
|
# @!attribute [rw] metrics
|
2030
|
-
# The metrics.
|
2049
|
+
# The metrics that match your request.
|
2031
2050
|
# @return [Array<Types::Metric>]
|
2032
2051
|
#
|
2033
2052
|
# @!attribute [rw] next_token
|
@@ -2061,8 +2080,8 @@ module Aws::CloudWatch
|
|
2061
2080
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
2062
2081
|
# `
|
2063
2082
|
#
|
2064
|
-
# For more information
|
2065
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
2083
|
+
# For more information about ARN format, see [ Resource Types Defined
|
2084
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
2066
2085
|
# Reference*.
|
2067
2086
|
#
|
2068
2087
|
#
|
@@ -2694,7 +2713,7 @@ module Aws::CloudWatch
|
|
2694
2713
|
# In a `Get` operation, if you omit `Unit` then all data that was
|
2695
2714
|
# collected with any unit is returned, along with the corresponding
|
2696
2715
|
# units that were specified when the data was reported to CloudWatch.
|
2697
|
-
# If you specify a unit, the operation returns only data
|
2716
|
+
# If you specify a unit, the operation returns only data that was
|
2698
2717
|
# collected with that unit specified. If you specify a unit that does
|
2699
2718
|
# not match the data collected, the results of the operation are null.
|
2700
2719
|
# CloudWatch does not perform unit conversions.
|
@@ -2862,7 +2881,7 @@ module Aws::CloudWatch
|
|
2862
2881
|
#
|
2863
2882
|
# @!attribute [rw] alarm_name
|
2864
2883
|
# The name for the composite alarm. This name must be unique within
|
2865
|
-
#
|
2884
|
+
# the Region.
|
2866
2885
|
# @return [String]
|
2867
2886
|
#
|
2868
2887
|
# @!attribute [rw] alarm_rule
|
@@ -3009,7 +3028,7 @@ module Aws::CloudWatch
|
|
3009
3028
|
#
|
3010
3029
|
# If this result includes only warning messages, then the input was
|
3011
3030
|
# valid enough for the dashboard to be created or modified, but some
|
3012
|
-
# elements of the dashboard
|
3031
|
+
# elements of the dashboard might not render.
|
3013
3032
|
#
|
3014
3033
|
# If this result includes error messages, the input was not valid and
|
3015
3034
|
# the operation failed.
|
@@ -3154,8 +3173,7 @@ module Aws::CloudWatch
|
|
3154
3173
|
# }
|
3155
3174
|
#
|
3156
3175
|
# @!attribute [rw] alarm_name
|
3157
|
-
# The name for the alarm. This name must be unique within
|
3158
|
-
# account.
|
3176
|
+
# The name for the alarm. This name must be unique within the Region.
|
3159
3177
|
# @return [String]
|
3160
3178
|
#
|
3161
3179
|
# @!attribute [rw] alarm_description
|
@@ -3279,7 +3297,7 @@ module Aws::CloudWatch
|
|
3279
3297
|
# resolution, the alarm still attempts to gather data at the period
|
3280
3298
|
# rate that you specify. In this case, it does not receive data for
|
3281
3299
|
# the attempts that do not correspond to a one-minute data resolution,
|
3282
|
-
# and the alarm
|
3300
|
+
# and the alarm might often lapse into INSUFFICENT\_DATA status.
|
3283
3301
|
# Specifying 10 or 30 also sets this alarm as a high-resolution alarm,
|
3284
3302
|
# which has a higher charge than other alarms. For more information
|
3285
3303
|
# about pricing, see [Amazon CloudWatch Pricing][1].
|
@@ -3304,12 +3322,12 @@ module Aws::CloudWatch
|
|
3304
3322
|
#
|
3305
3323
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types
|
3306
3324
|
# that have been published for the metric and attempts to evaluate the
|
3307
|
-
# alarm. Usually metrics are published with only one unit, so the
|
3308
|
-
# alarm
|
3325
|
+
# alarm. Usually, metrics are published with only one unit, so the
|
3326
|
+
# alarm works as intended.
|
3309
3327
|
#
|
3310
3328
|
# However, if the metric is published with multiple types of units and
|
3311
3329
|
# you don't specify a unit, the alarm's behavior is not defined and
|
3312
|
-
#
|
3330
|
+
# it behaves predictably.
|
3313
3331
|
#
|
3314
3332
|
# We recommend omitting `Unit` so that you don't inadvertently
|
3315
3333
|
# specify an incorrect unit that is not published for this metric.
|
@@ -3416,7 +3434,7 @@ module Aws::CloudWatch
|
|
3416
3434
|
# associate as many as 50 tags with an alarm.
|
3417
3435
|
#
|
3418
3436
|
# Tags can help you organize and categorize your resources. You can
|
3419
|
-
# also use them to scope user permissions
|
3437
|
+
# also use them to scope user permissions by granting a user
|
3420
3438
|
# permission to access or change only resources with certain tag
|
3421
3439
|
# values.
|
3422
3440
|
# @return [Array<Types::Tag>]
|
@@ -3583,8 +3601,7 @@ module Aws::CloudWatch
|
|
3583
3601
|
# }
|
3584
3602
|
#
|
3585
3603
|
# @!attribute [rw] alarm_name
|
3586
|
-
# The name
|
3587
|
-
# account. The maximum length is 255 characters.
|
3604
|
+
# The name of the alarm.
|
3588
3605
|
# @return [String]
|
3589
3606
|
#
|
3590
3607
|
# @!attribute [rw] state_value
|
@@ -3707,8 +3724,8 @@ module Aws::CloudWatch
|
|
3707
3724
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
3708
3725
|
# `
|
3709
3726
|
#
|
3710
|
-
# For more information
|
3711
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
3727
|
+
# For more information about ARN format, see [ Resource Types Defined
|
3728
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
3712
3729
|
# Reference*.
|
3713
3730
|
#
|
3714
3731
|
#
|
@@ -3751,8 +3768,8 @@ module Aws::CloudWatch
|
|
3751
3768
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
3752
3769
|
# `
|
3753
3770
|
#
|
3754
|
-
# For more information
|
3755
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
3771
|
+
# For more information about ARN format, see [ Resource Types Defined
|
3772
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
3756
3773
|
# Reference*.
|
3757
3774
|
#
|
3758
3775
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudwatch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.42.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-07-
|
11
|
+
date: 2020-07-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|