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