aws-sdk-cloudwatch 1.62.0 → 1.64.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +11 -2
- data/lib/aws-sdk-cloudwatch/client.rb +94 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +22 -0
- data/lib/aws-sdk-cloudwatch/metric.rb +7 -0
- data/lib/aws-sdk-cloudwatch/types.rb +188 -21
- 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: 918f50d5e3f8d43f139fda5f9f3e5cd9b7e5dea0bb93ed7926df40c9d2a5156c
|
|
4
|
+
data.tar.gz: c992a354593a95ba169777d3a1b8e28e2136443796a808166dd8f8fcd2a599c0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3bd904fd9553fd6709653b1f2c4c9e835e8f0871a866871ae259f177fa0a4fe8faacf4385a2bd7e2a5e55b10aea598d986d280ac9ce695c394c75917734925e8
|
|
7
|
+
data.tar.gz: 06e82055db45c57c29cf0dff6a2468b40c887a7dd79b0a2abc89b23ced0b04906dd2f2616b6fad5505b66fbe251133045be966114b4ba30f4c954c0b8123623a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.64.0 (2022-04-14)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Updates documentation for additional statistics in CloudWatch Metric Streams.
|
|
8
|
+
|
|
9
|
+
1.63.0 (2022-04-13)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Adds support for additional statistics in CloudWatch Metric Streams.
|
|
13
|
+
|
|
4
14
|
1.62.0 (2022-02-24)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.64.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]
|
|
@@ -1444,19 +1444,30 @@ module Aws::CloudWatch
|
|
|
1444
1444
|
req.send_request(options)
|
|
1445
1445
|
end
|
|
1446
1446
|
|
|
1447
|
-
# You can use the `GetMetricData` API to retrieve
|
|
1448
|
-
#
|
|
1449
|
-
#
|
|
1450
|
-
#
|
|
1451
|
-
#
|
|
1452
|
-
#
|
|
1453
|
-
#
|
|
1454
|
-
# math expressions
|
|
1455
|
-
#
|
|
1447
|
+
# You can use the `GetMetricData` API to retrieve CloudWatch metric
|
|
1448
|
+
# values. The operation can also include a CloudWatch Metrics Insights
|
|
1449
|
+
# query, and one or more metric math functions.
|
|
1450
|
+
#
|
|
1451
|
+
# A `GetMetricData` operation that does not include a query can retrieve
|
|
1452
|
+
# as many as 500 different metrics in a single request, with a total of
|
|
1453
|
+
# as many as 100,800 data points. You can also optionally perform metric
|
|
1454
|
+
# math expressions on the values of the returned statistics, to create
|
|
1455
|
+
# new time series that represent new insights into your data. For
|
|
1456
|
+
# example, using Lambda metrics, you could divide the Errors metric by
|
|
1457
|
+
# the Invocations metric to get an error rate time series. For more
|
|
1458
|
+
# information about metric math expressions, see [Metric Math Syntax and
|
|
1459
|
+
# Functions][1] in the *Amazon CloudWatch User Guide*.
|
|
1460
|
+
#
|
|
1461
|
+
# If you include a Metrics Insights query, each `GetMetricData`
|
|
1462
|
+
# operation can include only one query. But the same `GetMetricData`
|
|
1463
|
+
# operation can also retrieve other metrics. Metrics Insights queries
|
|
1464
|
+
# can query only the most recent three hours of metric data. For more
|
|
1465
|
+
# information about Metrics Insights, see [Query your metrics with
|
|
1466
|
+
# CloudWatch Metrics Insights][2].
|
|
1456
1467
|
#
|
|
1457
1468
|
# Calls to the `GetMetricData` API have a different pricing structure
|
|
1458
1469
|
# than calls to `GetMetricStatistics`. For more information about
|
|
1459
|
-
# pricing, see [Amazon CloudWatch Pricing][
|
|
1470
|
+
# pricing, see [Amazon CloudWatch Pricing][3].
|
|
1460
1471
|
#
|
|
1461
1472
|
# Amazon CloudWatch retains metric data as follows:
|
|
1462
1473
|
#
|
|
@@ -1490,16 +1501,29 @@ module Aws::CloudWatch
|
|
|
1490
1501
|
# collected, the results of the operation are null. CloudWatch does not
|
|
1491
1502
|
# perform unit conversions.
|
|
1492
1503
|
#
|
|
1504
|
+
# **Using Metrics Insights queries with metric math**
|
|
1505
|
+
#
|
|
1506
|
+
# You can't mix a Metric Insights query and metric math syntax in the
|
|
1507
|
+
# same expression, but you can reference results from a Metrics Insights
|
|
1508
|
+
# query within other Metric math expressions. A Metrics Insights query
|
|
1509
|
+
# without a **GROUP BY** clause returns a single time-series (TS), and
|
|
1510
|
+
# can be used as input for a metric math expression that expects a
|
|
1511
|
+
# single time series. A Metrics Insights query with a **GROUP BY**
|
|
1512
|
+
# clause returns an array of time-series (TS\[\]), and can be used as
|
|
1513
|
+
# input for a metric math expression that expects an array of time
|
|
1514
|
+
# series.
|
|
1515
|
+
#
|
|
1493
1516
|
#
|
|
1494
1517
|
#
|
|
1495
1518
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
|
1496
|
-
# [2]: https://aws.amazon.com/
|
|
1519
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html
|
|
1520
|
+
# [3]: https://aws.amazon.com/cloudwatch/pricing/
|
|
1497
1521
|
#
|
|
1498
1522
|
# @option params [required, Array<Types::MetricDataQuery>] :metric_data_queries
|
|
1499
1523
|
# The metric queries to be returned. A single `GetMetricData` call can
|
|
1500
1524
|
# 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.
|
|
1525
|
+
# structures can specify either a metric to retrieve, a Metrics Insights
|
|
1526
|
+
# query, or a math expression to perform on retrieved data.
|
|
1503
1527
|
#
|
|
1504
1528
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
|
1505
1529
|
# The time stamp indicating the earliest data to be returned.
|
|
@@ -1872,6 +1896,7 @@ module Aws::CloudWatch
|
|
|
1872
1896
|
# * {Types::GetMetricStreamOutput#creation_date #creation_date} => Time
|
|
1873
1897
|
# * {Types::GetMetricStreamOutput#last_update_date #last_update_date} => Time
|
|
1874
1898
|
# * {Types::GetMetricStreamOutput#output_format #output_format} => String
|
|
1899
|
+
# * {Types::GetMetricStreamOutput#statistics_configurations #statistics_configurations} => Array<Types::MetricStreamStatisticsConfiguration>
|
|
1875
1900
|
#
|
|
1876
1901
|
# @example Request syntax with placeholder values
|
|
1877
1902
|
#
|
|
@@ -1893,6 +1918,12 @@ module Aws::CloudWatch
|
|
|
1893
1918
|
# resp.creation_date #=> Time
|
|
1894
1919
|
# resp.last_update_date #=> Time
|
|
1895
1920
|
# resp.output_format #=> String, one of "json", "opentelemetry0.7"
|
|
1921
|
+
# resp.statistics_configurations #=> Array
|
|
1922
|
+
# resp.statistics_configurations[0].include_metrics #=> Array
|
|
1923
|
+
# resp.statistics_configurations[0].include_metrics[0].namespace #=> String
|
|
1924
|
+
# resp.statistics_configurations[0].include_metrics[0].metric_name #=> String
|
|
1925
|
+
# resp.statistics_configurations[0].additional_statistics #=> Array
|
|
1926
|
+
# resp.statistics_configurations[0].additional_statistics[0] #=> String
|
|
1896
1927
|
#
|
|
1897
1928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStream AWS API Documentation
|
|
1898
1929
|
#
|
|
@@ -2370,7 +2401,10 @@ module Aws::CloudWatch
|
|
|
2370
2401
|
# rule are met.
|
|
2371
2402
|
#
|
|
2372
2403
|
# The alarms specified in a composite alarm's rule expression can
|
|
2373
|
-
# include metric alarms and other composite alarms.
|
|
2404
|
+
# include metric alarms and other composite alarms. The rule expression
|
|
2405
|
+
# of a composite alarm can include as many as 100 underlying alarms. Any
|
|
2406
|
+
# single alarm can be included in the rule expressions of as many as 150
|
|
2407
|
+
# composite alarms.
|
|
2374
2408
|
#
|
|
2375
2409
|
# Using composite alarms can reduce alarm noise. You can create multiple
|
|
2376
2410
|
# metric alarms, and also create a composite alarm and set up alerts
|
|
@@ -2936,6 +2970,13 @@ module Aws::CloudWatch
|
|
|
2936
2970
|
#
|
|
2937
2971
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
|
2938
2972
|
#
|
|
2973
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
|
2974
|
+
# `ignore` missing data even if you choose a different option for
|
|
2975
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
|
2976
|
+
# alarms that evaluate that metric remain in their current state.
|
|
2977
|
+
#
|
|
2978
|
+
# </note>
|
|
2979
|
+
#
|
|
2939
2980
|
#
|
|
2940
2981
|
#
|
|
2941
2982
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
|
@@ -3207,6 +3248,13 @@ module Aws::CloudWatch
|
|
|
3207
3248
|
# * Stream metrics from only the metric namespaces that you list in
|
|
3208
3249
|
# `IncludeFilters`.
|
|
3209
3250
|
#
|
|
3251
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
|
3252
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
|
3253
|
+
# the `StatisticsConfigurations` parameter to have the metric stream
|
|
3254
|
+
# also send additional statistics in the stream. Streaming additional
|
|
3255
|
+
# statistics incurs additional costs. For more information, see [Amazon
|
|
3256
|
+
# CloudWatch Pricing][2].
|
|
3257
|
+
#
|
|
3210
3258
|
# When you use `PutMetricStream` to create a new metric stream, the
|
|
3211
3259
|
# stream is created in the `running` state. If you use it to update an
|
|
3212
3260
|
# existing stream, the state of the stream is not changed.
|
|
@@ -3214,6 +3262,7 @@ module Aws::CloudWatch
|
|
|
3214
3262
|
#
|
|
3215
3263
|
#
|
|
3216
3264
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html
|
|
3265
|
+
# [2]: https://aws.amazon.com/cloudwatch/pricing/
|
|
3217
3266
|
#
|
|
3218
3267
|
# @option params [required, String] :name
|
|
3219
3268
|
# If you are creating a new metric stream, this is the name for the new
|
|
@@ -3282,6 +3331,25 @@ module Aws::CloudWatch
|
|
|
3282
3331
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
|
|
3283
3332
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
|
3284
3333
|
#
|
|
3334
|
+
# @option params [Array<Types::MetricStreamStatisticsConfiguration>] :statistics_configurations
|
|
3335
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
|
3336
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
|
3337
|
+
# this parameter to have the metric stream also send additional
|
|
3338
|
+
# statistics in the stream. This array can have up to 100 members.
|
|
3339
|
+
#
|
|
3340
|
+
# For each entry in this array, you specify one or more metrics and the
|
|
3341
|
+
# list of additional statistics to stream for those metrics. The
|
|
3342
|
+
# additional statistics that you can stream depend on the stream's
|
|
3343
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
|
3344
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
|
3345
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
|
3346
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as p95,
|
|
3347
|
+
# p99.9 and so on.
|
|
3348
|
+
#
|
|
3349
|
+
#
|
|
3350
|
+
#
|
|
3351
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
|
3352
|
+
#
|
|
3285
3353
|
# @return [Types::PutMetricStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3286
3354
|
#
|
|
3287
3355
|
# * {Types::PutMetricStreamOutput#arn #arn} => String
|
|
@@ -3309,6 +3377,17 @@ module Aws::CloudWatch
|
|
|
3309
3377
|
# value: "TagValue", # required
|
|
3310
3378
|
# },
|
|
3311
3379
|
# ],
|
|
3380
|
+
# statistics_configurations: [
|
|
3381
|
+
# {
|
|
3382
|
+
# include_metrics: [ # required
|
|
3383
|
+
# {
|
|
3384
|
+
# namespace: "Namespace", # required
|
|
3385
|
+
# metric_name: "MetricName", # required
|
|
3386
|
+
# },
|
|
3387
|
+
# ],
|
|
3388
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
|
3389
|
+
# },
|
|
3390
|
+
# ],
|
|
3312
3391
|
# })
|
|
3313
3392
|
#
|
|
3314
3393
|
# @example Response structure
|
|
@@ -3554,7 +3633,7 @@ module Aws::CloudWatch
|
|
|
3554
3633
|
params: params,
|
|
3555
3634
|
config: config)
|
|
3556
3635
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
|
3557
|
-
context[:gem_version] = '1.
|
|
3636
|
+
context[:gem_version] = '1.64.0'
|
|
3558
3637
|
Seahorse::Client::Request.new(handlers, context)
|
|
3559
3638
|
end
|
|
3560
3639
|
|
|
@@ -193,6 +193,12 @@ module Aws::CloudWatch
|
|
|
193
193
|
MetricStreamNames = Shapes::ListShape.new(name: 'MetricStreamNames')
|
|
194
194
|
MetricStreamOutputFormat = Shapes::StringShape.new(name: 'MetricStreamOutputFormat')
|
|
195
195
|
MetricStreamState = Shapes::StringShape.new(name: 'MetricStreamState')
|
|
196
|
+
MetricStreamStatistic = Shapes::StringShape.new(name: 'MetricStreamStatistic')
|
|
197
|
+
MetricStreamStatisticsAdditionalStatistics = Shapes::ListShape.new(name: 'MetricStreamStatisticsAdditionalStatistics')
|
|
198
|
+
MetricStreamStatisticsConfiguration = Shapes::StructureShape.new(name: 'MetricStreamStatisticsConfiguration')
|
|
199
|
+
MetricStreamStatisticsConfigurations = Shapes::ListShape.new(name: 'MetricStreamStatisticsConfigurations')
|
|
200
|
+
MetricStreamStatisticsIncludeMetrics = Shapes::ListShape.new(name: 'MetricStreamStatisticsIncludeMetrics')
|
|
201
|
+
MetricStreamStatisticsMetric = Shapes::StructureShape.new(name: 'MetricStreamStatisticsMetric')
|
|
196
202
|
MetricWidget = Shapes::StringShape.new(name: 'MetricWidget')
|
|
197
203
|
MetricWidgetImage = Shapes::BlobShape.new(name: 'MetricWidgetImage')
|
|
198
204
|
Metrics = Shapes::ListShape.new(name: 'Metrics')
|
|
@@ -542,6 +548,7 @@ module Aws::CloudWatch
|
|
|
542
548
|
GetMetricStreamOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationDate"))
|
|
543
549
|
GetMetricStreamOutput.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdateDate"))
|
|
544
550
|
GetMetricStreamOutput.add_member(:output_format, Shapes::ShapeRef.new(shape: MetricStreamOutputFormat, location_name: "OutputFormat"))
|
|
551
|
+
GetMetricStreamOutput.add_member(:statistics_configurations, Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfigurations, location_name: "StatisticsConfigurations"))
|
|
545
552
|
GetMetricStreamOutput.struct_class = Types::GetMetricStreamOutput
|
|
546
553
|
|
|
547
554
|
GetMetricWidgetImageInput.add_member(:metric_widget, Shapes::ShapeRef.new(shape: MetricWidget, required: true, location_name: "MetricWidget"))
|
|
@@ -751,6 +758,20 @@ module Aws::CloudWatch
|
|
|
751
758
|
|
|
752
759
|
MetricStreamNames.member = Shapes::ShapeRef.new(shape: MetricStreamName)
|
|
753
760
|
|
|
761
|
+
MetricStreamStatisticsAdditionalStatistics.member = Shapes::ShapeRef.new(shape: MetricStreamStatistic)
|
|
762
|
+
|
|
763
|
+
MetricStreamStatisticsConfiguration.add_member(:include_metrics, Shapes::ShapeRef.new(shape: MetricStreamStatisticsIncludeMetrics, required: true, location_name: "IncludeMetrics"))
|
|
764
|
+
MetricStreamStatisticsConfiguration.add_member(:additional_statistics, Shapes::ShapeRef.new(shape: MetricStreamStatisticsAdditionalStatistics, required: true, location_name: "AdditionalStatistics"))
|
|
765
|
+
MetricStreamStatisticsConfiguration.struct_class = Types::MetricStreamStatisticsConfiguration
|
|
766
|
+
|
|
767
|
+
MetricStreamStatisticsConfigurations.member = Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfiguration)
|
|
768
|
+
|
|
769
|
+
MetricStreamStatisticsIncludeMetrics.member = Shapes::ShapeRef.new(shape: MetricStreamStatisticsMetric)
|
|
770
|
+
|
|
771
|
+
MetricStreamStatisticsMetric.add_member(:namespace, Shapes::ShapeRef.new(shape: Namespace, required: true, location_name: "Namespace"))
|
|
772
|
+
MetricStreamStatisticsMetric.add_member(:metric_name, Shapes::ShapeRef.new(shape: MetricName, required: true, location_name: "MetricName"))
|
|
773
|
+
MetricStreamStatisticsMetric.struct_class = Types::MetricStreamStatisticsMetric
|
|
774
|
+
|
|
754
775
|
Metrics.member = Shapes::ShapeRef.new(shape: Metric)
|
|
755
776
|
|
|
756
777
|
MissingRequiredParameterException.add_member(:message, Shapes::ShapeRef.new(shape: AwsQueryErrorMessage, location_name: "message"))
|
|
@@ -833,6 +854,7 @@ module Aws::CloudWatch
|
|
|
833
854
|
PutMetricStreamInput.add_member(:role_arn, Shapes::ShapeRef.new(shape: AmazonResourceName, required: true, location_name: "RoleArn"))
|
|
834
855
|
PutMetricStreamInput.add_member(:output_format, Shapes::ShapeRef.new(shape: MetricStreamOutputFormat, required: true, location_name: "OutputFormat"))
|
|
835
856
|
PutMetricStreamInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
|
857
|
+
PutMetricStreamInput.add_member(:statistics_configurations, Shapes::ShapeRef.new(shape: MetricStreamStatisticsConfigurations, location_name: "StatisticsConfigurations"))
|
|
836
858
|
PutMetricStreamInput.struct_class = Types::PutMetricStreamInput
|
|
837
859
|
|
|
838
860
|
PutMetricStreamOutput.add_member(:arn, Shapes::ShapeRef.new(shape: AmazonResourceName, location_name: "Arn"))
|
|
@@ -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
|
|
@@ -1031,10 +1031,13 @@ module Aws::CloudWatch
|
|
|
1031
1031
|
end
|
|
1032
1032
|
|
|
1033
1033
|
# A dimension is a name/value pair that is part of the identity of a
|
|
1034
|
-
# metric.
|
|
1035
|
-
#
|
|
1036
|
-
# you
|
|
1037
|
-
#
|
|
1034
|
+
# metric. Because dimensions are part of the unique identifier for a
|
|
1035
|
+
# metric, whenever you add a unique name/value pair to one of your
|
|
1036
|
+
# metrics, you are creating a new variation of that metric. For example,
|
|
1037
|
+
# many Amazon EC2 metrics publish `InstanceId` as a dimension name, and
|
|
1038
|
+
# the actual instance ID as the value for that dimension.
|
|
1039
|
+
#
|
|
1040
|
+
# You can assign up to 10 dimensions to a metric.
|
|
1038
1041
|
#
|
|
1039
1042
|
# @note When making an API call, you may pass Dimension
|
|
1040
1043
|
# data as a hash:
|
|
@@ -1046,7 +1049,8 @@ module Aws::CloudWatch
|
|
|
1046
1049
|
#
|
|
1047
1050
|
# @!attribute [rw] name
|
|
1048
1051
|
# The name of the dimension. Dimension names must contain only ASCII
|
|
1049
|
-
# characters
|
|
1052
|
+
# characters, must include at least one non-whitespace character, and
|
|
1053
|
+
# cannot start with a colon (`:`).
|
|
1050
1054
|
# @return [String]
|
|
1051
1055
|
#
|
|
1052
1056
|
# @!attribute [rw] value
|
|
@@ -1429,8 +1433,8 @@ module Aws::CloudWatch
|
|
|
1429
1433
|
# @!attribute [rw] metric_data_queries
|
|
1430
1434
|
# The metric queries to be returned. A single `GetMetricData` call can
|
|
1431
1435
|
# 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.
|
|
1436
|
+
# structures can specify either a metric to retrieve, a Metrics
|
|
1437
|
+
# Insights query, or a math expression to perform on retrieved data.
|
|
1434
1438
|
# @return [Array<Types::MetricDataQuery>]
|
|
1435
1439
|
#
|
|
1436
1440
|
# @!attribute [rw] start_time
|
|
@@ -1784,8 +1788,26 @@ module Aws::CloudWatch
|
|
|
1784
1788
|
# @return [Time]
|
|
1785
1789
|
#
|
|
1786
1790
|
# @!attribute [rw] output_format
|
|
1791
|
+
# The output format for the stream. Valid values are `json` and
|
|
1792
|
+
# `opentelemetry0.7`. For more information about metric stream output
|
|
1793
|
+
# formats, see [ Metric streams output formats][1].
|
|
1794
|
+
#
|
|
1795
|
+
#
|
|
1796
|
+
#
|
|
1797
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html
|
|
1787
1798
|
# @return [String]
|
|
1788
1799
|
#
|
|
1800
|
+
# @!attribute [rw] statistics_configurations
|
|
1801
|
+
# Each entry in this array displays information about one or more
|
|
1802
|
+
# metrics that include additional statistics in the metric stream. For
|
|
1803
|
+
# more information about the additional statistics, see [ CloudWatch
|
|
1804
|
+
# statistics definitions][1].
|
|
1805
|
+
#
|
|
1806
|
+
#
|
|
1807
|
+
#
|
|
1808
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
|
1809
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
|
1810
|
+
#
|
|
1789
1811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStreamOutput AWS API Documentation
|
|
1790
1812
|
#
|
|
1791
1813
|
class GetMetricStreamOutput < Struct.new(
|
|
@@ -1798,7 +1820,8 @@ module Aws::CloudWatch
|
|
|
1798
1820
|
:state,
|
|
1799
1821
|
:creation_date,
|
|
1800
1822
|
:last_update_date,
|
|
1801
|
-
:output_format
|
|
1823
|
+
:output_format,
|
|
1824
|
+
:statistics_configurations)
|
|
1802
1825
|
SENSITIVE = []
|
|
1803
1826
|
include Aws::Structure
|
|
1804
1827
|
end
|
|
@@ -2592,8 +2615,17 @@ module Aws::CloudWatch
|
|
|
2592
2615
|
# @return [String]
|
|
2593
2616
|
#
|
|
2594
2617
|
# @!attribute [rw] treat_missing_data
|
|
2595
|
-
# Sets how this alarm is to handle missing data points.
|
|
2596
|
-
#
|
|
2618
|
+
# Sets how this alarm is to handle missing data points. The valid
|
|
2619
|
+
# values are `breaching`, `notBreaching`, `ignore`, and `missing`. For
|
|
2620
|
+
# more information, see [Configuring how CloudWatch alarms treat
|
|
2621
|
+
# missing data][1].
|
|
2622
|
+
#
|
|
2623
|
+
# If this parameter is omitted, the default behavior of `missing` is
|
|
2624
|
+
# used.
|
|
2625
|
+
#
|
|
2626
|
+
#
|
|
2627
|
+
#
|
|
2628
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
|
2597
2629
|
# @return [String]
|
|
2598
2630
|
#
|
|
2599
2631
|
# @!attribute [rw] evaluate_low_sample_count_percentile
|
|
@@ -2658,9 +2690,9 @@ module Aws::CloudWatch
|
|
|
2658
2690
|
#
|
|
2659
2691
|
# When used in `GetMetricData`, it indicates the metric data to return,
|
|
2660
2692
|
# 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.
|
|
2693
|
+
# metric, or is performing a Metrics Insights query or a math
|
|
2694
|
+
# expression. A single `GetMetricData` call can include up to 500
|
|
2695
|
+
# `MetricDataQuery` structures.
|
|
2664
2696
|
#
|
|
2665
2697
|
# When used in `PutMetricAlarm`, it enables you to create an alarm based
|
|
2666
2698
|
# on a metric math expression. Each `MetricDataQuery` in the array
|
|
@@ -2733,20 +2765,25 @@ module Aws::CloudWatch
|
|
|
2733
2765
|
# @return [Types::MetricStat]
|
|
2734
2766
|
#
|
|
2735
2767
|
# @!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
|
|
2768
|
+
# This field can contain either a Metrics Insights query, or a metric
|
|
2769
|
+
# math expression to be performed on the returned data. For more
|
|
2770
|
+
# information about Metrics Insights queries, see [Metrics Insights
|
|
2771
|
+
# query components and syntax][1] in the *Amazon CloudWatch User
|
|
2742
2772
|
# Guide*.
|
|
2743
2773
|
#
|
|
2774
|
+
# A math expression can use the `Id` of the other metrics or queries
|
|
2775
|
+
# to refer to those metrics, and can also use the `Id` of other
|
|
2776
|
+
# expressions to use the result of those expressions. For more
|
|
2777
|
+
# information about metric math expressions, see [Metric Math Syntax
|
|
2778
|
+
# and Functions][2] in the *Amazon CloudWatch User Guide*.
|
|
2779
|
+
#
|
|
2744
2780
|
# Within each MetricDataQuery object, you must specify either
|
|
2745
2781
|
# `Expression` or `MetricStat` but not both.
|
|
2746
2782
|
#
|
|
2747
2783
|
#
|
|
2748
2784
|
#
|
|
2749
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/
|
|
2785
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage
|
|
2786
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
|
2750
2787
|
# @return [String]
|
|
2751
2788
|
#
|
|
2752
2789
|
# @!attribute [rw] label
|
|
@@ -3188,6 +3225,96 @@ module Aws::CloudWatch
|
|
|
3188
3225
|
include Aws::Structure
|
|
3189
3226
|
end
|
|
3190
3227
|
|
|
3228
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
|
3229
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. This
|
|
3230
|
+
# structure contains information for one metric that includes additional
|
|
3231
|
+
# statistics in the stream. For more information about statistics, see
|
|
3232
|
+
# CloudWatch, listed in [ CloudWatch statistics definitions][1].
|
|
3233
|
+
#
|
|
3234
|
+
#
|
|
3235
|
+
#
|
|
3236
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
|
3237
|
+
#
|
|
3238
|
+
# @note When making an API call, you may pass MetricStreamStatisticsConfiguration
|
|
3239
|
+
# data as a hash:
|
|
3240
|
+
#
|
|
3241
|
+
# {
|
|
3242
|
+
# include_metrics: [ # required
|
|
3243
|
+
# {
|
|
3244
|
+
# namespace: "Namespace", # required
|
|
3245
|
+
# metric_name: "MetricName", # required
|
|
3246
|
+
# },
|
|
3247
|
+
# ],
|
|
3248
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
|
3249
|
+
# }
|
|
3250
|
+
#
|
|
3251
|
+
# @!attribute [rw] include_metrics
|
|
3252
|
+
# An array of metric name and namespace pairs that stream the
|
|
3253
|
+
# additional statistics listed in the value of the
|
|
3254
|
+
# `AdditionalStatistics` parameter. There can be as many as 100 pairs
|
|
3255
|
+
# in the array.
|
|
3256
|
+
#
|
|
3257
|
+
# All metrics that match the combination of metric name and namespace
|
|
3258
|
+
# will be streamed with the additional statistics, no matter their
|
|
3259
|
+
# dimensions.
|
|
3260
|
+
# @return [Array<Types::MetricStreamStatisticsMetric>]
|
|
3261
|
+
#
|
|
3262
|
+
# @!attribute [rw] additional_statistics
|
|
3263
|
+
# The list of additional statistics that are to be streamed for the
|
|
3264
|
+
# metrics listed in the `IncludeMetrics` array in this structure. This
|
|
3265
|
+
# list can include as many as 20 statistics.
|
|
3266
|
+
#
|
|
3267
|
+
# If the `OutputFormat` for the stream is `opentelemetry0.7`, the only
|
|
3268
|
+
# valid values are `p?? ` percentile statistics such as `p90`, `p99`
|
|
3269
|
+
# and so on.
|
|
3270
|
+
#
|
|
3271
|
+
# If the `OutputFormat` for the stream is `json`, the valid values
|
|
3272
|
+
# include the abbreviations for all of the statistics listed in [
|
|
3273
|
+
# CloudWatch statistics definitions][1]. For example, this includes
|
|
3274
|
+
# `tm98, ` `wm90`, `PR(:300)`, and so on.
|
|
3275
|
+
#
|
|
3276
|
+
#
|
|
3277
|
+
#
|
|
3278
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
|
3279
|
+
# @return [Array<String>]
|
|
3280
|
+
#
|
|
3281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsConfiguration AWS API Documentation
|
|
3282
|
+
#
|
|
3283
|
+
class MetricStreamStatisticsConfiguration < Struct.new(
|
|
3284
|
+
:include_metrics,
|
|
3285
|
+
:additional_statistics)
|
|
3286
|
+
SENSITIVE = []
|
|
3287
|
+
include Aws::Structure
|
|
3288
|
+
end
|
|
3289
|
+
|
|
3290
|
+
# This object contains the information for one metric that is to be
|
|
3291
|
+
# streamed with additional statistics.
|
|
3292
|
+
#
|
|
3293
|
+
# @note When making an API call, you may pass MetricStreamStatisticsMetric
|
|
3294
|
+
# data as a hash:
|
|
3295
|
+
#
|
|
3296
|
+
# {
|
|
3297
|
+
# namespace: "Namespace", # required
|
|
3298
|
+
# metric_name: "MetricName", # required
|
|
3299
|
+
# }
|
|
3300
|
+
#
|
|
3301
|
+
# @!attribute [rw] namespace
|
|
3302
|
+
# The namespace of the metric.
|
|
3303
|
+
# @return [String]
|
|
3304
|
+
#
|
|
3305
|
+
# @!attribute [rw] metric_name
|
|
3306
|
+
# The name of the metric.
|
|
3307
|
+
# @return [String]
|
|
3308
|
+
#
|
|
3309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStreamStatisticsMetric AWS API Documentation
|
|
3310
|
+
#
|
|
3311
|
+
class MetricStreamStatisticsMetric < Struct.new(
|
|
3312
|
+
:namespace,
|
|
3313
|
+
:metric_name)
|
|
3314
|
+
SENSITIVE = []
|
|
3315
|
+
include Aws::Structure
|
|
3316
|
+
end
|
|
3317
|
+
|
|
3191
3318
|
# An input parameter that is required is missing.
|
|
3192
3319
|
#
|
|
3193
3320
|
# @!attribute [rw] message
|
|
@@ -3929,6 +4056,13 @@ module Aws::CloudWatch
|
|
|
3929
4056
|
#
|
|
3930
4057
|
# Valid Values: `breaching | notBreaching | ignore | missing`
|
|
3931
4058
|
#
|
|
4059
|
+
# <note markdown="1"> Alarms that evaluate metrics in the `AWS/DynamoDB` namespace always
|
|
4060
|
+
# `ignore` missing data even if you choose a different option for
|
|
4061
|
+
# `TreatMissingData`. When an `AWS/DynamoDB` metric has missing data,
|
|
4062
|
+
# alarms that evaluate that metric remain in their current state.
|
|
4063
|
+
#
|
|
4064
|
+
# </note>
|
|
4065
|
+
#
|
|
3932
4066
|
#
|
|
3933
4067
|
#
|
|
3934
4068
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data
|
|
@@ -4109,6 +4243,17 @@ module Aws::CloudWatch
|
|
|
4109
4243
|
# value: "TagValue", # required
|
|
4110
4244
|
# },
|
|
4111
4245
|
# ],
|
|
4246
|
+
# statistics_configurations: [
|
|
4247
|
+
# {
|
|
4248
|
+
# include_metrics: [ # required
|
|
4249
|
+
# {
|
|
4250
|
+
# namespace: "Namespace", # required
|
|
4251
|
+
# metric_name: "MetricName", # required
|
|
4252
|
+
# },
|
|
4253
|
+
# ],
|
|
4254
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
|
4255
|
+
# },
|
|
4256
|
+
# ],
|
|
4112
4257
|
# }
|
|
4113
4258
|
#
|
|
4114
4259
|
# @!attribute [rw] name
|
|
@@ -4187,6 +4332,27 @@ module Aws::CloudWatch
|
|
|
4187
4332
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
|
4188
4333
|
# @return [Array<Types::Tag>]
|
|
4189
4334
|
#
|
|
4335
|
+
# @!attribute [rw] statistics_configurations
|
|
4336
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`,
|
|
4337
|
+
# and `SAMPLECOUNT` statistics for each metric that is streamed. You
|
|
4338
|
+
# can use this parameter to have the metric stream also send
|
|
4339
|
+
# additional statistics in the stream. This array can have up to 100
|
|
4340
|
+
# members.
|
|
4341
|
+
#
|
|
4342
|
+
# For each entry in this array, you specify one or more metrics and
|
|
4343
|
+
# the list of additional statistics to stream for those metrics. The
|
|
4344
|
+
# additional statistics that you can stream depend on the stream's
|
|
4345
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
|
4346
|
+
# additional statistic that is supported by CloudWatch, listed in [
|
|
4347
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
|
4348
|
+
# `opentelemetry0.7`, you can stream percentile statistics such as
|
|
4349
|
+
# p95, p99.9 and so on.
|
|
4350
|
+
#
|
|
4351
|
+
#
|
|
4352
|
+
#
|
|
4353
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
|
4354
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
|
4355
|
+
#
|
|
4190
4356
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation
|
|
4191
4357
|
#
|
|
4192
4358
|
class PutMetricStreamInput < Struct.new(
|
|
@@ -4196,7 +4362,8 @@ module Aws::CloudWatch
|
|
|
4196
4362
|
:firehose_arn,
|
|
4197
4363
|
:role_arn,
|
|
4198
4364
|
:output_format,
|
|
4199
|
-
:tags
|
|
4365
|
+
:tags,
|
|
4366
|
+
:statistics_configurations)
|
|
4200
4367
|
SENSITIVE = []
|
|
4201
4368
|
include Aws::Structure
|
|
4202
4369
|
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.64.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-04-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|