@aws-sdk/client-cloudwatch 3.229.0 → 3.231.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.
- package/README.md +0 -2
- package/dist-cjs/endpoint/ruleset.js +1 -10
- package/dist-cjs/models/models_0.js +7 -3
- package/dist-cjs/protocols/Aws_query.js +8 -0
- package/dist-es/endpoint/ruleset.js +1 -10
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_query.js +8 -0
- package/dist-types/CloudWatch.d.ts +112 -148
- package/dist-types/CloudWatchClient.d.ts +2 -4
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +4 -4
- package/dist-types/commands/DeleteInsightRulesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +1 -2
- package/dist-types/commands/GetDashboardCommand.d.ts +1 -1
- package/dist-types/commands/GetInsightRuleReportCommand.d.ts +17 -17
- package/dist-types/commands/GetMetricDataCommand.d.ts +9 -15
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +10 -15
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +7 -9
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +4 -6
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +1 -1
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +10 -12
- package/dist-types/commands/PutDashboardCommand.d.ts +3 -3
- package/dist-types/commands/PutInsightRuleCommand.d.ts +1 -1
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +15 -27
- package/dist-types/commands/PutMetricDataCommand.d.ts +8 -10
- package/dist-types/commands/PutMetricStreamCommand.d.ts +6 -8
- package/dist-types/commands/SetAlarmStateCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +206 -214
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +5 -5
|
@@ -165,15 +165,13 @@ export interface CloudWatchClientResolvedConfig extends CloudWatchClientResolved
|
|
|
165
165
|
* applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
|
|
166
166
|
* metrics, which are the variables you want to measure for your resources and
|
|
167
167
|
* applications.</p>
|
|
168
|
-
*
|
|
169
|
-
* <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
|
|
168
|
+
* <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
|
|
170
169
|
* that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
|
|
171
170
|
* instances. Then, use this data to determine whether you should launch
|
|
172
171
|
* additional instances to handle increased load. You can also use this data to stop
|
|
173
172
|
* under-used instances to save
|
|
174
173
|
* money.</p>
|
|
175
|
-
*
|
|
176
|
-
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
|
|
174
|
+
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
|
|
177
175
|
* your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
|
|
178
176
|
* utilization, application performance, and operational health.</p>
|
|
179
177
|
*/
|
|
@@ -11,17 +11,17 @@ export interface DeleteAlarmsCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more
|
|
12
12
|
* than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't
|
|
13
13
|
* delete two composite alarms with one operation.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>
|
|
15
15
|
* In the event of an error, no alarms are
|
|
16
16
|
* deleted.</p>
|
|
17
|
-
*
|
|
17
|
+
* <note>
|
|
18
18
|
* <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
|
|
19
19
|
* composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle
|
|
20
20
|
* because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>To get out of such a situation, you must
|
|
22
22
|
* break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest
|
|
23
23
|
* change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
|
|
25
25
|
* </p>
|
|
26
26
|
* </note>
|
|
27
27
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface DeleteInsightRulesCommandOutput extends DeleteInsightRulesOutpu
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Permanently deletes the specified Contributor Insights rules.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
|
|
13
13
|
* the rule was created might
|
|
14
14
|
* not be available.</p>
|
|
15
15
|
* @example
|
|
@@ -10,8 +10,8 @@ export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryO
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the history for the specified alarm. You can filter the results by date range or item type.
|
|
12
12
|
* If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
|
|
14
|
+
* <p>To use this operation and return information about a composite alarm, you must be signed on with
|
|
15
15
|
* the <code>cloudwatch:DescribeAlarmHistory</code> permission that is scoped to <code>*</code>. You can't return information
|
|
16
16
|
* about composite alarms if your <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
|
|
17
17
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm
|
|
12
12
|
* name, the alarm state, or a prefix for any action.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To use this operation and return information about composite alarms, you must be signed on with
|
|
14
14
|
* the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to <code>*</code>. You can't return information
|
|
15
15
|
* about composite alarms if your <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
|
|
16
16
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForM
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves the alarms for the specified metric. To
|
|
12
12
|
* filter the results, specify a statistic, period, or unit.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>This operation retrieves only standard alarms that are based on
|
|
14
14
|
* the specified metric. It does not return alarms based on math expressions that
|
|
15
15
|
* use the specified metric, or composite alarms that use the specified metric.</p>
|
|
16
16
|
* @example
|
|
@@ -9,8 +9,7 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns a list of all the Contributor Insights rules in your account.</p>
|
|
12
|
-
*
|
|
13
|
-
* <p>For more information about Contributor Insights, see
|
|
12
|
+
* <p>For more information about Contributor Insights, see
|
|
14
13
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Displays the details of the dashboard that you specify.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned
|
|
13
13
|
* within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create
|
|
14
14
|
* the copy.</p>
|
|
15
15
|
* @example
|
|
@@ -10,40 +10,40 @@ export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportO
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of
|
|
12
12
|
* contributors to the log group.</p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* <p>You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:</p>
|
|
14
|
+
* <ul>
|
|
15
15
|
* <li>
|
|
16
|
-
*
|
|
16
|
+
* <p>
|
|
17
17
|
* <code>UniqueContributors</code> -- the number of unique contributors for each data point.</p>
|
|
18
|
-
*
|
|
18
|
+
* </li>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>
|
|
21
21
|
* <code>MaxContributorValue</code> -- the value of the top contributor for each data point. The identity of the
|
|
22
22
|
* contributor might change for each data point in the graph.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
|
|
24
24
|
* most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified
|
|
25
25
|
* by the rule's <code>Value</code>, during that period.</p>
|
|
26
|
-
*
|
|
26
|
+
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>
|
|
29
29
|
* <code>SampleCount</code> -- the number of data points matched by the rule.</p>
|
|
30
|
-
*
|
|
30
|
+
* </li>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <code>Sum</code> -- the sum of the values from all contributors during the time period represented by that data point.</p>
|
|
34
|
-
*
|
|
34
|
+
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <code>Minimum</code> -- the minimum value from a single observation during the time period represented by that data point.</p>
|
|
38
|
-
*
|
|
38
|
+
* </li>
|
|
39
39
|
* <li>
|
|
40
|
-
*
|
|
40
|
+
* <p>
|
|
41
41
|
* <code>Maximum</code> -- the maximum value from a single observation during the time period represented by that data point.</p>
|
|
42
|
-
*
|
|
42
|
+
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
*
|
|
44
|
+
* <p>
|
|
45
45
|
* <code>Average</code> -- the average value from all contributors during the time period represented by that data point.</p>
|
|
46
|
-
*
|
|
46
|
+
* </li>
|
|
47
47
|
* </ul>
|
|
48
48
|
* @example
|
|
49
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,26 +10,22 @@ export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __Metad
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric values. The operation
|
|
12
12
|
* can also include a CloudWatch Metrics Insights query, and one or more metric math functions.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>A <code>GetMetricData</code> operation that does not include a query can retrieve as many as 500 different
|
|
14
14
|
* metrics in a single request, with a total of as many as 100,800 data points. You can also
|
|
15
15
|
* optionally perform metric math expressions on the values of the returned statistics, to create
|
|
16
16
|
* new time series that represent new insights into your data. For example, using Lambda
|
|
17
17
|
* metrics, you could divide the Errors metric by the Invocations metric to get an error
|
|
18
18
|
* 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
|
|
19
19
|
* Guide</i>.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
|
|
20
|
+
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one
|
|
23
21
|
* query. But the same <code>GetMetricData</code> operation can also retrieve other metrics. Metrics Insights queries
|
|
24
22
|
* can query only the most recent three hours of metric data. For more information about Metrics Insights,
|
|
25
23
|
* 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>
|
|
26
|
-
*
|
|
27
|
-
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
24
|
+
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
28
25
|
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
|
|
29
26
|
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* <ul>
|
|
27
|
+
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
28
|
+
* <ul>
|
|
33
29
|
* <li>
|
|
34
30
|
* <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
|
|
35
31
|
* metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
|
|
@@ -44,19 +40,17 @@ export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __Metad
|
|
|
44
40
|
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
|
|
45
41
|
* </li>
|
|
46
42
|
* </ul>
|
|
47
|
-
*
|
|
43
|
+
* <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
|
|
48
44
|
* data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
|
|
49
45
|
* but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
|
|
50
46
|
* a resolution of 1 hour.</p>
|
|
51
|
-
*
|
|
52
|
-
* <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
|
|
47
|
+
* <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
|
|
53
48
|
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
|
|
54
49
|
* 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>
|
|
55
|
-
*
|
|
56
|
-
* <p>
|
|
50
|
+
* <p>
|
|
57
51
|
* <b>Using Metrics Insights queries with metric math</b>
|
|
58
52
|
* </p>
|
|
59
|
-
*
|
|
53
|
+
* <p>You can't mix a Metric Insights query and metric math syntax in the same expression, but
|
|
60
54
|
* you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights
|
|
61
55
|
* query without a <b>GROUP BY</b> clause returns a single time-series (TS),
|
|
62
56
|
* and can be used as input for a metric math expression that expects a single time series. A Metrics Insights
|
|
@@ -9,24 +9,20 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Gets statistics for the specified metric.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <p>The maximum number of data points returned from a single call is 1,440. If
|
|
12
|
+
* <p>The maximum number of data points returned from a single call is 1,440. If
|
|
16
13
|
* you request more than 1,440 data points, CloudWatch returns an error.
|
|
17
14
|
* To reduce the number of data points, you can narrow the specified time range and make
|
|
18
15
|
* multiple requests across adjacent time ranges, or you can increase the specified period.
|
|
19
16
|
* Data points are not returned in chronological order.</p>
|
|
20
|
-
*
|
|
21
|
-
* <p>CloudWatch aggregates data points based on the length of the period
|
|
17
|
+
* <p>CloudWatch aggregates data points based on the length of the period
|
|
22
18
|
* that you specify. For example, if you request statistics with a one-hour period,
|
|
23
19
|
* CloudWatch aggregates all data points with time stamps that fall within each
|
|
24
20
|
* one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than
|
|
25
21
|
* the number of data points returned.</p>
|
|
26
|
-
*
|
|
22
|
+
* <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
|
|
27
23
|
* data using a statistic set instead, you can only retrieve
|
|
28
24
|
* percentile statistics for this data if one of the following conditions is true:</p>
|
|
29
|
-
*
|
|
25
|
+
* <ul>
|
|
30
26
|
* <li>
|
|
31
27
|
* <p>The SampleCount value of the statistic set is 1.</p>
|
|
32
28
|
* </li>
|
|
@@ -34,9 +30,9 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut
|
|
|
34
30
|
* <p>The Min and the Max values of the statistic set are equal.</p>
|
|
35
31
|
* </li>
|
|
36
32
|
* </ul>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
33
|
+
* <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
|
|
34
|
+
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
35
|
+
* <ul>
|
|
40
36
|
* <li>
|
|
41
37
|
* <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
|
|
42
38
|
* metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
|
|
@@ -51,13 +47,12 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut
|
|
|
51
47
|
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
|
|
52
48
|
* </li>
|
|
53
49
|
* </ul>
|
|
54
|
-
*
|
|
50
|
+
* <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
|
|
55
51
|
* data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
|
|
56
52
|
* but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
|
|
57
53
|
* a resolution of 1 hour.</p>
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
|
|
54
|
+
* <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
|
|
55
|
+
* <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
|
|
61
56
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch Metrics and Dimensions Reference</a> in the
|
|
62
57
|
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
63
58
|
* @example
|
|
@@ -13,18 +13,16 @@ export interface GetMetricWidgetImageCommandOutput extends GetMetricWidgetImageO
|
|
|
13
13
|
* image into your services and products, such as wiki pages, reports, and documents.
|
|
14
14
|
* You could also retrieve images regularly, such as every minute, and create your own
|
|
15
15
|
* custom live dashboard.</p>
|
|
16
|
-
*
|
|
17
|
-
* <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
|
|
16
|
+
* <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
|
|
18
17
|
* and horizontal and vertical annotations.</p>
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* <ul>
|
|
18
|
+
* <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p>
|
|
19
|
+
* <ul>
|
|
22
20
|
* <li>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
21
|
+
* <p>As many as 100 metrics in the graph.</p>
|
|
22
|
+
* </li>
|
|
25
23
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
24
|
+
* <p>Up to 100 KB uncompressed payload.</p>
|
|
25
|
+
* </li>
|
|
28
26
|
* </ul>
|
|
29
27
|
* @example
|
|
30
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,7 @@ export interface ListDashboardsCommandOutput extends ListDashboardsOutput, __Met
|
|
|
12
12
|
* those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are
|
|
13
13
|
* listed.
|
|
14
14
|
* </p>
|
|
15
|
-
*
|
|
15
|
+
* <p>
|
|
16
16
|
* <code>ListDashboards</code> returns up to 1000 results on one page. If there
|
|
17
17
|
* are more than 1000 dashboards, you can call <code>ListDashboards</code> again and
|
|
18
18
|
* include the value you received for <code>NextToken</code> in the first call, to receive
|
|
@@ -9,16 +9,14 @@ export interface ListMetricsCommandOutput extends ListMetricsOutput, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>List the specified metrics. You can use the returned metrics with <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> to get statistical data.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Up to 500 results are returned for any one call. To retrieve additional results,
|
|
13
13
|
* use the returned token with subsequent calls.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>After you create a metric, allow up to 15 minutes for the metric to appear. To see metric
|
|
15
15
|
* statistics sooner, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
|
|
16
|
-
*
|
|
17
|
-
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
16
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
18
17
|
* view metrics from the linked source accounts. For more information, see
|
|
19
18
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
20
|
-
*
|
|
21
|
-
* <p>
|
|
19
|
+
* <p>
|
|
22
20
|
* <code>ListMetrics</code> doesn't return information about metrics if those metrics haven't
|
|
23
21
|
* reported data in the past two weeks. To retrieve those metrics, use
|
|
24
22
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
@@ -10,7 +10,7 @@ export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorOutpu
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates an anomaly detection model for a CloudWatch metric. You can use the model
|
|
12
12
|
* to display a band of expected normal values when the metric is graphed.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html">CloudWatch Anomaly Detection</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -12,42 +12,40 @@ export interface PutCompositeAlarmCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* alarm, you specify a rule expression for the alarm that takes into account the alarm
|
|
13
13
|
* states of other alarms that you have created. The composite alarm goes into ALARM state
|
|
14
14
|
* only if all conditions of the rule are met.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>The alarms specified in a composite alarm's rule expression can include metric alarms
|
|
16
16
|
* and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms.
|
|
17
17
|
* Any single alarm can be included in the rule expressions of as many as 150 composite alarms.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>Using composite alarms can reduce
|
|
19
19
|
* alarm noise. You can create multiple metric alarms,
|
|
20
20
|
* and also create a composite alarm and
|
|
21
21
|
* set up alerts only
|
|
22
22
|
* for the composite alarm. For example, you could create a composite
|
|
23
23
|
* alarm that goes into ALARM state only when more than one of the underlying metric alarms
|
|
24
24
|
* are in ALARM state.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>Currently, the only alarm actions that can be taken by composite alarms are notifying
|
|
26
26
|
* SNS topics.</p>
|
|
27
|
-
*
|
|
27
|
+
* <note>
|
|
28
28
|
* <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
|
|
29
29
|
* composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle
|
|
30
30
|
* because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>To get out of such a situation, you must
|
|
32
32
|
* break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest
|
|
33
33
|
* change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
|
|
34
|
-
*
|
|
34
|
+
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
|
|
35
35
|
* </p>
|
|
36
36
|
* </note>
|
|
37
|
-
*
|
|
37
|
+
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
38
38
|
* <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
|
|
39
39
|
* appropriately. Any actions associated with the new state are then executed. For a
|
|
40
40
|
* composite alarm, this initial time after creation is the only time that
|
|
41
41
|
* the
|
|
42
42
|
* alarm can be in <code>INSUFFICIENT_DATA</code> state.</p>
|
|
43
|
-
*
|
|
43
|
+
* <p>When you update an existing alarm, its state is left unchanged, but the update
|
|
44
44
|
* completely overwrites the previous configuration of the alarm.</p>
|
|
45
|
-
*
|
|
46
|
-
* <p>To use this operation, you must be signed on with
|
|
45
|
+
* <p>To use this operation, you must be signed on with
|
|
47
46
|
* the <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a
|
|
48
47
|
* composite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>
|
|
49
|
-
*
|
|
50
|
-
* <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
|
|
48
|
+
* <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
|
|
51
49
|
* a composite alarm that has Systems Manager OpsItem actions.</p>
|
|
52
50
|
* @example
|
|
53
51
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,14 +10,14 @@ export interface PutDashboardCommandOutput extends PutDashboardOutput, __Metadat
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,
|
|
12
12
|
* the entire contents are replaced with what you specify here.</p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* <p>All dashboards in your account are global, not region-specific.</p>
|
|
14
|
+
* <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an
|
|
15
15
|
* existing dashboard. To copy an existing dashboard using the console, you can load the dashboard
|
|
16
16
|
* and then use the View/edit source command in the Actions menu to display the JSON block
|
|
17
17
|
* for that dashboard. Another way to copy a dashboard is to
|
|
18
18
|
* use <code>GetDashboard</code>, and then use the data returned
|
|
19
19
|
* within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to
|
|
21
21
|
* add a text widget at the top of the dashboard with a message that the dashboard was created by script and should
|
|
22
22
|
* not be changed in the console. This message could also point console users to the location
|
|
23
23
|
* of the <code>DashboardBody</code> script or the CloudFormation template used to create the
|
|
@@ -11,7 +11,7 @@ export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __Met
|
|
|
11
11
|
* <p>Creates a Contributor Insights rule. Rules evaluate log events in a
|
|
12
12
|
* CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information,
|
|
13
13
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
|
|
15
15
|
* the rule was created might not be available.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,50 +9,38 @@ export interface PutMetricAlarmCommandOutput extends __MetadataBearer {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates an alarm and associates it with the specified metric, metric math expression,
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
12
|
+
* anomaly detection model, or Metrics Insights query. For more information about using
|
|
13
|
+
* a Metrics Insights query for an alarm, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create alarms on Metrics Insights queries</a>.</p>
|
|
14
|
+
* <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
|
|
15
|
+
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
17
16
|
* <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
|
|
18
17
|
* appropriately. Any actions associated with the new state are then executed.</p>
|
|
19
|
-
*
|
|
18
|
+
* <p>When you update an existing alarm, its state is left unchanged, but the
|
|
20
19
|
* update completely overwrites the previous configuration of the alarm.</p>
|
|
21
|
-
*
|
|
22
|
-
* <p>If you are an IAM user, you must have
|
|
20
|
+
* <p>If you are an IAM user, you must have
|
|
23
21
|
* Amazon EC2 permissions for some alarm operations:</p>
|
|
24
|
-
*
|
|
22
|
+
* <ul>
|
|
25
23
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* </li>
|
|
24
|
+
* <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
|
|
25
|
+
* </li>
|
|
29
26
|
* <li>
|
|
30
|
-
*
|
|
31
|
-
* <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
|
|
27
|
+
* <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
|
|
32
28
|
* with Systems Manager OpsItem actions.</p>
|
|
33
|
-
*
|
|
29
|
+
* </li>
|
|
34
30
|
* </ul>
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* <p>The first time you create an alarm in the
|
|
31
|
+
* <p>The first time you create an alarm in the
|
|
42
32
|
* Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
|
|
43
33
|
* creates the necessary service-linked role for you. The service-linked roles
|
|
44
34
|
* are called <code>AWSServiceRoleForCloudWatchEvents</code> and
|
|
45
35
|
* <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>.
|
|
46
36
|
* For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
|
|
47
|
-
*
|
|
48
|
-
* <p>
|
|
37
|
+
* <p>
|
|
49
38
|
* <b>Cross-account alarms</b>
|
|
50
39
|
* </p>
|
|
51
|
-
*
|
|
52
|
-
* <p>You can set an alarm on metrics in the current account, or in another
|
|
40
|
+
* <p>You can set an alarm on metrics in the current account, or in another
|
|
53
41
|
* account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following
|
|
54
42
|
* pre-requisites:</p>
|
|
55
|
-
*
|
|
43
|
+
* <ul>
|
|
56
44
|
* <li>
|
|
57
45
|
* <p>The account where the metrics are located (the <i>sharing account</i>) must
|
|
58
46
|
* already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not already
|
|
@@ -12,37 +12,35 @@ export interface PutMetricDataCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* the data points with the specified metric. If the specified metric does not exist,
|
|
13
13
|
* CloudWatch creates the metric. When CloudWatch creates a metric, it can
|
|
14
14
|
* take up to fifteen minutes for the metric to appear in calls to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
|
|
15
|
-
*
|
|
16
|
-
* <p>You can publish either individual data points in the <code>Value</code> field, or
|
|
15
|
+
* <p>You can publish either individual data points in the <code>Value</code> field, or
|
|
17
16
|
* arrays of values and the number of times each value occurred during the period by using the
|
|
18
17
|
* <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using
|
|
19
18
|
* the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric
|
|
20
19
|
* with one <code>PutMetricData</code> request, and
|
|
21
20
|
* supports retrieving percentile statistics on this data.</p>
|
|
22
|
-
*
|
|
21
|
+
* <p>Each <code>PutMetricData</code> request is limited to 1 MB in size for HTTP POST requests. You can
|
|
23
22
|
* send a payload compressed by gzip. Each request
|
|
24
23
|
* is also limited to no more than 1000 different metrics.</p>
|
|
25
|
-
*
|
|
24
|
+
* <p>Although the <code>Value</code> parameter accepts numbers of type
|
|
26
25
|
* <code>Double</code>, CloudWatch rejects values that are either too small
|
|
27
26
|
* or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
|
|
28
27
|
* -Infinity) are not supported.</p>
|
|
29
|
-
*
|
|
28
|
+
* <p>You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension
|
|
30
29
|
* consists of a Name and Value pair. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the
|
|
31
30
|
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
32
|
-
*
|
|
33
|
-
* <p>You specify the time stamp to be associated with each data point. You can specify
|
|
31
|
+
* <p>You specify the time stamp to be associated with each data point. You can specify
|
|
34
32
|
* time stamps that are as much as two weeks before the current date, and as much as 2 hours after
|
|
35
33
|
* the current day and time.</p>
|
|
36
|
-
*
|
|
34
|
+
* <p>Data points with time stamps from 24 hours ago or longer can take at least 48
|
|
37
35
|
* hours to become available for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
38
36
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> from the time they
|
|
39
37
|
* are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available
|
|
40
38
|
* for for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
41
39
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
|
|
42
|
-
*
|
|
40
|
+
* <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
|
|
43
41
|
* data using a statistic set instead, you can only retrieve
|
|
44
42
|
* percentile statistics for this data if one of the following conditions is true:</p>
|
|
45
|
-
*
|
|
43
|
+
* <ul>
|
|
46
44
|
* <li>
|
|
47
45
|
* <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>,
|
|
48
46
|
* <code>Max</code>, and <code>Sum</code> are all equal.</p>
|
|
@@ -11,14 +11,14 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M
|
|
|
11
11
|
* <p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
|
|
12
12
|
* metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
|
|
13
13
|
* solutions.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html">
|
|
15
15
|
* Using Metric Streams</a>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>To create a metric stream, you must be signed in to an account that has the
|
|
17
17
|
* <code>iam:PassRole</code> permission and either the
|
|
18
18
|
* <code>CloudWatchFullAccess</code> policy or the
|
|
19
19
|
* <code>cloudwatch:PutMetricStream</code> permission.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <p>When you create or update a metric stream, you choose one of the following:</p>
|
|
21
|
+
* <ul>
|
|
22
22
|
* <li>
|
|
23
23
|
* <p>Stream metrics from all metric namespaces in the account.</p>
|
|
24
24
|
* </li>
|
|
@@ -31,14 +31,12 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M
|
|
|
31
31
|
* <code>IncludeFilters</code>.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* </ul>
|
|
34
|
-
*
|
|
35
|
-
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
34
|
+
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
36
35
|
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
37
36
|
* streamed. You can use the <code>StatisticsConfigurations</code> parameter to have the
|
|
38
37
|
* metric stream send additional statistics in the stream. Streaming additional statistics
|
|
39
38
|
* incurs additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
|
|
40
|
-
*
|
|
41
|
-
* <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
|
|
39
|
+
* <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
|
|
42
40
|
* is created in the <code>running</code> state. If you use it to update an existing stream,
|
|
43
41
|
* the state of the stream is not changed.</p>
|
|
44
42
|
* @example
|