@aws-sdk/client-cloudwatch 3.692.0 → 3.694.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 +13 -13
- package/dist-cjs/index.js +110 -17
- package/dist-es/protocols/Aws_query.js +112 -16
- package/dist-types/CloudWatch.d.ts +13 -13
- package/dist-types/CloudWatchClient.d.ts +13 -13
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +18 -16
- package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +5 -10
- package/dist-types/commands/DeleteDashboardsCommand.d.ts +4 -4
- package/dist-types/commands/DeleteInsightRulesCommand.d.ts +2 -3
- package/dist-types/commands/DeleteMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +7 -5
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +6 -5
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +2 -2
- package/dist-types/commands/DisableAlarmActionsCommand.d.ts +2 -2
- package/dist-types/commands/DisableInsightRulesCommand.d.ts +2 -2
- package/dist-types/commands/EnableInsightRulesCommand.d.ts +2 -1
- package/dist-types/commands/GetDashboardCommand.d.ts +5 -4
- package/dist-types/commands/GetInsightRuleReportCommand.d.ts +23 -14
- package/dist-types/commands/GetMetricDataCommand.d.ts +50 -34
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +38 -27
- package/dist-types/commands/GetMetricStreamCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +9 -8
- package/dist-types/commands/ListDashboardsCommand.d.ts +9 -9
- package/dist-types/commands/ListManagedInsightRulesCommand.d.ts +3 -6
- package/dist-types/commands/ListMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/ListMetricsCommand.d.ts +10 -11
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +8 -6
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +33 -31
- package/dist-types/commands/PutDashboardCommand.d.ts +15 -12
- package/dist-types/commands/PutInsightRuleCommand.d.ts +6 -5
- package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +9 -16
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +32 -35
- package/dist-types/commands/PutMetricDataCommand.d.ts +85 -38
- package/dist-types/commands/PutMetricStreamCommand.d.ts +22 -21
- package/dist-types/commands/SetAlarmStateCommand.d.ts +16 -16
- package/dist-types/commands/StartMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/StopMetricStreamsCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +15 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/index.d.ts +13 -13
- package/dist-types/models/models_0.d.ts +1312 -1203
- package/dist-types/ts3.4/models/models_0.d.ts +28 -18
- package/package.json +13 -13
|
@@ -28,9 +28,8 @@ declare const DeleteInsightRulesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Permanently deletes the specified Contributor Insights rules.</p>
|
|
31
|
-
* <p>If you create a rule, delete it, and then re-create it with the same name, historical
|
|
32
|
-
*
|
|
33
|
-
* not be available.</p>
|
|
31
|
+
* <p>If you create a rule, delete it, and then re-create it with the same name, historical
|
|
32
|
+
* data from the first time the rule was created might not be available.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -50,7 +50,8 @@ declare const DeleteMetricStreamCommand_base: {
|
|
|
50
50
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
51
51
|
*
|
|
52
52
|
* @throws {@link InternalServiceFault} (server fault)
|
|
53
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
53
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
54
|
+
* failure.</p>
|
|
54
55
|
*
|
|
55
56
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
56
57
|
* <p>The value of an input parameter is bad or out-of-range.</p>
|
|
@@ -27,12 +27,14 @@ declare const DescribeAlarmHistoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the history for the specified alarm. You can filter the results by date
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves the history for the specified alarm. You can filter the results by date
|
|
31
|
+
* range or item type. If an alarm name is not specified, the histories for either all
|
|
32
|
+
* metric alarms or all composite alarms are returned.</p>
|
|
32
33
|
* <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
|
|
33
|
-
* <p>To use this operation and return information about a composite alarm, you must be
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <p>To use this operation and return information about a composite alarm, you must be
|
|
35
|
+
* signed on with the <code>cloudwatch:DescribeAlarmHistory</code> permission that is
|
|
36
|
+
* scoped to <code>*</code>. You can't return information about composite alarms if your
|
|
37
|
+
* <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
|
|
36
38
|
* @example
|
|
37
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
40
|
* ```javascript
|
|
@@ -27,11 +27,12 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the specified alarms. You can filter the results by specifying a prefix
|
|
31
|
-
*
|
|
32
|
-
* <p>To use this operation and return information about composite alarms, you must be
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Retrieves the specified alarms. You can filter the results by specifying a prefix
|
|
31
|
+
* for the alarm name, the alarm state, or a prefix for any action.</p>
|
|
32
|
+
* <p>To use this operation and return information about composite alarms, you must be
|
|
33
|
+
* signed on with the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to
|
|
34
|
+
* <code>*</code>. You can't return information about composite alarms if your
|
|
35
|
+
* <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -27,11 +27,11 @@ declare const DescribeAlarmsForMetricCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves the alarms for the specified metric. To
|
|
31
|
-
*
|
|
32
|
-
* <p>This operation retrieves only standard alarms that are based on
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>Retrieves the alarms for the specified metric. To filter the results, specify a
|
|
31
|
+
* statistic, period, or unit.</p>
|
|
32
|
+
* <p>This operation retrieves only standard alarms that are based on the specified
|
|
33
|
+
* metric. It does not return alarms based on math expressions that use the specified
|
|
34
|
+
* metric, or composite alarms that use the specified metric.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -27,13 +27,12 @@ declare const DescribeAnomalyDetectorsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the anomaly detection models that you have created in your account.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* This will return all metric math anomaly detectors in your account.</p>
|
|
30
|
+
* <p>Lists the anomaly detection models that you have created in your account. For single
|
|
31
|
+
* metric anomaly detectors, you can list all of the models in your account or filter the
|
|
32
|
+
* results to only the models that are related to a certain namespace, metric name, or
|
|
33
|
+
* metric dimension. For metric math anomaly detectors, you can list them by adding
|
|
34
|
+
* <code>METRIC_MATH</code> to the <code>AnomalyDetectorTypes</code> array. This will
|
|
35
|
+
* return all metric math anomaly detectors in your account.</p>
|
|
37
36
|
* @example
|
|
38
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
38
|
* ```javascript
|
|
@@ -130,7 +129,8 @@ declare const DescribeAnomalyDetectorsCommand_base: {
|
|
|
130
129
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
131
130
|
*
|
|
132
131
|
* @throws {@link InternalServiceFault} (server fault)
|
|
133
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
132
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
133
|
+
* failure.</p>
|
|
134
134
|
*
|
|
135
135
|
* @throws {@link InvalidNextToken} (client fault)
|
|
136
136
|
* <p>The next token specified is invalid.</p>
|
|
@@ -28,8 +28,8 @@ declare const DescribeInsightRulesCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Returns a list of all the Contributor Insights rules in your account.</p>
|
|
31
|
-
* <p>For more information about Contributor Insights, see
|
|
32
|
-
*
|
|
31
|
+
* <p>For more information about Contributor Insights, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor
|
|
32
|
+
* Insights to Analyze High-Cardinality Data</a>.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const DisableAlarmActionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Disables the actions for the specified alarms. When an alarm's actions are
|
|
31
|
-
*
|
|
30
|
+
* <p>Disables the actions for the specified alarms. When an alarm's actions are
|
|
31
|
+
* disabled, the alarm actions do not execute when the alarm state changes.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,8 +27,8 @@ declare const DisableInsightRulesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Disables the specified Contributor Insights rules. When rules are disabled, they do
|
|
31
|
-
*
|
|
30
|
+
* <p>Disables the specified Contributor Insights rules. When rules are disabled, they do
|
|
31
|
+
* not analyze log groups and do not incur costs.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -27,7 +27,8 @@ declare const EnableInsightRulesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Enables the specified Contributor Insights rules. When rules are enabled, they
|
|
30
|
+
* <p>Enables the specified Contributor Insights rules. When rules are enabled, they
|
|
31
|
+
* immediately begin analyzing log data.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -28,9 +28,9 @@ declare const GetDashboardCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Displays the details of the dashboard that you specify.</p>
|
|
31
|
-
* <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data
|
|
32
|
-
*
|
|
33
|
-
*
|
|
31
|
+
* <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data
|
|
32
|
+
* returned within <code>DashboardBody</code> as the template for the new dashboard when
|
|
33
|
+
* you call <code>PutDashboard</code> to create the copy.</p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
36
|
* ```javascript
|
|
@@ -60,7 +60,8 @@ declare const GetDashboardCommand_base: {
|
|
|
60
60
|
* <p>The specified dashboard does not exist.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InternalServiceFault} (server fault)
|
|
63
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
63
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
64
|
+
* failure.</p>
|
|
64
65
|
*
|
|
65
66
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
66
67
|
* <p>The value of an input parameter is bad or out-of-range.</p>
|
|
@@ -27,41 +27,50 @@ declare const GetInsightRuleReportCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This operation returns the time series data collected by a Contributor Insights rule.
|
|
31
|
-
*
|
|
32
|
-
* <p>You can also optionally return one or more statistics about each data point in the
|
|
30
|
+
* <p>This operation returns the time series data collected by a Contributor Insights rule.
|
|
31
|
+
* The data includes the identity and number of contributors to the log group.</p>
|
|
32
|
+
* <p>You can also optionally return one or more statistics about each data point in the
|
|
33
|
+
* time series. These statistics can include the following:</p>
|
|
33
34
|
* <ul>
|
|
34
35
|
* <li>
|
|
35
36
|
* <p>
|
|
36
|
-
* <code>UniqueContributors</code> -- the number of unique contributors for each
|
|
37
|
+
* <code>UniqueContributors</code> -- the number of unique contributors for each
|
|
38
|
+
* data point.</p>
|
|
37
39
|
* </li>
|
|
38
40
|
* <li>
|
|
39
41
|
* <p>
|
|
40
|
-
* <code>MaxContributorValue</code> -- the value of the top contributor for each
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
42
|
+
* <code>MaxContributorValue</code> -- the value of the top contributor for each
|
|
43
|
+
* data point. The identity of the contributor might change for each data point in
|
|
44
|
+
* the graph.</p>
|
|
45
|
+
* <p>If this rule aggregates by COUNT, the top contributor for each data point is
|
|
46
|
+
* the contributor with the most occurrences in that period. If the rule aggregates
|
|
47
|
+
* by SUM, the top contributor is the contributor with the highest sum in the log
|
|
48
|
+
* field specified by the rule's <code>Value</code>, during that period.</p>
|
|
45
49
|
* </li>
|
|
46
50
|
* <li>
|
|
47
51
|
* <p>
|
|
48
|
-
* <code>SampleCount</code> -- the number of data points matched by the
|
|
52
|
+
* <code>SampleCount</code> -- the number of data points matched by the
|
|
53
|
+
* rule.</p>
|
|
49
54
|
* </li>
|
|
50
55
|
* <li>
|
|
51
56
|
* <p>
|
|
52
|
-
* <code>Sum</code> -- the sum of the values from all contributors during the
|
|
57
|
+
* <code>Sum</code> -- the sum of the values from all contributors during the
|
|
58
|
+
* time period represented by that data point.</p>
|
|
53
59
|
* </li>
|
|
54
60
|
* <li>
|
|
55
61
|
* <p>
|
|
56
|
-
* <code>Minimum</code> -- the minimum value from a single observation during the
|
|
62
|
+
* <code>Minimum</code> -- the minimum value from a single observation during the
|
|
63
|
+
* time period represented by that data point.</p>
|
|
57
64
|
* </li>
|
|
58
65
|
* <li>
|
|
59
66
|
* <p>
|
|
60
|
-
* <code>Maximum</code> -- the maximum value from a single observation during the
|
|
67
|
+
* <code>Maximum</code> -- the maximum value from a single observation during the
|
|
68
|
+
* time period represented by that data point.</p>
|
|
61
69
|
* </li>
|
|
62
70
|
* <li>
|
|
63
71
|
* <p>
|
|
64
|
-
* <code>Average</code> -- the average value from all contributors during the
|
|
72
|
+
* <code>Average</code> -- the average value from all contributors during the
|
|
73
|
+
* time period represented by that data point.</p>
|
|
65
74
|
* </li>
|
|
66
75
|
* </ul>
|
|
67
76
|
* @example
|
|
@@ -27,54 +27,70 @@ declare const GetMetricDataCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
30
|
+
* <p>You can use the <code>GetMetricData</code> API to retrieve CloudWatch metric
|
|
31
|
+
* values. The operation can also include a CloudWatch Metrics Insights query, and
|
|
32
|
+
* one or more metric math functions.</p>
|
|
33
|
+
* <p>A <code>GetMetricData</code> operation that does not include a query can retrieve
|
|
34
|
+
* as many as 500 different metrics in a single request, with a total of as many as 100,800
|
|
35
|
+
* data points. You can also optionally perform metric math expressions on the values of
|
|
36
|
+
* the returned statistics, to create new time series that represent new insights into your
|
|
37
|
+
* data. For example, using Lambda metrics, you could divide the Errors metric by the
|
|
38
|
+
* Invocations metric to get an error rate time series. For more information about metric
|
|
39
|
+
* 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
|
|
40
|
+
* Guide</i>.</p>
|
|
41
|
+
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can
|
|
42
|
+
* include only one query. But the same <code>GetMetricData</code> operation can also
|
|
43
|
+
* retrieve other metrics. Metrics Insights queries can query only the most recent three
|
|
44
|
+
* hours of metric data. For more information about Metrics Insights, 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>
|
|
43
45
|
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
+
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
|
|
47
|
+
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
48
|
+
* Pricing</a>.</p>
|
|
46
49
|
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
47
50
|
* <ul>
|
|
48
51
|
* <li>
|
|
49
|
-
* <p>Data points with a period of less than 60 seconds are available for 3
|
|
50
|
-
*
|
|
52
|
+
* <p>Data points with a period of less than 60 seconds are available for 3
|
|
53
|
+
* hours. These data points are high-resolution metrics and are available only for
|
|
54
|
+
* custom metrics that have been defined with a <code>StorageResolution</code> of
|
|
55
|
+
* 1.</p>
|
|
51
56
|
* </li>
|
|
52
57
|
* <li>
|
|
53
|
-
* <p>Data points with a period of 60 seconds (1-minute) are available for 15
|
|
58
|
+
* <p>Data points with a period of 60 seconds (1-minute) are available for 15
|
|
59
|
+
* days.</p>
|
|
54
60
|
* </li>
|
|
55
61
|
* <li>
|
|
56
|
-
* <p>Data points with a period of 300 seconds (5-minute) are available for 63
|
|
62
|
+
* <p>Data points with a period of 300 seconds (5-minute) are available for 63
|
|
63
|
+
* days.</p>
|
|
57
64
|
* </li>
|
|
58
65
|
* <li>
|
|
59
|
-
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455
|
|
66
|
+
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455
|
|
67
|
+
* days (15 months).</p>
|
|
60
68
|
* </li>
|
|
61
69
|
* </ul>
|
|
62
|
-
* <p>Data points that are initially published with a shorter period are aggregated
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
70
|
+
* <p>Data points that are initially published with a shorter period are aggregated
|
|
71
|
+
* together for long-term storage. For example, if you collect data using a period of 1
|
|
72
|
+
* minute, the data remains available for 15 days with 1-minute resolution. After 15 days,
|
|
73
|
+
* this data is still available, but is aggregated and retrievable only with a resolution
|
|
74
|
+
* of 5 minutes. After 63 days, the data is further aggregated and is available with a
|
|
75
|
+
* resolution of 1 hour.</p>
|
|
76
|
+
* <p>If you omit <code>Unit</code> in your request, all data that was collected with any
|
|
77
|
+
* unit is returned, along with the corresponding units that were specified when the data
|
|
78
|
+
* was reported to CloudWatch. If you specify a unit, the operation returns only data that
|
|
79
|
+
* was collected with that unit specified. If you specify a unit that does not match the
|
|
80
|
+
* data collected, the results of the operation are null. CloudWatch does not perform unit
|
|
81
|
+
* conversions.</p>
|
|
69
82
|
* <p>
|
|
70
|
-
* <b>Using Metrics Insights queries with metric
|
|
83
|
+
* <b>Using Metrics Insights queries with metric
|
|
84
|
+
* math</b>
|
|
71
85
|
* </p>
|
|
72
|
-
* <p>You can't mix a Metric Insights query and metric math syntax in the same expression,
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
86
|
+
* <p>You can't mix a Metric Insights query and metric math syntax in the same expression,
|
|
87
|
+
* but you can reference results from a Metrics Insights query within other Metric math
|
|
88
|
+
* expressions. A Metrics Insights query without a <b>GROUP
|
|
89
|
+
* BY</b> clause returns a single time-series (TS), and can be used as input for
|
|
90
|
+
* a metric math expression that expects a single time series. A Metrics Insights query
|
|
91
|
+
* with a <b>GROUP BY</b> clause returns an array of time-series
|
|
92
|
+
* (TS[]), and can be used as input for a metric math expression that expects an array of
|
|
93
|
+
* time series. </p>
|
|
78
94
|
* @example
|
|
79
95
|
* Use a bare-bones client and the command you need to make an API call.
|
|
80
96
|
* ```javascript
|
|
@@ -28,19 +28,19 @@ declare const GetMetricStatisticsCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Gets statistics for the specified metric.</p>
|
|
31
|
-
* <p>The maximum number of data points returned from a single call is 1,440. If
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>CloudWatch aggregates data points based on the length of the period
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
31
|
+
* <p>The maximum number of data points returned from a single call is 1,440. If you
|
|
32
|
+
* request more than 1,440 data points, CloudWatch returns an error. To reduce the number
|
|
33
|
+
* of data points, you can narrow the specified time range and make multiple requests
|
|
34
|
+
* across adjacent time ranges, or you can increase the specified period. Data points are
|
|
35
|
+
* not returned in chronological order.</p>
|
|
36
|
+
* <p>CloudWatch aggregates data points based on the length of the period that you
|
|
37
|
+
* specify. For example, if you request statistics with a one-hour period, CloudWatch
|
|
38
|
+
* aggregates all data points with time stamps that fall within each one-hour period.
|
|
39
|
+
* Therefore, the number of values aggregated by CloudWatch is larger than the number of
|
|
40
|
+
* data points returned.</p>
|
|
41
41
|
* <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* data using a statistic set instead, you can only retrieve percentile statistics for this
|
|
43
|
+
* data if one of the following conditions is true:</p>
|
|
44
44
|
* <ul>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>The SampleCount value of the statistic set is 1.</p>
|
|
@@ -49,31 +49,41 @@ declare const GetMetricStatisticsCommand_base: {
|
|
|
49
49
|
* <p>The Min and the Max values of the statistic set are equal.</p>
|
|
50
50
|
* </li>
|
|
51
51
|
* </ul>
|
|
52
|
-
* <p>Percentile statistics are not available for metrics when any of the metric values
|
|
52
|
+
* <p>Percentile statistics are not available for metrics when any of the metric values
|
|
53
|
+
* are negative numbers.</p>
|
|
53
54
|
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
54
55
|
* <ul>
|
|
55
56
|
* <li>
|
|
56
|
-
* <p>Data points with a period of less than 60 seconds are available for 3
|
|
57
|
-
*
|
|
57
|
+
* <p>Data points with a period of less than 60 seconds are available for 3
|
|
58
|
+
* hours. These data points are high-resolution metrics and are available only for
|
|
59
|
+
* custom metrics that have been defined with a <code>StorageResolution</code> of
|
|
60
|
+
* 1.</p>
|
|
58
61
|
* </li>
|
|
59
62
|
* <li>
|
|
60
|
-
* <p>Data points with a period of 60 seconds (1-minute) are available for 15
|
|
63
|
+
* <p>Data points with a period of 60 seconds (1-minute) are available for 15
|
|
64
|
+
* days.</p>
|
|
61
65
|
* </li>
|
|
62
66
|
* <li>
|
|
63
|
-
* <p>Data points with a period of 300 seconds (5-minute) are available for 63
|
|
67
|
+
* <p>Data points with a period of 300 seconds (5-minute) are available for 63
|
|
68
|
+
* days.</p>
|
|
64
69
|
* </li>
|
|
65
70
|
* <li>
|
|
66
|
-
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455
|
|
71
|
+
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455
|
|
72
|
+
* days (15 months).</p>
|
|
67
73
|
* </li>
|
|
68
74
|
* </ul>
|
|
69
|
-
* <p>Data points that are initially published with a shorter period are aggregated
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
75
|
+
* <p>Data points that are initially published with a shorter period are aggregated
|
|
76
|
+
* together for long-term storage. For example, if you collect data using a period of 1
|
|
77
|
+
* minute, the data remains available for 15 days with 1-minute resolution. After 15 days,
|
|
78
|
+
* this data is still available, but is aggregated and retrievable only with a resolution
|
|
79
|
+
* of 5 minutes. After 63 days, the data is further aggregated and is available with a
|
|
80
|
+
* resolution of 1 hour.</p>
|
|
81
|
+
* <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9,
|
|
82
|
+
* 2016.</p>
|
|
83
|
+
* <p>For information about metrics and dimensions supported by Amazon Web Services
|
|
84
|
+
* services, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch
|
|
85
|
+
* Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User
|
|
86
|
+
* Guide</i>.</p>
|
|
77
87
|
* @example
|
|
78
88
|
* Use a bare-bones client and the command you need to make an API call.
|
|
79
89
|
* ```javascript
|
|
@@ -129,7 +139,8 @@ declare const GetMetricStatisticsCommand_base: {
|
|
|
129
139
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
130
140
|
*
|
|
131
141
|
* @throws {@link InternalServiceFault} (server fault)
|
|
132
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
142
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
143
|
+
* failure.</p>
|
|
133
144
|
*
|
|
134
145
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
135
146
|
* <p>Parameters were used together that cannot be used together.</p>
|
|
@@ -89,7 +89,8 @@ declare const GetMetricStreamCommand_base: {
|
|
|
89
89
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
90
90
|
*
|
|
91
91
|
* @throws {@link InternalServiceFault} (server fault)
|
|
92
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
92
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
93
|
+
* failure.</p>
|
|
93
94
|
*
|
|
94
95
|
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
95
96
|
* <p>Parameters were used together that cannot be used together.</p>
|
|
@@ -27,14 +27,15 @@ declare const GetMetricWidgetImageCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* <p>The graph you retrieve can include all CloudWatch metric graph features, including
|
|
36
|
-
*
|
|
37
|
-
* <p>There is a limit of 20 transactions per second for this API. Each
|
|
30
|
+
* <p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph
|
|
31
|
+
* of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this
|
|
32
|
+
* image into your services and products, such as wiki pages, reports, and documents. You
|
|
33
|
+
* could also retrieve images regularly, such as every minute, and create your own custom
|
|
34
|
+
* live dashboard.</p>
|
|
35
|
+
* <p>The graph you retrieve can include all CloudWatch metric graph features, including
|
|
36
|
+
* metric math and horizontal and vertical annotations.</p>
|
|
37
|
+
* <p>There is a limit of 20 transactions per second for this API. Each
|
|
38
|
+
* <code>GetMetricWidgetImage</code> action has the following limits:</p>
|
|
38
39
|
* <ul>
|
|
39
40
|
* <li>
|
|
40
41
|
* <p>As many as 100 metrics in the graph.</p>
|
|
@@ -27,15 +27,14 @@ declare const ListDashboardsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of the dashboards for your account. If you include
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* </p>
|
|
30
|
+
* <p>Returns a list of the dashboards for your account. If you include
|
|
31
|
+
* <code>DashboardNamePrefix</code>, only those dashboards with names starting with the
|
|
32
|
+
* prefix are listed. Otherwise, all dashboards in your account are listed. </p>
|
|
34
33
|
* <p>
|
|
35
|
-
* <code>ListDashboards</code> returns up to 1000 results on one page. If there
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
34
|
+
* <code>ListDashboards</code> returns up to 1000 results on one page. If there are
|
|
35
|
+
* more than 1000 dashboards, you can call <code>ListDashboards</code> again and include
|
|
36
|
+
* the value you received for <code>NextToken</code> in the first call, to receive the next
|
|
37
|
+
* 1000 results.</p>
|
|
39
38
|
* @example
|
|
40
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
40
|
* ```javascript
|
|
@@ -69,7 +68,8 @@ declare const ListDashboardsCommand_base: {
|
|
|
69
68
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
70
69
|
*
|
|
71
70
|
* @throws {@link InternalServiceFault} (server fault)
|
|
72
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
71
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
72
|
+
* failure.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
75
75
|
* <p>The value of an input parameter is bad or out-of-range.</p>
|
|
@@ -27,13 +27,10 @@ declare const ListManagedInsightRulesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* that contains the number
|
|
33
|
-
* of managed Contributor Insights rules
|
|
34
|
-
* in your account.
|
|
30
|
+
* <p> Returns a list that contains the number of managed Contributor Insights rules in your
|
|
31
|
+
* account.
|
|
35
32
|
*
|
|
36
|
-
*
|
|
33
|
+
* </p>
|
|
37
34
|
* @example
|
|
38
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
36
|
* ```javascript
|
|
@@ -64,7 +64,8 @@ declare const ListMetricStreamsCommand_base: {
|
|
|
64
64
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link InternalServiceFault} (server fault)
|
|
67
|
-
* <p>Request processing has failed due to some unknown error, exception, or
|
|
67
|
+
* <p>Request processing has failed due to some unknown error, exception, or
|
|
68
|
+
* failure.</p>
|
|
68
69
|
*
|
|
69
70
|
* @throws {@link InvalidNextToken} (client fault)
|
|
70
71
|
* <p>The next token specified is invalid.</p>
|