@aws-sdk/client-cloudwatch 3.693.0 → 3.694.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/README.md +13 -13
  2. package/dist-cjs/index.js +110 -17
  3. package/dist-es/protocols/Aws_query.js +112 -16
  4. package/dist-types/CloudWatch.d.ts +13 -13
  5. package/dist-types/CloudWatchClient.d.ts +13 -13
  6. package/dist-types/commands/DeleteAlarmsCommand.d.ts +18 -16
  7. package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +5 -10
  8. package/dist-types/commands/DeleteDashboardsCommand.d.ts +4 -4
  9. package/dist-types/commands/DeleteInsightRulesCommand.d.ts +2 -3
  10. package/dist-types/commands/DeleteMetricStreamCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +7 -5
  12. package/dist-types/commands/DescribeAlarmsCommand.d.ts +6 -5
  13. package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +5 -5
  14. package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +8 -8
  15. package/dist-types/commands/DescribeInsightRulesCommand.d.ts +2 -2
  16. package/dist-types/commands/DisableAlarmActionsCommand.d.ts +2 -2
  17. package/dist-types/commands/DisableInsightRulesCommand.d.ts +2 -2
  18. package/dist-types/commands/EnableInsightRulesCommand.d.ts +2 -1
  19. package/dist-types/commands/GetDashboardCommand.d.ts +5 -4
  20. package/dist-types/commands/GetInsightRuleReportCommand.d.ts +23 -14
  21. package/dist-types/commands/GetMetricDataCommand.d.ts +50 -34
  22. package/dist-types/commands/GetMetricStatisticsCommand.d.ts +38 -27
  23. package/dist-types/commands/GetMetricStreamCommand.d.ts +2 -1
  24. package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +9 -8
  25. package/dist-types/commands/ListDashboardsCommand.d.ts +9 -9
  26. package/dist-types/commands/ListManagedInsightRulesCommand.d.ts +3 -6
  27. package/dist-types/commands/ListMetricStreamsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListMetricsCommand.d.ts +10 -11
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -3
  30. package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +8 -6
  31. package/dist-types/commands/PutCompositeAlarmCommand.d.ts +33 -31
  32. package/dist-types/commands/PutDashboardCommand.d.ts +15 -12
  33. package/dist-types/commands/PutInsightRuleCommand.d.ts +6 -5
  34. package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +9 -16
  35. package/dist-types/commands/PutMetricAlarmCommand.d.ts +32 -35
  36. package/dist-types/commands/PutMetricDataCommand.d.ts +85 -38
  37. package/dist-types/commands/PutMetricStreamCommand.d.ts +22 -21
  38. package/dist-types/commands/SetAlarmStateCommand.d.ts +16 -16
  39. package/dist-types/commands/StartMetricStreamsCommand.d.ts +2 -1
  40. package/dist-types/commands/StopMetricStreamsCommand.d.ts +2 -1
  41. package/dist-types/commands/TagResourceCommand.d.ts +15 -11
  42. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  43. package/dist-types/index.d.ts +13 -13
  44. package/dist-types/models/models_0.d.ts +1312 -1203
  45. package/dist-types/ts3.4/models/models_0.d.ts +28 -18
  46. package/package.json +1 -1
@@ -28,39 +28,39 @@ declare const PutMetricStreamCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
31
- * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
32
- * solutions.</p>
33
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html">
34
- * Using Metric Streams</a>.</p>
31
+ * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
32
+ * solutions.</p>
33
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html"> Using
34
+ * Metric Streams</a>.</p>
35
35
  * <p>To create a metric stream, you must be signed in to an account that has the
36
- * <code>iam:PassRole</code> permission and either the
37
- * <code>CloudWatchFullAccess</code> policy or the
38
- * <code>cloudwatch:PutMetricStream</code> permission.</p>
36
+ * <code>iam:PassRole</code> permission and either the
37
+ * <code>CloudWatchFullAccess</code> policy or the
38
+ * <code>cloudwatch:PutMetricStream</code> permission.</p>
39
39
  * <p>When you create or update a metric stream, you choose one of the following:</p>
40
40
  * <ul>
41
41
  * <li>
42
42
  * <p>Stream metrics from all metric namespaces in the account.</p>
43
43
  * </li>
44
44
  * <li>
45
- * <p>Stream metrics from all metric namespaces in the account, except
46
- * for the namespaces that you list in <code>ExcludeFilters</code>.</p>
45
+ * <p>Stream metrics from all metric namespaces in the account, except for the
46
+ * namespaces that you list in <code>ExcludeFilters</code>.</p>
47
47
  * </li>
48
48
  * <li>
49
49
  * <p>Stream metrics from only the metric namespaces that you list in
50
- * <code>IncludeFilters</code>.</p>
50
+ * <code>IncludeFilters</code>.</p>
51
51
  * </li>
52
52
  * </ul>
53
53
  * <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
54
- * <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
55
- * streamed. You can use the <code>StatisticsConfigurations</code> parameter to have the
56
- * metric stream send additional statistics in the stream. Streaming additional statistics
57
- * incurs additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
58
- * <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream
59
- * is created in the <code>running</code> state. If you use it to update an existing stream,
60
- * the state of the stream is not changed.</p>
61
- * <p>If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account,
62
- * you can choose whether to include metrics from source accounts in the stream. For more information, see
63
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
54
+ * <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
55
+ * streamed. You can use the <code>StatisticsConfigurations</code> parameter to have the
56
+ * metric stream send additional statistics in the stream. Streaming additional statistics
57
+ * incurs additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
58
+ * <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream is
59
+ * created in the <code>running</code> state. If you use it to update an existing stream,
60
+ * the state of the stream is not changed.</p>
61
+ * <p>If you are using CloudWatch cross-account observability and you create a metric
62
+ * stream in a monitoring account, you can choose whether to include metrics from source
63
+ * accounts in the stream. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
64
64
  * @example
65
65
  * Use a bare-bones client and the command you need to make an API call.
66
66
  * ```javascript
@@ -127,7 +127,8 @@ declare const PutMetricStreamCommand_base: {
127
127
  * <p>More than one process tried to modify a resource at the same time.</p>
128
128
  *
129
129
  * @throws {@link InternalServiceFault} (server fault)
130
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
130
+ * <p>Request processing has failed due to some unknown error, exception, or
131
+ * failure.</p>
131
132
  *
132
133
  * @throws {@link InvalidParameterCombinationException} (client fault)
133
134
  * <p>Parameters were used together that cannot be used together.</p>
@@ -27,22 +27,22 @@ declare const SetAlarmStateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Temporarily sets the state of an alarm for testing purposes. When the updated
31
- * state differs from the previous value, the action configured for
32
- * the appropriate state is invoked. For example, if your alarm is configured to send an
33
- * Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to
34
- * <code>ALARM</code> sends an SNS message.</p>
35
- * <p>Metric alarms
36
- * returns to their actual state quickly, often within seconds. Because the metric alarm state change
37
- * happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through
38
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html">DescribeAlarmHistory</a>.</p>
39
- * <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is not guaranteed to return
40
- * to its actual state. It
41
- * returns to its actual state only once any of its children alarms change state. It is also
42
- * reevaluated if you update its
43
- * configuration.</p>
44
- * <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include
45
- * information in the <code>StateReasonData</code> parameter to enable the policy to take the correct action.</p>
30
+ * <p>Temporarily sets the state of an alarm for testing purposes. When the updated state
31
+ * differs from the previous value, the action configured for the appropriate state is
32
+ * invoked. For example, if your alarm is configured to send an Amazon SNS message when an
33
+ * alarm is triggered, temporarily changing the alarm state to <code>ALARM</code> sends an
34
+ * SNS message.</p>
35
+ * <p>Metric alarms returns to their actual state quickly, often within seconds. Because
36
+ * the metric alarm state change happens quickly, it is typically only visible in the
37
+ * alarm's <b>History</b> tab in the Amazon CloudWatch console or
38
+ * through <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html">DescribeAlarmHistory</a>.</p>
39
+ * <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is
40
+ * not guaranteed to return to its actual state. It returns to its actual state only once
41
+ * any of its children alarms change state. It is also reevaluated if you update its
42
+ * configuration.</p>
43
+ * <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling
44
+ * policies, you must include information in the <code>StateReasonData</code> parameter to
45
+ * enable the policy to take the correct action.</p>
46
46
  * @example
47
47
  * Use a bare-bones client and the command you need to make an API call.
48
48
  * ```javascript
@@ -52,7 +52,8 @@ declare const StartMetricStreamsCommand_base: {
52
52
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
53
53
  *
54
54
  * @throws {@link InternalServiceFault} (server fault)
55
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
55
+ * <p>Request processing has failed due to some unknown error, exception, or
56
+ * failure.</p>
56
57
  *
57
58
  * @throws {@link InvalidParameterValueException} (client fault)
58
59
  * <p>The value of an input parameter is bad or out-of-range.</p>
@@ -52,7 +52,8 @@ declare const StopMetricStreamsCommand_base: {
52
52
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
53
53
  *
54
54
  * @throws {@link InternalServiceFault} (server fault)
55
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
55
+ * <p>Request processing has failed due to some unknown error, exception, or
56
+ * failure.</p>
56
57
  *
57
58
  * @throws {@link InvalidParameterValueException} (client fault)
58
59
  * <p>The value of an input parameter is bad or out-of-range.</p>
@@ -27,16 +27,19 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that
31
- * can be tagged are alarms and Contributor Insights rules.</p>
32
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
33
- * permissions by granting a user
34
- * permission to access or change only resources with certain tag values.</p>
35
- * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
36
- * <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,
37
- * this tag is appended to the list of tags associated
38
- * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
39
- * the previous value for that tag.</p>
30
+ * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.
31
+ * Currently, the only CloudWatch resources that can be tagged are alarms and Contributor
32
+ * Insights rules.</p>
33
+ * <p>Tags can help you organize and categorize your resources. You can also use them to
34
+ * scope user permissions by granting a user permission to access or change only resources
35
+ * with certain tag values.</p>
36
+ * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted
37
+ * strictly as strings of characters.</p>
38
+ * <p>You can use the <code>TagResource</code> action with an alarm that already has tags.
39
+ * If you specify a new tag key for the alarm, this tag is appended to the list of tags
40
+ * associated with the alarm. If you specify a tag key that is already associated with the
41
+ * alarm, the new tag value that you specify replaces the previous value for that
42
+ * tag.</p>
40
43
  * <p>You can associate as many as 50 tags with a CloudWatch resource.</p>
41
44
  * @example
42
45
  * Use a bare-bones client and the command you need to make an API call.
@@ -69,7 +72,8 @@ declare const TagResourceCommand_base: {
69
72
  * <p>More than one process tried to modify a resource at the same time.</p>
70
73
  *
71
74
  * @throws {@link InternalServiceFault} (server fault)
72
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
75
+ * <p>Request processing has failed due to some unknown error, exception, or
76
+ * failure.</p>
73
77
  *
74
78
  * @throws {@link InvalidParameterValueException} (client fault)
75
79
  * <p>The value of an input parameter is bad or out-of-range.</p>
@@ -56,7 +56,8 @@ declare const UntagResourceCommand_base: {
56
56
  * <p>More than one process tried to modify a resource at the same time.</p>
57
57
  *
58
58
  * @throws {@link InternalServiceFault} (server fault)
59
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
59
+ * <p>Request processing has failed due to some unknown error, exception, or
60
+ * failure.</p>
60
61
  *
61
62
  * @throws {@link InvalidParameterValueException} (client fault)
62
63
  * <p>The value of an input parameter is bad or out-of-range.</p>
@@ -1,17 +1,17 @@
1
1
  /**
2
- * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
3
- * applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
4
- * metrics, which are the variables you want to measure for your resources and
5
- * applications.</p>
6
- * <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
7
- * that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
8
- * instances. Then, use this data to determine whether you should launch
9
- * additional instances to handle increased load. You can also use this data to stop
10
- * under-used instances to save
11
- * money.</p>
12
- * <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
13
- * your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
14
- * utilization, application performance, and operational health.</p>
2
+ * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
3
+ * resources and the applications you run on Amazon Web Services in real time. You can use
4
+ * CloudWatch to collect and track metrics, which are the variables you want to
5
+ * measure for your resources and applications.</p>
6
+ * <p>CloudWatch alarms send notifications or automatically change the resources you are
7
+ * monitoring based on rules that you define. For example, you can monitor the CPU usage
8
+ * and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
9
+ * whether you should launch additional instances to handle increased load. You can also
10
+ * use this data to stop under-used instances to save money.</p>
11
+ * <p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
12
+ * you can monitor your own custom metrics. With CloudWatch, you gain system-wide
13
+ * visibility into resource utilization, application performance, and operational
14
+ * health.</p>
15
15
  *
16
16
  * @packageDocumentation
17
17
  */