@aws-sdk/client-cloudwatch 3.36.0 → 3.39.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/CHANGELOG.md +42 -0
- package/dist-cjs/CloudWatch.js +0 -17
- package/dist-cjs/CloudWatchClient.js +0 -22
- package/dist-cjs/commands/DeleteAlarmsCommand.js +0 -39
- package/dist-cjs/commands/DeleteAnomalyDetectorCommand.js +0 -24
- package/dist-cjs/commands/DeleteDashboardsCommand.js +0 -26
- package/dist-cjs/commands/DeleteInsightRulesCommand.js +0 -27
- package/dist-cjs/commands/DeleteMetricStreamCommand.js +0 -24
- package/dist-cjs/commands/DescribeAlarmHistoryCommand.js +0 -26
- package/dist-cjs/commands/DescribeAlarmsCommand.js +0 -25
- package/dist-cjs/commands/DescribeAlarmsForMetricCommand.js +0 -28
- package/dist-cjs/commands/DescribeAnomalyDetectorsCommand.js +0 -26
- package/dist-cjs/commands/DescribeInsightRulesCommand.js +0 -27
- package/dist-cjs/commands/DisableAlarmActionsCommand.js +0 -25
- package/dist-cjs/commands/DisableInsightRulesCommand.js +0 -25
- package/dist-cjs/commands/EnableAlarmActionsCommand.js +0 -24
- package/dist-cjs/commands/EnableInsightRulesCommand.js +0 -24
- package/dist-cjs/commands/GetDashboardCommand.js +0 -27
- package/dist-cjs/commands/GetInsightRuleReportCommand.js +0 -60
- package/dist-cjs/commands/GetMetricDataCommand.js +0 -59
- package/dist-cjs/commands/GetMetricStatisticsCommand.js +0 -75
- package/dist-cjs/commands/GetMetricStreamCommand.js +0 -24
- package/dist-cjs/commands/GetMetricWidgetImageCommand.js +0 -41
- package/dist-cjs/commands/ListDashboardsCommand.js +0 -32
- package/dist-cjs/commands/ListMetricStreamsCommand.js +0 -24
- package/dist-cjs/commands/ListMetricsCommand.js +0 -37
- package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
- package/dist-cjs/commands/PutAnomalyDetectorCommand.js +0 -26
- package/dist-cjs/commands/PutCompositeAlarmCommand.js +0 -59
- package/dist-cjs/commands/PutDashboardCommand.js +0 -37
- package/dist-cjs/commands/PutInsightRuleCommand.js +0 -28
- package/dist-cjs/commands/PutMetricAlarmCommand.js +0 -87
- package/dist-cjs/commands/PutMetricDataCommand.js +0 -68
- package/dist-cjs/commands/PutMetricStreamCommand.js +0 -51
- package/dist-cjs/commands/SetAlarmStateCommand.js +0 -39
- package/dist-cjs/commands/StartMetricStreamsCommand.js +0 -24
- package/dist-cjs/commands/StopMetricStreamsCommand.js +0 -24
- package/dist-cjs/commands/TagResourceCommand.js +0 -34
- package/dist-cjs/commands/UntagResourceCommand.js +0 -24
- package/dist-cjs/commands/index.js +39 -0
- package/dist-cjs/endpoints.js +6 -1
- package/dist-cjs/index.js +5 -48
- package/dist-cjs/models/models_0.js +0 -315
- package/dist-cjs/pagination/DescribeAlarmHistoryPaginator.js +0 -10
- package/dist-cjs/pagination/DescribeAlarmsPaginator.js +0 -10
- package/dist-cjs/pagination/DescribeInsightRulesPaginator.js +0 -10
- package/dist-cjs/pagination/GetMetricDataPaginator.js +0 -10
- package/dist-cjs/pagination/ListDashboardsPaginator.js +0 -10
- package/dist-cjs/pagination/ListMetricStreamsPaginator.js +0 -10
- package/dist-cjs/pagination/ListMetricsPaginator.js +0 -10
- package/dist-cjs/pagination/index.js +11 -0
- package/dist-cjs/protocols/Aws_query.js +0 -2
- package/dist-cjs/runtimeConfig.browser.js +1 -5
- package/dist-cjs/runtimeConfig.js +1 -5
- package/dist-cjs/runtimeConfig.native.js +0 -3
- package/dist-cjs/runtimeConfig.shared.js +0 -3
- package/dist-cjs/waiters/index.js +5 -0
- package/dist-cjs/waiters/waitForAlarmExists.js +0 -9
- package/dist-cjs/waiters/waitForCompositeAlarmExists.js +0 -9
- package/dist-es/commands/index.js +36 -0
- package/dist-es/endpoints.js +6 -1
- package/dist-es/index.js +5 -48
- package/dist-es/pagination/index.js +8 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-types/commands/index.d.ts +36 -0
- package/dist-types/index.d.ts +5 -48
- package/dist-types/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/CloudWatch.d.ts +37 -536
- package/dist-types/ts3.4/CloudWatchClient.d.ts +24 -103
- package/dist-types/ts3.4/commands/DeleteAlarmsCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/DeleteAnomalyDetectorCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DeleteDashboardsCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DeleteInsightRulesCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DeleteMetricStreamCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/DescribeAlarmHistoryCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DescribeAlarmsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DescribeAlarmsForMetricCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/DescribeAnomalyDetectorsCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/DescribeInsightRulesCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/DisableAlarmActionsCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/DisableInsightRulesCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/EnableAlarmActionsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/EnableInsightRulesCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +2 -23
- package/dist-types/ts3.4/commands/GetInsightRuleReportCommand.d.ts +2 -56
- package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +2 -55
- package/dist-types/ts3.4/commands/GetMetricStatisticsCommand.d.ts +2 -71
- package/dist-types/ts3.4/commands/GetMetricStreamCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/GetMetricWidgetImageCommand.d.ts +2 -37
- package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +2 -28
- package/dist-types/ts3.4/commands/ListMetricStreamsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -21
- package/dist-types/ts3.4/commands/PutAnomalyDetectorCommand.d.ts +2 -22
- package/dist-types/ts3.4/commands/PutCompositeAlarmCommand.d.ts +2 -55
- package/dist-types/ts3.4/commands/PutDashboardCommand.d.ts +2 -33
- package/dist-types/ts3.4/commands/PutInsightRuleCommand.d.ts +2 -24
- package/dist-types/ts3.4/commands/PutMetricAlarmCommand.d.ts +2 -83
- package/dist-types/ts3.4/commands/PutMetricDataCommand.d.ts +2 -64
- package/dist-types/ts3.4/commands/PutMetricStreamCommand.d.ts +2 -47
- package/dist-types/ts3.4/commands/SetAlarmStateCommand.d.ts +2 -35
- package/dist-types/ts3.4/commands/StartMetricStreamsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/StopMetricStreamsCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -30
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
- package/dist-types/ts3.4/commands/index.d.ts +36 -0
- package/dist-types/ts3.4/index.d.ts +5 -48
- package/dist-types/ts3.4/models/models_0.d.ts +481 -2223
- package/dist-types/ts3.4/pagination/index.d.ts +8 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForAlarmExists.d.ts +2 -9
- package/dist-types/ts3.4/waiters/waitForCompositeAlarmExists.d.ts +2 -9
- package/dist-types/waiters/index.d.ts +2 -0
- package/package.json +33 -33
|
@@ -5,38 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Displays the details of the dashboard that you specify.</p>
|
|
10
|
-
* <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned
|
|
11
|
-
* within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create
|
|
12
|
-
* the copy.</p>
|
|
13
|
-
* @example
|
|
14
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
-
* ```javascript
|
|
16
|
-
* import { CloudWatchClient, GetDashboardCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
17
|
-
* // const { CloudWatchClient, GetDashboardCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
18
|
-
* const client = new CloudWatchClient(config);
|
|
19
|
-
* const command = new GetDashboardCommand(input);
|
|
20
|
-
* const response = await client.send(command);
|
|
21
|
-
* ```
|
|
22
|
-
*
|
|
23
|
-
* @see {@link GetDashboardCommandInput} for command's `input` shape.
|
|
24
|
-
* @see {@link GetDashboardCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
26
|
-
*
|
|
27
|
-
*/
|
|
28
8
|
class GetDashboardCommand extends smithy_client_1.Command {
|
|
29
|
-
// Start section: command_properties
|
|
30
|
-
// End section: command_properties
|
|
31
9
|
constructor(input) {
|
|
32
|
-
// Start section: command_constructor
|
|
33
10
|
super();
|
|
34
11
|
this.input = input;
|
|
35
|
-
// End section: command_constructor
|
|
36
12
|
}
|
|
37
|
-
/**
|
|
38
|
-
* @internal
|
|
39
|
-
*/
|
|
40
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
41
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
42
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,71 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of
|
|
10
|
-
* contributors to the log group.</p>
|
|
11
|
-
* <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>
|
|
12
|
-
* <ul>
|
|
13
|
-
* <li>
|
|
14
|
-
* <p>
|
|
15
|
-
* <code>UniqueContributors</code> -- the number of unique contributors for each data point.</p>
|
|
16
|
-
* </li>
|
|
17
|
-
* <li>
|
|
18
|
-
* <p>
|
|
19
|
-
* <code>MaxContributorValue</code> -- the value of the top contributor for each data point. The identity of the
|
|
20
|
-
* contributor might change for each data point in the graph.</p>
|
|
21
|
-
* <p>If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
|
|
22
|
-
* 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
|
|
23
|
-
* by the rule's <code>Value</code>, during that period.</p>
|
|
24
|
-
* </li>
|
|
25
|
-
* <li>
|
|
26
|
-
* <p>
|
|
27
|
-
* <code>SampleCount</code> -- the number of data points matched by the rule.</p>
|
|
28
|
-
* </li>
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>
|
|
31
|
-
* <code>Sum</code> -- the sum of the values from all contributors during the time period represented by that data point.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>
|
|
35
|
-
* <code>Minimum</code> -- the minimum value from a single observation during the time period represented by that data point.</p>
|
|
36
|
-
* </li>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>
|
|
39
|
-
* <code>Maximum</code> -- the maximum value from a single observation during the time period represented by that data point.</p>
|
|
40
|
-
* </li>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>
|
|
43
|
-
* <code>Average</code> -- the average value from all contributors during the time period represented by that data point.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* </ul>
|
|
46
|
-
* @example
|
|
47
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
48
|
-
* ```javascript
|
|
49
|
-
* import { CloudWatchClient, GetInsightRuleReportCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
50
|
-
* // const { CloudWatchClient, GetInsightRuleReportCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
51
|
-
* const client = new CloudWatchClient(config);
|
|
52
|
-
* const command = new GetInsightRuleReportCommand(input);
|
|
53
|
-
* const response = await client.send(command);
|
|
54
|
-
* ```
|
|
55
|
-
*
|
|
56
|
-
* @see {@link GetInsightRuleReportCommandInput} for command's `input` shape.
|
|
57
|
-
* @see {@link GetInsightRuleReportCommandOutput} for command's `response` shape.
|
|
58
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
59
|
-
*
|
|
60
|
-
*/
|
|
61
8
|
class GetInsightRuleReportCommand extends smithy_client_1.Command {
|
|
62
|
-
// Start section: command_properties
|
|
63
|
-
// End section: command_properties
|
|
64
9
|
constructor(input) {
|
|
65
|
-
// Start section: command_constructor
|
|
66
10
|
super();
|
|
67
11
|
this.input = input;
|
|
68
|
-
// End section: command_constructor
|
|
69
12
|
}
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
74
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
75
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,70 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>You can use the <code>GetMetricData</code> API to retrieve as many as 500 different
|
|
10
|
-
* metrics in a single request, with a total of as many as 100,800 data points. You can also
|
|
11
|
-
* optionally perform math expressions on the values of the returned statistics, to create
|
|
12
|
-
* new time series that represent new insights into your data. For example, using Lambda
|
|
13
|
-
* metrics, you could divide the Errors metric by the Invocations metric to get an error
|
|
14
|
-
* 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
|
|
15
|
-
* Guide</i>.</p>
|
|
16
|
-
*
|
|
17
|
-
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
18
|
-
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
|
|
19
|
-
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
|
|
20
|
-
*
|
|
21
|
-
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
22
|
-
* <ul>
|
|
23
|
-
* <li>
|
|
24
|
-
* <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
|
|
25
|
-
* metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
|
|
26
|
-
* </li>
|
|
27
|
-
* <li>
|
|
28
|
-
* <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
|
|
29
|
-
* </li>
|
|
30
|
-
* <li>
|
|
31
|
-
* <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
|
|
35
|
-
* </li>
|
|
36
|
-
* </ul>
|
|
37
|
-
* <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
|
|
38
|
-
* 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,
|
|
39
|
-
* but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
|
|
40
|
-
* a resolution of 1 hour.</p>
|
|
41
|
-
*
|
|
42
|
-
* <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
|
|
43
|
-
* when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
|
|
44
|
-
* 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>
|
|
45
|
-
* @example
|
|
46
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
47
|
-
* ```javascript
|
|
48
|
-
* import { CloudWatchClient, GetMetricDataCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
49
|
-
* // const { CloudWatchClient, GetMetricDataCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
50
|
-
* const client = new CloudWatchClient(config);
|
|
51
|
-
* const command = new GetMetricDataCommand(input);
|
|
52
|
-
* const response = await client.send(command);
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @see {@link GetMetricDataCommandInput} for command's `input` shape.
|
|
56
|
-
* @see {@link GetMetricDataCommandOutput} for command's `response` shape.
|
|
57
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
58
|
-
*
|
|
59
|
-
*/
|
|
60
8
|
class GetMetricDataCommand extends smithy_client_1.Command {
|
|
61
|
-
// Start section: command_properties
|
|
62
|
-
// End section: command_properties
|
|
63
9
|
constructor(input) {
|
|
64
|
-
// Start section: command_constructor
|
|
65
10
|
super();
|
|
66
11
|
this.input = input;
|
|
67
|
-
// End section: command_constructor
|
|
68
12
|
}
|
|
69
|
-
/**
|
|
70
|
-
* @internal
|
|
71
|
-
*/
|
|
72
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
73
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
74
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,86 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Gets statistics for the specified metric.</p>
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* <p>The maximum number of data points returned from a single call is 1,440. If
|
|
14
|
-
* you request more than 1,440 data points, CloudWatch returns an error.
|
|
15
|
-
* To reduce the number of data points, you can narrow the specified time range and make
|
|
16
|
-
* multiple requests across adjacent time ranges, or you can increase the specified period.
|
|
17
|
-
* Data points are not returned in chronological order.</p>
|
|
18
|
-
*
|
|
19
|
-
* <p>CloudWatch aggregates data points based on the length of the period
|
|
20
|
-
* that you specify. For example, if you request statistics with a one-hour period,
|
|
21
|
-
* CloudWatch aggregates all data points with time stamps that fall within each
|
|
22
|
-
* one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than
|
|
23
|
-
* the number of data points returned.</p>
|
|
24
|
-
* <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
|
|
25
|
-
* data using a statistic set instead, you can only retrieve
|
|
26
|
-
* percentile statistics for this data if one of the following conditions is true:</p>
|
|
27
|
-
* <ul>
|
|
28
|
-
* <li>
|
|
29
|
-
* <p>The SampleCount value of the statistic set is 1.</p>
|
|
30
|
-
* </li>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>The Min and the Max values of the statistic set are equal.</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* </ul>
|
|
35
|
-
* <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
|
|
36
|
-
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
37
|
-
* <ul>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
|
|
40
|
-
* metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
|
|
47
|
-
* </li>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
|
|
50
|
-
* </li>
|
|
51
|
-
* </ul>
|
|
52
|
-
* <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
|
|
53
|
-
* 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,
|
|
54
|
-
* but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
|
|
55
|
-
* a resolution of 1 hour.</p>
|
|
56
|
-
* <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
|
|
57
|
-
*
|
|
58
|
-
* <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
|
|
59
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch Metrics and Dimensions Reference</a> in the
|
|
60
|
-
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
61
|
-
* @example
|
|
62
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
63
|
-
* ```javascript
|
|
64
|
-
* import { CloudWatchClient, GetMetricStatisticsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
65
|
-
* // const { CloudWatchClient, GetMetricStatisticsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
66
|
-
* const client = new CloudWatchClient(config);
|
|
67
|
-
* const command = new GetMetricStatisticsCommand(input);
|
|
68
|
-
* const response = await client.send(command);
|
|
69
|
-
* ```
|
|
70
|
-
*
|
|
71
|
-
* @see {@link GetMetricStatisticsCommandInput} for command's `input` shape.
|
|
72
|
-
* @see {@link GetMetricStatisticsCommandOutput} for command's `response` shape.
|
|
73
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
74
|
-
*
|
|
75
|
-
*/
|
|
76
8
|
class GetMetricStatisticsCommand extends smithy_client_1.Command {
|
|
77
|
-
// Start section: command_properties
|
|
78
|
-
// End section: command_properties
|
|
79
9
|
constructor(input) {
|
|
80
|
-
// Start section: command_constructor
|
|
81
10
|
super();
|
|
82
11
|
this.input = input;
|
|
83
|
-
// End section: command_constructor
|
|
84
12
|
}
|
|
85
|
-
/**
|
|
86
|
-
* @internal
|
|
87
|
-
*/
|
|
88
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
89
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
90
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,35 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Returns information about the metric stream that you specify.</p>
|
|
10
|
-
* @example
|
|
11
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
12
|
-
* ```javascript
|
|
13
|
-
* import { CloudWatchClient, GetMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
14
|
-
* // const { CloudWatchClient, GetMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
15
|
-
* const client = new CloudWatchClient(config);
|
|
16
|
-
* const command = new GetMetricStreamCommand(input);
|
|
17
|
-
* const response = await client.send(command);
|
|
18
|
-
* ```
|
|
19
|
-
*
|
|
20
|
-
* @see {@link GetMetricStreamCommandInput} for command's `input` shape.
|
|
21
|
-
* @see {@link GetMetricStreamCommandOutput} for command's `response` shape.
|
|
22
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
23
|
-
*
|
|
24
|
-
*/
|
|
25
8
|
class GetMetricStreamCommand extends smithy_client_1.Command {
|
|
26
|
-
// Start section: command_properties
|
|
27
|
-
// End section: command_properties
|
|
28
9
|
constructor(input) {
|
|
29
|
-
// Start section: command_constructor
|
|
30
10
|
super();
|
|
31
11
|
this.input = input;
|
|
32
|
-
// End section: command_constructor
|
|
33
12
|
}
|
|
34
|
-
/**
|
|
35
|
-
* @internal
|
|
36
|
-
*/
|
|
37
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
38
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
39
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,52 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>You can use the <code>GetMetricWidgetImage</code> API to retrieve a snapshot graph of
|
|
10
|
-
* one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this
|
|
11
|
-
* image into your services and products, such as wiki pages, reports, and documents.
|
|
12
|
-
* You could also retrieve images regularly, such as every minute, and create your own
|
|
13
|
-
* custom live dashboard.</p>
|
|
14
|
-
*
|
|
15
|
-
* <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
|
|
16
|
-
* and horizontal and vertical annotations.</p>
|
|
17
|
-
*
|
|
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>
|
|
20
|
-
* <li>
|
|
21
|
-
* <p>As many as 100 metrics in the graph.</p>
|
|
22
|
-
* </li>
|
|
23
|
-
* <li>
|
|
24
|
-
* <p>Up to 100 KB uncompressed payload.</p>
|
|
25
|
-
* </li>
|
|
26
|
-
* </ul>
|
|
27
|
-
* @example
|
|
28
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
-
* ```javascript
|
|
30
|
-
* import { CloudWatchClient, GetMetricWidgetImageCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
31
|
-
* // const { CloudWatchClient, GetMetricWidgetImageCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
32
|
-
* const client = new CloudWatchClient(config);
|
|
33
|
-
* const command = new GetMetricWidgetImageCommand(input);
|
|
34
|
-
* const response = await client.send(command);
|
|
35
|
-
* ```
|
|
36
|
-
*
|
|
37
|
-
* @see {@link GetMetricWidgetImageCommandInput} for command's `input` shape.
|
|
38
|
-
* @see {@link GetMetricWidgetImageCommandOutput} for command's `response` shape.
|
|
39
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
40
|
-
*
|
|
41
|
-
*/
|
|
42
8
|
class GetMetricWidgetImageCommand extends smithy_client_1.Command {
|
|
43
|
-
// Start section: command_properties
|
|
44
|
-
// End section: command_properties
|
|
45
9
|
constructor(input) {
|
|
46
|
-
// Start section: command_constructor
|
|
47
10
|
super();
|
|
48
11
|
this.input = input;
|
|
49
|
-
// End section: command_constructor
|
|
50
12
|
}
|
|
51
|
-
/**
|
|
52
|
-
* @internal
|
|
53
|
-
*/
|
|
54
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
55
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
56
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,43 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only
|
|
10
|
-
* those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are
|
|
11
|
-
* listed.
|
|
12
|
-
* </p>
|
|
13
|
-
* <p>
|
|
14
|
-
* <code>ListDashboards</code> returns up to 1000 results on one page. If there
|
|
15
|
-
* are more than 1000 dashboards, you can call <code>ListDashboards</code> again and
|
|
16
|
-
* include the value you received for <code>NextToken</code> in the first call, to receive
|
|
17
|
-
* the next 1000 results.</p>
|
|
18
|
-
* @example
|
|
19
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
20
|
-
* ```javascript
|
|
21
|
-
* import { CloudWatchClient, ListDashboardsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
22
|
-
* // const { CloudWatchClient, ListDashboardsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
23
|
-
* const client = new CloudWatchClient(config);
|
|
24
|
-
* const command = new ListDashboardsCommand(input);
|
|
25
|
-
* const response = await client.send(command);
|
|
26
|
-
* ```
|
|
27
|
-
*
|
|
28
|
-
* @see {@link ListDashboardsCommandInput} for command's `input` shape.
|
|
29
|
-
* @see {@link ListDashboardsCommandOutput} for command's `response` shape.
|
|
30
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
33
8
|
class ListDashboardsCommand extends smithy_client_1.Command {
|
|
34
|
-
// Start section: command_properties
|
|
35
|
-
// End section: command_properties
|
|
36
9
|
constructor(input) {
|
|
37
|
-
// Start section: command_constructor
|
|
38
10
|
super();
|
|
39
11
|
this.input = input;
|
|
40
|
-
// End section: command_constructor
|
|
41
12
|
}
|
|
42
|
-
/**
|
|
43
|
-
* @internal
|
|
44
|
-
*/
|
|
45
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
46
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
47
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,35 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Returns a list of metric streams in this account.</p>
|
|
10
|
-
* @example
|
|
11
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
12
|
-
* ```javascript
|
|
13
|
-
* import { CloudWatchClient, ListMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
14
|
-
* // const { CloudWatchClient, ListMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
15
|
-
* const client = new CloudWatchClient(config);
|
|
16
|
-
* const command = new ListMetricStreamsCommand(input);
|
|
17
|
-
* const response = await client.send(command);
|
|
18
|
-
* ```
|
|
19
|
-
*
|
|
20
|
-
* @see {@link ListMetricStreamsCommandInput} for command's `input` shape.
|
|
21
|
-
* @see {@link ListMetricStreamsCommandOutput} for command's `response` shape.
|
|
22
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
23
|
-
*
|
|
24
|
-
*/
|
|
25
8
|
class ListMetricStreamsCommand extends smithy_client_1.Command {
|
|
26
|
-
// Start section: command_properties
|
|
27
|
-
// End section: command_properties
|
|
28
9
|
constructor(input) {
|
|
29
|
-
// Start section: command_constructor
|
|
30
10
|
super();
|
|
31
11
|
this.input = input;
|
|
32
|
-
// End section: command_constructor
|
|
33
12
|
}
|
|
34
|
-
/**
|
|
35
|
-
* @internal
|
|
36
|
-
*/
|
|
37
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
38
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
39
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,48 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>List the specified metrics. You can use the returned metrics with
|
|
10
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
11
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> to obtain statistical data.</p>
|
|
12
|
-
* <p>Up to 500 results are returned for any one call. To retrieve additional results,
|
|
13
|
-
* use the returned token with subsequent calls.</p>
|
|
14
|
-
* <p>After you create a metric, allow up to 15 minutes before the metric appears.
|
|
15
|
-
* You can see statistics about the metric sooner by using <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
16
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
|
|
17
|
-
*
|
|
18
|
-
* <p>
|
|
19
|
-
* <code>ListMetrics</code> doesn't return information about metrics if those metrics haven't
|
|
20
|
-
* reported data in the past two weeks. To retrieve those metrics, use
|
|
21
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
|
|
23
|
-
* @example
|
|
24
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
25
|
-
* ```javascript
|
|
26
|
-
* import { CloudWatchClient, ListMetricsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
27
|
-
* // const { CloudWatchClient, ListMetricsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
28
|
-
* const client = new CloudWatchClient(config);
|
|
29
|
-
* const command = new ListMetricsCommand(input);
|
|
30
|
-
* const response = await client.send(command);
|
|
31
|
-
* ```
|
|
32
|
-
*
|
|
33
|
-
* @see {@link ListMetricsCommandInput} for command's `input` shape.
|
|
34
|
-
* @see {@link ListMetricsCommandOutput} for command's `response` shape.
|
|
35
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
38
8
|
class ListMetricsCommand extends smithy_client_1.Command {
|
|
39
|
-
// Start section: command_properties
|
|
40
|
-
// End section: command_properties
|
|
41
9
|
constructor(input) {
|
|
42
|
-
// Start section: command_constructor
|
|
43
10
|
super();
|
|
44
11
|
this.input = input;
|
|
45
|
-
// End section: command_constructor
|
|
46
12
|
}
|
|
47
|
-
/**
|
|
48
|
-
* @internal
|
|
49
|
-
*/
|
|
50
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
51
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
52
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,36 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Displays the tags associated with a CloudWatch resource. Currently, alarms
|
|
10
|
-
* and Contributor Insights rules support tagging.</p>
|
|
11
|
-
* @example
|
|
12
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
-
* ```javascript
|
|
14
|
-
* import { CloudWatchClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
15
|
-
* // const { CloudWatchClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
16
|
-
* const client = new CloudWatchClient(config);
|
|
17
|
-
* const command = new ListTagsForResourceCommand(input);
|
|
18
|
-
* const response = await client.send(command);
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
22
|
-
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
24
|
-
*
|
|
25
|
-
*/
|
|
26
8
|
class ListTagsForResourceCommand extends smithy_client_1.Command {
|
|
27
|
-
// Start section: command_properties
|
|
28
|
-
// End section: command_properties
|
|
29
9
|
constructor(input) {
|
|
30
|
-
// Start section: command_constructor
|
|
31
10
|
super();
|
|
32
11
|
this.input = input;
|
|
33
|
-
// End section: command_constructor
|
|
34
12
|
}
|
|
35
|
-
/**
|
|
36
|
-
* @internal
|
|
37
|
-
*/
|
|
38
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
39
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
40
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,37 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Creates an anomaly detection model for a CloudWatch metric. You can use the model
|
|
10
|
-
* to display a band of expected normal values when the metric is graphed.</p>
|
|
11
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html">CloudWatch Anomaly Detection</a>.</p>
|
|
12
|
-
* @example
|
|
13
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
-
* ```javascript
|
|
15
|
-
* import { CloudWatchClient, PutAnomalyDetectorCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
16
|
-
* // const { CloudWatchClient, PutAnomalyDetectorCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
17
|
-
* const client = new CloudWatchClient(config);
|
|
18
|
-
* const command = new PutAnomalyDetectorCommand(input);
|
|
19
|
-
* const response = await client.send(command);
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* @see {@link PutAnomalyDetectorCommandInput} for command's `input` shape.
|
|
23
|
-
* @see {@link PutAnomalyDetectorCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
27
8
|
class PutAnomalyDetectorCommand extends smithy_client_1.Command {
|
|
28
|
-
// Start section: command_properties
|
|
29
|
-
// End section: command_properties
|
|
30
9
|
constructor(input) {
|
|
31
|
-
// Start section: command_constructor
|
|
32
10
|
super();
|
|
33
11
|
this.input = input;
|
|
34
|
-
// End section: command_constructor
|
|
35
12
|
}
|
|
36
|
-
/**
|
|
37
|
-
* @internal
|
|
38
|
-
*/
|
|
39
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
40
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
41
15
|
const stack = clientStack.concat(this.middlewareStack);
|
|
@@ -5,70 +5,11 @@ const middleware_serde_1 = require("@aws-sdk/middleware-serde");
|
|
|
5
5
|
const smithy_client_1 = require("@aws-sdk/smithy-client");
|
|
6
6
|
const models_0_1 = require("../models/models_0");
|
|
7
7
|
const Aws_query_1 = require("../protocols/Aws_query");
|
|
8
|
-
/**
|
|
9
|
-
* <p>Creates or updates a <i>composite alarm</i>. When you create a composite
|
|
10
|
-
* alarm, you specify a rule expression for the alarm that takes into account the alarm
|
|
11
|
-
* states of other alarms that you have created. The composite alarm goes into ALARM state
|
|
12
|
-
* only if all conditions of the rule are met.</p>
|
|
13
|
-
* <p>The alarms specified in a composite alarm's rule expression can include metric alarms
|
|
14
|
-
* and other composite alarms.</p>
|
|
15
|
-
* <p>Using composite alarms can reduce
|
|
16
|
-
* alarm noise. You can create multiple metric alarms,
|
|
17
|
-
* and also create a composite alarm and
|
|
18
|
-
* set up alerts only
|
|
19
|
-
* for the composite alarm. For example, you could create a composite
|
|
20
|
-
* alarm that goes into ALARM state only when more than one of the underlying metric alarms
|
|
21
|
-
* are in ALARM state.</p>
|
|
22
|
-
* <p>Currently, the only alarm actions that can be taken by composite alarms are notifying
|
|
23
|
-
* SNS topics.</p>
|
|
24
|
-
* <note>
|
|
25
|
-
* <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
|
|
26
|
-
* 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
|
|
27
|
-
* because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
|
|
28
|
-
* <p>To get out of such a situation, you must
|
|
29
|
-
* 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
|
|
30
|
-
* change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>False</code>. </p>
|
|
31
|
-
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
|
|
32
|
-
* </p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
35
|
-
* <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
|
|
36
|
-
* appropriately. Any actions associated with the new state are then executed. For a
|
|
37
|
-
* composite alarm, this initial time after creation is the only time that
|
|
38
|
-
* the
|
|
39
|
-
* alarm can be in <code>INSUFFICIENT_DATA</code> state.</p>
|
|
40
|
-
* <p>When you update an existing alarm, its state is left unchanged, but the update
|
|
41
|
-
* completely overwrites the previous configuration of the alarm.</p>
|
|
42
|
-
*
|
|
43
|
-
* <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
|
|
44
|
-
* a composite alarm that has Systems Manager OpsItem actions.</p>
|
|
45
|
-
* @example
|
|
46
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
47
|
-
* ```javascript
|
|
48
|
-
* import { CloudWatchClient, PutCompositeAlarmCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
49
|
-
* // const { CloudWatchClient, PutCompositeAlarmCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
50
|
-
* const client = new CloudWatchClient(config);
|
|
51
|
-
* const command = new PutCompositeAlarmCommand(input);
|
|
52
|
-
* const response = await client.send(command);
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @see {@link PutCompositeAlarmCommandInput} for command's `input` shape.
|
|
56
|
-
* @see {@link PutCompositeAlarmCommandOutput} for command's `response` shape.
|
|
57
|
-
* @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
|
|
58
|
-
*
|
|
59
|
-
*/
|
|
60
8
|
class PutCompositeAlarmCommand extends smithy_client_1.Command {
|
|
61
|
-
// Start section: command_properties
|
|
62
|
-
// End section: command_properties
|
|
63
9
|
constructor(input) {
|
|
64
|
-
// Start section: command_constructor
|
|
65
10
|
super();
|
|
66
11
|
this.input = input;
|
|
67
|
-
// End section: command_constructor
|
|
68
12
|
}
|
|
69
|
-
/**
|
|
70
|
-
* @internal
|
|
71
|
-
*/
|
|
72
13
|
resolveMiddleware(clientStack, configuration, options) {
|
|
73
14
|
this.middlewareStack.use(middleware_serde_1.getSerdePlugin(configuration, this.serialize, this.deserialize));
|
|
74
15
|
const stack = clientStack.concat(this.middlewareStack);
|