aws-sdk-cloudwatch 1.39.1 → 1.44.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 +5 -2
- data/lib/aws-sdk-cloudwatch/alarm.rb +2 -0
- data/lib/aws-sdk-cloudwatch/client.rb +80 -50
- data/lib/aws-sdk-cloudwatch/client_api.rb +4 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +2 -0
- data/lib/aws-sdk-cloudwatch/customizations.rb +1 -0
- data/lib/aws-sdk-cloudwatch/errors.rb +2 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +14 -13
- data/lib/aws-sdk-cloudwatch/resource.rb +16 -4
- data/lib/aws-sdk-cloudwatch/types.rb +132 -31
- data/lib/aws-sdk-cloudwatch/waiters.rb +2 -0
- 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: 0be685b2a4beb76797422f844a0748eb8b529b3dc7184fc78feae952bedb7485
|
4
|
+
data.tar.gz: 80b39e955a3cdc7bbc9444a56aeacf298ba7858713287d9236a43931e2c087b8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d625a238d5f72f14f2bcfec278a463d1fa51e5878c5f4bef5ca452ff00be125de121fe84d3c309ea81990f8ed43dcdbfca320e9b8365e8250187a47c01fd1ac
|
7
|
+
data.tar.gz: af43403695d5a69d67d0338c88b43889359d7d50964b7c6a6c59d2a8daea9444f38ec74817102df885479fc04fb2061593dbbfddfa7263b36da41889a2e39e19
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -46,9 +49,9 @@ require_relative 'aws-sdk-cloudwatch/customizations'
|
|
46
49
|
#
|
47
50
|
# See {Errors} for more information.
|
48
51
|
#
|
49
|
-
#
|
52
|
+
# @!group service
|
50
53
|
module Aws::CloudWatch
|
51
54
|
|
52
|
-
GEM_VERSION = '1.
|
55
|
+
GEM_VERSION = '1.44.0'
|
53
56
|
|
54
57
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -83,13 +85,28 @@ module Aws::CloudWatch
|
|
83
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
86
|
# credentials.
|
85
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
|
+
#
|
86
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
103
|
# from an EC2 IMDS on an EC2 instance.
|
88
104
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
91
107
|
#
|
92
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
93
110
|
#
|
94
111
|
# When `:credentials` are not configured directly, the following
|
95
112
|
# locations will be searched for credentials:
|
@@ -99,10 +116,10 @@ module Aws::CloudWatch
|
|
99
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
117
|
# * `~/.aws/credentials`
|
101
118
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# 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.
|
106
123
|
#
|
107
124
|
# @option options [required, String] :region
|
108
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -396,7 +413,7 @@ module Aws::CloudWatch
|
|
396
413
|
req.send_request(options)
|
397
414
|
end
|
398
415
|
|
399
|
-
# Deletes all dashboards that you specify. You
|
416
|
+
# Deletes all dashboards that you specify. You can specify up to 100
|
400
417
|
# dashboards to delete. If there is an error during this call, no
|
401
418
|
# dashboards are deleted.
|
402
419
|
#
|
@@ -423,8 +440,8 @@ module Aws::CloudWatch
|
|
423
440
|
# Permanently deletes the specified Contributor Insights rules.
|
424
441
|
#
|
425
442
|
# If you create a rule, delete it, and then re-create it with the same
|
426
|
-
# name, historical data from the first time the rule was created
|
427
|
-
#
|
443
|
+
# name, historical data from the first time the rule was created might
|
444
|
+
# not be available.
|
428
445
|
#
|
429
446
|
# @option params [required, Array<String>] :rule_names
|
430
447
|
# An array of the rule names to delete. If you need to find out the
|
@@ -568,7 +585,7 @@ module Aws::CloudWatch
|
|
568
585
|
#
|
569
586
|
# If you specify `ChildrenOfAlarmName`, you cannot specify any other
|
570
587
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
571
|
-
# you do so, you
|
588
|
+
# you do so, you receive a validation error.
|
572
589
|
#
|
573
590
|
# <note markdown="1"> Only the `Alarm Name`, `ARN`, `StateValue`
|
574
591
|
# (OK/ALARM/INSUFFICIENT\_DATA), and `StateUpdatedTimestamp` information
|
@@ -589,7 +606,7 @@ module Aws::CloudWatch
|
|
589
606
|
#
|
590
607
|
# If you specify `ParentsOfAlarmName`, you cannot specify any other
|
591
608
|
# parameters in the request except for `MaxRecords` and `NextToken`. If
|
592
|
-
# you do so, you
|
609
|
+
# you do so, you receive a validation error.
|
593
610
|
#
|
594
611
|
# <note markdown="1"> Only the Alarm Name and ARN are returned by this operation when you
|
595
612
|
# use this parameter. To get complete information about these alarms,
|
@@ -918,7 +935,7 @@ module Aws::CloudWatch
|
|
918
935
|
#
|
919
936
|
# @option params [Integer] :max_results
|
920
937
|
# This parameter is not currently used. Reserved for future use. If it
|
921
|
-
# is used in the future, the maximum value
|
938
|
+
# is used in the future, the maximum value might be different.
|
922
939
|
#
|
923
940
|
# @return [Types::DescribeInsightRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
924
941
|
#
|
@@ -1121,8 +1138,8 @@ module Aws::CloudWatch
|
|
1121
1138
|
# data point.
|
1122
1139
|
#
|
1123
1140
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1124
|
-
# data point. The identity of the contributor
|
1125
|
-
# point in the graph.
|
1141
|
+
# data point. The identity of the contributor might change for each
|
1142
|
+
# data point in the graph.
|
1126
1143
|
#
|
1127
1144
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1128
1145
|
# point is the contributor with the most occurrences in that period.
|
@@ -1173,8 +1190,8 @@ module Aws::CloudWatch
|
|
1173
1190
|
# data point.
|
1174
1191
|
#
|
1175
1192
|
# * `MaxContributorValue` -- the value of the top contributor for each
|
1176
|
-
# data point. The identity of the contributor
|
1177
|
-
# point in the graph.
|
1193
|
+
# data point. The identity of the contributor might change for each
|
1194
|
+
# data point in the graph.
|
1178
1195
|
#
|
1179
1196
|
# If this rule aggregates by COUNT, the top contributor for each data
|
1180
1197
|
# point is the contributor with the most occurrences in that period.
|
@@ -1295,10 +1312,10 @@ module Aws::CloudWatch
|
|
1295
1312
|
# If you omit `Unit` in your request, all data that was collected with
|
1296
1313
|
# any unit is returned, along with the corresponding units that were
|
1297
1314
|
# specified when the data was reported to CloudWatch. If you specify a
|
1298
|
-
# unit, the operation returns only data
|
1299
|
-
#
|
1300
|
-
#
|
1301
|
-
#
|
1315
|
+
# unit, the operation returns only data that was collected with that
|
1316
|
+
# unit specified. If you specify a unit that does not match the data
|
1317
|
+
# collected, the results of the operation are null. CloudWatch does not
|
1318
|
+
# perform unit conversions.
|
1302
1319
|
#
|
1303
1320
|
#
|
1304
1321
|
#
|
@@ -1604,10 +1621,10 @@ module Aws::CloudWatch
|
|
1604
1621
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
1605
1622
|
# collected with any unit is returned, along with the corresponding
|
1606
1623
|
# units that were specified when the data was reported to CloudWatch. If
|
1607
|
-
# you specify a unit, the operation returns only data
|
1608
|
-
#
|
1609
|
-
#
|
1610
|
-
#
|
1624
|
+
# you specify a unit, the operation returns only data that was collected
|
1625
|
+
# with that unit specified. If you specify a unit that does not match
|
1626
|
+
# the data collected, the results of the operation are null. CloudWatch
|
1627
|
+
# does not perform unit conversions.
|
1611
1628
|
#
|
1612
1629
|
# @return [Types::GetMetricStatisticsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1613
1630
|
#
|
@@ -1806,9 +1823,13 @@ module Aws::CloudWatch
|
|
1806
1823
|
# Up to 500 results are returned for any one call. To retrieve
|
1807
1824
|
# additional results, use the returned token with subsequent calls.
|
1808
1825
|
#
|
1809
|
-
# After you create a metric, allow up to
|
1810
|
-
#
|
1811
|
-
#
|
1826
|
+
# After you create a metric, allow up to 15 minutes before the metric
|
1827
|
+
# appears. You can see statistics about the metric sooner by using
|
1828
|
+
# [GetMetricData][1] or [GetMetricStatistics][2].
|
1829
|
+
#
|
1830
|
+
# `ListMetrics` doesn't return information about metrics if those
|
1831
|
+
# metrics haven't reported data in the past two weeks. To retrieve
|
1832
|
+
# those metrics, use [GetMetricData][1] or [GetMetricStatistics][2].
|
1812
1833
|
#
|
1813
1834
|
#
|
1814
1835
|
#
|
@@ -1828,6 +1849,16 @@ module Aws::CloudWatch
|
|
1828
1849
|
# The token returned by a previous call to indicate that there is more
|
1829
1850
|
# data available.
|
1830
1851
|
#
|
1852
|
+
# @option params [String] :recently_active
|
1853
|
+
# To filter the results to show only metrics that have had data points
|
1854
|
+
# published in the past three hours, specify this parameter with a value
|
1855
|
+
# of `PT3H`. This is the only valid value for this parameter.
|
1856
|
+
#
|
1857
|
+
# The results that are returned are an approximation of the value you
|
1858
|
+
# specify. There is a low probability that the returned results include
|
1859
|
+
# metrics with last published data as much as 40 minutes more than the
|
1860
|
+
# specified time interval.
|
1861
|
+
#
|
1831
1862
|
# @return [Types::ListMetricsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1832
1863
|
#
|
1833
1864
|
# * {Types::ListMetricsOutput#metrics #metrics} => Array<Types::Metric>
|
@@ -1847,6 +1878,7 @@ module Aws::CloudWatch
|
|
1847
1878
|
# },
|
1848
1879
|
# ],
|
1849
1880
|
# next_token: "NextToken",
|
1881
|
+
# recently_active: "PT3H", # accepts PT3H
|
1850
1882
|
# })
|
1851
1883
|
#
|
1852
1884
|
# @example Response structure
|
@@ -1880,7 +1912,7 @@ module Aws::CloudWatch
|
|
1880
1912
|
# The ARN format of a Contributor Insights rule is
|
1881
1913
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
1882
1914
|
#
|
1883
|
-
# For more information
|
1915
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
1884
1916
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
1885
1917
|
#
|
1886
1918
|
#
|
@@ -2039,8 +2071,8 @@ module Aws::CloudWatch
|
|
2039
2071
|
# The description for the composite alarm.
|
2040
2072
|
#
|
2041
2073
|
# @option params [required, String] :alarm_name
|
2042
|
-
# The name for the composite alarm. This name must be unique within
|
2043
|
-
#
|
2074
|
+
# The name for the composite alarm. This name must be unique within the
|
2075
|
+
# Region.
|
2044
2076
|
#
|
2045
2077
|
# @option params [required, String] :alarm_rule
|
2046
2078
|
# An expression that specifies which other alarms are to be evaluated to
|
@@ -2223,8 +2255,8 @@ module Aws::CloudWatch
|
|
2223
2255
|
# Contributor Insights to Analyze High-Cardinality Data][1].
|
2224
2256
|
#
|
2225
2257
|
# If you create a rule, delete it, and then re-create it with the same
|
2226
|
-
# name, historical data from the first time the rule was created
|
2227
|
-
#
|
2258
|
+
# name, historical data from the first time the rule was created might
|
2259
|
+
# not be available.
|
2228
2260
|
#
|
2229
2261
|
#
|
2230
2262
|
#
|
@@ -2343,8 +2375,7 @@ module Aws::CloudWatch
|
|
2343
2375
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
|
2344
2376
|
#
|
2345
2377
|
# @option params [required, String] :alarm_name
|
2346
|
-
# The name for the alarm. This name must be unique within
|
2347
|
-
# account.
|
2378
|
+
# The name for the alarm. This name must be unique within the Region.
|
2348
2379
|
#
|
2349
2380
|
# @option params [String] :alarm_description
|
2350
2381
|
# The description for the alarm.
|
@@ -2456,8 +2487,8 @@ module Aws::CloudWatch
|
|
2456
2487
|
# resolution, the alarm still attempts to gather data at the period rate
|
2457
2488
|
# that you specify. In this case, it does not receive data for the
|
2458
2489
|
# attempts that do not correspond to a one-minute data resolution, and
|
2459
|
-
# the alarm
|
2460
|
-
# or 30 also sets this alarm as a high-resolution alarm, which has a
|
2490
|
+
# the alarm might often lapse into INSUFFICENT\_DATA status. Specifying
|
2491
|
+
# 10 or 30 also sets this alarm as a high-resolution alarm, which has a
|
2461
2492
|
# higher charge than other alarms. For more information about pricing,
|
2462
2493
|
# see [Amazon CloudWatch Pricing][1].
|
2463
2494
|
#
|
@@ -2479,12 +2510,12 @@ module Aws::CloudWatch
|
|
2479
2510
|
#
|
2480
2511
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types that
|
2481
2512
|
# have been published for the metric and attempts to evaluate the alarm.
|
2482
|
-
# Usually metrics are published with only one unit, so the alarm
|
2483
|
-
#
|
2513
|
+
# Usually, metrics are published with only one unit, so the alarm works
|
2514
|
+
# as intended.
|
2484
2515
|
#
|
2485
2516
|
# However, if the metric is published with multiple types of units and
|
2486
|
-
# you don't specify a unit, the alarm's behavior is not defined and
|
2487
|
-
#
|
2517
|
+
# you don't specify a unit, the alarm's behavior is not defined and it
|
2518
|
+
# behaves predictably.
|
2488
2519
|
#
|
2489
2520
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
2490
2521
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -2582,7 +2613,7 @@ module Aws::CloudWatch
|
|
2582
2613
|
# associate as many as 50 tags with an alarm.
|
2583
2614
|
#
|
2584
2615
|
# Tags can help you organize and categorize your resources. You can also
|
2585
|
-
# use them to scope user permissions
|
2616
|
+
# use them to scope user permissions by granting a user permission to
|
2586
2617
|
# access or change only resources with certain tag values.
|
2587
2618
|
#
|
2588
2619
|
# @option params [String] :threshold_metric_id
|
@@ -2781,9 +2812,9 @@ module Aws::CloudWatch
|
|
2781
2812
|
# CloudWatch console or through [DescribeAlarmHistory][1].
|
2782
2813
|
#
|
2783
2814
|
# If you use `SetAlarmState` on a composite alarm, the composite alarm
|
2784
|
-
# is not guaranteed to return to its actual state. It
|
2815
|
+
# is not guaranteed to return to its actual state. It returns to its
|
2785
2816
|
# actual state only once any of its children alarms change state. It is
|
2786
|
-
# also
|
2817
|
+
# also reevaluated if you update its configuration.
|
2787
2818
|
#
|
2788
2819
|
# If an alarm triggers EC2 Auto Scaling policies or application Auto
|
2789
2820
|
# Scaling policies, you must include information in the
|
@@ -2795,8 +2826,7 @@ module Aws::CloudWatch
|
|
2795
2826
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html
|
2796
2827
|
#
|
2797
2828
|
# @option params [required, String] :alarm_name
|
2798
|
-
# The name
|
2799
|
-
# account. The maximum length is 255 characters.
|
2829
|
+
# The name of the alarm.
|
2800
2830
|
#
|
2801
2831
|
# @option params [required, String] :state_value
|
2802
2832
|
# The value of the state.
|
@@ -2839,7 +2869,7 @@ module Aws::CloudWatch
|
|
2839
2869
|
# are alarms and Contributor Insights rules.
|
2840
2870
|
#
|
2841
2871
|
# Tags can help you organize and categorize your resources. You can also
|
2842
|
-
# use them to scope user permissions
|
2872
|
+
# use them to scope user permissions by granting a user permission to
|
2843
2873
|
# access or change only resources with certain tag values.
|
2844
2874
|
#
|
2845
2875
|
# Tags don't have any semantic meaning to AWS and are interpreted
|
@@ -2862,7 +2892,7 @@ module Aws::CloudWatch
|
|
2862
2892
|
# The ARN format of a Contributor Insights rule is
|
2863
2893
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2864
2894
|
#
|
2865
|
-
# For more information
|
2895
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2866
2896
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2867
2897
|
#
|
2868
2898
|
#
|
@@ -2906,7 +2936,7 @@ module Aws::CloudWatch
|
|
2906
2936
|
# The ARN format of a Contributor Insights rule is
|
2907
2937
|
# `arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name `
|
2908
2938
|
#
|
2909
|
-
# For more information
|
2939
|
+
# For more information about ARN format, see [ Resource Types Defined by
|
2910
2940
|
# Amazon CloudWatch][1] in the *Amazon Web Services General Reference*.
|
2911
2941
|
#
|
2912
2942
|
#
|
@@ -2947,7 +2977,7 @@ module Aws::CloudWatch
|
|
2947
2977
|
params: params,
|
2948
2978
|
config: config)
|
2949
2979
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
2950
|
-
context[:gem_version] = '1.
|
2980
|
+
context[:gem_version] = '1.44.0'
|
2951
2981
|
Seahorse::Client::Request.new(handlers, context)
|
2952
2982
|
end
|
2953
2983
|
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -189,6 +191,7 @@ module Aws::CloudWatch
|
|
189
191
|
PutMetricAlarmInput = Shapes::StructureShape.new(name: 'PutMetricAlarmInput')
|
190
192
|
PutMetricDataInput = Shapes::StructureShape.new(name: 'PutMetricDataInput')
|
191
193
|
Range = Shapes::StructureShape.new(name: 'Range')
|
194
|
+
RecentlyActive = Shapes::StringShape.new(name: 'RecentlyActive')
|
192
195
|
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
193
196
|
ResourceList = Shapes::ListShape.new(name: 'ResourceList')
|
194
197
|
ResourceName = Shapes::StringShape.new(name: 'ResourceName')
|
@@ -565,6 +568,7 @@ module Aws::CloudWatch
|
|
565
568
|
ListMetricsInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
|
566
569
|
ListMetricsInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionFilters, location_name: "Dimensions"))
|
567
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"))
|
568
572
|
ListMetricsInput.struct_class = Types::ListMetricsInput
|
569
573
|
|
570
574
|
ListMetricsOutput.add_member(:metrics, Shapes::ShapeRef.new(shape: Metrics, location_name: "Metrics"))
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -288,10 +290,10 @@ module Aws::CloudWatch
|
|
288
290
|
# The unit for a given metric. If you omit `Unit`, all data that was
|
289
291
|
# collected with any unit is returned, along with the corresponding
|
290
292
|
# units that were specified when the data was reported to CloudWatch. If
|
291
|
-
# you specify a unit, the operation returns only data
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
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.
|
295
297
|
# @return [Types::GetMetricStatisticsOutput]
|
296
298
|
def get_statistics(options = {})
|
297
299
|
options = options.merge(
|
@@ -361,8 +363,7 @@ module Aws::CloudWatch
|
|
361
363
|
# })
|
362
364
|
# @param [Hash] options ({})
|
363
365
|
# @option options [required, String] :alarm_name
|
364
|
-
# The name for the alarm. This name must be unique within
|
365
|
-
# account.
|
366
|
+
# The name for the alarm. This name must be unique within the Region.
|
366
367
|
# @option options [String] :alarm_description
|
367
368
|
# The description for the alarm.
|
368
369
|
# @option options [Boolean] :actions_enabled
|
@@ -452,8 +453,8 @@ module Aws::CloudWatch
|
|
452
453
|
# resolution, the alarm still attempts to gather data at the period rate
|
453
454
|
# that you specify. In this case, it does not receive data for the
|
454
455
|
# attempts that do not correspond to a one-minute data resolution, and
|
455
|
-
# the alarm
|
456
|
-
# 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
|
457
458
|
# higher charge than other alarms. For more information about pricing,
|
458
459
|
# see [Amazon CloudWatch Pricing][1].
|
459
460
|
#
|
@@ -474,12 +475,12 @@ module Aws::CloudWatch
|
|
474
475
|
#
|
475
476
|
# If you don't specify `Unit`, CloudWatch retrieves all unit types that
|
476
477
|
# have been published for the metric and attempts to evaluate the alarm.
|
477
|
-
# Usually metrics are published with only one unit, so the alarm
|
478
|
-
#
|
478
|
+
# Usually, metrics are published with only one unit, so the alarm works
|
479
|
+
# as intended.
|
479
480
|
#
|
480
481
|
# However, if the metric is published with multiple types of units and
|
481
|
-
# you don't specify a unit, the alarm's behavior is not defined and
|
482
|
-
#
|
482
|
+
# you don't specify a unit, the alarm's behavior is not defined and it
|
483
|
+
# behaves predictably.
|
483
484
|
#
|
484
485
|
# We recommend omitting `Unit` so that you don't inadvertently specify
|
485
486
|
# an incorrect unit that is not published for this metric. Doing so
|
@@ -569,7 +570,7 @@ module Aws::CloudWatch
|
|
569
570
|
# associate as many as 50 tags with an alarm.
|
570
571
|
#
|
571
572
|
# Tags can help you organize and categorize your resources. You can also
|
572
|
-
# use them to scope user permissions
|
573
|
+
# use them to scope user permissions by granting a user permission to
|
573
574
|
# access or change only resources with certain tag values.
|
574
575
|
# @option options [String] :threshold_metric_id
|
575
576
|
# If this is an alarm based on an anomaly detection model, make this
|