You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-cloudwatch/src/CloudWatch.ts
+29-4
Original file line number
Diff line number
Diff line change
@@ -782,13 +782,21 @@ export class CloudWatch extends CloudWatchClient {
782
782
}
783
783
784
784
/**
785
-
* <p>You can use the <code>GetMetricData</code> API to retrieve as many as 500 different
785
+
* <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation
786
+
* can also include a CloudWatch Metrics Insights query, and one or more metric math functions.</p>
787
+
* <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
786
788
* metrics in a single request, with a total of as many as 100,800 data points. You can also
787
-
* optionally perform math expressions on the values of the returned statistics, to create
789
+
* optionally perform metric math expressions on the values of the returned statistics, to create
788
790
* new time series that represent new insights into your data. For example, using Lambda
789
791
* metrics, you could divide the Errors metric by the Invocations metric to get an error
790
792
* rate time series. For more information about metric math expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
791
-
* Guide</i>.</p>
793
+
* Guide</i>.</p>
794
+
*
795
+
*
796
+
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
797
+
* query. But the same <code>GetMetricData</code> operation can also retrieve other metrics. Metrics Insights queries
798
+
* can query only the most recent three hours of metric data. For more information about Metrics Insights,
799
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html">Query your metrics with CloudWatch Metrics Insights</a>.</p>
792
800
*
793
801
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
794
802
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
@@ -818,6 +826,16 @@ export class CloudWatch extends CloudWatchClient {
818
826
* <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
819
827
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
820
828
* If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
829
+
*
830
+
* <p>
831
+
* <b>Using Metrics Insights queries with metric math</b>
832
+
* </p>
833
+
* <p>You can't mix a Metric Insights query and metric math syntax in the same expression, but
834
+
* you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights
835
+
* query without a <b>GROUP BY</b> clause returns a single time-series (TS),
836
+
* and can be used as input for a metric math expression that expects a single time series. A Metrics Insights
837
+
* query with a <b>GROUP BY</b> clause returns an array of time-series (TS[]),
838
+
* and can be used as input for a metric math expression that expects an array of time series. </p>
821
839
*/
822
840
publicgetMetricData(
823
841
args: GetMetricDataCommandInput,
@@ -1196,7 +1214,8 @@ export class CloudWatch extends CloudWatchClient {
1196
1214
* states of other alarms that you have created. The composite alarm goes into ALARM state
1197
1215
* only if all conditions of the rule are met.</p>
1198
1216
* <p>The alarms specified in a composite alarm's rule expression can include metric alarms
1199
-
* and other composite alarms.</p>
1217
+
* and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms.
1218
+
* Any single alarm can be included in the rule expressions of as many as 150 composite alarms.</p>
1200
1219
* <p>Using composite alarms can reduce
1201
1220
* alarm noise. You can create multiple metric alarms,
1202
1221
* and also create a composite alarm and
@@ -1536,6 +1555,12 @@ export class CloudWatch extends CloudWatchClient {
1536
1555
* </li>
1537
1556
* </ul>
1538
1557
*
1558
+
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
1559
+
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use the
1560
+
* <code>StatisticsConfigurations</code> parameter to have
1561
+
* the metric stream also send extended statistics in the stream. Streaming extended statistics incurs
1562
+
* additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
1563
+
*
1539
1564
* <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
1540
1565
* is created in the <code>running</code> state. If you use it to update an existing stream,
* <p>You can use the <code>GetMetricData</code> API to retrieve as many as 500 different
25
+
* <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation
26
+
* can also include a CloudWatch Metrics Insights query, and one or more metric math functions.</p>
27
+
* <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
26
28
* metrics in a single request, with a total of as many as 100,800 data points. You can also
27
-
* optionally perform math expressions on the values of the returned statistics, to create
29
+
* optionally perform metric math expressions on the values of the returned statistics, to create
28
30
* new time series that represent new insights into your data. For example, using Lambda
29
31
* metrics, you could divide the Errors metric by the Invocations metric to get an error
30
32
* rate time series. For more information about metric math expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
31
-
* Guide</i>.</p>
33
+
* Guide</i>.</p>
34
+
*
35
+
*
36
+
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
37
+
* query. But the same <code>GetMetricData</code> operation can also retrieve other metrics. Metrics Insights queries
38
+
* can query only the most recent three hours of metric data. For more information about Metrics Insights,
39
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html">Query your metrics with CloudWatch Metrics Insights</a>.</p>
32
40
*
33
41
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
34
42
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
* <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
59
67
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
60
68
* If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
69
+
*
70
+
* <p>
71
+
* <b>Using Metrics Insights queries with metric math</b>
72
+
* </p>
73
+
* <p>You can't mix a Metric Insights query and metric math syntax in the same expression, but
74
+
* you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights
75
+
* query without a <b>GROUP BY</b> clause returns a single time-series (TS),
76
+
* and can be used as input for a metric math expression that expects a single time series. A Metrics Insights
77
+
* query with a <b>GROUP BY</b> clause returns an array of time-series (TS[]),
78
+
* and can be used as input for a metric math expression that expects an array of time series. </p>
61
79
* @example
62
80
* Use a bare-bones client and the command you need to make an API call.
0 commit comments