aws-sdk-cloudwatch 1.60.0 → 1.63.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +11 -2
- data/lib/aws-sdk-cloudwatch/client.rb +90 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +22 -0
- data/lib/aws-sdk-cloudwatch/types.rb +179 -21
- data/lib/aws-sdk-cloudwatch.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8700346d69df22798982a45c12299f596cb8b9d20e0a6bd5c877182748f3295a
|
4
|
+
data.tar.gz: fdc16e10869b1f84c67dd3f0f4d270487547b7afdb47847ed3571b46842a8e19
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 80c6f183c2fdbab2f176c2d6eb3d862c7943ceafbad4e2b84c0af71009fbf47f6f6ae379c0d700248f57f22a81e9016e4a13cc310f1b1c66020be8af1a765386
|
7
|
+
data.tar.gz: edfd3e9952ed03e71c8db8d099a79fed3bb8dd32e554bdabc53337a76e8660312b9c444065a67f38a854a0a224667a78aff7d2df4ddb239cf303683dc4c178b1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.63.0 (2022-04-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds support for additional statistics in CloudWatch Metric Streams.
|
8
|
+
|
9
|
+
1.62.0 (2022-02-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.61.0 (2022-02-03)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
4
19
|
1.60.0 (2021-12-21)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.63.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]
|
@@ -27,7 +27,9 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
31
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
32
34
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
33
35
|
|
@@ -74,7 +76,9 @@ module Aws::CloudWatch
|
|
74
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
75
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
76
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
77
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
78
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
79
83
|
add_plugin(Aws::Plugins::Protocols::Query)
|
80
84
|
|
@@ -1440,19 +1444,30 @@ module Aws::CloudWatch
|
|
1440
1444
|
req.send_request(options)
|
1441
1445
|
end
|
1442
1446
|
|
1443
|
-
# You can use the `GetMetricData` API to retrieve
|
1444
|
-
#
|
1445
|
-
#
|
1446
|
-
#
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
# math expressions
|
1451
|
-
#
|
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].
|
1452
1467
|
#
|
1453
1468
|
# Calls to the `GetMetricData` API have a different pricing structure
|
1454
1469
|
# than calls to `GetMetricStatistics`. For more information about
|
1455
|
-
# pricing, see [Amazon CloudWatch Pricing][
|
1470
|
+
# pricing, see [Amazon CloudWatch Pricing][3].
|
1456
1471
|
#
|
1457
1472
|
# Amazon CloudWatch retains metric data as follows:
|
1458
1473
|
#
|
@@ -1486,16 +1501,29 @@ module Aws::CloudWatch
|
|
1486
1501
|
# collected, the results of the operation are null. CloudWatch does not
|
1487
1502
|
# perform unit conversions.
|
1488
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
|
+
#
|
1489
1516
|
#
|
1490
1517
|
#
|
1491
1518
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax
|
1492
|
-
# [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/
|
1493
1521
|
#
|
1494
1522
|
# @option params [required, Array<Types::MetricDataQuery>] :metric_data_queries
|
1495
1523
|
# The metric queries to be returned. A single `GetMetricData` call can
|
1496
1524
|
# include as many as 500 `MetricDataQuery` structures. Each of these
|
1497
|
-
# structures can specify either a metric to retrieve,
|
1498
|
-
# 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.
|
1499
1527
|
#
|
1500
1528
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1501
1529
|
# The time stamp indicating the earliest data to be returned.
|
@@ -1868,6 +1896,7 @@ module Aws::CloudWatch
|
|
1868
1896
|
# * {Types::GetMetricStreamOutput#creation_date #creation_date} => Time
|
1869
1897
|
# * {Types::GetMetricStreamOutput#last_update_date #last_update_date} => Time
|
1870
1898
|
# * {Types::GetMetricStreamOutput#output_format #output_format} => String
|
1899
|
+
# * {Types::GetMetricStreamOutput#statistics_configurations #statistics_configurations} => Array<Types::MetricStreamStatisticsConfiguration>
|
1871
1900
|
#
|
1872
1901
|
# @example Request syntax with placeholder values
|
1873
1902
|
#
|
@@ -1889,6 +1918,12 @@ module Aws::CloudWatch
|
|
1889
1918
|
# resp.creation_date #=> Time
|
1890
1919
|
# resp.last_update_date #=> Time
|
1891
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
|
1892
1927
|
#
|
1893
1928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStream AWS API Documentation
|
1894
1929
|
#
|
@@ -2366,7 +2401,10 @@ module Aws::CloudWatch
|
|
2366
2401
|
# rule are met.
|
2367
2402
|
#
|
2368
2403
|
# The alarms specified in a composite alarm's rule expression can
|
2369
|
-
# 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.
|
2370
2408
|
#
|
2371
2409
|
# Using composite alarms can reduce alarm noise. You can create multiple
|
2372
2410
|
# metric alarms, and also create a composite alarm and set up alerts
|
@@ -3203,6 +3241,13 @@ module Aws::CloudWatch
|
|
3203
3241
|
# * Stream metrics from only the metric namespaces that you list in
|
3204
3242
|
# `IncludeFilters`.
|
3205
3243
|
#
|
3244
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3245
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3246
|
+
# the `StatisticsConfigurations` parameter to have the metric stream
|
3247
|
+
# also send extended statistics in the stream. Streaming extended
|
3248
|
+
# statistics incurs additional costs. For more information, see [Amazon
|
3249
|
+
# CloudWatch Pricing][2].
|
3250
|
+
#
|
3206
3251
|
# When you use `PutMetricStream` to create a new metric stream, the
|
3207
3252
|
# stream is created in the `running` state. If you use it to update an
|
3208
3253
|
# existing stream, the state of the stream is not changed.
|
@@ -3210,6 +3255,7 @@ module Aws::CloudWatch
|
|
3210
3255
|
#
|
3211
3256
|
#
|
3212
3257
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html
|
3258
|
+
# [2]: https://aws.amazon.com/cloudwatch/pricing/
|
3213
3259
|
#
|
3214
3260
|
# @option params [required, String] :name
|
3215
3261
|
# If you are creating a new metric stream, this is the name for the new
|
@@ -3278,6 +3324,24 @@ module Aws::CloudWatch
|
|
3278
3324
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
|
3279
3325
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
3280
3326
|
#
|
3327
|
+
# @option params [Array<Types::MetricStreamStatisticsConfiguration>] :statistics_configurations
|
3328
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`, and
|
3329
|
+
# `SAMPLECOUNT` statistics for each metric that is streamed. You can use
|
3330
|
+
# this parameter to have the metric stream also send extended statistics
|
3331
|
+
# in the stream. This array can have up to 100 members.
|
3332
|
+
#
|
3333
|
+
# For each entry in this array, you specify one or more metrics and the
|
3334
|
+
# list of extended statistics to stream for those metrics. The extended
|
3335
|
+
# statistics that you can stream depend on the stream's `OutputFormat`.
|
3336
|
+
# If the `OutputFormat` is `json`, you can stream any extended statistic
|
3337
|
+
# that is supported by CloudWatch, listed in [ CloudWatch statistics
|
3338
|
+
# definitions][1]. If the `OutputFormat` is `opentelemetry0.7`, you can
|
3339
|
+
# stream percentile statistics (p*??*).
|
3340
|
+
#
|
3341
|
+
#
|
3342
|
+
#
|
3343
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3344
|
+
#
|
3281
3345
|
# @return [Types::PutMetricStreamOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3282
3346
|
#
|
3283
3347
|
# * {Types::PutMetricStreamOutput#arn #arn} => String
|
@@ -3305,6 +3369,17 @@ module Aws::CloudWatch
|
|
3305
3369
|
# value: "TagValue", # required
|
3306
3370
|
# },
|
3307
3371
|
# ],
|
3372
|
+
# statistics_configurations: [
|
3373
|
+
# {
|
3374
|
+
# include_metrics: [ # required
|
3375
|
+
# {
|
3376
|
+
# namespace: "Namespace", # required
|
3377
|
+
# metric_name: "MetricName", # required
|
3378
|
+
# },
|
3379
|
+
# ],
|
3380
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
3381
|
+
# },
|
3382
|
+
# ],
|
3308
3383
|
# })
|
3309
3384
|
#
|
3310
3385
|
# @example Response structure
|
@@ -3550,7 +3625,7 @@ module Aws::CloudWatch
|
|
3550
3625
|
params: params,
|
3551
3626
|
config: config)
|
3552
3627
|
context[:gem_name] = 'aws-sdk-cloudwatch'
|
3553
|
-
context[:gem_version] = '1.
|
3628
|
+
context[:gem_version] = '1.63.0'
|
3554
3629
|
Seahorse::Client::Request.new(handlers, context)
|
3555
3630
|
end
|
3556
3631
|
|
@@ -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"))
|
@@ -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 extended statistics in the metric stream. For
|
1803
|
+
# more information about extended 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 extended
|
3231
|
+
# statistics in the stream. For more information about extended
|
3232
|
+
# statistics, see CloudWatch, listed in [ CloudWatch statistics
|
3233
|
+
# definitions][1].
|
3234
|
+
#
|
3235
|
+
#
|
3236
|
+
#
|
3237
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
3238
|
+
#
|
3239
|
+
# @note When making an API call, you may pass MetricStreamStatisticsConfiguration
|
3240
|
+
# data as a hash:
|
3241
|
+
#
|
3242
|
+
# {
|
3243
|
+
# include_metrics: [ # required
|
3244
|
+
# {
|
3245
|
+
# namespace: "Namespace", # required
|
3246
|
+
# metric_name: "MetricName", # required
|
3247
|
+
# },
|
3248
|
+
# ],
|
3249
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
3250
|
+
# }
|
3251
|
+
#
|
3252
|
+
# @!attribute [rw] include_metrics
|
3253
|
+
# An array of metric name and namespace pairs that stream the extended
|
3254
|
+
# statistics listed in the value of the `AdditionalStatistics`
|
3255
|
+
# parameter. There can be as many as 100 pairs in the array.
|
3256
|
+
#
|
3257
|
+
# All metrics that match the combination of metric name and namespace
|
3258
|
+
# will be streamed with the extended statistics, no matter their
|
3259
|
+
# dimensions.
|
3260
|
+
# @return [Array<Types::MetricStreamStatisticsMetric>]
|
3261
|
+
#
|
3262
|
+
# @!attribute [rw] additional_statistics
|
3263
|
+
# The list of extended 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 are
|
3272
|
+
# include the abbreviations for all of the extended statistics listed
|
3273
|
+
# in [ CloudWatch statistics definitions][1]. For example, this
|
3274
|
+
# includes `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
|
3291
|
+
# streamed with extended 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 metric namespace for 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
|
@@ -4109,6 +4236,17 @@ module Aws::CloudWatch
|
|
4109
4236
|
# value: "TagValue", # required
|
4110
4237
|
# },
|
4111
4238
|
# ],
|
4239
|
+
# statistics_configurations: [
|
4240
|
+
# {
|
4241
|
+
# include_metrics: [ # required
|
4242
|
+
# {
|
4243
|
+
# namespace: "Namespace", # required
|
4244
|
+
# metric_name: "MetricName", # required
|
4245
|
+
# },
|
4246
|
+
# ],
|
4247
|
+
# additional_statistics: ["MetricStreamStatistic"], # required
|
4248
|
+
# },
|
4249
|
+
# ],
|
4112
4250
|
# }
|
4113
4251
|
#
|
4114
4252
|
# @!attribute [rw] name
|
@@ -4187,6 +4325,25 @@ module Aws::CloudWatch
|
|
4187
4325
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html
|
4188
4326
|
# @return [Array<Types::Tag>]
|
4189
4327
|
#
|
4328
|
+
# @!attribute [rw] statistics_configurations
|
4329
|
+
# By default, a metric stream always sends the `MAX`, `MIN`, `SUM`,
|
4330
|
+
# and `SAMPLECOUNT` statistics for each metric that is streamed. You
|
4331
|
+
# can use this parameter to have the metric stream also send extended
|
4332
|
+
# statistics in the stream. This array can have up to 100 members.
|
4333
|
+
#
|
4334
|
+
# For each entry in this array, you specify one or more metrics and
|
4335
|
+
# the list of extended statistics to stream for those metrics. The
|
4336
|
+
# extended statistics that you can stream depend on the stream's
|
4337
|
+
# `OutputFormat`. If the `OutputFormat` is `json`, you can stream any
|
4338
|
+
# extended statistic that is supported by CloudWatch, listed in [
|
4339
|
+
# CloudWatch statistics definitions][1]. If the `OutputFormat` is
|
4340
|
+
# `opentelemetry0.7`, you can stream percentile statistics (p*??*).
|
4341
|
+
#
|
4342
|
+
#
|
4343
|
+
#
|
4344
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html
|
4345
|
+
# @return [Array<Types::MetricStreamStatisticsConfiguration>]
|
4346
|
+
#
|
4190
4347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStreamInput AWS API Documentation
|
4191
4348
|
#
|
4192
4349
|
class PutMetricStreamInput < Struct.new(
|
@@ -4196,7 +4353,8 @@ module Aws::CloudWatch
|
|
4196
4353
|
:firehose_arn,
|
4197
4354
|
:role_arn,
|
4198
4355
|
:output_format,
|
4199
|
-
:tags
|
4356
|
+
:tags,
|
4357
|
+
:statistics_configurations)
|
4200
4358
|
SENSITIVE = []
|
4201
4359
|
include Aws::Structure
|
4202
4360
|
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.63.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:
|
11
|
+
date: 2022-04-13 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.127.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.127.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|