@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,42 +6,11 @@ export interface PutDashboardCommandInput extends PutDashboardInput {
6
6
  }
7
7
  export interface PutDashboardCommandOutput extends PutDashboardOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,
11
- * the entire contents are replaced with what you specify here.</p>
12
- * <p>All dashboards in your account are global, not region-specific.</p>
13
- * <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an
14
- * existing dashboard. To copy an existing dashboard using the console, you can load the dashboard
15
- * and then use the View/edit source command in the Actions menu to display the JSON block
16
- * for that dashboard. Another way to copy a dashboard is to
17
- * use <code>GetDashboard</code>, and then use the data returned
18
- * within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p>
19
- * <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to
20
- * add a text widget at the top of the dashboard with a message that the dashboard was created by script and should
21
- * not be changed in the console. This message could also point console users to the location
22
- * of the <code>DashboardBody</code> script or the CloudFormation template used to create the
23
- * dashboard.</p>
24
- * @example
25
- * Use a bare-bones client and the command you need to make an API call.
26
- * ```javascript
27
- * import { CloudWatchClient, PutDashboardCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
28
- * // const { CloudWatchClient, PutDashboardCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
29
- * const client = new CloudWatchClient(config);
30
- * const command = new PutDashboardCommand(input);
31
- * const response = await client.send(command);
32
- * ```
33
- *
34
- * @see {@link PutDashboardCommandInput} for command's `input` shape.
35
- * @see {@link PutDashboardCommandOutput} for command's `response` shape.
36
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
37
- *
38
- */
9
+
39
10
  export declare class PutDashboardCommand extends $Command<PutDashboardCommandInput, PutDashboardCommandOutput, CloudWatchClientResolvedConfig> {
40
11
  readonly input: PutDashboardCommandInput;
41
12
  constructor(input: PutDashboardCommandInput);
42
- /**
43
- * @internal
44
- */
13
+
45
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutDashboardCommandInput, PutDashboardCommandOutput>;
46
15
  private serialize;
47
16
  private deserialize;
@@ -6,33 +6,11 @@ export interface PutInsightRuleCommandInput extends PutInsightRuleInput {
6
6
  }
7
7
  export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates a Contributor Insights rule. Rules evaluate log events in a
11
- * CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information,
12
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor Insights to Analyze High-Cardinality Data</a>.</p>
13
- * <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
14
- * the rule was created might not be available.</p>
15
- * @example
16
- * Use a bare-bones client and the command you need to make an API call.
17
- * ```javascript
18
- * import { CloudWatchClient, PutInsightRuleCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
19
- * // const { CloudWatchClient, PutInsightRuleCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
20
- * const client = new CloudWatchClient(config);
21
- * const command = new PutInsightRuleCommand(input);
22
- * const response = await client.send(command);
23
- * ```
24
- *
25
- * @see {@link PutInsightRuleCommandInput} for command's `input` shape.
26
- * @see {@link PutInsightRuleCommandOutput} for command's `response` shape.
27
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
28
- *
29
- */
9
+
30
10
  export declare class PutInsightRuleCommand extends $Command<PutInsightRuleCommandInput, PutInsightRuleCommandOutput, CloudWatchClientResolvedConfig> {
31
11
  readonly input: PutInsightRuleCommandInput;
32
12
  constructor(input: PutInsightRuleCommandInput);
33
- /**
34
- * @internal
35
- */
13
+
36
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutInsightRuleCommandInput, PutInsightRuleCommandOutput>;
37
15
  private serialize;
38
16
  private deserialize;
@@ -6,92 +6,11 @@ export interface PutMetricAlarmCommandInput extends PutMetricAlarmInput {
6
6
  }
7
7
  export interface PutMetricAlarmCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates or updates an alarm and associates it with the specified metric, metric math expression,
11
- * or anomaly detection model.</p>
12
- *
13
- *
14
- * <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
15
- * <p>When this operation creates an alarm, the alarm state is immediately set to
16
- * <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
17
- * appropriately. Any actions associated with the new state are then executed.</p>
18
- * <p>When you update an existing alarm, its state is left unchanged, but the
19
- * update completely overwrites the previous configuration of the alarm.</p>
20
- *
21
- * <p>If you are an IAM user, you must have
22
- * Amazon EC2 permissions for some alarm operations:</p>
23
- * <ul>
24
- * <li>
25
- * <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
26
- *
27
- * </li>
28
- * <li>
29
- *
30
- * <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
31
- * with Systems Manager OpsItem actions.</p>
32
- * </li>
33
- * </ul>
34
- *
35
- *
36
- *
37
- *
38
- *
39
- *
40
- * <p>The first time you create an alarm in the
41
- * Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
42
- * creates the necessary service-linked role for you. The service-linked roles
43
- * are called <code>AWSServiceRoleForCloudWatchEvents</code> and
44
- * <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>.
45
- * For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
46
- *
47
- * <p>
48
- * <b>Cross-account alarms</b>
49
- * </p>
50
- *
51
- * <p>You can set an alarm on metrics in the current account, or in another
52
- * account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following
53
- * pre-requisites:</p>
54
- * <ul>
55
- * <li>
56
- * <p>The account where the metrics are located (the <i>sharing account</i>) must
57
- * already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not already
58
- * have this role, you must create it using the instructions in <b>Set up a
59
- * sharing account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
60
- * Cross-account cross-Region CloudWatch console</a>. The policy for that
61
- * role must grant access
62
- * to the ID of the account where you are creating the alarm.
63
- * </p>
64
- * </li>
65
- * <li>
66
- * <p>The account where you are creating the alarm (the <i>monitoring account</i>) must
67
- * already have a service-linked role named
68
- * <b>AWSServiceRoleForCloudWatchCrossAccount</b> to allow
69
- * CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in <b>Set up a
70
- * monitoring account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
71
- * Cross-account cross-Region CloudWatch console</a>.</p>
72
- * </li>
73
- * </ul>
74
- * @example
75
- * Use a bare-bones client and the command you need to make an API call.
76
- * ```javascript
77
- * import { CloudWatchClient, PutMetricAlarmCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
78
- * // const { CloudWatchClient, PutMetricAlarmCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
79
- * const client = new CloudWatchClient(config);
80
- * const command = new PutMetricAlarmCommand(input);
81
- * const response = await client.send(command);
82
- * ```
83
- *
84
- * @see {@link PutMetricAlarmCommandInput} for command's `input` shape.
85
- * @see {@link PutMetricAlarmCommandOutput} for command's `response` shape.
86
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
87
- *
88
- */
9
+
89
10
  export declare class PutMetricAlarmCommand extends $Command<PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput, CloudWatchClientResolvedConfig> {
90
11
  readonly input: PutMetricAlarmCommandInput;
91
12
  constructor(input: PutMetricAlarmCommandInput);
92
- /**
93
- * @internal
94
- */
13
+
95
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput>;
96
15
  private serialize;
97
16
  private deserialize;
@@ -6,73 +6,11 @@ export interface PutMetricDataCommandInput extends PutMetricDataInput {
6
6
  }
7
7
  export interface PutMetricDataCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates
11
- * the data points with the specified metric. If the specified metric does not exist,
12
- * CloudWatch creates the metric. When CloudWatch creates a metric, it can
13
- * take up to fifteen minutes for the metric to appear in calls to <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html">ListMetrics</a>.</p>
14
- *
15
- * <p>You can publish either individual data points in the <code>Value</code> field, or
16
- * arrays of values and the number of times each value occurred during the period by using the
17
- * <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using
18
- * the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric
19
- * with one <code>PutMetricData</code> request, and
20
- * supports retrieving percentile statistics on this data.</p>
21
- * <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests. You can
22
- * send a payload compressed by gzip. Each request
23
- * is also limited to no more than 20 different metrics.</p>
24
- * <p>Although the <code>Value</code> parameter accepts numbers of type
25
- * <code>Double</code>, CloudWatch rejects values that are either too small
26
- * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
27
- * -Infinity) are not supported.</p>
28
- * <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension
29
- * consists of a Name and Value pair. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the
30
- * <i>Amazon CloudWatch User Guide</i>.</p>
31
- *
32
- * <p>You specify the time stamp to be associated with each data point. You can specify
33
- * time stamps that are as much as two weeks before the current date, and as much as 2 hours after
34
- * the current day and time.</p>
35
- * <p>Data points with time stamps from 24 hours ago or longer can take at least 48
36
- * hours to become available for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
37
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a> from the time they
38
- * are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available
39
- * for for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
40
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
41
- * <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
42
- * data using a statistic set instead, you can only retrieve
43
- * percentile statistics for this data if one of the following conditions is true:</p>
44
- * <ul>
45
- * <li>
46
- * <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>,
47
- * <code>Max</code>, and <code>Sum</code> are all equal.</p>
48
- * </li>
49
- * <li>
50
- * <p>The <code>Min</code> and
51
- * <code>Max</code> are equal, and <code>Sum</code> is equal to <code>Min</code>
52
- * multiplied by <code>SampleCount</code>.</p>
53
- * </li>
54
- * </ul>
55
- * @example
56
- * Use a bare-bones client and the command you need to make an API call.
57
- * ```javascript
58
- * import { CloudWatchClient, PutMetricDataCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
59
- * // const { CloudWatchClient, PutMetricDataCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
60
- * const client = new CloudWatchClient(config);
61
- * const command = new PutMetricDataCommand(input);
62
- * const response = await client.send(command);
63
- * ```
64
- *
65
- * @see {@link PutMetricDataCommandInput} for command's `input` shape.
66
- * @see {@link PutMetricDataCommandOutput} for command's `response` shape.
67
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
68
- *
69
- */
9
+
70
10
  export declare class PutMetricDataCommand extends $Command<PutMetricDataCommandInput, PutMetricDataCommandOutput, CloudWatchClientResolvedConfig> {
71
11
  readonly input: PutMetricDataCommandInput;
72
12
  constructor(input: PutMetricDataCommandInput);
73
- /**
74
- * @internal
75
- */
13
+
76
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricDataCommandInput, PutMetricDataCommandOutput>;
77
15
  private serialize;
78
16
  private deserialize;
@@ -6,56 +6,11 @@ export interface PutMetricStreamCommandInput extends PutMetricStreamInput {
6
6
  }
7
7
  export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics
11
- * to Amazon Web Services destinations including
12
- * Amazon S3 and to many third-party solutions.</p>
13
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Metric-Streams.html">
14
- * Using Metric Streams</a>.</p>
15
- * <p>To create a metric stream,
16
- * you must be logged on to an account that has the <code>iam:PassRole</code> permission
17
- * and either the <code>CloudWatchFullAccess</code>
18
- * policy or the <code>cloudwatch:PutMetricStream</code>
19
- * permission.</p>
20
- * <p>When you create or update a metric stream, you choose one of the following:</p>
21
- * <ul>
22
- * <li>
23
- * <p>Stream metrics from all metric namespaces in the account.</p>
24
- * </li>
25
- * <li>
26
- * <p>Stream metrics from all metric namespaces in the account, except
27
- * for the namespaces that you list in <code>ExcludeFilters</code>.</p>
28
- * </li>
29
- * <li>
30
- * <p>Stream metrics from only the metric namespaces that you list in
31
- * <code>IncludeFilters</code>.</p>
32
- * </li>
33
- * </ul>
34
- *
35
- * <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
36
- * is created in the <code>running</code> state. If you use it to update an existing stream,
37
- * the state of the stream is not changed.</p>
38
- * @example
39
- * Use a bare-bones client and the command you need to make an API call.
40
- * ```javascript
41
- * import { CloudWatchClient, PutMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
42
- * // const { CloudWatchClient, PutMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
43
- * const client = new CloudWatchClient(config);
44
- * const command = new PutMetricStreamCommand(input);
45
- * const response = await client.send(command);
46
- * ```
47
- *
48
- * @see {@link PutMetricStreamCommandInput} for command's `input` shape.
49
- * @see {@link PutMetricStreamCommandOutput} for command's `response` shape.
50
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
51
- *
52
- */
9
+
53
10
  export declare class PutMetricStreamCommand extends $Command<PutMetricStreamCommandInput, PutMetricStreamCommandOutput, CloudWatchClientResolvedConfig> {
54
11
  readonly input: PutMetricStreamCommandInput;
55
12
  constructor(input: PutMetricStreamCommandInput);
56
- /**
57
- * @internal
58
- */
13
+
59
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricStreamCommandInput, PutMetricStreamCommandOutput>;
60
15
  private serialize;
61
16
  private deserialize;
@@ -6,44 +6,11 @@ export interface SetAlarmStateCommandInput extends SetAlarmStateInput {
6
6
  }
7
7
  export interface SetAlarmStateCommandOutput extends __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Temporarily sets the state of an alarm for testing purposes. When the updated
11
- * state differs from the previous value, the action configured for
12
- * the appropriate state is invoked. For example, if your alarm is configured to send an
13
- * Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to
14
- * <code>ALARM</code> sends an SNS message.</p>
15
- * <p>Metric alarms
16
- * returns to their actual state quickly, often within seconds. Because the metric alarm state change
17
- * happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through
18
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html">DescribeAlarmHistory</a>.</p>
19
- * <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is not guaranteed to return
20
- * to its actual state. It
21
- * returns to its actual state only once any of its children alarms change state. It is also
22
- * reevaluated if you update its
23
- * configuration.</p>
24
- * <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include
25
- * information in the <code>StateReasonData</code> parameter to enable the policy to take the correct action.</p>
26
- * @example
27
- * Use a bare-bones client and the command you need to make an API call.
28
- * ```javascript
29
- * import { CloudWatchClient, SetAlarmStateCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
30
- * // const { CloudWatchClient, SetAlarmStateCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
31
- * const client = new CloudWatchClient(config);
32
- * const command = new SetAlarmStateCommand(input);
33
- * const response = await client.send(command);
34
- * ```
35
- *
36
- * @see {@link SetAlarmStateCommandInput} for command's `input` shape.
37
- * @see {@link SetAlarmStateCommandOutput} for command's `response` shape.
38
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
39
- *
40
- */
9
+
41
10
  export declare class SetAlarmStateCommand extends $Command<SetAlarmStateCommandInput, SetAlarmStateCommandOutput, CloudWatchClientResolvedConfig> {
42
11
  readonly input: SetAlarmStateCommandInput;
43
12
  constructor(input: SetAlarmStateCommandInput);
44
- /**
45
- * @internal
46
- */
13
+
47
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetAlarmStateCommandInput, SetAlarmStateCommandOutput>;
48
15
  private serialize;
49
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface StartMetricStreamsCommandInput extends StartMetricStreamsInput
6
6
  }
7
7
  export interface StartMetricStreamsCommandOutput extends StartMetricStreamsOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Starts the streaming of metrics for one or more of your metric streams.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { CloudWatchClient, StartMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
15
- * // const { CloudWatchClient, StartMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
16
- * const client = new CloudWatchClient(config);
17
- * const command = new StartMetricStreamsCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link StartMetricStreamsCommandInput} for command's `input` shape.
22
- * @see {@link StartMetricStreamsCommandOutput} for command's `response` shape.
23
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class StartMetricStreamsCommand extends $Command<StartMetricStreamsCommandInput, StartMetricStreamsCommandOutput, CloudWatchClientResolvedConfig> {
27
11
  readonly input: StartMetricStreamsCommandInput;
28
12
  constructor(input: StartMetricStreamsCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartMetricStreamsCommandInput, StartMetricStreamsCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface StopMetricStreamsCommandInput extends StopMetricStreamsInput {
6
6
  }
7
7
  export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Stops the streaming of metrics for one or more of your metric streams.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { CloudWatchClient, StopMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
15
- * // const { CloudWatchClient, StopMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
16
- * const client = new CloudWatchClient(config);
17
- * const command = new StopMetricStreamsCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link StopMetricStreamsCommandInput} for command's `input` shape.
22
- * @see {@link StopMetricStreamsCommandOutput} for command's `response` shape.
23
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class StopMetricStreamsCommand extends $Command<StopMetricStreamsCommandInput, StopMetricStreamsCommandOutput, CloudWatchClientResolvedConfig> {
27
11
  readonly input: StopMetricStreamsCommandInput;
28
12
  constructor(input: StopMetricStreamsCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopMetricStreamsCommandInput, StopMetricStreamsCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -6,39 +6,11 @@ export interface TagResourceCommandInput extends TagResourceInput {
6
6
  }
7
7
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that
11
- * can be tagged are alarms and Contributor Insights rules.</p>
12
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
13
- * permissions by granting a user
14
- * permission to access or change only resources with certain tag values.</p>
15
- * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
16
- * <p>You can use the <code>TagResource</code> action with an alarm that already has tags. If you specify a new tag key for the alarm,
17
- * this tag is appended to the list of tags associated
18
- * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
19
- * the previous value for that tag.</p>
20
- * <p>You can associate as many as 50 tags with a CloudWatch resource.</p>
21
- * @example
22
- * Use a bare-bones client and the command you need to make an API call.
23
- * ```javascript
24
- * import { CloudWatchClient, TagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
25
- * // const { CloudWatchClient, TagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
26
- * const client = new CloudWatchClient(config);
27
- * const command = new TagResourceCommand(input);
28
- * const response = await client.send(command);
29
- * ```
30
- *
31
- * @see {@link TagResourceCommandInput} for command's `input` shape.
32
- * @see {@link TagResourceCommandOutput} for command's `response` shape.
33
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
34
- *
35
- */
9
+
36
10
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CloudWatchClientResolvedConfig> {
37
11
  readonly input: TagResourceCommandInput;
38
12
  constructor(input: TagResourceCommandInput);
39
- /**
40
- * @internal
41
- */
13
+
42
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
43
15
  private serialize;
44
16
  private deserialize;
@@ -6,29 +6,11 @@ export interface UntagResourceCommandInput extends UntagResourceInput {
6
6
  }
7
7
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
8
8
  }
9
- /**
10
- * <p>Removes one or more tags from the specified resource.</p>
11
- * @example
12
- * Use a bare-bones client and the command you need to make an API call.
13
- * ```javascript
14
- * import { CloudWatchClient, UntagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
15
- * // const { CloudWatchClient, UntagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
16
- * const client = new CloudWatchClient(config);
17
- * const command = new UntagResourceCommand(input);
18
- * const response = await client.send(command);
19
- * ```
20
- *
21
- * @see {@link UntagResourceCommandInput} for command's `input` shape.
22
- * @see {@link UntagResourceCommandOutput} for command's `response` shape.
23
- * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape.
24
- *
25
- */
9
+
26
10
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CloudWatchClientResolvedConfig> {
27
11
  readonly input: UntagResourceCommandInput;
28
12
  constructor(input: UntagResourceCommandInput);
29
- /**
30
- * @internal
31
- */
13
+
32
14
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
33
15
  private serialize;
34
16
  private deserialize;
@@ -0,0 +1,36 @@
1
+ export * from "./DeleteAlarmsCommand";
2
+ export * from "./DeleteAnomalyDetectorCommand";
3
+ export * from "./DeleteDashboardsCommand";
4
+ export * from "./DeleteInsightRulesCommand";
5
+ export * from "./DeleteMetricStreamCommand";
6
+ export * from "./DescribeAlarmHistoryCommand";
7
+ export * from "./DescribeAlarmsCommand";
8
+ export * from "./DescribeAlarmsForMetricCommand";
9
+ export * from "./DescribeAnomalyDetectorsCommand";
10
+ export * from "./DescribeInsightRulesCommand";
11
+ export * from "./DisableAlarmActionsCommand";
12
+ export * from "./DisableInsightRulesCommand";
13
+ export * from "./EnableAlarmActionsCommand";
14
+ export * from "./EnableInsightRulesCommand";
15
+ export * from "./GetDashboardCommand";
16
+ export * from "./GetInsightRuleReportCommand";
17
+ export * from "./GetMetricDataCommand";
18
+ export * from "./GetMetricStatisticsCommand";
19
+ export * from "./GetMetricStreamCommand";
20
+ export * from "./GetMetricWidgetImageCommand";
21
+ export * from "./ListDashboardsCommand";
22
+ export * from "./ListMetricStreamsCommand";
23
+ export * from "./ListMetricsCommand";
24
+ export * from "./ListTagsForResourceCommand";
25
+ export * from "./PutAnomalyDetectorCommand";
26
+ export * from "./PutCompositeAlarmCommand";
27
+ export * from "./PutDashboardCommand";
28
+ export * from "./PutInsightRuleCommand";
29
+ export * from "./PutMetricAlarmCommand";
30
+ export * from "./PutMetricDataCommand";
31
+ export * from "./PutMetricStreamCommand";
32
+ export * from "./SetAlarmStateCommand";
33
+ export * from "./StartMetricStreamsCommand";
34
+ export * from "./StopMetricStreamsCommand";
35
+ export * from "./TagResourceCommand";
36
+ export * from "./UntagResourceCommand";
@@ -1,49 +1,6 @@
1
- export * from "./CloudWatchClient";
2
1
  export * from "./CloudWatch";
3
- export * from "./commands/DeleteAlarmsCommand";
4
- export * from "./commands/DeleteAnomalyDetectorCommand";
5
- export * from "./commands/DeleteDashboardsCommand";
6
- export * from "./commands/DeleteInsightRulesCommand";
7
- export * from "./commands/DeleteMetricStreamCommand";
8
- export * from "./commands/DescribeAlarmHistoryCommand";
9
- export * from "./pagination/DescribeAlarmHistoryPaginator";
10
- export * from "./commands/DescribeAlarmsCommand";
11
- export * from "./pagination/DescribeAlarmsPaginator";
12
- export * from "./waiters/waitForAlarmExists";
13
- export * from "./waiters/waitForCompositeAlarmExists";
14
- export * from "./commands/DescribeAlarmsForMetricCommand";
15
- export * from "./commands/DescribeAnomalyDetectorsCommand";
16
- export * from "./commands/DescribeInsightRulesCommand";
17
- export * from "./pagination/DescribeInsightRulesPaginator";
18
- export * from "./commands/DisableAlarmActionsCommand";
19
- export * from "./commands/DisableInsightRulesCommand";
20
- export * from "./commands/EnableAlarmActionsCommand";
21
- export * from "./commands/EnableInsightRulesCommand";
22
- export * from "./commands/GetDashboardCommand";
23
- export * from "./commands/GetInsightRuleReportCommand";
24
- export * from "./commands/GetMetricDataCommand";
25
- export * from "./pagination/GetMetricDataPaginator";
26
- export * from "./commands/GetMetricStatisticsCommand";
27
- export * from "./commands/GetMetricStreamCommand";
28
- export * from "./commands/GetMetricWidgetImageCommand";
29
- export * from "./commands/ListDashboardsCommand";
30
- export * from "./pagination/ListDashboardsPaginator";
31
- export * from "./commands/ListMetricsCommand";
32
- export * from "./pagination/ListMetricsPaginator";
33
- export * from "./commands/ListMetricStreamsCommand";
34
- export * from "./pagination/ListMetricStreamsPaginator";
35
- export * from "./commands/ListTagsForResourceCommand";
36
- export * from "./commands/PutAnomalyDetectorCommand";
37
- export * from "./commands/PutCompositeAlarmCommand";
38
- export * from "./commands/PutDashboardCommand";
39
- export * from "./commands/PutInsightRuleCommand";
40
- export * from "./commands/PutMetricAlarmCommand";
41
- export * from "./commands/PutMetricDataCommand";
42
- export * from "./commands/PutMetricStreamCommand";
43
- export * from "./commands/SetAlarmStateCommand";
44
- export * from "./commands/StartMetricStreamsCommand";
45
- export * from "./commands/StopMetricStreamsCommand";
46
- export * from "./commands/TagResourceCommand";
47
- export * from "./commands/UntagResourceCommand";
48
- export * from "./pagination/Interfaces";
49
- export * from "./models/index";
2
+ export * from "./CloudWatchClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
6
+ export * from "./waiters";