aws-sdk-cloudwatch 1.12.0 → 1.13.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/alarm.rb +6 -0
- data/lib/aws-sdk-cloudwatch/client.rb +131 -39
- data/lib/aws-sdk-cloudwatch/client_api.rb +5 -3
- data/lib/aws-sdk-cloudwatch/metric.rb +51 -15
- data/lib/aws-sdk-cloudwatch/types.rb +130 -49
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5b4039d21497b3f62dd18d7b8b017ca4e28d687d
|
4
|
+
data.tar.gz: 7492d20e1a11e4b77f9518452c525dd6db723230
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bffe0c4e282c66bc0ec10fb93ba7f3c564688d420662eb90b2451ad8a0d18042da912a7322566d043405a168979e11b160c62749ce63a8fb0933bf179ee41540
|
7
|
+
data.tar.gz: dbbdbb2ee3577d728c8d5131e479b7b7fa14d8ec0ceea2e399e02f406439014ba72e81006abf2a93a18181ea60759f8b1d9979329acb7403c41aa9ccce36a705
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
@@ -15,6 +15,8 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
|
15
15
|
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
16
|
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
17
|
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
18
20
|
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
21
|
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
22
|
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
@@ -45,6 +47,8 @@ module Aws::CloudWatch
|
|
45
47
|
add_plugin(Aws::Plugins::RetryErrors)
|
46
48
|
add_plugin(Aws::Plugins::GlobalConfiguration)
|
47
49
|
add_plugin(Aws::Plugins::RegionalEndpoint)
|
50
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
51
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
48
52
|
add_plugin(Aws::Plugins::ResponsePaging)
|
49
53
|
add_plugin(Aws::Plugins::StubResponses)
|
50
54
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
@@ -98,6 +102,10 @@ module Aws::CloudWatch
|
|
98
102
|
#
|
99
103
|
# @option options [String] :access_key_id
|
100
104
|
#
|
105
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
106
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
107
|
+
# the background every 60 secs (default). Defaults to `false`.
|
108
|
+
#
|
101
109
|
# @option options [Boolean] :client_side_monitoring (false)
|
102
110
|
# When `true`, client-side metrics will be collected for all API requests from
|
103
111
|
# this client.
|
@@ -118,11 +126,30 @@ module Aws::CloudWatch
|
|
118
126
|
# When `true`, an attempt is made to coerce request parameters into
|
119
127
|
# the required types.
|
120
128
|
#
|
129
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
130
|
+
# Set to true to disable SDK automatically adding host prefix
|
131
|
+
# to default service endpoint when available.
|
132
|
+
#
|
121
133
|
# @option options [String] :endpoint
|
122
134
|
# The client endpoint is normally constructed from the `:region`
|
123
135
|
# option. You should only configure an `:endpoint` when connecting
|
124
136
|
# to test endpoints. This should be avalid HTTP(S) URI.
|
125
137
|
#
|
138
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
139
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
140
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
141
|
+
#
|
142
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
143
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
146
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
147
|
+
# Use this option to config the time interval in seconds for making
|
148
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
151
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
152
|
+
#
|
126
153
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
127
154
|
# The log formatter.
|
128
155
|
#
|
@@ -359,6 +386,19 @@ module Aws::CloudWatch
|
|
359
386
|
# resp.metric_alarms[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
|
360
387
|
# resp.metric_alarms[0].treat_missing_data #=> String
|
361
388
|
# resp.metric_alarms[0].evaluate_low_sample_count_percentile #=> String
|
389
|
+
# resp.metric_alarms[0].metrics #=> Array
|
390
|
+
# resp.metric_alarms[0].metrics[0].id #=> String
|
391
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.namespace #=> String
|
392
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.metric_name #=> String
|
393
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions #=> Array
|
394
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions[0].name #=> String
|
395
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions[0].value #=> String
|
396
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.period #=> Integer
|
397
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.stat #=> String
|
398
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
|
399
|
+
# resp.metric_alarms[0].metrics[0].expression #=> String
|
400
|
+
# resp.metric_alarms[0].metrics[0].label #=> String
|
401
|
+
# resp.metric_alarms[0].metrics[0].return_data #=> Boolean
|
362
402
|
# resp.next_token #=> String
|
363
403
|
#
|
364
404
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms AWS API Documentation
|
@@ -452,6 +492,19 @@ module Aws::CloudWatch
|
|
452
492
|
# resp.metric_alarms[0].comparison_operator #=> String, one of "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold"
|
453
493
|
# resp.metric_alarms[0].treat_missing_data #=> String
|
454
494
|
# resp.metric_alarms[0].evaluate_low_sample_count_percentile #=> String
|
495
|
+
# resp.metric_alarms[0].metrics #=> Array
|
496
|
+
# resp.metric_alarms[0].metrics[0].id #=> String
|
497
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.namespace #=> String
|
498
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.metric_name #=> String
|
499
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions #=> Array
|
500
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions[0].name #=> String
|
501
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.metric.dimensions[0].value #=> String
|
502
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.period #=> Integer
|
503
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.stat #=> String
|
504
|
+
# resp.metric_alarms[0].metrics[0].metric_stat.unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
|
505
|
+
# resp.metric_alarms[0].metrics[0].expression #=> String
|
506
|
+
# resp.metric_alarms[0].metrics[0].label #=> String
|
507
|
+
# resp.metric_alarms[0].metrics[0].return_data #=> Boolean
|
455
508
|
#
|
456
509
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric AWS API Documentation
|
457
510
|
#
|
@@ -1163,20 +1216,19 @@ module Aws::CloudWatch
|
|
1163
1216
|
end
|
1164
1217
|
|
1165
1218
|
# Creates or updates an alarm and associates it with the specified
|
1166
|
-
# metric
|
1167
|
-
# SNS resources with the alarm.
|
1219
|
+
# metric or metric math expression.
|
1168
1220
|
#
|
1169
1221
|
# When this operation creates an alarm, the alarm state is immediately
|
1170
|
-
# set to `INSUFFICIENT_DATA`. The alarm is evaluated and its state
|
1171
|
-
# set appropriately. Any actions associated with the state are
|
1172
|
-
# executed.
|
1222
|
+
# set to `INSUFFICIENT_DATA`. The alarm is then evaluated and its state
|
1223
|
+
# is set appropriately. Any actions associated with the new state are
|
1224
|
+
# then executed.
|
1173
1225
|
#
|
1174
1226
|
# When you update an existing alarm, its state is left unchanged, but
|
1175
1227
|
# the update completely overwrites the previous configuration of the
|
1176
1228
|
# alarm.
|
1177
1229
|
#
|
1178
1230
|
# If you are an IAM user, you must have Amazon EC2 permissions for some
|
1179
|
-
# operations:
|
1231
|
+
# alarm operations:
|
1180
1232
|
#
|
1181
1233
|
# * `iam:CreateServiceLinkedRole` for all alarms with EC2 actions
|
1182
1234
|
#
|
@@ -1207,15 +1259,15 @@ module Aws::CloudWatch
|
|
1207
1259
|
# The first time you create an alarm in the AWS Management Console, the
|
1208
1260
|
# CLI, or by using the PutMetricAlarm API, CloudWatch creates the
|
1209
1261
|
# necessary service-linked role for you. The service-linked role is
|
1210
|
-
# called `AWSServiceRoleForCloudWatchEvents`. For more information
|
1211
|
-
#
|
1262
|
+
# called `AWSServiceRoleForCloudWatchEvents`. For more information, see
|
1263
|
+
# [AWS service-linked role][1].
|
1212
1264
|
#
|
1213
1265
|
#
|
1214
1266
|
#
|
1215
1267
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role
|
1216
1268
|
#
|
1217
1269
|
# @option params [required, String] :alarm_name
|
1218
|
-
# The name for the alarm. This name must be unique within
|
1270
|
+
# The name for the alarm. This name must be unique within your AWS
|
1219
1271
|
# account.
|
1220
1272
|
#
|
1221
1273
|
# @option params [String] :alarm_description
|
@@ -1223,7 +1275,7 @@ module Aws::CloudWatch
|
|
1223
1275
|
#
|
1224
1276
|
# @option params [Boolean] :actions_enabled
|
1225
1277
|
# Indicates whether actions should be executed during any changes to the
|
1226
|
-
# alarm state.
|
1278
|
+
# alarm state. The default is TRUE.
|
1227
1279
|
#
|
1228
1280
|
# @option params [Array<String>] :ok_actions
|
1229
1281
|
# The actions to execute when this alarm transitions to an `OK` state
|
@@ -1233,6 +1285,7 @@ module Aws::CloudWatch
|
|
1233
1285
|
# Valid Values: `arn:aws:automate:region:ec2:stop` \|
|
1234
1286
|
# `arn:aws:automate:region:ec2:terminate` \|
|
1235
1287
|
# `arn:aws:automate:region:ec2:recover` \|
|
1288
|
+
# `arn:aws:automate:region:ec2:reboot` \|
|
1236
1289
|
# `arn:aws:sns:region:account-id:sns-topic-name ` \|
|
1237
1290
|
# `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
1238
1291
|
# `
|
@@ -1282,30 +1335,36 @@ module Aws::CloudWatch
|
|
1282
1335
|
# \|
|
1283
1336
|
# `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
1284
1337
|
#
|
1285
|
-
# @option params [
|
1338
|
+
# @option params [String] :metric_name
|
1286
1339
|
# The name for the metric associated with the alarm.
|
1287
1340
|
#
|
1288
|
-
#
|
1289
|
-
#
|
1341
|
+
# If you are creating an alarm based on a math expression, you cannot
|
1342
|
+
# specify this parameter, or any of the `Dimensions`, `Period`,
|
1343
|
+
# `Namespace`, `Statistic`, or `ExtendedStatistic` parameters. Instead,
|
1344
|
+
# you specify all this information in the `Metrics` array.
|
1345
|
+
#
|
1346
|
+
# @option params [String] :namespace
|
1347
|
+
# The namespace for the metric associated specified in `MetricName`.
|
1290
1348
|
#
|
1291
1349
|
# @option params [String] :statistic
|
1292
|
-
# The statistic for the metric
|
1350
|
+
# The statistic for the metric specified in `MetricName`, other than
|
1293
1351
|
# percentile. For percentile statistics, use `ExtendedStatistic`. When
|
1294
|
-
# you call `PutMetricAlarm`, you must specify
|
1295
|
-
# `ExtendedStatistic,` but not both.
|
1352
|
+
# you call `PutMetricAlarm` and specify a `MetricName`, you must specify
|
1353
|
+
# either `Statistic` or `ExtendedStatistic,` but not both.
|
1296
1354
|
#
|
1297
1355
|
# @option params [String] :extended_statistic
|
1298
|
-
# The percentile statistic for the metric
|
1299
|
-
# Specify a value between p0.0 and p100. When you call `PutMetricAlarm
|
1300
|
-
# you must specify either `Statistic` or
|
1301
|
-
# both.
|
1356
|
+
# The percentile statistic for the metric specified in `MetricName`.
|
1357
|
+
# Specify a value between p0.0 and p100. When you call `PutMetricAlarm`
|
1358
|
+
# and specify a `MetricName`, you must specify either `Statistic` or
|
1359
|
+
# `ExtendedStatistic,` but not both.
|
1302
1360
|
#
|
1303
1361
|
# @option params [Array<Types::Dimension>] :dimensions
|
1304
|
-
# The dimensions for the metric
|
1362
|
+
# The dimensions for the metric specified in `MetricName`.
|
1305
1363
|
#
|
1306
|
-
# @option params [
|
1307
|
-
# The
|
1308
|
-
# Valid values are 10, 30, and any multiple
|
1364
|
+
# @option params [Integer] :period
|
1365
|
+
# The length, in seconds, used each time the metric specified in
|
1366
|
+
# `MetricName` is evaluated. Valid values are 10, 30, and any multiple
|
1367
|
+
# of 60.
|
1309
1368
|
#
|
1310
1369
|
# Be sure to specify 10 or 30 only for metrics that are stored by a
|
1311
1370
|
# `PutMetricData` call with a `StorageResolution` of 1. If you specify a
|
@@ -1340,7 +1399,7 @@ module Aws::CloudWatch
|
|
1340
1399
|
#
|
1341
1400
|
# @option params [required, Integer] :evaluation_periods
|
1342
1401
|
# The number of periods over which data is compared to the specified
|
1343
|
-
# threshold. If you are setting an alarm
|
1402
|
+
# threshold. If you are setting an alarm that requires that a number of
|
1344
1403
|
# consecutive data points be breaching to trigger the alarm, this value
|
1345
1404
|
# specifies that number. If you are setting an "M out of N" alarm,
|
1346
1405
|
# this value is the N.
|
@@ -1394,6 +1453,18 @@ module Aws::CloudWatch
|
|
1394
1453
|
#
|
1395
1454
|
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
|
1396
1455
|
#
|
1456
|
+
# @option params [Array<Types::MetricDataQuery>] :metrics
|
1457
|
+
# An array of `MetricDataQuery` structures that enable you to create an
|
1458
|
+
# alarm based on the result of a metric math expression. Each item in
|
1459
|
+
# the `Metrics` array either retrieves a metric or performs a math
|
1460
|
+
# expression.
|
1461
|
+
#
|
1462
|
+
# If you use the `Metrics` parameter, you cannot include the
|
1463
|
+
# `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or
|
1464
|
+
# `ExtendedStatistic` parameters of `PutMetricAlarm` in the same
|
1465
|
+
# operation. Instead, you retrieve the metrics you are using in your
|
1466
|
+
# math expression as part of the `Metrics` array.
|
1467
|
+
#
|
1397
1468
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1398
1469
|
#
|
1399
1470
|
# @example Request syntax with placeholder values
|
@@ -1405,8 +1476,8 @@ module Aws::CloudWatch
|
|
1405
1476
|
# ok_actions: ["ResourceName"],
|
1406
1477
|
# alarm_actions: ["ResourceName"],
|
1407
1478
|
# insufficient_data_actions: ["ResourceName"],
|
1408
|
-
# metric_name: "MetricName",
|
1409
|
-
# namespace: "Namespace",
|
1479
|
+
# metric_name: "MetricName",
|
1480
|
+
# namespace: "Namespace",
|
1410
1481
|
# statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
|
1411
1482
|
# extended_statistic: "ExtendedStatistic",
|
1412
1483
|
# dimensions: [
|
@@ -1415,7 +1486,7 @@ module Aws::CloudWatch
|
|
1415
1486
|
# value: "DimensionValue", # required
|
1416
1487
|
# },
|
1417
1488
|
# ],
|
1418
|
-
# period: 1,
|
1489
|
+
# period: 1,
|
1419
1490
|
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1420
1491
|
# evaluation_periods: 1, # required
|
1421
1492
|
# datapoints_to_alarm: 1,
|
@@ -1423,6 +1494,29 @@ module Aws::CloudWatch
|
|
1423
1494
|
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
1424
1495
|
# treat_missing_data: "TreatMissingData",
|
1425
1496
|
# evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
|
1497
|
+
# metrics: [
|
1498
|
+
# {
|
1499
|
+
# id: "MetricId", # required
|
1500
|
+
# metric_stat: {
|
1501
|
+
# metric: { # required
|
1502
|
+
# namespace: "Namespace",
|
1503
|
+
# metric_name: "MetricName",
|
1504
|
+
# dimensions: [
|
1505
|
+
# {
|
1506
|
+
# name: "DimensionName", # required
|
1507
|
+
# value: "DimensionValue", # required
|
1508
|
+
# },
|
1509
|
+
# ],
|
1510
|
+
# },
|
1511
|
+
# period: 1, # required
|
1512
|
+
# stat: "Stat", # required
|
1513
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1514
|
+
# },
|
1515
|
+
# expression: "MetricExpression",
|
1516
|
+
# label: "MetricLabel",
|
1517
|
+
# return_data: false,
|
1518
|
+
# },
|
1519
|
+
# ],
|
1426
1520
|
# })
|
1427
1521
|
#
|
1428
1522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm AWS API Documentation
|
@@ -1434,11 +1528,11 @@ module Aws::CloudWatch
|
|
1434
1528
|
req.send_request(options)
|
1435
1529
|
end
|
1436
1530
|
|
1437
|
-
# Publishes metric data to Amazon CloudWatch. CloudWatch
|
1438
|
-
# data with the specified metric. If the specified
|
1439
|
-
# exist, CloudWatch creates the metric. When CloudWatch
|
1440
|
-
# metric, it can take up to fifteen minutes for the metric to
|
1441
|
-
# calls to ListMetrics.
|
1531
|
+
# Publishes metric data points to Amazon CloudWatch. CloudWatch
|
1532
|
+
# associates the data points with the specified metric. If the specified
|
1533
|
+
# metric does not exist, CloudWatch creates the metric. When CloudWatch
|
1534
|
+
# creates a metric, it can take up to fifteen minutes for the metric to
|
1535
|
+
# appear in calls to ListMetrics.
|
1442
1536
|
#
|
1443
1537
|
# You can publish either individual data points in the `Value` field, or
|
1444
1538
|
# arrays of values and the number of times each value occurred during
|
@@ -1468,11 +1562,9 @@ module Aws::CloudWatch
|
|
1468
1562
|
# GetMetricStatistics from the time they are submitted.
|
1469
1563
|
#
|
1470
1564
|
# CloudWatch needs raw data points to calculate percentile statistics.
|
1471
|
-
#
|
1472
|
-
#
|
1473
|
-
#
|
1474
|
-
# percentile statistics for this data if one of the following conditions
|
1475
|
-
# is true:
|
1565
|
+
# If you publish data using a statistic set instead, you can only
|
1566
|
+
# retrieve percentile statistics for this data if one of the following
|
1567
|
+
# conditions is true:
|
1476
1568
|
#
|
1477
1569
|
# * The `SampleCount` value of the statistic set is 1 and `Min`, `Max`,
|
1478
1570
|
# and `Sum` are all equal.
|
@@ -1593,7 +1685,7 @@ module Aws::CloudWatch
|
|
1593
1685
|
params: params,
|
1594
1686
|
config: config)
|
1595
1687
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
1596
|
-
context[:gem_version] = '1.
|
1688
|
+
context[:gem_version] = '1.13.0'
|
1597
1689
|
Seahorse::Client::Request.new(handlers, context)
|
1598
1690
|
end
|
1599
1691
|
|
@@ -347,6 +347,7 @@ module Aws::CloudWatch
|
|
347
347
|
MetricAlarm.add_member(:comparison_operator, Shapes::ShapeRef.new(shape: ComparisonOperator, location_name: "ComparisonOperator"))
|
348
348
|
MetricAlarm.add_member(:treat_missing_data, Shapes::ShapeRef.new(shape: TreatMissingData, location_name: "TreatMissingData"))
|
349
349
|
MetricAlarm.add_member(:evaluate_low_sample_count_percentile, Shapes::ShapeRef.new(shape: EvaluateLowSampleCountPercentile, location_name: "EvaluateLowSampleCountPercentile"))
|
350
|
+
MetricAlarm.add_member(:metrics, Shapes::ShapeRef.new(shape: MetricDataQueries, location_name: "Metrics"))
|
350
351
|
MetricAlarm.struct_class = Types::MetricAlarm
|
351
352
|
|
352
353
|
MetricAlarms.member = Shapes::ShapeRef.new(shape: MetricAlarm)
|
@@ -406,12 +407,12 @@ module Aws::CloudWatch
|
|
406
407
|
PutMetricAlarmInput.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions"))
|
407
408
|
PutMetricAlarmInput.add_member(:alarm_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "AlarmActions"))
|
408
409
|
PutMetricAlarmInput.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions"))
|
409
|
-
PutMetricAlarmInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName,
|
410
|
-
PutMetricAlarmInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace,
|
410
|
+
PutMetricAlarmInput.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, location_name: "MetricName"))
|
411
|
+
PutMetricAlarmInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, location_name: "Namespace"))
|
411
412
|
PutMetricAlarmInput.add_member(:statistic, Shapes::ShapeRef.new(shape: Statistic, location_name: "Statistic"))
|
412
413
|
PutMetricAlarmInput.add_member(:extended_statistic, Shapes::ShapeRef.new(shape: ExtendedStatistic, location_name: "ExtendedStatistic"))
|
413
414
|
PutMetricAlarmInput.add_member(:dimensions, Shapes::ShapeRef.new(shape: Dimensions, location_name: "Dimensions"))
|
414
|
-
PutMetricAlarmInput.add_member(:period, Shapes::ShapeRef.new(shape: Period,
|
415
|
+
PutMetricAlarmInput.add_member(:period, Shapes::ShapeRef.new(shape: Period, location_name: "Period"))
|
415
416
|
PutMetricAlarmInput.add_member(:unit, Shapes::ShapeRef.new(shape: StandardUnit, location_name: "Unit"))
|
416
417
|
PutMetricAlarmInput.add_member(:evaluation_periods, Shapes::ShapeRef.new(shape: EvaluationPeriods, required: true, location_name: "EvaluationPeriods"))
|
417
418
|
PutMetricAlarmInput.add_member(:datapoints_to_alarm, Shapes::ShapeRef.new(shape: DatapointsToAlarm, location_name: "DatapointsToAlarm"))
|
@@ -419,6 +420,7 @@ module Aws::CloudWatch
|
|
419
420
|
PutMetricAlarmInput.add_member(:comparison_operator, Shapes::ShapeRef.new(shape: ComparisonOperator, required: true, location_name: "ComparisonOperator"))
|
420
421
|
PutMetricAlarmInput.add_member(:treat_missing_data, Shapes::ShapeRef.new(shape: TreatMissingData, location_name: "TreatMissingData"))
|
421
422
|
PutMetricAlarmInput.add_member(:evaluate_low_sample_count_percentile, Shapes::ShapeRef.new(shape: EvaluateLowSampleCountPercentile, location_name: "EvaluateLowSampleCountPercentile"))
|
423
|
+
PutMetricAlarmInput.add_member(:metrics, Shapes::ShapeRef.new(shape: MetricDataQueries, location_name: "Metrics"))
|
422
424
|
PutMetricAlarmInput.struct_class = Types::PutMetricAlarmInput
|
423
425
|
|
424
426
|
PutMetricDataInput.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location_name: "Namespace"))
|
@@ -312,7 +312,7 @@ module Aws::CloudWatch
|
|
312
312
|
# value: "DimensionValue", # required
|
313
313
|
# },
|
314
314
|
# ],
|
315
|
-
# period: 1,
|
315
|
+
# period: 1,
|
316
316
|
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
317
317
|
# evaluation_periods: 1, # required
|
318
318
|
# datapoints_to_alarm: 1,
|
@@ -320,16 +320,39 @@ module Aws::CloudWatch
|
|
320
320
|
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
321
321
|
# treat_missing_data: "TreatMissingData",
|
322
322
|
# evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
|
323
|
+
# metrics: [
|
324
|
+
# {
|
325
|
+
# id: "MetricId", # required
|
326
|
+
# metric_stat: {
|
327
|
+
# metric: { # required
|
328
|
+
# namespace: "Namespace",
|
329
|
+
# metric_name: "MetricName",
|
330
|
+
# dimensions: [
|
331
|
+
# {
|
332
|
+
# name: "DimensionName", # required
|
333
|
+
# value: "DimensionValue", # required
|
334
|
+
# },
|
335
|
+
# ],
|
336
|
+
# },
|
337
|
+
# period: 1, # required
|
338
|
+
# stat: "Stat", # required
|
339
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
340
|
+
# },
|
341
|
+
# expression: "MetricExpression",
|
342
|
+
# label: "MetricLabel",
|
343
|
+
# return_data: false,
|
344
|
+
# },
|
345
|
+
# ],
|
323
346
|
# })
|
324
347
|
# @param [Hash] options ({})
|
325
348
|
# @option options [required, String] :alarm_name
|
326
|
-
# The name for the alarm. This name must be unique within
|
349
|
+
# The name for the alarm. This name must be unique within your AWS
|
327
350
|
# account.
|
328
351
|
# @option options [String] :alarm_description
|
329
352
|
# The description for the alarm.
|
330
353
|
# @option options [Boolean] :actions_enabled
|
331
354
|
# Indicates whether actions should be executed during any changes to the
|
332
|
-
# alarm state.
|
355
|
+
# alarm state. The default is TRUE.
|
333
356
|
# @option options [Array<String>] :ok_actions
|
334
357
|
# The actions to execute when this alarm transitions to an `OK` state
|
335
358
|
# from any other state. Each action is specified as an Amazon Resource
|
@@ -338,6 +361,7 @@ module Aws::CloudWatch
|
|
338
361
|
# Valid Values: `arn:aws:automate:region:ec2:stop` \|
|
339
362
|
# `arn:aws:automate:region:ec2:terminate` \|
|
340
363
|
# `arn:aws:automate:region:ec2:recover` \|
|
364
|
+
# `arn:aws:automate:region:ec2:reboot` \|
|
341
365
|
# `arn:aws:sns:region:account-id:sns-topic-name ` \|
|
342
366
|
# `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
343
367
|
# `
|
@@ -385,20 +409,21 @@ module Aws::CloudWatch
|
|
385
409
|
# \|
|
386
410
|
# `arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0`
|
387
411
|
# @option options [String] :statistic
|
388
|
-
# The statistic for the metric
|
412
|
+
# The statistic for the metric specified in `MetricName`, other than
|
389
413
|
# percentile. For percentile statistics, use `ExtendedStatistic`. When
|
390
|
-
# you call `PutMetricAlarm`, you must specify
|
391
|
-
# `ExtendedStatistic,` but not both.
|
414
|
+
# you call `PutMetricAlarm` and specify a `MetricName`, you must specify
|
415
|
+
# either `Statistic` or `ExtendedStatistic,` but not both.
|
392
416
|
# @option options [String] :extended_statistic
|
393
|
-
# The percentile statistic for the metric
|
394
|
-
# Specify a value between p0.0 and p100. When you call `PutMetricAlarm
|
395
|
-
# you must specify either `Statistic` or
|
396
|
-
# both.
|
417
|
+
# The percentile statistic for the metric specified in `MetricName`.
|
418
|
+
# Specify a value between p0.0 and p100. When you call `PutMetricAlarm`
|
419
|
+
# and specify a `MetricName`, you must specify either `Statistic` or
|
420
|
+
# `ExtendedStatistic,` but not both.
|
397
421
|
# @option options [Array<Types::Dimension>] :dimensions
|
398
|
-
# The dimensions for the metric
|
399
|
-
# @option options [
|
400
|
-
# The
|
401
|
-
# Valid values are 10, 30, and any multiple
|
422
|
+
# The dimensions for the metric specified in `MetricName`.
|
423
|
+
# @option options [Integer] :period
|
424
|
+
# The length, in seconds, used each time the metric specified in
|
425
|
+
# `MetricName` is evaluated. Valid values are 10, 30, and any multiple
|
426
|
+
# of 60.
|
402
427
|
#
|
403
428
|
# Be sure to specify 10 or 30 only for metrics that are stored by a
|
404
429
|
# `PutMetricData` call with a `StorageResolution` of 1. If you specify a
|
@@ -431,7 +456,7 @@ module Aws::CloudWatch
|
|
431
456
|
# `INSUFFICIENT DATA` state.
|
432
457
|
# @option options [required, Integer] :evaluation_periods
|
433
458
|
# The number of periods over which data is compared to the specified
|
434
|
-
# threshold. If you are setting an alarm
|
459
|
+
# threshold. If you are setting an alarm that requires that a number of
|
435
460
|
# consecutive data points be breaching to trigger the alarm, this value
|
436
461
|
# specifies that number. If you are setting an "M out of N" alarm,
|
437
462
|
# this value is the N.
|
@@ -479,6 +504,17 @@ module Aws::CloudWatch
|
|
479
504
|
#
|
480
505
|
#
|
481
506
|
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
|
507
|
+
# @option options [Array<Types::MetricDataQuery>] :metrics
|
508
|
+
# An array of `MetricDataQuery` structures that enable you to create an
|
509
|
+
# alarm based on the result of a metric math expression. Each item in
|
510
|
+
# the `Metrics` array either retrieves a metric or performs a math
|
511
|
+
# expression.
|
512
|
+
#
|
513
|
+
# If you use the `Metrics` parameter, you cannot include the
|
514
|
+
# `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or
|
515
|
+
# `ExtendedStatistic` parameters of `PutMetricAlarm` in the same
|
516
|
+
# operation. Instead, you retrieve the metrics you are using in your
|
517
|
+
# math expression as part of the `Metrics` array.
|
482
518
|
# @return [Alarm]
|
483
519
|
def put_alarm(options = {})
|
484
520
|
options = options.merge(
|
@@ -1008,7 +1008,7 @@ module Aws::CloudWatch
|
|
1008
1008
|
# @return [String]
|
1009
1009
|
#
|
1010
1010
|
# @!attribute [rw] metric_name
|
1011
|
-
# The name of the metric.
|
1011
|
+
# The name of the metric. This is a required field.
|
1012
1012
|
# @return [String]
|
1013
1013
|
#
|
1014
1014
|
# @!attribute [rw] dimensions
|
@@ -1144,6 +1144,9 @@ module Aws::CloudWatch
|
|
1144
1144
|
# matter how many data points are available.
|
1145
1145
|
# @return [String]
|
1146
1146
|
#
|
1147
|
+
# @!attribute [rw] metrics
|
1148
|
+
# @return [Array<Types::MetricDataQuery>]
|
1149
|
+
#
|
1147
1150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm AWS API Documentation
|
1148
1151
|
#
|
1149
1152
|
class MetricAlarm < Struct.new(
|
@@ -1171,14 +1174,41 @@ module Aws::CloudWatch
|
|
1171
1174
|
:threshold,
|
1172
1175
|
:comparison_operator,
|
1173
1176
|
:treat_missing_data,
|
1174
|
-
:evaluate_low_sample_count_percentile
|
1177
|
+
:evaluate_low_sample_count_percentile,
|
1178
|
+
:metrics)
|
1175
1179
|
include Aws::Structure
|
1176
1180
|
end
|
1177
1181
|
|
1178
|
-
# This structure
|
1179
|
-
#
|
1180
|
-
#
|
1181
|
-
#
|
1182
|
+
# This structure is used in both `GetMetricData` and `PutMetricAlarm`.
|
1183
|
+
# The supported use of this structure is different for those two
|
1184
|
+
# operations.
|
1185
|
+
#
|
1186
|
+
# When used in `GetMetricData`, it indicates the metric data to return,
|
1187
|
+
# and whether this call is just retrieving a batch set of data for one
|
1188
|
+
# metric, or is performing a math expression on metric data. A single
|
1189
|
+
# `GetMetricData` call can include up to 100 `MetricDataQuery`
|
1190
|
+
# structures.
|
1191
|
+
#
|
1192
|
+
# When used in `PutMetricAlarm`, it enables you to create an alarm based
|
1193
|
+
# on a metric math expression. Each `MetricDataQuery` in the array
|
1194
|
+
# specifies either a metric to retrieve, or a math expression to be
|
1195
|
+
# performed on retrieved metrics. A single `PutMetricAlarm` call can
|
1196
|
+
# include up to 20 `MetricDataQuery` structures in the array. The 20
|
1197
|
+
# structures can include as many as 10 structures that contain a
|
1198
|
+
# `MetricStat` parameter to retrieve a metric, and as many as 10
|
1199
|
+
# structures that contain the `Expression` parameter to perform a math
|
1200
|
+
# expression. Any expression used in a `PutMetricAlarm` operation must
|
1201
|
+
# return a single time series. For more information, see [Metric Math
|
1202
|
+
# Syntax and Functions][1] in the *Amazon CloudWatch User Guide*.
|
1203
|
+
#
|
1204
|
+
# Some of the parameters of this structure also have different uses
|
1205
|
+
# whether you are using this structure in a `GetMetricData` operation or
|
1206
|
+
# a `PutMetricAlarm` operation. These differences are explained in the
|
1207
|
+
# following parameter list.
|
1208
|
+
#
|
1209
|
+
#
|
1210
|
+
#
|
1211
|
+
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
1182
1212
|
#
|
1183
1213
|
# @note When making an API call, you may pass MetricDataQuery
|
1184
1214
|
# data as a hash:
|
@@ -1206,31 +1236,33 @@ module Aws::CloudWatch
|
|
1206
1236
|
# }
|
1207
1237
|
#
|
1208
1238
|
# @!attribute [rw] id
|
1209
|
-
# A short name used to tie this
|
1210
|
-
#
|
1211
|
-
#
|
1212
|
-
#
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
# letter.
|
1239
|
+
# A short name used to tie this object to the results in the response.
|
1240
|
+
# This name must be unique within a single call to `GetMetricData`. If
|
1241
|
+
# you are performing math expressions on this set of data, this name
|
1242
|
+
# represents that data and can serve as a variable in the mathematical
|
1243
|
+
# expression. The valid characters are letters, numbers, and
|
1244
|
+
# underscore. The first character must be a lowercase letter.
|
1216
1245
|
# @return [String]
|
1217
1246
|
#
|
1218
1247
|
# @!attribute [rw] metric_stat
|
1219
1248
|
# The metric to be returned, along with statistics, period, and units.
|
1220
|
-
# Use this parameter only if this
|
1221
|
-
#
|
1249
|
+
# Use this parameter only if this object is retrieving a metric and
|
1250
|
+
# not performing a math expression on returned data.
|
1222
1251
|
#
|
1223
|
-
# Within one MetricDataQuery
|
1252
|
+
# Within one MetricDataQuery object, you must specify either
|
1224
1253
|
# `Expression` or `MetricStat` but not both.
|
1225
1254
|
# @return [Types::MetricStat]
|
1226
1255
|
#
|
1227
1256
|
# @!attribute [rw] expression
|
1228
1257
|
# The math expression to be performed on the returned data, if this
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
#
|
1233
|
-
#
|
1258
|
+
# object is performing a math expression. This expression can use the
|
1259
|
+
# `Id` of the other metrics to refer to those metrics, and can also
|
1260
|
+
# use the `Id` of other expressions to use the result of those
|
1261
|
+
# expressions. For more information about metric math expressions, see
|
1262
|
+
# [Metric Math Syntax and Functions][1] in the *Amazon CloudWatch User
|
1263
|
+
# Guide*.
|
1264
|
+
#
|
1265
|
+
# Within each MetricDataQuery object, you must specify either
|
1234
1266
|
# `Expression` or `MetricStat` but not both.
|
1235
1267
|
#
|
1236
1268
|
#
|
@@ -1247,10 +1279,15 @@ module Aws::CloudWatch
|
|
1247
1279
|
# @return [String]
|
1248
1280
|
#
|
1249
1281
|
# @!attribute [rw] return_data
|
1250
|
-
#
|
1251
|
-
#
|
1252
|
-
#
|
1253
|
-
#
|
1282
|
+
# When used in `GetMetricData`, this option indicates whether to
|
1283
|
+
# return the timestamps and raw data values of this metric. If you are
|
1284
|
+
# performing this call just to do math expressions and do not also
|
1285
|
+
# need the raw data returned, you can specify `False`. If you omit
|
1286
|
+
# this, the default of `True` is used.
|
1287
|
+
#
|
1288
|
+
# When used in `PutMetricAlarm`, specify `True` for the one expression
|
1289
|
+
# result to use as the alarm. For all other metrics and expressions in
|
1290
|
+
# the same `PutMetricAlarm` operation, specify `ReturnData` as False.
|
1254
1291
|
# @return [Boolean]
|
1255
1292
|
#
|
1256
1293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery AWS API Documentation
|
@@ -1266,7 +1303,7 @@ module Aws::CloudWatch
|
|
1266
1303
|
|
1267
1304
|
# A `GetMetricData` call returns an array of `MetricDataResult`
|
1268
1305
|
# structures. Each of these structures includes the data points for that
|
1269
|
-
# metric, along with the
|
1306
|
+
# metric, along with the timestamps of those data points and other
|
1270
1307
|
# identifying information.
|
1271
1308
|
#
|
1272
1309
|
# @!attribute [rw] id
|
@@ -1278,15 +1315,15 @@ module Aws::CloudWatch
|
|
1278
1315
|
# @return [String]
|
1279
1316
|
#
|
1280
1317
|
# @!attribute [rw] timestamps
|
1281
|
-
# The
|
1282
|
-
# format. The number of
|
1283
|
-
#
|
1318
|
+
# The timestamps for the data points, formatted in Unix timestamp
|
1319
|
+
# format. The number of timestamps always matches the number of values
|
1320
|
+
# and the value for Timestamps\[x\] is Values\[x\].
|
1284
1321
|
# @return [Array<Time>]
|
1285
1322
|
#
|
1286
1323
|
# @!attribute [rw] values
|
1287
1324
|
# The data points for the metric corresponding to `Timestamps`. The
|
1288
|
-
# number of values always matches the number of
|
1289
|
-
#
|
1325
|
+
# number of values always matches the number of timestamps and the
|
1326
|
+
# timestamp for Values\[x\] is Timestamps\[x\].
|
1290
1327
|
# @return [Array<Float>]
|
1291
1328
|
#
|
1292
1329
|
# @!attribute [rw] status_code
|
@@ -1461,7 +1498,7 @@ module Aws::CloudWatch
|
|
1461
1498
|
# @return [Types::Metric]
|
1462
1499
|
#
|
1463
1500
|
# @!attribute [rw] period
|
1464
|
-
# The period to use when retrieving the metric.
|
1501
|
+
# The period, in seconds, to use when retrieving the metric.
|
1465
1502
|
# @return [Integer]
|
1466
1503
|
#
|
1467
1504
|
# @!attribute [rw] stat
|
@@ -1545,8 +1582,8 @@ module Aws::CloudWatch
|
|
1545
1582
|
# ok_actions: ["ResourceName"],
|
1546
1583
|
# alarm_actions: ["ResourceName"],
|
1547
1584
|
# insufficient_data_actions: ["ResourceName"],
|
1548
|
-
# metric_name: "MetricName",
|
1549
|
-
# namespace: "Namespace",
|
1585
|
+
# metric_name: "MetricName",
|
1586
|
+
# namespace: "Namespace",
|
1550
1587
|
# statistic: "SampleCount", # accepts SampleCount, Average, Sum, Minimum, Maximum
|
1551
1588
|
# extended_statistic: "ExtendedStatistic",
|
1552
1589
|
# dimensions: [
|
@@ -1555,7 +1592,7 @@ module Aws::CloudWatch
|
|
1555
1592
|
# value: "DimensionValue", # required
|
1556
1593
|
# },
|
1557
1594
|
# ],
|
1558
|
-
# period: 1,
|
1595
|
+
# period: 1,
|
1559
1596
|
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1560
1597
|
# evaluation_periods: 1, # required
|
1561
1598
|
# datapoints_to_alarm: 1,
|
@@ -1563,10 +1600,33 @@ module Aws::CloudWatch
|
|
1563
1600
|
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
1564
1601
|
# treat_missing_data: "TreatMissingData",
|
1565
1602
|
# evaluate_low_sample_count_percentile: "EvaluateLowSampleCountPercentile",
|
1603
|
+
# metrics: [
|
1604
|
+
# {
|
1605
|
+
# id: "MetricId", # required
|
1606
|
+
# metric_stat: {
|
1607
|
+
# metric: { # required
|
1608
|
+
# namespace: "Namespace",
|
1609
|
+
# metric_name: "MetricName",
|
1610
|
+
# dimensions: [
|
1611
|
+
# {
|
1612
|
+
# name: "DimensionName", # required
|
1613
|
+
# value: "DimensionValue", # required
|
1614
|
+
# },
|
1615
|
+
# ],
|
1616
|
+
# },
|
1617
|
+
# period: 1, # required
|
1618
|
+
# stat: "Stat", # required
|
1619
|
+
# unit: "Seconds", # accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1620
|
+
# },
|
1621
|
+
# expression: "MetricExpression",
|
1622
|
+
# label: "MetricLabel",
|
1623
|
+
# return_data: false,
|
1624
|
+
# },
|
1625
|
+
# ],
|
1566
1626
|
# }
|
1567
1627
|
#
|
1568
1628
|
# @!attribute [rw] alarm_name
|
1569
|
-
# The name for the alarm. This name must be unique within
|
1629
|
+
# The name for the alarm. This name must be unique within your AWS
|
1570
1630
|
# account.
|
1571
1631
|
# @return [String]
|
1572
1632
|
#
|
@@ -1576,7 +1636,7 @@ module Aws::CloudWatch
|
|
1576
1636
|
#
|
1577
1637
|
# @!attribute [rw] actions_enabled
|
1578
1638
|
# Indicates whether actions should be executed during any changes to
|
1579
|
-
# the alarm state.
|
1639
|
+
# the alarm state. The default is TRUE.
|
1580
1640
|
# @return [Boolean]
|
1581
1641
|
#
|
1582
1642
|
# @!attribute [rw] ok_actions
|
@@ -1587,6 +1647,7 @@ module Aws::CloudWatch
|
|
1587
1647
|
# Valid Values: `arn:aws:automate:region:ec2:stop` \|
|
1588
1648
|
# `arn:aws:automate:region:ec2:terminate` \|
|
1589
1649
|
# `arn:aws:automate:region:ec2:recover` \|
|
1650
|
+
# `arn:aws:automate:region:ec2:reboot` \|
|
1590
1651
|
# `arn:aws:sns:region:account-id:sns-topic-name ` \|
|
1591
1652
|
# `arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
|
1592
1653
|
# `
|
@@ -1641,33 +1702,39 @@ module Aws::CloudWatch
|
|
1641
1702
|
#
|
1642
1703
|
# @!attribute [rw] metric_name
|
1643
1704
|
# The name for the metric associated with the alarm.
|
1705
|
+
#
|
1706
|
+
# If you are creating an alarm based on a math expression, you cannot
|
1707
|
+
# specify this parameter, or any of the `Dimensions`, `Period`,
|
1708
|
+
# `Namespace`, `Statistic`, or `ExtendedStatistic` parameters.
|
1709
|
+
# Instead, you specify all this information in the `Metrics` array.
|
1644
1710
|
# @return [String]
|
1645
1711
|
#
|
1646
1712
|
# @!attribute [rw] namespace
|
1647
|
-
# The namespace for the metric associated
|
1713
|
+
# The namespace for the metric associated specified in `MetricName`.
|
1648
1714
|
# @return [String]
|
1649
1715
|
#
|
1650
1716
|
# @!attribute [rw] statistic
|
1651
|
-
# The statistic for the metric
|
1717
|
+
# The statistic for the metric specified in `MetricName`, other than
|
1652
1718
|
# percentile. For percentile statistics, use `ExtendedStatistic`. When
|
1653
|
-
# you call `PutMetricAlarm
|
1654
|
-
# `ExtendedStatistic,` but not both.
|
1719
|
+
# you call `PutMetricAlarm` and specify a `MetricName`, you must
|
1720
|
+
# specify either `Statistic` or `ExtendedStatistic,` but not both.
|
1655
1721
|
# @return [String]
|
1656
1722
|
#
|
1657
1723
|
# @!attribute [rw] extended_statistic
|
1658
|
-
# The percentile statistic for the metric
|
1724
|
+
# The percentile statistic for the metric specified in `MetricName`.
|
1659
1725
|
# Specify a value between p0.0 and p100. When you call
|
1660
|
-
# `PutMetricAlarm`, you must specify either
|
1661
|
-
# `ExtendedStatistic,` but not both.
|
1726
|
+
# `PutMetricAlarm` and specify a `MetricName`, you must specify either
|
1727
|
+
# `Statistic` or `ExtendedStatistic,` but not both.
|
1662
1728
|
# @return [String]
|
1663
1729
|
#
|
1664
1730
|
# @!attribute [rw] dimensions
|
1665
|
-
# The dimensions for the metric
|
1731
|
+
# The dimensions for the metric specified in `MetricName`.
|
1666
1732
|
# @return [Array<Types::Dimension>]
|
1667
1733
|
#
|
1668
1734
|
# @!attribute [rw] period
|
1669
|
-
# The
|
1670
|
-
#
|
1735
|
+
# The length, in seconds, used each time the metric specified in
|
1736
|
+
# `MetricName` is evaluated. Valid values are 10, 30, and any multiple
|
1737
|
+
# of 60.
|
1671
1738
|
#
|
1672
1739
|
# Be sure to specify 10 or 30 only for metrics that are stored by a
|
1673
1740
|
# `PutMetricData` call with a `StorageResolution` of 1. If you specify
|
@@ -1705,7 +1772,7 @@ module Aws::CloudWatch
|
|
1705
1772
|
#
|
1706
1773
|
# @!attribute [rw] evaluation_periods
|
1707
1774
|
# The number of periods over which data is compared to the specified
|
1708
|
-
# threshold. If you are setting an alarm
|
1775
|
+
# threshold. If you are setting an alarm that requires that a number
|
1709
1776
|
# of consecutive data points be breaching to trigger the alarm, this
|
1710
1777
|
# value specifies that number. If you are setting an "M out of N"
|
1711
1778
|
# alarm, this value is the N.
|
@@ -1765,6 +1832,19 @@ module Aws::CloudWatch
|
|
1765
1832
|
# [1]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples
|
1766
1833
|
# @return [String]
|
1767
1834
|
#
|
1835
|
+
# @!attribute [rw] metrics
|
1836
|
+
# An array of `MetricDataQuery` structures that enable you to create
|
1837
|
+
# an alarm based on the result of a metric math expression. Each item
|
1838
|
+
# in the `Metrics` array either retrieves a metric or performs a math
|
1839
|
+
# expression.
|
1840
|
+
#
|
1841
|
+
# If you use the `Metrics` parameter, you cannot include the
|
1842
|
+
# `MetricName`, `Dimensions`, `Period`, `Namespace`, `Statistic`, or
|
1843
|
+
# `ExtendedStatistic` parameters of `PutMetricAlarm` in the same
|
1844
|
+
# operation. Instead, you retrieve the metrics you are using in your
|
1845
|
+
# math expression as part of the `Metrics` array.
|
1846
|
+
# @return [Array<Types::MetricDataQuery>]
|
1847
|
+
#
|
1768
1848
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmInput AWS API Documentation
|
1769
1849
|
#
|
1770
1850
|
class PutMetricAlarmInput < Struct.new(
|
@@ -1786,7 +1866,8 @@ module Aws::CloudWatch
|
|
1786
1866
|
:threshold,
|
1787
1867
|
:comparison_operator,
|
1788
1868
|
:treat_missing_data,
|
1789
|
-
:evaluate_low_sample_count_percentile
|
1869
|
+
:evaluate_low_sample_count_percentile,
|
1870
|
+
:metrics)
|
1790
1871
|
include Aws::Structure
|
1791
1872
|
end
|
1792
1873
|
|
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.13.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: 2018-
|
11
|
+
date: 2018-11-20 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.39.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.39.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|