Skip to content

Commit 30a32a5

Browse files
author
awstools
committed
docs(client-cloudwatch): Updates documentation for additional statistics in CloudWatch Metric Streams.
1 parent e52c79d commit 30a32a5

File tree

4 files changed

+52
-26
lines changed

4 files changed

+52
-26
lines changed

clients/client-cloudwatch/src/CloudWatch.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1558,7 +1558,7 @@ export class CloudWatch extends CloudWatchClient {
15581558
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
15591559
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use the
15601560
* <code>StatisticsConfigurations</code> parameter to have
1561-
* the metric stream also send extended statistics in the stream. Streaming extended statistics incurs
1561+
* the metric stream also send additional statistics in the stream. Streaming additional statistics incurs
15621562
* additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
15631563
*
15641564
* <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream

clients/client-cloudwatch/src/commands/PutMetricStreamCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M
5050
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
5151
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use the
5252
* <code>StatisticsConfigurations</code> parameter to have
53-
* the metric stream also send extended statistics in the stream. Streaming extended statistics incurs
53+
* the metric stream also send additional statistics in the stream. Streaming additional statistics incurs
5454
* additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
5555
*
5656
* <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream

clients/client-cloudwatch/src/models/models_0.ts

+20-15
Original file line numberDiff line numberDiff line change
@@ -2611,12 +2611,12 @@ export enum MetricStreamOutputFormat {
26112611
}
26122612

26132613
/**
2614-
* <p>This object contains the information for one metric that is to streamed with
2615-
* extended statistics.</p>
2614+
* <p>This object contains the information for one metric that is to be streamed with
2615+
* additional statistics.</p>
26162616
*/
26172617
export interface MetricStreamStatisticsMetric {
26182618
/**
2619-
* <p>The metric namespace for the metric.</p>
2619+
* <p>The namespace of the metric.</p>
26202620
*/
26212621
Namespace: string | undefined;
26222622

@@ -2638,29 +2638,29 @@ export namespace MetricStreamStatisticsMetric {
26382638
/**
26392639
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
26402640
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. This structure contains information for
2641-
* one metric that includes extended statistics in the stream. For more information about extended statistics,
2641+
* one metric that includes additional statistics in the stream. For more information about statistics,
26422642
* see CloudWatch, listed in
26432643
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
26442644
* CloudWatch statistics definitions</a>.</p>
26452645
*/
26462646
export interface MetricStreamStatisticsConfiguration {
26472647
/**
2648-
* <p>An array of metric name and namespace pairs that stream the extended statistics listed
2648+
* <p>An array of metric name and namespace pairs that stream the additional statistics listed
26492649
* in the value of the <code>AdditionalStatistics</code> parameter. There can be as many as
26502650
* 100 pairs in the array.</p>
26512651
* <p>All metrics that match the combination of metric name and namespace will be streamed
2652-
* with the extended statistics, no matter their dimensions.</p>
2652+
* with the additional statistics, no matter their dimensions.</p>
26532653
*/
26542654
IncludeMetrics: MetricStreamStatisticsMetric[] | undefined;
26552655

26562656
/**
2657-
* <p>The list of extended statistics that are to be streamed for the metrics listed
2657+
* <p>The list of additional statistics that are to be streamed for the metrics listed
26582658
* in the <code>IncludeMetrics</code> array in this structure. This list can include as many as 20 statistics.</p>
26592659
* <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry0.7</code>, the only
26602660
* valid values are <code>p<i>??</i>
26612661
* </code> percentile statistics such as <code>p90</code>, <code>p99</code> and so on.</p>
26622662
* <p>If the <code>OutputFormat</code> for the stream is <code>json</code>,
2663-
* the valid values are include the abbreviations for all of the extended statistics listed in
2663+
* the valid values include the abbreviations for all of the statistics listed in
26642664
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
26652665
* CloudWatch statistics definitions</a>. For example, this includes
26662666
* <code>tm98, </code>
@@ -2740,8 +2740,8 @@ export interface GetMetricStreamOutput {
27402740
OutputFormat?: MetricStreamOutputFormat | string;
27412741

27422742
/**
2743-
* <p>Each entry in this array displays information about one or more metrics that include extended statistics
2744-
* in the metric stream. For more information about extended statistics, see
2743+
* <p>Each entry in this array displays information about one or more metrics that include additional statistics
2744+
* in the metric stream. For more information about the additional statistics, see
27452745
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
27462746
* CloudWatch statistics definitions</a>. </p>
27472747
*/
@@ -3712,6 +3712,11 @@ export interface PutMetricAlarmInput {
37123712
* Alarms Treats Missing Data</a>.</p>
37133713
* <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>
37143714
* </p>
3715+
* <note>
3716+
* <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always <code>ignore</code>
3717+
* missing data even if you choose a different option for <code>TreatMissingData</code>. When an
3718+
* <code>AWS/DynamoDB</code> metric has missing data, alarms that evaluate that metric remain in their current state.</p>
3719+
* </note>
37153720
*/
37163721
TreatMissingData?: string;
37173722

@@ -3982,15 +3987,15 @@ export interface PutMetricStreamInput {
39823987
/**
39833988
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>,
39843989
* and <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use this parameter to have
3985-
* the metric stream also send extended statistics in the stream. This
3990+
* the metric stream also send additional statistics in the stream. This
39863991
* array can have up to 100 members.</p>
3987-
* <p>For each entry in this array, you specify one or more metrics and the list of extended statistics to stream
3988-
* for those metrics. The extended statistics that you can stream depend on the stream's <code>OutputFormat</code>.
3989-
* If the <code>OutputFormat</code> is <code>json</code>, you can stream any extended statistic that is supported
3992+
* <p>For each entry in this array, you specify one or more metrics and the list of additional statistics to stream
3993+
* for those metrics. The additional statistics that you can stream depend on the stream's <code>OutputFormat</code>.
3994+
* If the <code>OutputFormat</code> is <code>json</code>, you can stream any additional statistic that is supported
39903995
* by CloudWatch, listed in
39913996
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html">
39923997
* CloudWatch statistics definitions</a>. If the <code>OutputFormat</code> is
3993-
* <code>opentelemetry0.7</code>, you can stream percentile statistics (p<i>??</i>).</p>
3998+
* <code>opentelemetry0.7</code>, you can stream percentile statistics such as p95, p99.9 and so on.</p>
39943999
*/
39954000
StatisticsConfigurations?: MetricStreamStatisticsConfiguration[];
39964001
}

0 commit comments

Comments
 (0)