aws-sdk-cloudwatch 1.62.0 → 1.65.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +11 -2
- data/lib/aws-sdk-cloudwatch/client.rb +123 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +34 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +59 -1
- data/lib/aws-sdk-cloudwatch/metric.rb +7 -0
- data/lib/aws-sdk-cloudwatch/types.rb +273 -24
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- 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: 9882292fa5689699f213f674aca54dfc40cd6dcc3233297a7a447993317fb386
|
4
|
+
data.tar.gz: d10daaa3174ea14a2667d4cf28c3758e38609fb0dc942ea5cb957da8d4fd9a7c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0704a30c53f1ba4a13826c8fa66c3b2a46c6268d877fe26b5f9438919f2bfb9f13e01bb7fabac24434c359fbcf798332d66be78e0cdd3156273f2a8e402245ae
|
7
|
+
data.tar.gz: f775047d967d586ece529236c894bf5ca0751b8de3cf29e14deeab0fe4cec346cb94d98f34aea73e9809e76e2a6ceb6aa5f61618e8af87c3087035765af581cd
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.65.0 (2022-07-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adding support for the suppression of Composite Alarm actions
|
8
|
+
|
9
|
+
1.64.0 (2022-04-14)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Updates documentation for additional statistics in CloudWatch Metric Streams.
|
13
|
+
|
14
|
+
1.63.0 (2022-04-13)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Adds support for additional statistics in CloudWatch Metric Streams.
|
18
|
+
|
4
19
|
1.62.0 (2022-02-24)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.65.0
|
@@ -180,8 +180,17 @@ module Aws::CloudWatch
|
|
180
180
|
data[:comparison_operator]
|
181
181
|
end
|
182
182
|
|
183
|
-
# Sets how this alarm is to handle missing data points.
|
184
|
-
#
|
183
|
+
# Sets how this alarm is to handle missing data points. The valid values
|
184
|
+
# are `breaching`, `notBreaching`, `ignore`, and `missing`. For more
|
185
|
+
# information, see [Configuring how CloudWatch alarms treat missing
|
186
|
+
# data][1].
|
187
|
+
#
|
188
|
+
# If this parameter is omitted, the default behavior of `missing` is
|
189
|
+
# used.
|
190
|
+
#
|
191
|
+
#
|
192
|
+
#
|
193
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
185
194
|
# @return [String]
|
186
195
|
def treat_missing_data
|
187
196
|
data[:treat_missing_data]
|
@@ -809,6 +809,12 @@ module Aws::CloudWatch
|
|
809
809
|
# resp.composite_alarms[0].state_reason_data #=> String
|
810
810
|
# resp.composite_alarms[0].state_updated_timestamp #=> Time
|
811
811
|
# resp.composite_alarms[0].state_value #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
|
812
|
+
# resp.composite_alarms[0].state_transitioned_timestamp #=> Time
|
813
|
+
# resp.composite_alarms[0].actions_suppressed_by #=> String, one of "WaitPeriod", "ExtensionPeriod", "Alarm"
|
814
|
+
# resp.composite_alarms[0].actions_suppressed_reason #=> String
|
815
|
+
# resp.composite_alarms[0].actions_suppressor #=> String
|
816
|
+
# resp.composite_alarms[0].actions_suppressor_wait_period #=> Integer
|
817
|
+
# resp.composite_alarms[0].actions_suppressor_extension_period #=> Integer
|
812
818
|
# resp.metric_alarms #=> Array
|
813
819
|
# resp.metric_alarms[0].alarm_name #=> String
|
814
820
|
# resp.metric_alarms[0].alarm_arn #=> String
|
@@ -1444,19 +1450,30 @@ module Aws::CloudWatch
|
|
1444
1450
|
req.send_request(options)
|
1445
1451
|
end
|
1446
1452
|
|
1447
|
-
# You can use the `GetMetricData` API to retrieve
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1453
|
-
#
|
1454
|
-
# math expressions
|
1455
|
-
#
|
1453
|
+
# You can use the `GetMetricData` API to retrieve CloudWatch metric
|
1454
|
+
# values. The operation can also include a CloudWatch Metrics Insights
|
1455
|
+
# query, and one or more metric math functions.
|
1456
|
+
#
|
1457
|
+
# A `GetMetricData` operation that does not include a query can retrieve
|
1458
|
+
# as many as 500 different metrics in a single request, with a total of
|
1459
|
+
# as many as 100,800 data points. You can also optionally perform metric
|
1460
|
+
# math expressions on the values of the returned statistics, to create
|
1461
|
+
# new time series that represent new insights into your data. For
|
1462
|
+
# example, using Lambda metrics, you could divide the Errors metric by
|
1463
|
+
# the Invocations metric to get an error rate time series. For more
|
1464
|
+
# information about metric math expressions, see [Metric Math Syntax and
|
1465
|
+
# Functions][1] in the *Amazon CloudWatch User Guide*.
|
1466
|
+
#
|
1467
|
+
# If you include a Metrics Insights query, each `GetMetricData`
|
1468
|
+
# operation can include only one query. But the same `GetMetricData`
|
1469
|
+
# operation can also retrieve other metrics. Metrics Insights queries
|
1470
|
+
# can query only the most recent three hours of metric data. For more
|
1471
|
+
# information about Metrics Insights, see [Query your metrics with
|
1472
|
+
# CloudWatch Metrics Insights][2].
|
1456
1473
|
#
|
1457
1474
|
# Calls to the `GetMetricData` API have a different pricing structure
|
1458
1475
|
# than calls to `GetMetricStatistics`. For more information about
|
1459
|
-
# pricing, see [Amazon CloudWatch Pricing][
|
1476
|
+
# pricing, see [Amazon CloudWatch Pricing][3].
|
1460
1477
|
#
|
1461
1478
|
# Amazon CloudWatch retains metric data as follows:
|
1462
1479
|
#
|
@@ -1490,16 +1507,29 @@ module Aws::CloudWatch
|
|
1490
1507
|
# collected, the results of the operation are null. CloudWatch does not
|
1491
1508
|
# perform unit conversions.
|
1492
1509
|
#
|
1510
|
+
# **Using Metrics Insights queries with metric math**
|
1511
|
+
#
|
1512
|
+
# You can't mix a Metric Insights query and metric math syntax in the
|
1513
|
+
# same expression, but you can reference results from a Metrics Insights
|
1514
|
+
# query within other Metric math expressions. A Metrics Insights query
|
1515
|
+
# without a **GROUP BY** clause returns a single time-series (TS), and
|
1516
|
+
# can be used as input for a metric math expression that expects a
|
1517
|
+
# single time series. A Metrics Insights query with a **GROUP BY**
|
1518
|
+
# clause returns an array of time-series (TS\[\]), and can be used as
|
1519
|
+
# input for a metric math expression that expects an array of time
|
1520
|
+
# series.
|
1521
|
+
#
|
1493
1522
|
#
|
1494
1523
|
#
|
1495
1524
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
1496
|
-
# [2]: https://aws.amazon.com/
|
1525
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html
|
1526
|
+
# [3]: https://aws.amazon.com/cloudwatch/pricing/
|
1497
1527
|
#
|
1498
1528
|
# @option params [required, Array<Types::MetricDataQuery>] :metric_data_queries
|
1499
1529
|
# The metric queries to be returned. A single `GetMetricData` call can
|
1500
1530
|
# include as many as 500 `MetricDataQuery` structures. Each of these
|
1501
|
-
# structures can specify either a metric to retrieve,
|
1502
|
-
# expression to perform on retrieved data.
|
1531
|
+
# structures can specify either a metric to retrieve, a Metrics Insights
|
1532
|
+
# query, or a math expression to perform on retrieved data.
|
1503
1533
|
#
|
1504
1534
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1505
1535
|
# The time stamp indicating the earliest data to be returned.
|
@@ -1872,6 +1902,7 @@ module Aws::CloudWatch
|
|
1872
1902
|
# * {Types::GetMetricStreamOutput#creation_date #creation_date} => Time
|
1873
1903
|
# * {Types::GetMetricStreamOutput#last_update_date #last_update_date} => Time
|
1874
1904
|
# * {Types::GetMetricStreamOutput#output_format #output_format} => String
|
1905
|
+
# * {Types::GetMetricStreamOutput#statistics_configurations #statistics_configurations} => Array<Types::MetricStreamStatisticsConfiguration>
|
1875
1906
|
#
|
1876
1907
|
# @example Request syntax with placeholder values
|
1877
1908
|
#
|
@@ -1893,6 +1924,12 @@ module Aws::CloudWatch
|
|
1893
1924
|
# resp.creation_date #=> Time
|
1894
1925
|
# resp.last_update_date #=> Time
|
1895
1926
|
# resp.output_format #=> String, one of "json", "opentelemetry0.7"
|
1927
|
+
# resp.statistics_configurations #=> Array
|
1928
|
+
# resp.statistics_configurations[0].include_metrics #=> Array
|
1929
|
+
# resp.statistics_configurations[0].include_metrics[0].namespace #=> String
|
1930
|
+
# resp.statistics_configurations[0].include_metrics[0].metric_name #=> String
|
1931
|
+
# resp.statistics_configurations[0].additional_statistics #=> Array
|
1932
|
+
# resp.statistics_configurations[0].additional_statistics[0] #=> String
|
1896
1933
|
#
|
1897
1934
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStream AWS API Documentation
|
1898
1935
|
#
|
@@ -2370,7 +2407,10 @@ module Aws::CloudWatch
|
|
2370
2407
|
# rule are met.
|
2371
2408
|
#
|
2372
2409
|
# The alarms specified in a composite alarm's rule expression can
|
2373
|
-
# include metric alarms and other composite alarms.
|
2410
|
+
# include metric alarms and other composite alarms. The rule expression
|
2411
|
+
# of a composite alarm can include as many as 100 underlying alarms. Any
|
2412
|
+
# single alarm can be included in the rule expressions of as many as 150
|
2413
|
+
# composite alarms.
|
2374
2414
|
#
|
2375
2415
|
# Using composite alarms can reduce alarm noise. You can create multiple
|
2376
2416
|
# metric alarms, and also create a composite alarm and set up alerts
|
@@ -2516,6 +2556,26 @@ module Aws::CloudWatch
|
|
2516
2556
|
# use them to scope user permissions, by granting a user permission to
|
2517
2557
|
# access or change only resources with certain tag values.
|
2518
2558
|
#
|
2559
|
+
# @option params [String] :actions_suppressor
|
2560
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
2561
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
2562
|
+
# Name (ARN) from an existing alarm.
|
2563
|
+
#
|
2564
|
+
# @option params [Integer] :actions_suppressor_wait_period
|
2565
|
+
# The maximum time in seconds that the composite alarm waits for the
|
2566
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
2567
|
+
# composite alarm performs its actions.
|
2568
|
+
#
|
2569
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
2570
|
+
#
|
2571
|
+
# @option params [Integer] :actions_suppressor_extension_period
|
2572
|
+
# The maximum time in seconds that the composite alarm waits after
|
2573
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
2574
|
+
# composite alarm performs its actions.
|
2575
|
+
#
|
2576
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
2577
|
+
# specified.
|
2578
|
+
#
|
2519
2579
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2520
2580
|
#
|
2521
2581
|
# @example Request syntax with placeholder values
|
@@ -2534,6 +2594,9 @@ module Aws::CloudWatch
|
|
2534
2594
|
# value: "TagValue", # required
|
2535
2595
|
# },
|
2536
2596
|
# ],
|
2597
|
+
# actions_suppressor: "AlarmArn",
|
2598
|
+
# actions_suppressor_wait_period: 1,
|
2599
|
+
# actions_suppressor_extension_period: 1,
|
2537
2600
|
# })
|
2538
2601
|
#
|
2539
2602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm AWS API Documentation
|
@@ -2936,6 +2999,13 @@ module Aws::CloudWatch
|
|
2936
2999
|
#
|
2937
3000
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
2938
3001
|
#
|
3002
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
3003
|
+
# `ignore` missing data even if you choose a different option for
|
3004
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
3005
|
+
# alarms that evaluate that metric remain in their current state.
|
3006
|
+
#
|
3007
|
+
# </note>
|
3008
|
+
#
|
2939
3009
|
#
|
2940
3010
|
#
|
2941
3011
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -3207,6 +3277,13 @@ module Aws::CloudWatch
|
|
3207
3277
|
# * Stream metrics from only the metric namespaces that you list in
|
3208
3278
|
# `IncludeFilters`.
|
3209
3279
|
#
|
3280
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3281
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3282
|
+
# the `StatisticsConfigurations` parameter to have the metric stream
|
3283
|
+
# also send additional statistics in the stream. Streaming additional
|
3284
|
+
# statistics incurs additional costs. For more information, see [Amazon
|
3285
|
+
# CloudWatch Pricing][2].
|
3286
|
+
#
|
3210
3287
|
# When you use `PutMetricStream` to create a new metric stream, the
|
3211
3288
|
# stream is created in the `running` state. If you use it to update an
|
3212
3289
|
# existing stream, the state of the stream is not changed.
|
@@ -3214,6 +3291,7 @@ module Aws::CloudWatch
|
|
3214
3291
|
#
|
3215
3292
|
#
|
3216
3293
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html
|
3294
|
+
# [2]: https://aws.amazon.com/cloudwatch/pricing/
|
3217
3295
|
#
|
3218
3296
|
# @option params [required, String] :name
|
3219
3297
|
# If you are creating a new metric stream, this is the name for the new
|
@@ -3282,6 +3360,25 @@ module Aws::CloudWatch
|
|
3282
3360
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
|
3283
3361
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
3284
3362
|
#
|
3363
|
+
# @option params [Array<Types::MetricStreamStatisticsConfiguration>] :statistics_configurations
|
3364
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3365
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3366
|
+
# this parameter to have the metric stream also send additional
|
3367
|
+
# statistics in the stream. This array can have up to 100 members.
|
3368
|
+
#
|
3369
|
+
# For each entry in this array, you specify one or more metrics and the
|
3370
|
+
# list of additional statistics to stream for those metrics. The
|
3371
|
+
# additional statistics that you can stream depend on the stream's
|
3372
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
3373
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
3374
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
3375
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as p95,
|
3376
|
+
# p99.9 and so on.
|
3377
|
+
#
|
3378
|
+
#
|
3379
|
+
#
|
3380
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3381
|
+
#
|
3285
3382
|
# @return [Types::PutMetricStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3286
3383
|
#
|
3287
3384
|
# * {Types::PutMetricStreamOutput#arn #arn} => String
|
@@ -3309,6 +3406,17 @@ module Aws::CloudWatch
|
|
3309
3406
|
# value: "TagValue", # required
|
3310
3407
|
# },
|
3311
3408
|
# ],
|
3409
|
+
# statistics_configurations: [
|
3410
|
+
# {
|
3411
|
+
# include_metrics: [ # required
|
3412
|
+
# {
|
3413
|
+
# namespace: "Namespace", # required
|
3414
|
+
# metric_name: "MetricName", # required
|
3415
|
+
# },
|
3416
|
+
# ],
|
3417
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
3418
|
+
# },
|
3419
|
+
# ],
|
3312
3420
|
# })
|
3313
3421
|
#
|
3314
3422
|
# @example Response structure
|
@@ -3554,7 +3662,7 @@ module Aws::CloudWatch
|
|
3554
3662
|
params: params,
|
3555
3663
|
config: config)
|
3556
3664
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
3557
|
-
context[:gem_version] = '1.
|
3665
|
+
context[:gem_version] = '1.65.0'
|
3558
3666
|
Seahorse::Client::Request.new(handlers, context)
|
3559
3667
|
end
|
3560
3668
|
|
@@ -16,6 +16,8 @@ module Aws::CloudWatch
|
|
16
16
|
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
17
17
|
ActionPrefix = Shapes::StringShape.new(name: 'ActionPrefix')
|
18
18
|
ActionsEnabled = Shapes::BooleanShape.new(name: 'ActionsEnabled')
|
19
|
+
ActionsSuppressedBy = Shapes::StringShape.new(name: 'ActionsSuppressedBy')
|
20
|
+
ActionsSuppressedReason = Shapes::StringShape.new(name: 'ActionsSuppressedReason')
|
19
21
|
AlarmArn = Shapes::StringShape.new(name: 'AlarmArn')
|
20
22
|
AlarmDescription = Shapes::StringShape.new(name: 'AlarmDescription')
|
21
23
|
AlarmHistoryItem = Shapes::StructureShape.new(name: 'AlarmHistoryItem')
|
@@ -193,6 +195,12 @@ module Aws::CloudWatch
|
|
193
195
|
MetricStreamNames = Shapes::ListShape.new(name: 'MetricStreamNames')
|
194
196
|
MetricStreamOutputFormat = Shapes::StringShape.new(name: 'MetricStreamOutputFormat')
|
195
197
|
MetricStreamState = Shapes::StringShape.new(name: 'MetricStreamState')
|
198
|
+
MetricStreamStatistic = Shapes::StringShape.new(name: 'MetricStreamStatistic')
|
199
|
+
MetricStreamStatisticsAdditionalStatistics = Shapes::ListShape.new(name: 'MetricStreamStatisticsAdditionalStatistics')
|
200
|
+
MetricStreamStatisticsConfiguration = Shapes::StructureShape.new(name: 'MetricStreamStatisticsConfiguration')
|
201
|
+
MetricStreamStatisticsConfigurations = Shapes::ListShape.new(name: 'MetricStreamStatisticsConfigurations')
|
202
|
+
MetricStreamStatisticsIncludeMetrics = Shapes::ListShape.new(name: 'MetricStreamStatisticsIncludeMetrics')
|
203
|
+
MetricStreamStatisticsMetric = Shapes::StructureShape.new(name: 'MetricStreamStatisticsMetric')
|
196
204
|
MetricWidget = Shapes::StringShape.new(name: 'MetricWidget')
|
197
205
|
MetricWidgetImage = Shapes::BlobShape.new(name: 'MetricWidgetImage')
|
198
206
|
Metrics = Shapes::ListShape.new(name: 'Metrics')
|
@@ -240,6 +248,7 @@ module Aws::CloudWatch
|
|
240
248
|
StopMetricStreamsInput = Shapes::StructureShape.new(name: 'StopMetricStreamsInput')
|
241
249
|
StopMetricStreamsOutput = Shapes::StructureShape.new(name: 'StopMetricStreamsOutput')
|
242
250
|
StorageResolution = Shapes::IntegerShape.new(name: 'StorageResolution')
|
251
|
+
SuppressorPeriod = Shapes::IntegerShape.new(name: 'SuppressorPeriod')
|
243
252
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
244
253
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
245
254
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
@@ -304,6 +313,12 @@ module Aws::CloudWatch
|
|
304
313
|
CompositeAlarm.add_member(:state_reason_data, Shapes::ShapeRef.new(shape: StateReasonData, location_name: "StateReasonData"))
|
305
314
|
CompositeAlarm.add_member(:state_updated_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateUpdatedTimestamp"))
|
306
315
|
CompositeAlarm.add_member(:state_value, Shapes::ShapeRef.new(shape: StateValue, location_name: "StateValue"))
|
316
|
+
CompositeAlarm.add_member(:state_transitioned_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StateTransitionedTimestamp"))
|
317
|
+
CompositeAlarm.add_member(:actions_suppressed_by, Shapes::ShapeRef.new(shape: ActionsSuppressedBy, location_name: "ActionsSuppressedBy"))
|
318
|
+
CompositeAlarm.add_member(:actions_suppressed_reason, Shapes::ShapeRef.new(shape: ActionsSuppressedReason, location_name: "ActionsSuppressedReason"))
|
319
|
+
CompositeAlarm.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
|
320
|
+
CompositeAlarm.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
|
321
|
+
CompositeAlarm.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
|
307
322
|
CompositeAlarm.struct_class = Types::CompositeAlarm
|
308
323
|
|
309
324
|
CompositeAlarms.member = Shapes::ShapeRef.new(shape: CompositeAlarm)
|
@@ -542,6 +557,7 @@ module Aws::CloudWatch
|
|
542
557
|
GetMetricStreamOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationDate"))
|
543
558
|
GetMetricStreamOutput.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdateDate"))
|
544
559
|
GetMetricStreamOutput.add_member(:output_format, Shapes::ShapeRef.new(shape: MetricStreamOutputFormat, location_name: "OutputFormat"))
|
560
|
+
GetMetricStreamOutput.add_member(:statistics_configurations, Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfigurations, location_name: "StatisticsConfigurations"))
|
545
561
|
GetMetricStreamOutput.struct_class = Types::GetMetricStreamOutput
|
546
562
|
|
547
563
|
GetMetricWidgetImageInput.add_member(:metric_widget, Shapes::ShapeRef.new(shape: MetricWidget, required: true, location_name: "MetricWidget"))
|
@@ -751,6 +767,20 @@ module Aws::CloudWatch
|
|
751
767
|
|
752
768
|
MetricStreamNames.member = Shapes::ShapeRef.new(shape: MetricStreamName)
|
753
769
|
|
770
|
+
MetricStreamStatisticsAdditionalStatistics.member = Shapes::ShapeRef.new(shape: MetricStreamStatistic)
|
771
|
+
|
772
|
+
MetricStreamStatisticsConfiguration.add_member(:include_metrics, Shapes::ShapeRef.new(shape: MetricStreamStatisticsIncludeMetrics, required: true, location_name: "IncludeMetrics"))
|
773
|
+
MetricStreamStatisticsConfiguration.add_member(:additional_statistics, Shapes::ShapeRef.new(shape: MetricStreamStatisticsAdditionalStatistics, required: true, location_name: "AdditionalStatistics"))
|
774
|
+
MetricStreamStatisticsConfiguration.struct_class = Types::MetricStreamStatisticsConfiguration
|
775
|
+
|
776
|
+
MetricStreamStatisticsConfigurations.member = Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfiguration)
|
777
|
+
|
778
|
+
MetricStreamStatisticsIncludeMetrics.member = Shapes::ShapeRef.new(shape: MetricStreamStatisticsMetric)
|
779
|
+
|
780
|
+
MetricStreamStatisticsMetric.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location_name: "Namespace"))
|
781
|
+
MetricStreamStatisticsMetric.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
|
782
|
+
MetricStreamStatisticsMetric.struct_class = Types::MetricStreamStatisticsMetric
|
783
|
+
|
754
784
|
Metrics.member = Shapes::ShapeRef.new(shape: Metric)
|
755
785
|
|
756
786
|
MissingRequiredParameterException.add_member(:message, Shapes::ShapeRef.new(shape: AwsQueryErrorMessage, location_name: "message"))
|
@@ -781,6 +811,9 @@ module Aws::CloudWatch
|
|
781
811
|
PutCompositeAlarmInput.add_member(:insufficient_data_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "InsufficientDataActions"))
|
782
812
|
PutCompositeAlarmInput.add_member(:ok_actions, Shapes::ShapeRef.new(shape: ResourceList, location_name: "OKActions"))
|
783
813
|
PutCompositeAlarmInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
814
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor, Shapes::ShapeRef.new(shape: AlarmArn, location_name: "ActionsSuppressor"))
|
815
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor_wait_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorWaitPeriod"))
|
816
|
+
PutCompositeAlarmInput.add_member(:actions_suppressor_extension_period, Shapes::ShapeRef.new(shape: SuppressorPeriod, location_name: "ActionsSuppressorExtensionPeriod"))
|
784
817
|
PutCompositeAlarmInput.struct_class = Types::PutCompositeAlarmInput
|
785
818
|
|
786
819
|
PutDashboardInput.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: DashboardName, required: true, location_name: "DashboardName"))
|
@@ -833,6 +866,7 @@ module Aws::CloudWatch
|
|
833
866
|
PutMetricStreamInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "RoleArn"))
|
834
867
|
PutMetricStreamInput.add_member(:output_format, Shapes::ShapeRef.new(shape: MetricStreamOutputFormat, required: true, location_name: "OutputFormat"))
|
835
868
|
PutMetricStreamInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
869
|
+
PutMetricStreamInput.add_member(:statistics_configurations, Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfigurations, location_name: "StatisticsConfigurations"))
|
836
870
|
PutMetricStreamInput.struct_class = Types::PutMetricStreamInput
|
837
871
|
|
838
872
|
PutMetricStreamOutput.add_member(:arn, Shapes::ShapeRef.new(shape: AmazonResourceName, location_name: "Arn"))
|
@@ -102,7 +102,8 @@ module Aws::CloudWatch
|
|
102
102
|
data[:state_reason_data]
|
103
103
|
end
|
104
104
|
|
105
|
-
#
|
105
|
+
# Tracks the timestamp of any state update, even if `StateValue`
|
106
|
+
# doesn't change.
|
106
107
|
# @return [Time]
|
107
108
|
def state_updated_timestamp
|
108
109
|
data[:state_updated_timestamp]
|
@@ -114,6 +115,63 @@ module Aws::CloudWatch
|
|
114
115
|
data[:state_value]
|
115
116
|
end
|
116
117
|
|
118
|
+
# The timestamp of the last change to the alarm's `StateValue`.
|
119
|
+
# @return [Time]
|
120
|
+
def state_transitioned_timestamp
|
121
|
+
data[:state_transitioned_timestamp]
|
122
|
+
end
|
123
|
+
|
124
|
+
# When the value is `ALARM`, it means that the actions are suppressed
|
125
|
+
# because the suppressor alarm is in `ALARM` When the value is
|
126
|
+
# `WaitPeriod`, it means that the actions are suppressed because the
|
127
|
+
# composite alarm is waiting for the suppressor alarm to go into into
|
128
|
+
# the `ALARM` state. The maximum waiting time is as specified in
|
129
|
+
# `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
|
130
|
+
# performs its actions. When the value is `ExtensionPeriod`, it means
|
131
|
+
# that the actions are suppressed because the composite alarm is waiting
|
132
|
+
# after the suppressor alarm went out of the `ALARM` state. The maximum
|
133
|
+
# waiting time is as specified in `ActionsSuppressorExtensionPeriod`.
|
134
|
+
# After this time, the composite alarm performs its actions.
|
135
|
+
# @return [String]
|
136
|
+
def actions_suppressed_by
|
137
|
+
data[:actions_suppressed_by]
|
138
|
+
end
|
139
|
+
|
140
|
+
# Captures the reason for action suppression.
|
141
|
+
# @return [String]
|
142
|
+
def actions_suppressed_reason
|
143
|
+
data[:actions_suppressed_reason]
|
144
|
+
end
|
145
|
+
|
146
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
147
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
148
|
+
# Name (ARN) from an existing alarm.
|
149
|
+
# @return [String]
|
150
|
+
def actions_suppressor
|
151
|
+
data[:actions_suppressor]
|
152
|
+
end
|
153
|
+
|
154
|
+
# The maximum time in seconds that the composite alarm waits for the
|
155
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
156
|
+
# composite alarm performs its actions.
|
157
|
+
#
|
158
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
159
|
+
# @return [Integer]
|
160
|
+
def actions_suppressor_wait_period
|
161
|
+
data[:actions_suppressor_wait_period]
|
162
|
+
end
|
163
|
+
|
164
|
+
# The maximum time in seconds that the composite alarm waits after
|
165
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
166
|
+
# composite alarm performs its actions.
|
167
|
+
#
|
168
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
169
|
+
# specified.
|
170
|
+
# @return [Integer]
|
171
|
+
def actions_suppressor_extension_period
|
172
|
+
data[:actions_suppressor_extension_period]
|
173
|
+
end
|
174
|
+
|
117
175
|
# @!endgroup
|
118
176
|
|
119
177
|
# @return [Client]
|
@@ -531,6 +531,13 @@ module Aws::CloudWatch
|
|
531
531
|
#
|
532
532
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
533
533
|
#
|
534
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
535
|
+
# `ignore` missing data even if you choose a different option for
|
536
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
537
|
+
# alarms that evaluate that metric remain in their current state.
|
538
|
+
#
|
539
|
+
# </note>
|
540
|
+
#
|
534
541
|
#
|
535
542
|
#
|
536
543
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -205,13 +205,60 @@ module Aws::CloudWatch
|
|
205
205
|
# @return [String]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] state_updated_timestamp
|
208
|
-
#
|
208
|
+
# Tracks the timestamp of any state update, even if `StateValue`
|
209
|
+
# doesn't change.
|
209
210
|
# @return [Time]
|
210
211
|
#
|
211
212
|
# @!attribute [rw] state_value
|
212
213
|
# The state value for the alarm.
|
213
214
|
# @return [String]
|
214
215
|
#
|
216
|
+
# @!attribute [rw] state_transitioned_timestamp
|
217
|
+
# The timestamp of the last change to the alarm's `StateValue`.
|
218
|
+
# @return [Time]
|
219
|
+
#
|
220
|
+
# @!attribute [rw] actions_suppressed_by
|
221
|
+
# When the value is `ALARM`, it means that the actions are suppressed
|
222
|
+
# because the suppressor alarm is in `ALARM` When the value is
|
223
|
+
# `WaitPeriod`, it means that the actions are suppressed because the
|
224
|
+
# composite alarm is waiting for the suppressor alarm to go into into
|
225
|
+
# the `ALARM` state. The maximum waiting time is as specified in
|
226
|
+
# `ActionsSuppressorWaitPeriod`. After this time, the composite alarm
|
227
|
+
# performs its actions. When the value is `ExtensionPeriod`, it means
|
228
|
+
# that the actions are suppressed because the composite alarm is
|
229
|
+
# waiting after the suppressor alarm went out of the `ALARM` state.
|
230
|
+
# The maximum waiting time is as specified in
|
231
|
+
# `ActionsSuppressorExtensionPeriod`. After this time, the composite
|
232
|
+
# alarm performs its actions.
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @!attribute [rw] actions_suppressed_reason
|
236
|
+
# Captures the reason for action suppression.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] actions_suppressor
|
240
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
241
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
242
|
+
# Name (ARN) from an existing alarm.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
246
|
+
# The maximum time in seconds that the composite alarm waits for the
|
247
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
248
|
+
# composite alarm performs its actions.
|
249
|
+
#
|
250
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
251
|
+
# @return [Integer]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
254
|
+
# The maximum time in seconds that the composite alarm waits after
|
255
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
256
|
+
# composite alarm performs its actions.
|
257
|
+
#
|
258
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
259
|
+
# specified.
|
260
|
+
# @return [Integer]
|
261
|
+
#
|
215
262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/CompositeAlarm AWS API Documentation
|
216
263
|
#
|
217
264
|
class CompositeAlarm < Struct.new(
|
@@ -227,7 +274,13 @@ module Aws::CloudWatch
|
|
227
274
|
:state_reason,
|
228
275
|
:state_reason_data,
|
229
276
|
:state_updated_timestamp,
|
230
|
-
:state_value
|
277
|
+
:state_value,
|
278
|
+
:state_transitioned_timestamp,
|
279
|
+
:actions_suppressed_by,
|
280
|
+
:actions_suppressed_reason,
|
281
|
+
:actions_suppressor,
|
282
|
+
:actions_suppressor_wait_period,
|
283
|
+
:actions_suppressor_extension_period)
|
231
284
|
SENSITIVE = []
|
232
285
|
include Aws::Structure
|
233
286
|
end
|
@@ -1031,10 +1084,13 @@ module Aws::CloudWatch
|
|
1031
1084
|
end
|
1032
1085
|
|
1033
1086
|
# A dimension is a name/value pair that is part of the identity of a
|
1034
|
-
# metric.
|
1035
|
-
#
|
1036
|
-
# you
|
1037
|
-
#
|
1087
|
+
# metric. Because dimensions are part of the unique identifier for a
|
1088
|
+
# metric, whenever you add a unique name/value pair to one of your
|
1089
|
+
# metrics, you are creating a new variation of that metric. For example,
|
1090
|
+
# many Amazon EC2 metrics publish `InstanceId` as a dimension name, and
|
1091
|
+
# the actual instance ID as the value for that dimension.
|
1092
|
+
#
|
1093
|
+
# You can assign up to 10 dimensions to a metric.
|
1038
1094
|
#
|
1039
1095
|
# @note When making an API call, you may pass Dimension
|
1040
1096
|
# data as a hash:
|
@@ -1046,7 +1102,8 @@ module Aws::CloudWatch
|
|
1046
1102
|
#
|
1047
1103
|
# @!attribute [rw] name
|
1048
1104
|
# The name of the dimension. Dimension names must contain only ASCII
|
1049
|
-
# characters
|
1105
|
+
# characters, must include at least one non-whitespace character, and
|
1106
|
+
# cannot start with a colon (`:`).
|
1050
1107
|
# @return [String]
|
1051
1108
|
#
|
1052
1109
|
# @!attribute [rw] value
|
@@ -1429,8 +1486,8 @@ module Aws::CloudWatch
|
|
1429
1486
|
# @!attribute [rw] metric_data_queries
|
1430
1487
|
# The metric queries to be returned. A single `GetMetricData` call can
|
1431
1488
|
# include as many as 500 `MetricDataQuery` structures. Each of these
|
1432
|
-
# structures can specify either a metric to retrieve,
|
1433
|
-
# expression to perform on retrieved data.
|
1489
|
+
# structures can specify either a metric to retrieve, a Metrics
|
1490
|
+
# Insights query, or a math expression to perform on retrieved data.
|
1434
1491
|
# @return [Array<Types::MetricDataQuery>]
|
1435
1492
|
#
|
1436
1493
|
# @!attribute [rw] start_time
|
@@ -1784,8 +1841,26 @@ module Aws::CloudWatch
|
|
1784
1841
|
# @return [Time]
|
1785
1842
|
#
|
1786
1843
|
# @!attribute [rw] output_format
|
1844
|
+
# The output format for the stream. Valid values are `json` and
|
1845
|
+
# `opentelemetry0.7`. For more information about metric stream output
|
1846
|
+
# formats, see [ Metric streams output formats][1].
|
1847
|
+
#
|
1848
|
+
#
|
1849
|
+
#
|
1850
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html
|
1787
1851
|
# @return [String]
|
1788
1852
|
#
|
1853
|
+
# @!attribute [rw] statistics_configurations
|
1854
|
+
# Each entry in this array displays information about one or more
|
1855
|
+
# metrics that include additional statistics in the metric stream. For
|
1856
|
+
# more information about the additional statistics, see [ CloudWatch
|
1857
|
+
# statistics definitions][1].
|
1858
|
+
#
|
1859
|
+
#
|
1860
|
+
#
|
1861
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
1862
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
1863
|
+
#
|
1789
1864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStreamOutput AWS API Documentation
|
1790
1865
|
#
|
1791
1866
|
class GetMetricStreamOutput < Struct.new(
|
@@ -1798,7 +1873,8 @@ module Aws::CloudWatch
|
|
1798
1873
|
:state,
|
1799
1874
|
:creation_date,
|
1800
1875
|
:last_update_date,
|
1801
|
-
:output_format
|
1876
|
+
:output_format,
|
1877
|
+
:statistics_configurations)
|
1802
1878
|
SENSITIVE = []
|
1803
1879
|
include Aws::Structure
|
1804
1880
|
end
|
@@ -2592,8 +2668,17 @@ module Aws::CloudWatch
|
|
2592
2668
|
# @return [String]
|
2593
2669
|
#
|
2594
2670
|
# @!attribute [rw] treat_missing_data
|
2595
|
-
# Sets how this alarm is to handle missing data points.
|
2596
|
-
#
|
2671
|
+
# Sets how this alarm is to handle missing data points. The valid
|
2672
|
+
# values are `breaching`, `notBreaching`, `ignore`, and `missing`. For
|
2673
|
+
# more information, see [Configuring how CloudWatch alarms treat
|
2674
|
+
# missing data][1].
|
2675
|
+
#
|
2676
|
+
# If this parameter is omitted, the default behavior of `missing` is
|
2677
|
+
# used.
|
2678
|
+
#
|
2679
|
+
#
|
2680
|
+
#
|
2681
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
2597
2682
|
# @return [String]
|
2598
2683
|
#
|
2599
2684
|
# @!attribute [rw] evaluate_low_sample_count_percentile
|
@@ -2658,9 +2743,9 @@ module Aws::CloudWatch
|
|
2658
2743
|
#
|
2659
2744
|
# When used in `GetMetricData`, it indicates the metric data to return,
|
2660
2745
|
# and whether this call is just retrieving a batch set of data for one
|
2661
|
-
# metric, or is performing a
|
2662
|
-
# `GetMetricData` call can include up to 500
|
2663
|
-
# structures.
|
2746
|
+
# metric, or is performing a Metrics Insights query or a math
|
2747
|
+
# expression. A single `GetMetricData` call can include up to 500
|
2748
|
+
# `MetricDataQuery` structures.
|
2664
2749
|
#
|
2665
2750
|
# When used in `PutMetricAlarm`, it enables you to create an alarm based
|
2666
2751
|
# on a metric math expression. Each `MetricDataQuery` in the array
|
@@ -2733,20 +2818,25 @@ module Aws::CloudWatch
|
|
2733
2818
|
# @return [Types::MetricStat]
|
2734
2819
|
#
|
2735
2820
|
# @!attribute [rw] expression
|
2736
|
-
#
|
2737
|
-
#
|
2738
|
-
#
|
2739
|
-
#
|
2740
|
-
# expressions. For more information about metric math expressions, see
|
2741
|
-
# [Metric Math Syntax and Functions][1] in the *Amazon CloudWatch User
|
2821
|
+
# This field can contain either a Metrics Insights query, or a metric
|
2822
|
+
# math expression to be performed on the returned data. For more
|
2823
|
+
# information about Metrics Insights queries, see [Metrics Insights
|
2824
|
+
# query components and syntax][1] in the *Amazon CloudWatch User
|
2742
2825
|
# Guide*.
|
2743
2826
|
#
|
2827
|
+
# A math expression can use the `Id` of the other metrics or queries
|
2828
|
+
# to refer to those metrics, and can also use the `Id` of other
|
2829
|
+
# expressions to use the result of those expressions. For more
|
2830
|
+
# information about metric math expressions, see [Metric Math Syntax
|
2831
|
+
# and Functions][2] in the *Amazon CloudWatch User Guide*.
|
2832
|
+
#
|
2744
2833
|
# Within each MetricDataQuery object, you must specify either
|
2745
2834
|
# `Expression` or `MetricStat` but not both.
|
2746
2835
|
#
|
2747
2836
|
#
|
2748
2837
|
#
|
2749
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/
|
2838
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage
|
2839
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
2750
2840
|
# @return [String]
|
2751
2841
|
#
|
2752
2842
|
# @!attribute [rw] label
|
@@ -3188,6 +3278,96 @@ module Aws::CloudWatch
|
|
3188
3278
|
include Aws::Structure
|
3189
3279
|
end
|
3190
3280
|
|
3281
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3282
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. This
|
3283
|
+
# structure contains information for one metric that includes additional
|
3284
|
+
# statistics in the stream. For more information about statistics, see
|
3285
|
+
# CloudWatch, listed in [ CloudWatch statistics definitions][1].
|
3286
|
+
#
|
3287
|
+
#
|
3288
|
+
#
|
3289
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3290
|
+
#
|
3291
|
+
# @note When making an API call, you may pass MetricStreamStatisticsConfiguration
|
3292
|
+
# data as a hash:
|
3293
|
+
#
|
3294
|
+
# {
|
3295
|
+
# include_metrics: [ # required
|
3296
|
+
# {
|
3297
|
+
# namespace: "Namespace", # required
|
3298
|
+
# metric_name: "MetricName", # required
|
3299
|
+
# },
|
3300
|
+
# ],
|
3301
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
3302
|
+
# }
|
3303
|
+
#
|
3304
|
+
# @!attribute [rw] include_metrics
|
3305
|
+
# An array of metric name and namespace pairs that stream the
|
3306
|
+
# additional statistics listed in the value of the
|
3307
|
+
# `AdditionalStatistics` parameter. There can be as many as 100 pairs
|
3308
|
+
# in the array.
|
3309
|
+
#
|
3310
|
+
# All metrics that match the combination of metric name and namespace
|
3311
|
+
# will be streamed with the additional statistics, no matter their
|
3312
|
+
# dimensions.
|
3313
|
+
# @return [Array<Types::MetricStreamStatisticsMetric>]
|
3314
|
+
#
|
3315
|
+
# @!attribute [rw] additional_statistics
|
3316
|
+
# The list of additional statistics that are to be streamed for the
|
3317
|
+
# metrics listed in the `IncludeMetrics` array in this structure. This
|
3318
|
+
# list can include as many as 20 statistics.
|
3319
|
+
#
|
3320
|
+
# If the `OutputFormat` for the stream is `opentelemetry0.7`, the only
|
3321
|
+
# valid values are `p?? ` percentile statistics such as `p90`, `p99`
|
3322
|
+
# and so on.
|
3323
|
+
#
|
3324
|
+
# If the `OutputFormat` for the stream is `json`, the valid values
|
3325
|
+
# include the abbreviations for all of the statistics listed in [
|
3326
|
+
# CloudWatch statistics definitions][1]. For example, this includes
|
3327
|
+
# `tm98, ` `wm90`, `PR(:300)`, and so on.
|
3328
|
+
#
|
3329
|
+
#
|
3330
|
+
#
|
3331
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3332
|
+
# @return [Array<String>]
|
3333
|
+
#
|
3334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsConfiguration AWS API Documentation
|
3335
|
+
#
|
3336
|
+
class MetricStreamStatisticsConfiguration < Struct.new(
|
3337
|
+
:include_metrics,
|
3338
|
+
:additional_statistics)
|
3339
|
+
SENSITIVE = []
|
3340
|
+
include Aws::Structure
|
3341
|
+
end
|
3342
|
+
|
3343
|
+
# This object contains the information for one metric that is to be
|
3344
|
+
# streamed with additional statistics.
|
3345
|
+
#
|
3346
|
+
# @note When making an API call, you may pass MetricStreamStatisticsMetric
|
3347
|
+
# data as a hash:
|
3348
|
+
#
|
3349
|
+
# {
|
3350
|
+
# namespace: "Namespace", # required
|
3351
|
+
# metric_name: "MetricName", # required
|
3352
|
+
# }
|
3353
|
+
#
|
3354
|
+
# @!attribute [rw] namespace
|
3355
|
+
# The namespace of the metric.
|
3356
|
+
# @return [String]
|
3357
|
+
#
|
3358
|
+
# @!attribute [rw] metric_name
|
3359
|
+
# The name of the metric.
|
3360
|
+
# @return [String]
|
3361
|
+
#
|
3362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsMetric AWS API Documentation
|
3363
|
+
#
|
3364
|
+
class MetricStreamStatisticsMetric < Struct.new(
|
3365
|
+
:namespace,
|
3366
|
+
:metric_name)
|
3367
|
+
SENSITIVE = []
|
3368
|
+
include Aws::Structure
|
3369
|
+
end
|
3370
|
+
|
3191
3371
|
# An input parameter that is required is missing.
|
3192
3372
|
#
|
3193
3373
|
# @!attribute [rw] message
|
@@ -3398,6 +3578,9 @@ module Aws::CloudWatch
|
|
3398
3578
|
# value: "TagValue", # required
|
3399
3579
|
# },
|
3400
3580
|
# ],
|
3581
|
+
# actions_suppressor: "AlarmArn",
|
3582
|
+
# actions_suppressor_wait_period: 1,
|
3583
|
+
# actions_suppressor_extension_period: 1,
|
3401
3584
|
# }
|
3402
3585
|
#
|
3403
3586
|
# @!attribute [rw] actions_enabled
|
@@ -3508,6 +3691,29 @@ module Aws::CloudWatch
|
|
3508
3691
|
# values.
|
3509
3692
|
# @return [Array<Types::Tag>]
|
3510
3693
|
#
|
3694
|
+
# @!attribute [rw] actions_suppressor
|
3695
|
+
# Actions will be suppressed if the suppressor alarm is in the `ALARM`
|
3696
|
+
# state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource
|
3697
|
+
# Name (ARN) from an existing alarm.
|
3698
|
+
# @return [String]
|
3699
|
+
#
|
3700
|
+
# @!attribute [rw] actions_suppressor_wait_period
|
3701
|
+
# The maximum time in seconds that the composite alarm waits for the
|
3702
|
+
# suppressor alarm to go into the `ALARM` state. After this time, the
|
3703
|
+
# composite alarm performs its actions.
|
3704
|
+
#
|
3705
|
+
# `WaitPeriod` is required only when `ActionsSuppressor` is specified.
|
3706
|
+
# @return [Integer]
|
3707
|
+
#
|
3708
|
+
# @!attribute [rw] actions_suppressor_extension_period
|
3709
|
+
# The maximum time in seconds that the composite alarm waits after
|
3710
|
+
# suppressor alarm goes out of the `ALARM` state. After this time, the
|
3711
|
+
# composite alarm performs its actions.
|
3712
|
+
#
|
3713
|
+
# `ExtensionPeriod` is required only when `ActionsSuppressor` is
|
3714
|
+
# specified.
|
3715
|
+
# @return [Integer]
|
3716
|
+
#
|
3511
3717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarmInput AWS API Documentation
|
3512
3718
|
#
|
3513
3719
|
class PutCompositeAlarmInput < Struct.new(
|
@@ -3518,7 +3724,10 @@ module Aws::CloudWatch
|
|
3518
3724
|
:alarm_rule,
|
3519
3725
|
:insufficient_data_actions,
|
3520
3726
|
:ok_actions,
|
3521
|
-
:tags
|
3727
|
+
:tags,
|
3728
|
+
:actions_suppressor,
|
3729
|
+
:actions_suppressor_wait_period,
|
3730
|
+
:actions_suppressor_extension_period)
|
3522
3731
|
SENSITIVE = []
|
3523
3732
|
include Aws::Structure
|
3524
3733
|
end
|
@@ -3929,6 +4138,13 @@ module Aws::CloudWatch
|
|
3929
4138
|
#
|
3930
4139
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
3931
4140
|
#
|
4141
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
4142
|
+
# `ignore` missing data even if you choose a different option for
|
4143
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
4144
|
+
# alarms that evaluate that metric remain in their current state.
|
4145
|
+
#
|
4146
|
+
# </note>
|
4147
|
+
#
|
3932
4148
|
#
|
3933
4149
|
#
|
3934
4150
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
@@ -4109,6 +4325,17 @@ module Aws::CloudWatch
|
|
4109
4325
|
# value: "TagValue", # required
|
4110
4326
|
# },
|
4111
4327
|
# ],
|
4328
|
+
# statistics_configurations: [
|
4329
|
+
# {
|
4330
|
+
# include_metrics: [ # required
|
4331
|
+
# {
|
4332
|
+
# namespace: "Namespace", # required
|
4333
|
+
# metric_name: "MetricName", # required
|
4334
|
+
# },
|
4335
|
+
# ],
|
4336
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
4337
|
+
# },
|
4338
|
+
# ],
|
4112
4339
|
# }
|
4113
4340
|
#
|
4114
4341
|
# @!attribute [rw] name
|
@@ -4187,6 +4414,27 @@ module Aws::CloudWatch
|
|
4187
4414
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
4188
4415
|
# @return [Array<Types::Tag>]
|
4189
4416
|
#
|
4417
|
+
# @!attribute [rw] statistics_configurations
|
4418
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`,
|
4419
|
+
# and `SAMPLECOUNT` statistics for each metric that is streamed. You
|
4420
|
+
# can use this parameter to have the metric stream also send
|
4421
|
+
# additional statistics in the stream. This array can have up to 100
|
4422
|
+
# members.
|
4423
|
+
#
|
4424
|
+
# For each entry in this array, you specify one or more metrics and
|
4425
|
+
# the list of additional statistics to stream for those metrics. The
|
4426
|
+
# additional statistics that you can stream depend on the stream's
|
4427
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
4428
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
4429
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
4430
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as
|
4431
|
+
# p95, p99.9 and so on.
|
4432
|
+
#
|
4433
|
+
#
|
4434
|
+
#
|
4435
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
4436
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
4437
|
+
#
|
4190
4438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation
|
4191
4439
|
#
|
4192
4440
|
class PutMetricStreamInput < Struct.new(
|
@@ -4196,7 +4444,8 @@ module Aws::CloudWatch
|
|
4196
4444
|
:firehose_arn,
|
4197
4445
|
:role_arn,
|
4198
4446
|
:output_format,
|
4199
|
-
:tags
|
4447
|
+
:tags,
|
4448
|
+
:statistics_configurations)
|
4200
4449
|
SENSITIVE = []
|
4201
4450
|
include Aws::Structure
|
4202
4451
|
end
|
data/lib/aws-sdk-cloudwatch.rb
CHANGED
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.65.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: 2022-
|
11
|
+
date: 2022-07-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|