aws-sdk-cloudwatch 1.41.0 → 1.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-cloudwatch.rb +3 -2
- data/lib/aws-sdk-cloudwatch/alarm.rb +1 -1
- data/lib/aws-sdk-cloudwatch/client.rb +100 -62
- data/lib/aws-sdk-cloudwatch/client_api.rb +2 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +14 -15
- data/lib/aws-sdk-cloudwatch/resource.rb +20 -7
- data/lib/aws-sdk-cloudwatch/types.rb +64 -43
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1347762bcffca8868d6ad9213c7cfd1d938f9bd0ff3d625fa1150b5748b79258
|
4
|
+
data.tar.gz: 004300b9fb06235b2e748fd7a948479bbb4a432f6e0f3b28a254356f62f9bf16
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3dd159ec62cf5bd822acde7677769e944236e22504d2cb03946063627ec1201e1be35e588aedf10a7c05f42667cfdcc90e807e3042b3561790026746d1f49418
|
7
|
+
data.tar.gz: 7535b020ff585ca226f974cf0505f4d2d9b950beace1f7b61fc4af3d67b5ac3da89cf29db57b5c916d5138837b20d0998ede397cae04df03e7df9742d95a7ac6
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -48,9 +49,9 @@ require_relative 'aws-sdk-cloudwatch/customizations'
|
|
48
49
|
#
|
49
50
|
# See {Errors} for more information.
|
50
51
|
#
|
51
|
-
#
|
52
|
+
# @!group service
|
52
53
|
module Aws::CloudWatch
|
53
54
|
|
54
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.46.0'
|
55
56
|
|
56
57
|
end
|
@@ -201,7 +201,7 @@ module Aws::CloudWatch
|
|
201
201
|
# metric math expression. Each structure either retrieves a metric or
|
202
202
|
# performs a math expression. One item in the Metrics array is the math
|
203
203
|
# expression that the alarm watches. This expression by designated by
|
204
|
-
# having `
|
204
|
+
# having `ReturnData` set to true.
|
205
205
|
# @return [Array<Types::MetricDataQuery>]
|
206
206
|
def metrics
|
207
207
|
data[:metrics]
|
@@ -85,13 +85,28 @@ module Aws::CloudWatch
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::CloudWatch
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -398,7 +413,7 @@ module Aws::CloudWatch
|
|
398
413
|
req.send_request(options)
|
399
414
|
end
|
400
415
|
|
401
|
-
# Deletes all dashboards that you specify. You
|
416
|
+
# Deletes all dashboards that you specify. You can specify up to 100
|
402
417
|
# dashboards to delete. If there is an error during this call, no
|
403
418
|
# dashboards are deleted.
|
404
419
|
#
|
@@ -425,8 +440,8 @@ module Aws::CloudWatch
|
|
425
440
|
# Permanently deletes the specified Contributor Insights rules.
|
426
441
|
#
|
427
442
|
# 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
|
-
#
|
443
|
+
# name, historical data from the first time the rule was created might
|
444
|
+
# not be available.
|
430
445
|
#
|
431
446
|
# @option params [required, Array<String>] :rule_names
|
432
447
|
# An array of the rule names to delete. If you need to find out the
|
@@ -570,7 +585,7 @@ module Aws::CloudWatch
|
|
570
585
|
#
|
571
586
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
572
587
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
573
|
-
# you do so, you
|
588
|
+
# you do so, you receive a validation error.
|
574
589
|
#
|
575
590
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
576
591
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information
|
@@ -591,7 +606,7 @@ module Aws::CloudWatch
|
|
591
606
|
#
|
592
607
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
593
608
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
594
|
-
# you do so, you
|
609
|
+
# you do so, you receive a validation error.
|
595
610
|
#
|
596
611
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
597
612
|
# use this parameter. To get complete information about these alarms,
|
@@ -724,6 +739,11 @@ module Aws::CloudWatch
|
|
724
739
|
# Retrieves the alarms for the specified metric. To filter the results,
|
725
740
|
# specify a statistic, period, or unit.
|
726
741
|
#
|
742
|
+
# This operation retrieves only standard alarms that are based on the
|
743
|
+
# specified metric. It does not return alarms based on math expressions
|
744
|
+
# that use the specified metric, or composite alarms that use the
|
745
|
+
# specified metric.
|
746
|
+
#
|
727
747
|
# @option params [required, String] :metric_name
|
728
748
|
# The name of the metric.
|
729
749
|
#
|
@@ -906,7 +926,6 @@ module Aws::CloudWatch
|
|
906
926
|
end
|
907
927
|
|
908
928
|
# Returns a list of all the Contributor Insights rules in your account.
|
909
|
-
# All rules in your account are returned with a single operation.
|
910
929
|
#
|
911
930
|
# For more information about Contributor Insights, see [Using
|
912
931
|
# Contributor Insights to Analyze High-Cardinality Data][1].
|
@@ -916,11 +935,12 @@ module Aws::CloudWatch
|
|
916
935
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html
|
917
936
|
#
|
918
937
|
# @option params [String] :next_token
|
919
|
-
#
|
938
|
+
# Include this value, if it was returned by the previous operation, to
|
939
|
+
# get the next set of rules.
|
920
940
|
#
|
921
941
|
# @option params [Integer] :max_results
|
922
|
-
#
|
923
|
-
#
|
942
|
+
# The maximum number of results to return in one operation. If you omit
|
943
|
+
# this parameter, the default of 500 is used.
|
924
944
|
#
|
925
945
|
# @return [Types::DescribeInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
926
946
|
#
|
@@ -1123,8 +1143,8 @@ module Aws::CloudWatch
|
|
1123
1143
|
# data point.
|
1124
1144
|
#
|
1125
1145
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1126
|
-
# data point. The identity of the contributor
|
1127
|
-
# point in the graph.
|
1146
|
+
# data point. The identity of the contributor might change for each
|
1147
|
+
# data point in the graph.
|
1128
1148
|
#
|
1129
1149
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1130
1150
|
# point is the contributor with the most occurrences in that period.
|
@@ -1175,8 +1195,8 @@ module Aws::CloudWatch
|
|
1175
1195
|
# data point.
|
1176
1196
|
#
|
1177
1197
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1178
|
-
# data point. The identity of the contributor
|
1179
|
-
# point in the graph.
|
1198
|
+
# data point. The identity of the contributor might change for each
|
1199
|
+
# data point in the graph.
|
1180
1200
|
#
|
1181
1201
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1182
1202
|
# point is the contributor with the most occurrences in that period.
|
@@ -1297,10 +1317,10 @@ module Aws::CloudWatch
|
|
1297
1317
|
# If you omit `Unit` in your request, all data that was collected with
|
1298
1318
|
# any unit is returned, along with the corresponding units that were
|
1299
1319
|
# specified when the data was reported to CloudWatch. If you specify a
|
1300
|
-
# unit, the operation returns only data
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1320
|
+
# unit, the operation returns only data that was collected with that
|
1321
|
+
# unit specified. If you specify a unit that does not match the data
|
1322
|
+
# collected, the results of the operation are null. CloudWatch does not
|
1323
|
+
# perform unit conversions.
|
1304
1324
|
#
|
1305
1325
|
#
|
1306
1326
|
#
|
@@ -1361,8 +1381,8 @@ module Aws::CloudWatch
|
|
1361
1381
|
# response from CloudWatch than setting 12:07 or 12:29 as the `EndTime`.
|
1362
1382
|
#
|
1363
1383
|
# @option params [String] :next_token
|
1364
|
-
# Include this value, if it was returned by the previous
|
1365
|
-
# the next set of data points.
|
1384
|
+
# Include this value, if it was returned by the previous `GetMetricData`
|
1385
|
+
# operation, to get the next set of data points.
|
1366
1386
|
#
|
1367
1387
|
# @option params [String] :scan_by
|
1368
1388
|
# The order in which data points should be returned.
|
@@ -1606,10 +1626,10 @@ module Aws::CloudWatch
|
|
1606
1626
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
1607
1627
|
# collected with any unit is returned, along with the corresponding
|
1608
1628
|
# 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
|
-
#
|
1629
|
+
# you specify a unit, the operation returns only data that was collected
|
1630
|
+
# with that unit specified. If you specify a unit that does not match
|
1631
|
+
# the data collected, the results of the operation are null. CloudWatch
|
1632
|
+
# does not perform unit conversions.
|
1613
1633
|
#
|
1614
1634
|
# @return [Types::GetMetricStatisticsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1615
1635
|
#
|
@@ -1808,9 +1828,13 @@ module Aws::CloudWatch
|
|
1808
1828
|
# Up to 500 results are returned for any one call. To retrieve
|
1809
1829
|
# additional results, use the returned token with subsequent calls.
|
1810
1830
|
#
|
1811
|
-
# After you create a metric, allow up to
|
1812
|
-
#
|
1813
|
-
#
|
1831
|
+
# After you create a metric, allow up to 15 minutes before the metric
|
1832
|
+
# appears. You can see statistics about the metric sooner by using
|
1833
|
+
# [GetMetricData][1] or [GetMetricStatistics][2].
|
1834
|
+
#
|
1835
|
+
# `ListMetrics` doesn't return information about metrics if those
|
1836
|
+
# metrics haven't reported data in the past two weeks. To retrieve
|
1837
|
+
# those metrics, use [GetMetricData][1] or [GetMetricStatistics][2].
|
1814
1838
|
#
|
1815
1839
|
#
|
1816
1840
|
#
|
@@ -1818,18 +1842,31 @@ module Aws::CloudWatch
|
|
1818
1842
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html
|
1819
1843
|
#
|
1820
1844
|
# @option params [String] :namespace
|
1821
|
-
# The namespace to filter against.
|
1845
|
+
# The metric namespace to filter against. Only the namespace that
|
1846
|
+
# matches exactly will be returned.
|
1822
1847
|
#
|
1823
1848
|
# @option params [String] :metric_name
|
1824
|
-
# The name of the metric to filter against.
|
1849
|
+
# The name of the metric to filter against. Only the metrics with names
|
1850
|
+
# that match exactly will be returned.
|
1825
1851
|
#
|
1826
1852
|
# @option params [Array<Types::DimensionFilter>] :dimensions
|
1827
|
-
# The dimensions to filter against.
|
1853
|
+
# The dimensions to filter against. Only the dimensions that match
|
1854
|
+
# exactly will be returned.
|
1828
1855
|
#
|
1829
1856
|
# @option params [String] :next_token
|
1830
1857
|
# The token returned by a previous call to indicate that there is more
|
1831
1858
|
# data available.
|
1832
1859
|
#
|
1860
|
+
# @option params [String] :recently_active
|
1861
|
+
# To filter the results to show only metrics that have had data points
|
1862
|
+
# published in the past three hours, specify this parameter with a value
|
1863
|
+
# of `PT3H`. This is the only valid value for this parameter.
|
1864
|
+
#
|
1865
|
+
# The results that are returned are an approximation of the value you
|
1866
|
+
# specify. There is a low probability that the returned results include
|
1867
|
+
# metrics with last published data as much as 40 minutes more than the
|
1868
|
+
# specified time interval.
|
1869
|
+
#
|
1833
1870
|
# @return [Types::ListMetricsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1834
1871
|
#
|
1835
1872
|
# * {Types::ListMetricsOutput#metrics #metrics} => Array<Types::Metric>
|
@@ -1849,6 +1886,7 @@ module Aws::CloudWatch
|
|
1849
1886
|
# },
|
1850
1887
|
# ],
|
1851
1888
|
# next_token: "NextToken",
|
1889
|
+
# recently_active: "PT3H", # accepts PT3H
|
1852
1890
|
# })
|
1853
1891
|
#
|
1854
1892
|
# @example Response structure
|
@@ -1882,7 +1920,7 @@ module Aws::CloudWatch
|
|
1882
1920
|
# The ARN format of a Contributor Insights rule is
|
1883
1921
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
1884
1922
|
#
|
1885
|
-
# For more information
|
1923
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
1886
1924
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
1887
1925
|
#
|
1888
1926
|
#
|
@@ -1944,8 +1982,6 @@ module Aws::CloudWatch
|
|
1944
1982
|
# The configuration can also include the time zone to use for the
|
1945
1983
|
# metric.
|
1946
1984
|
#
|
1947
|
-
# You can in
|
1948
|
-
#
|
1949
1985
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1950
1986
|
#
|
1951
1987
|
# @example Request syntax with placeholder values
|
@@ -2041,8 +2077,8 @@ module Aws::CloudWatch
|
|
2041
2077
|
# The description for the composite alarm.
|
2042
2078
|
#
|
2043
2079
|
# @option params [required, String] :alarm_name
|
2044
|
-
# The name for the composite alarm. This name must be unique within
|
2045
|
-
#
|
2080
|
+
# The name for the composite alarm. This name must be unique within the
|
2081
|
+
# Region.
|
2046
2082
|
#
|
2047
2083
|
# @option params [required, String] :alarm_rule
|
2048
2084
|
# An expression that specifies which other alarms are to be evaluated to
|
@@ -2225,8 +2261,8 @@ module Aws::CloudWatch
|
|
2225
2261
|
# Contributor Insights to Analyze High-Cardinality Data][1].
|
2226
2262
|
#
|
2227
2263
|
# 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
|
-
#
|
2264
|
+
# name, historical data from the first time the rule was created might
|
2265
|
+
# not be available.
|
2230
2266
|
#
|
2231
2267
|
#
|
2232
2268
|
#
|
@@ -2345,8 +2381,7 @@ module Aws::CloudWatch
|
|
2345
2381
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
|
2346
2382
|
#
|
2347
2383
|
# @option params [required, String] :alarm_name
|
2348
|
-
# The name for the alarm. This name must be unique within
|
2349
|
-
# account.
|
2384
|
+
# The name for the alarm. This name must be unique within the Region.
|
2350
2385
|
#
|
2351
2386
|
# @option params [String] :alarm_description
|
2352
2387
|
# The description for the alarm.
|
@@ -2458,8 +2493,8 @@ module Aws::CloudWatch
|
|
2458
2493
|
# resolution, the alarm still attempts to gather data at the period rate
|
2459
2494
|
# that you specify. In this case, it does not receive data for the
|
2460
2495
|
# 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
|
2496
|
+
# the alarm might often lapse into INSUFFICENT\_DATA status. Specifying
|
2497
|
+
# 10 or 30 also sets this alarm as a high-resolution alarm, which has a
|
2463
2498
|
# higher charge than other alarms. For more information about pricing,
|
2464
2499
|
# see [Amazon CloudWatch Pricing][1].
|
2465
2500
|
#
|
@@ -2481,12 +2516,12 @@ module Aws::CloudWatch
|
|
2481
2516
|
#
|
2482
2517
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types that
|
2483
2518
|
# 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
|
-
#
|
2519
|
+
# Usually, metrics are published with only one unit, so the alarm works
|
2520
|
+
# as intended.
|
2486
2521
|
#
|
2487
2522
|
# 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
|
-
#
|
2523
|
+
# you don't specify a unit, the alarm's behavior is not defined and it
|
2524
|
+
# behaves predictably.
|
2490
2525
|
#
|
2491
2526
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
2492
2527
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -2565,8 +2600,8 @@ module Aws::CloudWatch
|
|
2565
2600
|
# a math expression.
|
2566
2601
|
#
|
2567
2602
|
# One item in the `Metrics` array is the expression that the alarm
|
2568
|
-
# watches. You designate this expression by setting `
|
2569
|
-
#
|
2603
|
+
# watches. You designate this expression by setting `ReturnData` to true
|
2604
|
+
# for this object in the array. For more information, see
|
2570
2605
|
# [MetricDataQuery][1].
|
2571
2606
|
#
|
2572
2607
|
# If you use the `Metrics` parameter, you cannot include the
|
@@ -2584,7 +2619,7 @@ module Aws::CloudWatch
|
|
2584
2619
|
# associate as many as 50 tags with an alarm.
|
2585
2620
|
#
|
2586
2621
|
# Tags can help you organize and categorize your resources. You can also
|
2587
|
-
# use them to scope user permissions
|
2622
|
+
# use them to scope user permissions by granting a user permission to
|
2588
2623
|
# access or change only resources with certain tag values.
|
2589
2624
|
#
|
2590
2625
|
# @option params [String] :threshold_metric_id
|
@@ -2696,6 +2731,10 @@ module Aws::CloudWatch
|
|
2696
2731
|
# pair. For more information about specifying dimensions, see
|
2697
2732
|
# [Publishing Metrics][2] in the *Amazon CloudWatch User Guide*.
|
2698
2733
|
#
|
2734
|
+
# You specify the time stamp to be associated with each data point. You
|
2735
|
+
# can specify time stamps that are as much as two weeks before the
|
2736
|
+
# current date, and as much as 2 hours after the current day and time.
|
2737
|
+
#
|
2699
2738
|
# Data points with time stamps from 24 hours ago or longer can take at
|
2700
2739
|
# least 48 hours to become available for [GetMetricData][3] or
|
2701
2740
|
# [GetMetricStatistics][4] from the time they are submitted. Data points
|
@@ -2783,9 +2822,9 @@ module Aws::CloudWatch
|
|
2783
2822
|
# CloudWatch console or through [DescribeAlarmHistory][1].
|
2784
2823
|
#
|
2785
2824
|
# If you use `SetAlarmState` on a composite alarm, the composite alarm
|
2786
|
-
# is not guaranteed to return to its actual state. It
|
2825
|
+
# is not guaranteed to return to its actual state. It returns to its
|
2787
2826
|
# actual state only once any of its children alarms change state. It is
|
2788
|
-
# also
|
2827
|
+
# also reevaluated if you update its configuration.
|
2789
2828
|
#
|
2790
2829
|
# If an alarm triggers EC2 Auto Scaling policies or application Auto
|
2791
2830
|
# Scaling policies, you must include information in the
|
@@ -2797,8 +2836,7 @@ module Aws::CloudWatch
|
|
2797
2836
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html
|
2798
2837
|
#
|
2799
2838
|
# @option params [required, String] :alarm_name
|
2800
|
-
# The name
|
2801
|
-
# account. The maximum length is 255 characters.
|
2839
|
+
# The name of the alarm.
|
2802
2840
|
#
|
2803
2841
|
# @option params [required, String] :state_value
|
2804
2842
|
# The value of the state.
|
@@ -2841,7 +2879,7 @@ module Aws::CloudWatch
|
|
2841
2879
|
# are alarms and Contributor Insights rules.
|
2842
2880
|
#
|
2843
2881
|
# Tags can help you organize and categorize your resources. You can also
|
2844
|
-
# use them to scope user permissions
|
2882
|
+
# use them to scope user permissions by granting a user permission to
|
2845
2883
|
# access or change only resources with certain tag values.
|
2846
2884
|
#
|
2847
2885
|
# Tags don't have any semantic meaning to AWS and are interpreted
|
@@ -2864,7 +2902,7 @@ module Aws::CloudWatch
|
|
2864
2902
|
# The ARN format of a Contributor Insights rule is
|
2865
2903
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2866
2904
|
#
|
2867
|
-
# For more information
|
2905
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2868
2906
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2869
2907
|
#
|
2870
2908
|
#
|
@@ -2908,7 +2946,7 @@ module Aws::CloudWatch
|
|
2908
2946
|
# The ARN format of a Contributor Insights rule is
|
2909
2947
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2910
2948
|
#
|
2911
|
-
# For more information
|
2949
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2912
2950
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2913
2951
|
#
|
2914
2952
|
#
|
@@ -2949,7 +2987,7 @@ module Aws::CloudWatch
|
|
2949
2987
|
params: params,
|
2950
2988
|
config: config)
|
2951
2989
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
2952
|
-
context[:gem_version] = '1.
|
2990
|
+
context[:gem_version] = '1.46.0'
|
2953
2991
|
Seahorse::Client::Request.new(handlers, context)
|
2954
2992
|
end
|
2955
2993
|
|
@@ -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
|
@@ -553,8 +552,8 @@ module Aws::CloudWatch
|
|
553
552
|
# a math expression.
|
554
553
|
#
|
555
554
|
# One item in the `Metrics` array is the expression that the alarm
|
556
|
-
# watches. You designate this expression by setting `
|
557
|
-
#
|
555
|
+
# watches. You designate this expression by setting `ReturnData` to true
|
556
|
+
# for this object in the array. For more information, see
|
558
557
|
# [MetricDataQuery][1].
|
559
558
|
#
|
560
559
|
# If you use the `Metrics` parameter, you cannot include the
|
@@ -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,14 +253,27 @@ 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
|
259
|
-
# The namespace to filter against.
|
260
|
+
# The metric namespace to filter against. Only the namespace that
|
261
|
+
# matches exactly will be returned.
|
260
262
|
# @option options [String] :metric_name
|
261
|
-
# The name of the metric to filter against.
|
263
|
+
# The name of the metric to filter against. Only the metrics with names
|
264
|
+
# that match exactly will be returned.
|
262
265
|
# @option options [Array<Types::DimensionFilter>] :dimensions
|
263
|
-
# The dimensions to filter against.
|
266
|
+
# The dimensions to filter against. Only the dimensions that match
|
267
|
+
# exactly will be returned.
|
268
|
+
# @option options [String] :recently_active
|
269
|
+
# To filter the results to show only metrics that have had data points
|
270
|
+
# published in the past three hours, specify this parameter with a value
|
271
|
+
# of `PT3H`. This is the only valid value for this parameter.
|
272
|
+
#
|
273
|
+
# The results that are returned are an approximation of the value you
|
274
|
+
# specify. There is a low probability that the returned results include
|
275
|
+
# metrics with last published data as much as 40 minutes more than the
|
276
|
+
# specified time interval.
|
264
277
|
# @return [Metric::Collection]
|
265
278
|
def metrics(options = {})
|
266
279
|
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,
|
@@ -871,12 +871,13 @@ module Aws::CloudWatch
|
|
871
871
|
# }
|
872
872
|
#
|
873
873
|
# @!attribute [rw] next_token
|
874
|
-
#
|
874
|
+
# Include this value, if it was returned by the previous operation, to
|
875
|
+
# get the next set of rules.
|
875
876
|
# @return [String]
|
876
877
|
#
|
877
878
|
# @!attribute [rw] max_results
|
878
|
-
#
|
879
|
-
#
|
879
|
+
# The maximum number of results to return in one operation. If you
|
880
|
+
# omit this parameter, the default of 500 is used.
|
880
881
|
# @return [Integer]
|
881
882
|
#
|
882
883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeInsightRulesInput AWS API Documentation
|
@@ -889,7 +890,8 @@ module Aws::CloudWatch
|
|
889
890
|
end
|
890
891
|
|
891
892
|
# @!attribute [rw] next_token
|
892
|
-
#
|
893
|
+
# If this parameter is present, it is a token that marks the start of
|
894
|
+
# the next batch of returned results.
|
893
895
|
# @return [String]
|
894
896
|
#
|
895
897
|
# @!attribute [rw] insight_rules
|
@@ -905,7 +907,11 @@ module Aws::CloudWatch
|
|
905
907
|
include Aws::Structure
|
906
908
|
end
|
907
909
|
|
908
|
-
#
|
910
|
+
# A dimension is a name/value pair that is part of the identity of a
|
911
|
+
# metric. You can assign up to 10 dimensions to a metric. Because
|
912
|
+
# dimensions are part of the unique identifier for a metric, whenever
|
913
|
+
# you add a unique name/value pair to one of your metrics, you are
|
914
|
+
# creating a new variation of that metric.
|
909
915
|
#
|
910
916
|
# @note When making an API call, you may pass Dimension
|
911
917
|
# data as a hash:
|
@@ -916,11 +922,13 @@ module Aws::CloudWatch
|
|
916
922
|
# }
|
917
923
|
#
|
918
924
|
# @!attribute [rw] name
|
919
|
-
# The name of the dimension.
|
925
|
+
# The name of the dimension. Dimension names cannot contain blank
|
926
|
+
# spaces or non-ASCII characters.
|
920
927
|
# @return [String]
|
921
928
|
#
|
922
929
|
# @!attribute [rw] value
|
923
|
-
# The value
|
930
|
+
# The value of the dimension. Dimension values cannot contain blank
|
931
|
+
# spaces or non-ASCII characters.
|
924
932
|
# @return [String]
|
925
933
|
#
|
926
934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension AWS API Documentation
|
@@ -1167,7 +1175,7 @@ module Aws::CloudWatch
|
|
1167
1175
|
# data point.
|
1168
1176
|
#
|
1169
1177
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1170
|
-
# data point. The identity of the contributor
|
1178
|
+
# data point. The identity of the contributor might change for each
|
1171
1179
|
# data point in the graph.
|
1172
1180
|
#
|
1173
1181
|
# If this rule aggregates by COUNT, the top contributor for each
|
@@ -1349,8 +1357,8 @@ module Aws::CloudWatch
|
|
1349
1357
|
# @return [Time]
|
1350
1358
|
#
|
1351
1359
|
# @!attribute [rw] next_token
|
1352
|
-
# Include this value, if it was returned by the previous
|
1353
|
-
# the next set of data points.
|
1360
|
+
# Include this value, if it was returned by the previous
|
1361
|
+
# `GetMetricData` operation, to get the next set of data points.
|
1354
1362
|
# @return [String]
|
1355
1363
|
#
|
1356
1364
|
# @!attribute [rw] scan_by
|
@@ -1391,8 +1399,8 @@ module Aws::CloudWatch
|
|
1391
1399
|
# @!attribute [rw] messages
|
1392
1400
|
# Contains a message about this `GetMetricData` operation, if the
|
1393
1401
|
# 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
|
1402
|
+
# might be returned is `Maximum number of allowed metrics exceeded`.
|
1403
|
+
# If there is a message, as much of the operation as possible is still
|
1396
1404
|
# executed.
|
1397
1405
|
#
|
1398
1406
|
# A message appears here only if it is related to the global
|
@@ -1539,7 +1547,7 @@ module Aws::CloudWatch
|
|
1539
1547
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
1540
1548
|
# collected with any unit is returned, along with the corresponding
|
1541
1549
|
# units that were specified when the data was reported to CloudWatch.
|
1542
|
-
# If you specify a unit, the operation returns only data
|
1550
|
+
# If you specify a unit, the operation returns only data that was
|
1543
1551
|
# collected with that unit specified. If you specify a unit that does
|
1544
1552
|
# not match the data collected, the results of the operation are null.
|
1545
1553
|
# CloudWatch does not perform unit conversions.
|
@@ -1648,7 +1656,8 @@ module Aws::CloudWatch
|
|
1648
1656
|
end
|
1649
1657
|
|
1650
1658
|
# @!attribute [rw] metric_widget_image
|
1651
|
-
# The image of the graph, in the output format specified.
|
1659
|
+
# The image of the graph, in the output format specified. The output
|
1660
|
+
# is base64-encoded.
|
1652
1661
|
# @return [String]
|
1653
1662
|
#
|
1654
1663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImageOutput AWS API Documentation
|
@@ -1996,18 +2005,22 @@ module Aws::CloudWatch
|
|
1996
2005
|
# },
|
1997
2006
|
# ],
|
1998
2007
|
# next_token: "NextToken",
|
2008
|
+
# recently_active: "PT3H", # accepts PT3H
|
1999
2009
|
# }
|
2000
2010
|
#
|
2001
2011
|
# @!attribute [rw] namespace
|
2002
|
-
# The namespace to filter against.
|
2012
|
+
# The metric namespace to filter against. Only the namespace that
|
2013
|
+
# matches exactly will be returned.
|
2003
2014
|
# @return [String]
|
2004
2015
|
#
|
2005
2016
|
# @!attribute [rw] metric_name
|
2006
|
-
# The name of the metric to filter against.
|
2017
|
+
# The name of the metric to filter against. Only the metrics with
|
2018
|
+
# names that match exactly will be returned.
|
2007
2019
|
# @return [String]
|
2008
2020
|
#
|
2009
2021
|
# @!attribute [rw] dimensions
|
2010
|
-
# The dimensions to filter against.
|
2022
|
+
# The dimensions to filter against. Only the dimensions that match
|
2023
|
+
# exactly will be returned.
|
2011
2024
|
# @return [Array<Types::DimensionFilter>]
|
2012
2025
|
#
|
2013
2026
|
# @!attribute [rw] next_token
|
@@ -2015,19 +2028,31 @@ module Aws::CloudWatch
|
|
2015
2028
|
# data available.
|
2016
2029
|
# @return [String]
|
2017
2030
|
#
|
2031
|
+
# @!attribute [rw] recently_active
|
2032
|
+
# To filter the results to show only metrics that have had data points
|
2033
|
+
# published in the past three hours, specify this parameter with a
|
2034
|
+
# value of `PT3H`. This is the only valid value for this parameter.
|
2035
|
+
#
|
2036
|
+
# The results that are returned are an approximation of the value you
|
2037
|
+
# specify. There is a low probability that the returned results
|
2038
|
+
# include metrics with last published data as much as 40 minutes more
|
2039
|
+
# than the specified time interval.
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2018
2042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput AWS API Documentation
|
2019
2043
|
#
|
2020
2044
|
class ListMetricsInput < Struct.new(
|
2021
2045
|
:namespace,
|
2022
2046
|
:metric_name,
|
2023
2047
|
:dimensions,
|
2024
|
-
:next_token
|
2048
|
+
:next_token,
|
2049
|
+
:recently_active)
|
2025
2050
|
SENSITIVE = []
|
2026
2051
|
include Aws::Structure
|
2027
2052
|
end
|
2028
2053
|
|
2029
2054
|
# @!attribute [rw] metrics
|
2030
|
-
# The metrics.
|
2055
|
+
# The metrics that match your request.
|
2031
2056
|
# @return [Array<Types::Metric>]
|
2032
2057
|
#
|
2033
2058
|
# @!attribute [rw] next_token
|
@@ -2061,8 +2086,8 @@ module Aws::CloudWatch
|
|
2061
2086
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
2062
2087
|
# `
|
2063
2088
|
#
|
2064
|
-
# For more information
|
2065
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
2089
|
+
# For more information about ARN format, see [ Resource Types Defined
|
2090
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
2066
2091
|
# Reference*.
|
2067
2092
|
#
|
2068
2093
|
#
|
@@ -2275,7 +2300,7 @@ module Aws::CloudWatch
|
|
2275
2300
|
# metric math expression. Each structure either retrieves a metric or
|
2276
2301
|
# performs a math expression. One item in the Metrics array is the
|
2277
2302
|
# math expression that the alarm watches. This expression by
|
2278
|
-
# designated by having `
|
2303
|
+
# designated by having `ReturnData` set to true.
|
2279
2304
|
# @return [Array<Types::MetricDataQuery>]
|
2280
2305
|
#
|
2281
2306
|
# @!attribute [rw] threshold_metric_id
|
@@ -2694,7 +2719,7 @@ module Aws::CloudWatch
|
|
2694
2719
|
# In a `Get` operation, if you omit `Unit` then all data that was
|
2695
2720
|
# collected with any unit is returned, along with the corresponding
|
2696
2721
|
# units that were specified when the data was reported to CloudWatch.
|
2697
|
-
# If you specify a unit, the operation returns only data
|
2722
|
+
# If you specify a unit, the operation returns only data that was
|
2698
2723
|
# collected with that unit specified. If you specify a unit that does
|
2699
2724
|
# not match the data collected, the results of the operation are null.
|
2700
2725
|
# CloudWatch does not perform unit conversions.
|
@@ -2804,8 +2829,6 @@ module Aws::CloudWatch
|
|
2804
2829
|
#
|
2805
2830
|
# The configuration can also include the time zone to use for the
|
2806
2831
|
# metric.
|
2807
|
-
#
|
2808
|
-
# You can in
|
2809
2832
|
# @return [Types::AnomalyDetectorConfiguration]
|
2810
2833
|
#
|
2811
2834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutAnomalyDetectorInput AWS API Documentation
|
@@ -2862,7 +2885,7 @@ module Aws::CloudWatch
|
|
2862
2885
|
#
|
2863
2886
|
# @!attribute [rw] alarm_name
|
2864
2887
|
# The name for the composite alarm. This name must be unique within
|
2865
|
-
#
|
2888
|
+
# the Region.
|
2866
2889
|
# @return [String]
|
2867
2890
|
#
|
2868
2891
|
# @!attribute [rw] alarm_rule
|
@@ -3009,7 +3032,7 @@ module Aws::CloudWatch
|
|
3009
3032
|
#
|
3010
3033
|
# If this result includes only warning messages, then the input was
|
3011
3034
|
# valid enough for the dashboard to be created or modified, but some
|
3012
|
-
# elements of the dashboard
|
3035
|
+
# elements of the dashboard might not render.
|
3013
3036
|
#
|
3014
3037
|
# If this result includes error messages, the input was not valid and
|
3015
3038
|
# the operation failed.
|
@@ -3154,8 +3177,7 @@ module Aws::CloudWatch
|
|
3154
3177
|
# }
|
3155
3178
|
#
|
3156
3179
|
# @!attribute [rw] alarm_name
|
3157
|
-
# The name for the alarm. This name must be unique within
|
3158
|
-
# account.
|
3180
|
+
# The name for the alarm. This name must be unique within the Region.
|
3159
3181
|
# @return [String]
|
3160
3182
|
#
|
3161
3183
|
# @!attribute [rw] alarm_description
|
@@ -3279,7 +3301,7 @@ module Aws::CloudWatch
|
|
3279
3301
|
# resolution, the alarm still attempts to gather data at the period
|
3280
3302
|
# rate that you specify. In this case, it does not receive data for
|
3281
3303
|
# the attempts that do not correspond to a one-minute data resolution,
|
3282
|
-
# and the alarm
|
3304
|
+
# and the alarm might often lapse into INSUFFICENT\_DATA status.
|
3283
3305
|
# Specifying 10 or 30 also sets this alarm as a high-resolution alarm,
|
3284
3306
|
# which has a higher charge than other alarms. For more information
|
3285
3307
|
# about pricing, see [Amazon CloudWatch Pricing][1].
|
@@ -3304,12 +3326,12 @@ module Aws::CloudWatch
|
|
3304
3326
|
#
|
3305
3327
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types
|
3306
3328
|
# 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
|
3329
|
+
# alarm. Usually, metrics are published with only one unit, so the
|
3330
|
+
# alarm works as intended.
|
3309
3331
|
#
|
3310
3332
|
# However, if the metric is published with multiple types of units and
|
3311
3333
|
# you don't specify a unit, the alarm's behavior is not defined and
|
3312
|
-
#
|
3334
|
+
# it behaves predictably.
|
3313
3335
|
#
|
3314
3336
|
# We recommend omitting `Unit` so that you don't inadvertently
|
3315
3337
|
# specify an incorrect unit that is not published for this metric.
|
@@ -3396,7 +3418,7 @@ module Aws::CloudWatch
|
|
3396
3418
|
# performs a math expression.
|
3397
3419
|
#
|
3398
3420
|
# One item in the `Metrics` array is the expression that the alarm
|
3399
|
-
# watches. You designate this expression by setting `
|
3421
|
+
# watches. You designate this expression by setting `ReturnData` to
|
3400
3422
|
# true for this object in the array. For more information, see
|
3401
3423
|
# [MetricDataQuery][1].
|
3402
3424
|
#
|
@@ -3416,7 +3438,7 @@ module Aws::CloudWatch
|
|
3416
3438
|
# associate as many as 50 tags with an alarm.
|
3417
3439
|
#
|
3418
3440
|
# Tags can help you organize and categorize your resources. You can
|
3419
|
-
# also use them to scope user permissions
|
3441
|
+
# also use them to scope user permissions by granting a user
|
3420
3442
|
# permission to access or change only resources with certain tag
|
3421
3443
|
# values.
|
3422
3444
|
# @return [Array<Types::Tag>]
|
@@ -3583,8 +3605,7 @@ module Aws::CloudWatch
|
|
3583
3605
|
# }
|
3584
3606
|
#
|
3585
3607
|
# @!attribute [rw] alarm_name
|
3586
|
-
# The name
|
3587
|
-
# account. The maximum length is 255 characters.
|
3608
|
+
# The name of the alarm.
|
3588
3609
|
# @return [String]
|
3589
3610
|
#
|
3590
3611
|
# @!attribute [rw] state_value
|
@@ -3707,8 +3728,8 @@ module Aws::CloudWatch
|
|
3707
3728
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
3708
3729
|
# `
|
3709
3730
|
#
|
3710
|
-
# For more information
|
3711
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
3731
|
+
# For more information about ARN format, see [ Resource Types Defined
|
3732
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
3712
3733
|
# Reference*.
|
3713
3734
|
#
|
3714
3735
|
#
|
@@ -3751,8 +3772,8 @@ module Aws::CloudWatch
|
|
3751
3772
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
|
3752
3773
|
# `
|
3753
3774
|
#
|
3754
|
-
# For more information
|
3755
|
-
# Amazon CloudWatch][1] in the *Amazon Web Services General
|
3775
|
+
# For more information about ARN format, see [ Resource Types Defined
|
3776
|
+
# by Amazon CloudWatch][1] in the *Amazon Web Services General
|
3756
3777
|
# Reference*.
|
3757
3778
|
#
|
3758
3779
|
#
|
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.46.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-
|
11
|
+
date: 2020-11-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|