feat(client-cloudwatch): Adds support for adding related Entity infor…

…mation to metrics ingested through PutMetricData.
aws · Nov 15, 2024 · 5aadfed · 5aadfed
1 parent 4546850
commit 5aadfed
Show file tree

Hide file tree

Showing 44 changed files with 2,399 additions and 1,950 deletions.
diff --git a/clients/client-cloudwatch/README.md b/clients/client-cloudwatch/README.md
@@ -6,19 +6,19 @@
 
 AWS SDK for JavaScript CloudWatch Client for Node.js, Browser and React Native.
 
-<p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
-applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
-metrics, which are the variables you want to measure for your resources and
-applications.</p>
-<p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
-that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
-instances. Then, use this data to determine whether you should launch
-additional instances to handle increased load. You can also use this data to stop
-under-used instances to save
-money.</p>
-<p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
-your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
-utilization, application performance, and operational health.</p>
+<p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
+resources and the applications you run on Amazon Web Services in real time. You can use
+CloudWatch to collect and track metrics, which are the variables you want to
+measure for your resources and applications.</p>
+<p>CloudWatch alarms send notifications or automatically change the resources you are
+monitoring based on rules that you define. For example, you can monitor the CPU usage
+and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
+whether you should launch additional instances to handle increased load. You can also
+use this data to stop under-used instances to save money.</p>
+<p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
+you can monitor your own custom metrics. With CloudWatch, you gain system-wide
+visibility into resource utilization, application performance, and operational
+health.</p>
 
 ## Installing
 

diff --git a/clients/client-cloudwatch/src/CloudWatch.ts b/clients/client-cloudwatch/src/CloudWatch.ts
@@ -813,19 +813,19 @@ export interface CloudWatch {
 }
 
 /**
- * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
- * 			applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
- * 			metrics, which are the variables you want to measure for your resources and
- * 			applications.</p>
- *          <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
- * 			that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
- * 			instances. Then, use this data to determine whether you should launch
- * 			additional instances to handle increased load. You can also use this data to stop
- * 			under-used instances to save
- * 			money.</p>
- *          <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
- * 			your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
- * 			utilization, application performance, and operational health.</p>
+ * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
+ *             resources and the applications you run on Amazon Web Services in real time. You can use
+ *                 CloudWatch to collect and track metrics, which are the variables you want to
+ *             measure for your resources and applications.</p>
+ *          <p>CloudWatch alarms send notifications or automatically change the resources you are
+ *             monitoring based on rules that you define. For example, you can monitor the CPU usage
+ *             and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
+ *             whether you should launch additional instances to handle increased load. You can also
+ *             use this data to stop under-used instances to save money.</p>
+ *          <p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
+ *             you can monitor your own custom metrics. With CloudWatch, you gain system-wide
+ *             visibility into resource utilization, application performance, and operational
+ *             health.</p>
  * @public
  */
 export class CloudWatch extends CloudWatchClient implements CloudWatch {}

diff --git a/clients/client-cloudwatch/src/CloudWatchClient.ts b/clients/client-cloudwatch/src/CloudWatchClient.ts
@@ -406,19 +406,19 @@ export type CloudWatchClientResolvedConfigType = __SmithyResolvedConfiguration<_
 export interface CloudWatchClientResolvedConfig extends CloudWatchClientResolvedConfigType {}
 
 /**
- * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the
- * 			applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track
- * 			metrics, which are the variables you want to measure for your resources and
- * 			applications.</p>
- *          <p>CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules
- * 			that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2
- * 			instances. Then, use this data to determine whether you should launch
- * 			additional instances to handle increased load. You can also use this data to stop
- * 			under-used instances to save
- * 			money.</p>
- *          <p>In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor
- * 			your own custom metrics. With CloudWatch, you gain system-wide visibility into resource
- * 			utilization, application performance, and operational health.</p>
+ * <p>Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)
+ *             resources and the applications you run on Amazon Web Services in real time. You can use
+ *                 CloudWatch to collect and track metrics, which are the variables you want to
+ *             measure for your resources and applications.</p>
+ *          <p>CloudWatch alarms send notifications or automatically change the resources you are
+ *             monitoring based on rules that you define. For example, you can monitor the CPU usage
+ *             and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine
+ *             whether you should launch additional instances to handle increased load. You can also
+ *             use this data to stop under-used instances to save money.</p>
+ *          <p>In addition to monitoring the built-in metrics that come with Amazon Web Services,
+ *             you can monitor your own custom metrics. With CloudWatch, you gain system-wide
+ *             visibility into resource utilization, application performance, and operational
+ *             health.</p>
  * @public
  */
 export class CloudWatchClient extends __Client<

diff --git a/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts
@@ -28,23 +28,25 @@ export interface DeleteAlarmsCommandInput extends DeleteAlarmsInput {}
 export interface DeleteAlarmsCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more
- * 			than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't
- * 			delete two composite alarms with one operation.</p>
- *          <p>
- * 			If you specify an incorrect alarm name or make any other error in the operation, no alarms are
- * 			deleted. To confirm that alarms were deleted successfully, you can use
- * 			the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using
- * 		<code>DeleteAlarms</code>.</p>
+ * <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation.
+ *             However, this total can include no more than one composite alarm. For example, you could
+ *             delete 99 metric alarms and one composite alarms with one operation, but you can't
+ *             delete two composite alarms with one operation.</p>
+ *          <p> If you specify an incorrect alarm name or make any other error in the operation,
+ *             no alarms are deleted. To confirm that alarms were deleted successfully, you can use the
+ *             <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using <code>DeleteAlarms</code>.</p>
  *          <note>
- *             <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and
- * 			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
- * 			because there is always still a composite alarm that depends on that alarm that you want to delete.</p>
- *             <p>To get out of such a situation, you must
- * 				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
- * 				change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
- *             <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.
- * 			</p>
+ *             <p>It is possible to create a loop or cycle of composite alarms, where composite
+ *                 alarm A depends on composite alarm B, and 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 because there is always still a composite alarm that depends on
+ *                 that alarm that you want to delete.</p>
+ *             <p>To get out of such a situation, you must 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 change to make to break a cycle is to change the
+ *                 <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
+ *             <p>Additionally, the evaluation of composite alarms stops if CloudWatch
+ *                 detects a cycle in the evaluation path. </p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-cloudwatch/src/commands/DeleteAnomalyDetectorCommand.ts b/clients/client-cloudwatch/src/commands/DeleteAnomalyDetectorCommand.ts
@@ -28,15 +28,9 @@ export interface DeleteAnomalyDetectorCommandInput extends DeleteAnomalyDetector
 export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetectorOutput, __MetadataBearer {}
 
 /**
- * <p>
- * 			Deletes the specified anomaly detection model
- * 			from your account.
- * 			For more information
- * 			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 Guide</i>.
- * 		</p>
+ * <p> Deletes the specified anomaly detection model from your account. For more information
+ *             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
+ *             Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -101,7 +95,8 @@ export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetecto
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
  *
  * @throws {@link InternalServiceFault} (server fault)
- *  <p>Request processing has failed due to some unknown error, exception, or failure.</p>
+ *  <p>Request processing has failed due to some unknown error, exception, or
+ *             failure.</p>
  *
  * @throws {@link InvalidParameterCombinationException} (client fault)
  *  <p>Parameters were used together that cannot be used together.</p>

diff --git a/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts
@@ -28,9 +28,8 @@ export interface DeleteDashboardsCommandInput extends DeleteDashboardsInput {}
 export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, __MetadataBearer {}
 
 /**
- * <p>Deletes all dashboards that you specify. You
- * 			can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are
- * 			deleted.</p>
+ * <p>Deletes all dashboards that you specify. You can specify up to 100 dashboards to
+ *             delete. If there is an error during this call, no dashboards are deleted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -58,7 +57,8 @@ export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, _
  *  <p>The specified dashboard does not exist.</p>
  *
  * @throws {@link InternalServiceFault} (server fault)
- *  <p>Request processing has failed due to some unknown error, exception, or failure.</p>
+ *  <p>Request processing has failed due to some unknown error, exception, or
+ *             failure.</p>
  *
  * @throws {@link InvalidParameterValueException} (client fault)
  *  <p>The value of an input parameter is bad or out-of-range.</p>

diff --git a/clients/client-cloudwatch/src/commands/DeleteInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/DeleteInsightRulesCommand.ts
@@ -29,9 +29,8 @@ export interface DeleteInsightRulesCommandOutput extends DeleteInsightRulesOutpu
 
 /**
  * <p>Permanently deletes the specified Contributor Insights rules.</p>
- *          <p>If you create a rule, delete it, and then re-create it with the same name, historical data from the first time
- * 			the rule was created might
- * 			not be available.</p>
+ *          <p>If you create a rule, delete it, and then re-create it with the same name, historical
+ *             data from the first time the rule was created might not be available.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudwatch/src/commands/DeleteMetricStreamCommand.ts b/clients/client-cloudwatch/src/commands/DeleteMetricStreamCommand.ts
@@ -51,7 +51,8 @@ export interface DeleteMetricStreamCommandOutput extends DeleteMetricStreamOutpu
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
  *
  * @throws {@link InternalServiceFault} (server fault)
- *  <p>Request processing has failed due to some unknown error, exception, or failure.</p>
+ *  <p>Request processing has failed due to some unknown error, exception, or
+ *             failure.</p>
  *
  * @throws {@link InvalidParameterValueException} (client fault)
  *  <p>The value of an input parameter is bad or out-of-range.</p>

diff --git a/clients/client-cloudwatch/src/commands/DescribeAlarmHistoryCommand.ts b/clients/client-cloudwatch/src/commands/DescribeAlarmHistoryCommand.ts
@@ -28,12 +28,14 @@ export interface DescribeAlarmHistoryCommandInput extends DescribeAlarmHistoryIn
 export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryOutput, __MetadataBearer {}
 
 /**
- * <p>Retrieves the history for the specified alarm. You can filter the results by date range or item type.
- * 			If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p>
+ * <p>Retrieves the history for the specified alarm. You can filter the results by date
+ *             range or item type. If an alarm name is not specified, the histories for either all
+ *             metric alarms or all composite alarms are returned.</p>
  *          <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>
- *          <p>To use this operation and return information about a composite alarm, you must be signed on with
- * 			the <code>cloudwatch:DescribeAlarmHistory</code> permission that is scoped to <code>*</code>. You can't return information
- * 			about composite alarms if your <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
+ *          <p>To use this operation and return information about a composite alarm, you must be
+ *             signed on with the <code>cloudwatch:DescribeAlarmHistory</code> permission that is
+ *             scoped to <code>*</code>. You can't return information about composite alarms if your
+ *             <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudwatch/src/commands/DescribeAlarmsCommand.ts b/clients/client-cloudwatch/src/commands/DescribeAlarmsCommand.ts
@@ -28,11 +28,12 @@ export interface DescribeAlarmsCommandInput extends DescribeAlarmsInput {}
 export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __MetadataBearer {}
 
 /**
- * <p>Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm
- * 			name, the alarm state, or a prefix for any action.</p>
- *          <p>To use this operation and return information about composite alarms, you must be signed on with
- * 		the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to <code>*</code>. You can't return information
- * 			about composite alarms if your <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
+ * <p>Retrieves the specified alarms. You can filter the results by specifying a prefix
+ *             for the alarm name, the alarm state, or a prefix for any action.</p>
+ *          <p>To use this operation and return information about composite alarms, you must be
+ *             signed on with the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to
+ *             <code>*</code>. You can't return information about composite alarms if your
+ *             <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-cloudwatch/src/commands/DescribeAlarmsForMetricCommand.ts b/clients/client-cloudwatch/src/commands/DescribeAlarmsForMetricCommand.ts
@@ -28,11 +28,11 @@ export interface DescribeAlarmsForMetricCommandInput extends DescribeAlarmsForMe
 export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForMetricOutput, __MetadataBearer {}
 
 /**
- * <p>Retrieves the alarms for the specified metric. To
- * 			filter the results, specify a statistic, period, or unit.</p>
- *          <p>This operation retrieves only standard alarms that are based on
- * 		the specified metric. It does not return alarms based on math expressions that
- * 		use the specified metric, or composite alarms that use the specified metric.</p>
+ * <p>Retrieves the alarms for the specified metric. To filter the results, specify a
+ *             statistic, period, or unit.</p>
+ *          <p>This operation retrieves only standard alarms that are based on the specified
+ *             metric. It does not return alarms based on math expressions that use the specified
+ *             metric, or composite alarms that use the specified metric.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript