Skip to content

Commit 5aadfed

Browse files
author
awstools
committed
feat(client-cloudwatch): Adds support for adding related Entity information to metrics ingested through PutMetricData.
1 parent 4546850 commit 5aadfed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2399
-1950
lines changed

‎clients/client-cloudwatch/README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66

77
AWS SDK for JavaScript CloudWatch Client for Node.js, Browser and React Native.
88

9-
<p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
10-
applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
11-
metrics, which are the variables you want to measure for your resources and
12-
applications.</p>
13-
<p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
14-
that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
15-
instances. Then, use this data to determine whether you should launch
16-
additional instances to handle increased load. You can also use this data to stop
17-
under-used instances to save
18-
money.</p>
19-
<p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
20-
your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
21-
utilization, application performance, and operational health.</p>
9+
<p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
10+
resources and the applications you run on Amazon Web Services in real time. You can use
11+
CloudWatch to collect and track metrics, which are the variables you want to
12+
measure for your resources and applications.</p>
13+
<p>CloudWatch alarms send notifications or automatically change the resources you are
14+
monitoring based on rules that you define. For example, you can monitor the CPU usage
15+
and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
16+
whether you should launch additional instances to handle increased load. You can also
17+
use this data to stop under-used instances to save money.</p>
18+
<p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
19+
you can monitor your own custom metrics. With CloudWatch, you gain system-wide
20+
visibility into resource utilization, application performance, and operational
21+
health.</p>
2222

2323
## Installing
2424

‎clients/client-cloudwatch/src/CloudWatch.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -813,19 +813,19 @@ export interface CloudWatch {
813813
}
814814

815815
/**
816-
* <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
817-
* applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
818-
* metrics, which are the variables you want to measure for your resources and
819-
* applications.</p>
820-
* <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
821-
* that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
822-
* instances. Then, use this data to determine whether you should launch
823-
* additional instances to handle increased load. You can also use this data to stop
824-
* under-used instances to save
825-
* money.</p>
826-
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
827-
* your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
828-
* utilization, application performance, and operational health.</p>
816+
* <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
817+
* resources and the applications you run on Amazon Web Services in real time. You can use
818+
* CloudWatch to collect and track metrics, which are the variables you want to
819+
* measure for your resources and applications.</p>
820+
* <p>CloudWatch alarms send notifications or automatically change the resources you are
821+
* monitoring based on rules that you define. For example, you can monitor the CPU usage
822+
* and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
823+
* whether you should launch additional instances to handle increased load. You can also
824+
* use this data to stop under-used instances to save money.</p>
825+
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
826+
* you can monitor your own custom metrics. With CloudWatch, you gain system-wide
827+
* visibility into resource utilization, application performance, and operational
828+
* health.</p>
829829
* @public
830830
*/
831831
export class CloudWatch extends CloudWatchClient implements CloudWatch {}

‎clients/client-cloudwatch/src/CloudWatchClient.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -406,19 +406,19 @@ export type CloudWatchClientResolvedConfigType = __SmithyResolvedConfiguration<_
406406
export interface CloudWatchClientResolvedConfig extends CloudWatchClientResolvedConfigType {}
407407

408408
/**
409-
* <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
410-
* applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
411-
* metrics, which are the variables you want to measure for your resources and
412-
* applications.</p>
413-
* <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
414-
* that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
415-
* instances. Then, use this data to determine whether you should launch
416-
* additional instances to handle increased load. You can also use this data to stop
417-
* under-used instances to save
418-
* money.</p>
419-
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
420-
* your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
421-
* utilization, application performance, and operational health.</p>
409+
* <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
410+
* resources and the applications you run on Amazon Web Services in real time. You can use
411+
* CloudWatch to collect and track metrics, which are the variables you want to
412+
* measure for your resources and applications.</p>
413+
* <p>CloudWatch alarms send notifications or automatically change the resources you are
414+
* monitoring based on rules that you define. For example, you can monitor the CPU usage
415+
* and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
416+
* whether you should launch additional instances to handle increased load. You can also
417+
* use this data to stop under-used instances to save money.</p>
418+
* <p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
419+
* you can monitor your own custom metrics. With CloudWatch, you gain system-wide
420+
* visibility into resource utilization, application performance, and operational
421+
* health.</p>
422422
* @public
423423
*/
424424
export class CloudWatchClient extends __Client<

‎clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts

+18-16
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,25 @@ export interface DeleteAlarmsCommandInput extends DeleteAlarmsInput {}
2828
export interface DeleteAlarmsCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more
32-
* than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't
33-
* delete two composite alarms with one operation.</p>
34-
* <p>
35-
* If you specify an incorrect alarm name or make any other error in the operation, no alarms are
36-
* deleted. To confirm that alarms were deleted successfully, you can use
37-
* the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using
38-
* <code>DeleteAlarms</code>.</p>
31+
* <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation.
32+
* However, this total can include no more than one composite alarm. For example, you could
33+
* delete 99 metric alarms and one composite alarms with one operation, but you can't
34+
* delete two composite alarms with one operation.</p>
35+
* <p> If you specify an incorrect alarm name or make any other error in the operation,
36+
* no alarms are deleted. To confirm that alarms were deleted successfully, you can use the
37+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using <code>DeleteAlarms</code>.</p>
3938
* <note>
40-
* <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
41-
* 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
42-
* because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
43-
* <p>To get out of such a situation, you must
44-
* 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
45-
* change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
46-
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
47-
* </p>
39+
* <p>It is possible to create a loop or cycle of composite alarms, where composite
40+
* alarm A depends on composite alarm B, and composite alarm B also depends on
41+
* composite alarm A. In this scenario, you can't delete any composite alarm that is
42+
* part of the cycle because there is always still a composite alarm that depends on
43+
* that alarm that you want to delete.</p>
44+
* <p>To get out of such a situation, you must break the cycle by changing the rule of
45+
* one of the composite alarms in the cycle to remove a dependency that creates the
46+
* cycle. The simplest change to make to break a cycle is to change the
47+
* <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
48+
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch
49+
* detects a cycle in the evaluation path. </p>
4850
* </note>
4951
* @example
5052
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-cloudwatch/src/commands/DeleteAnomalyDetectorCommand.ts

+5-10
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,9 @@ export interface DeleteAnomalyDetectorCommandInput extends DeleteAnomalyDetector
2828
export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetectorOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>
32-
* Deletes the specified anomaly detection model
33-
* from your account.
34-
* For more information
35-
* about
36-
* how to delete an anomaly detection model,
37-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model">Deleting an anomaly detection model</a>
38-
* in the <i>CloudWatch User Guide</i>.
39-
* </p>
31+
* <p> Deletes the specified anomaly detection model from your account. For more information
32+
* about how to delete an anomaly detection model, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model">Deleting an anomaly detection model</a> in the <i>CloudWatch User
33+
* Guide</i>. </p>
4034
* @example
4135
* Use a bare-bones client and the command you need to make an API call.
4236
* ```javascript
@@ -101,7 +95,8 @@ export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetecto
10195
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
10296
*
10397
* @throws {@link InternalServiceFault} (server fault)
104-
* <p>Request processing has failed due to some unknown error, exception, or failure.</p>
98+
* <p>Request processing has failed due to some unknown error, exception, or
99+
* failure.</p>
105100
*
106101
* @throws {@link InvalidParameterCombinationException} (client fault)
107102
* <p>Parameters were used together that cannot be used together.</p>

‎clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ export interface DeleteDashboardsCommandInput extends DeleteDashboardsInput {}
2828
export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes all dashboards that you specify. You
32-
* can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are
33-
* deleted.</p>
31+
* <p>Deletes all dashboards that you specify. You can specify up to 100 dashboards to
32+
* delete. If there is an error during this call, no dashboards are deleted.</p>
3433
* @example
3534
* Use a bare-bones client and the command you need to make an API call.
3635
* ```javascript
@@ -58,7 +57,8 @@ export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, _
5857
* <p>The specified dashboard does not exist.</p>
5958
*
6059
* @throws {@link InternalServiceFault} (server fault)
61-
* <p>Request processing has failed due to some unknown error, exception, or failure.</p>
60+
* <p>Request processing has failed due to some unknown error, exception, or
61+
* failure.</p>
6262
*
6363
* @throws {@link InvalidParameterValueException} (client fault)
6464
* <p>The value of an input parameter is bad or out-of-range.</p>

‎clients/client-cloudwatch/src/commands/DeleteInsightRulesCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ export interface DeleteInsightRulesCommandOutput extends DeleteInsightRulesOutpu
2929

3030
/**
3131
* <p>Permanently deletes the specified Contributor Insights rules.</p>
32-
* <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
33-
* the rule was created might
34-
* not be available.</p>
32+
* <p>If you create a rule, delete it, and then re-create it with the same name, historical
33+
* data from the first time the rule was created might not be available.</p>
3534
* @example
3635
* Use a bare-bones client and the command you need to make an API call.
3736
* ```javascript

‎clients/client-cloudwatch/src/commands/DeleteMetricStreamCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ export interface DeleteMetricStreamCommandOutput extends DeleteMetricStreamOutpu
5151
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
5252
*
5353
* @throws {@link InternalServiceFault} (server fault)
54-
* <p>Request processing has failed due to some unknown error, exception, or failure.</p>
54+
* <p>Request processing has failed due to some unknown error, exception, or
55+
* failure.</p>
5556
*
5657
* @throws {@link InvalidParameterValueException} (client fault)
5758
* <p>The value of an input parameter is bad or out-of-range.</p>

‎clients/client-cloudwatch/src/commands/DescribeAlarmHistoryCommand.ts

+7-5
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ export interface DescribeAlarmHistoryCommandInput extends DescribeAlarmHistoryIn
2828
export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves the history for the specified alarm. You can filter the results by date range or item type.
32-
* If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p>
31+
* <p>Retrieves the history for the specified alarm. You can filter the results by date
32+
* range or item type. If an alarm name is not specified, the histories for either all
33+
* metric alarms or all composite alarms are returned.</p>
3334
* <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
34-
* <p>To use this operation and return information about a composite alarm, you must be signed on with
35-
* the <code>cloudwatch:DescribeAlarmHistory</code> permission that is scoped to <code>*</code>. You can't return information
36-
* about composite alarms if your <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
35+
* <p>To use this operation and return information about a composite alarm, you must be
36+
* signed on with the <code>cloudwatch:DescribeAlarmHistory</code> permission that is
37+
* scoped to <code>*</code>. You can't return information about composite alarms if your
38+
* <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
3739
* @example
3840
* Use a bare-bones client and the command you need to make an API call.
3941
* ```javascript

‎clients/client-cloudwatch/src/commands/DescribeAlarmsCommand.ts

+6-5
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ export interface DescribeAlarmsCommandInput extends DescribeAlarmsInput {}
2828
export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm
32-
* name, the alarm state, or a prefix for any action.</p>
33-
* <p>To use this operation and return information about composite alarms, you must be signed on with
34-
* the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to <code>*</code>. You can't return information
35-
* about composite alarms if your <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
31+
* <p>Retrieves the specified alarms. You can filter the results by specifying a prefix
32+
* for the alarm name, the alarm state, or a prefix for any action.</p>
33+
* <p>To use this operation and return information about composite alarms, you must be
34+
* signed on with the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to
35+
* <code>*</code>. You can't return information about composite alarms if your
36+
* <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
3637
* @example
3738
* Use a bare-bones client and the command you need to make an API call.
3839
* ```javascript

‎clients/client-cloudwatch/src/commands/DescribeAlarmsForMetricCommand.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ export interface DescribeAlarmsForMetricCommandInput extends DescribeAlarmsForMe
2828
export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForMetricOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves the alarms for the specified metric. To
32-
* filter the results, specify a statistic, period, or unit.</p>
33-
* <p>This operation retrieves only standard alarms that are based on
34-
* the specified metric. It does not return alarms based on math expressions that
35-
* use the specified metric, or composite alarms that use the specified metric.</p>
31+
* <p>Retrieves the alarms for the specified metric. To filter the results, specify a
32+
* statistic, period, or unit.</p>
33+
* <p>This operation retrieves only standard alarms that are based on the specified
34+
* metric. It does not return alarms based on math expressions that use the specified
35+
* metric, or composite alarms that use the specified metric.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

0 commit comments

Comments
 (0)