From 5aadfed77492e0bfdfb0600a8f8a0fa74465dd00 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 15 Nov 2024 19:12:00 +0000 Subject: [PATCH] feat(client-cloudwatch): Adds support for adding related Entity information to metrics ingested through PutMetricData. --- clients/client-cloudwatch/README.md | 26 +- clients/client-cloudwatch/src/CloudWatch.ts | 26 +- .../client-cloudwatch/src/CloudWatchClient.ts | 26 +- .../src/commands/DeleteAlarmsCommand.ts | 34 +- .../commands/DeleteAnomalyDetectorCommand.ts | 15 +- .../src/commands/DeleteDashboardsCommand.ts | 8 +- .../src/commands/DeleteInsightRulesCommand.ts | 5 +- .../src/commands/DeleteMetricStreamCommand.ts | 3 +- .../commands/DescribeAlarmHistoryCommand.ts | 12 +- .../src/commands/DescribeAlarmsCommand.ts | 11 +- .../DescribeAlarmsForMetricCommand.ts | 10 +- .../DescribeAnomalyDetectorsCommand.ts | 16 +- .../commands/DescribeInsightRulesCommand.ts | 4 +- .../commands/DisableAlarmActionsCommand.ts | 4 +- .../commands/DisableInsightRulesCommand.ts | 4 +- .../src/commands/EnableInsightRulesCommand.ts | 3 +- .../src/commands/GetDashboardCommand.ts | 9 +- .../commands/GetInsightRuleReportCommand.ts | 37 +- .../src/commands/GetMetricDataCommand.ts | 84 +- .../commands/GetMetricStatisticsCommand.ts | 65 +- .../src/commands/GetMetricStreamCommand.ts | 3 +- .../commands/GetMetricWidgetImageCommand.ts | 17 +- .../src/commands/ListDashboardsCommand.ts | 18 +- .../ListManagedInsightRulesCommand.ts | 9 +- .../src/commands/ListMetricStreamsCommand.ts | 3 +- .../src/commands/ListMetricsCommand.ts | 21 +- .../commands/ListTagsForResourceCommand.ts | 7 +- .../src/commands/PutAnomalyDetectorCommand.ts | 14 +- .../src/commands/PutCompositeAlarmCommand.ts | 64 +- .../src/commands/PutDashboardCommand.ts | 27 +- .../src/commands/PutInsightRuleCommand.ts | 11 +- .../commands/PutManagedInsightRulesCommand.ts | 25 +- .../src/commands/PutMetricAlarmCommand.ts | 67 +- .../src/commands/PutMetricDataCommand.ts | 123 +- .../src/commands/PutMetricStreamCommand.ts | 43 +- .../src/commands/SetAlarmStateCommand.ts | 32 +- .../src/commands/StartMetricStreamsCommand.ts | 3 +- .../src/commands/StopMetricStreamsCommand.ts | 3 +- .../src/commands/TagResourceCommand.ts | 26 +- .../src/commands/UntagResourceCommand.ts | 3 +- clients/client-cloudwatch/src/index.ts | 26 +- .../client-cloudwatch/src/models/models_0.ts | 2543 +++++++++-------- .../src/protocols/Aws_query.ts | 150 +- .../sdk-codegen/aws-models/cloudwatch.json | 709 +++-- 44 files changed, 2399 insertions(+), 1950 deletions(-) diff --git a/clients/client-cloudwatch/README.md b/clients/client-cloudwatch/README.md index 26c6092dd1220..a9213c736aa89 100644 --- 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. -

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.

-

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.

-

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.

+

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.

+

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.

+

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.

## Installing diff --git a/clients/client-cloudwatch/src/CloudWatch.ts b/clients/client-cloudwatch/src/CloudWatch.ts index 946d2811991dc..182217815411f 100644 --- a/clients/client-cloudwatch/src/CloudWatch.ts +++ b/clients/client-cloudwatch/src/CloudWatch.ts @@ -813,19 +813,19 @@ export interface CloudWatch { } /** - *

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.

- *

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.

- *

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.

+ *

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.

+ *

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.

+ *

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.

* @public */ export class CloudWatch extends CloudWatchClient implements CloudWatch {} diff --git a/clients/client-cloudwatch/src/CloudWatchClient.ts b/clients/client-cloudwatch/src/CloudWatchClient.ts index 1fe3b6499f4e5..24cee6713537c 100644 --- 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 {} /** - *

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.

- *

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.

- *

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.

+ *

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.

+ *

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.

+ *

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.

* @public */ export class CloudWatchClient extends __Client< diff --git a/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts index 109fe7c263e90..06c78cda878d3 100644 --- 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 {} /** - *

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.

- *

- * 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 DescribeAlarms operation after using - * DeleteAlarms.

+ *

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.

+ *

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 + * DescribeAlarms operation after using DeleteAlarms.

* - *

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.

- *

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 AlarmRule of one of the alarms to false.

- *

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. - *

+ *

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.

+ *

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 + * AlarmRule of one of the alarms to false.

+ *

Additionally, the evaluation of composite alarms stops if CloudWatch + * detects a cycle in the evaluation path.

* * @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 index cc6a72db21745..3623cc9b40749 100644 --- 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 {} /** - *

- * Deletes the specified anomaly detection model - * from your account. - * For more information - * about - * how to delete an anomaly detection model, - * see Deleting an anomaly detection model - * in the CloudWatch User Guide. - *

+ *

Deletes the specified anomaly detection model from your account. For more information + * about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User + * Guide.

* @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) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterCombinationException} (client fault) *

Parameters were used together that cannot be used together.

diff --git a/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts index dbc129c10ec7e..c78aa60b7983a 100644 --- 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 {} /** - *

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.

+ *

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.

* @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, _ *

The specified dashboard does not exist.

* * @throws {@link InternalServiceFault} (server fault) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value of an input parameter is bad or out-of-range.

diff --git a/clients/client-cloudwatch/src/commands/DeleteInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/DeleteInsightRulesCommand.ts index 8a8f726b81918..3cccd2e641e5b 100644 --- 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 /** *

Permanently deletes the specified Contributor Insights rules.

- *

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.

+ *

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.

* @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 index 0ab0fc6939cbb..90971bf08930c 100644 --- 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) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value of an input parameter is bad or out-of-range.

diff --git a/clients/client-cloudwatch/src/commands/DescribeAlarmHistoryCommand.ts b/clients/client-cloudwatch/src/commands/DescribeAlarmHistoryCommand.ts index bf5deaee7d627..d797882a374e7 100644 --- 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 {} /** - *

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.

+ *

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.

*

CloudWatch retains the history of an alarm even if you delete the alarm.

- *

To use this operation and return information about a composite alarm, you must be signed on with - * the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information - * about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

+ *

To use this operation and return information about a composite alarm, you must be + * signed on with the cloudwatch:DescribeAlarmHistory permission that is + * scoped to *. You can't return information about composite alarms if your + * cloudwatch:DescribeAlarmHistory permission has a narrower scope.

* @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 index 5091f1c49e119..aac7ef55b22f1 100644 --- 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 {} /** - *

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.

- *

To use this operation and return information about composite alarms, you must be signed on with - * the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information - * about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

+ *

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.

+ *

To use this operation and return information about composite alarms, you must be + * signed on with the cloudwatch:DescribeAlarms permission that is scoped to + * *. You can't return information about composite alarms if your + * cloudwatch:DescribeAlarms permission has a narrower scope.

* @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 index 5d8e5de390e32..ea3dd281e6603 100644 --- 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 {} /** - *

Retrieves the alarms for the specified metric. To - * filter the results, specify a statistic, period, or unit.

- *

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.

+ *

Retrieves the alarms for the specified metric. To filter the results, specify a + * statistic, period, or unit.

+ *

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.

* @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/DescribeAnomalyDetectorsCommand.ts b/clients/client-cloudwatch/src/commands/DescribeAnomalyDetectorsCommand.ts index 547ed2227bd7f..9e0606e0a95c0 100644 --- a/clients/client-cloudwatch/src/commands/DescribeAnomalyDetectorsCommand.ts +++ b/clients/client-cloudwatch/src/commands/DescribeAnomalyDetectorsCommand.ts @@ -28,13 +28,12 @@ export interface DescribeAnomalyDetectorsCommandInput extends DescribeAnomalyDet export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDetectorsOutput, __MetadataBearer {} /** - *

Lists the anomaly detection models that you have created in your account. - * For single metric anomaly detectors, - * you can list all of the models in your account or filter the results - * to only the models that are related to a certain namespace, metric name, or metric dimension. - * For metric math anomaly detectors, - * you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. - * This will return all metric math anomaly detectors in your account.

+ *

Lists the anomaly detection models that you have created in your account. For single + * metric anomaly detectors, you can list all of the models in your account or filter the + * results to only the models that are related to a certain namespace, metric name, or + * metric dimension. For metric math anomaly detectors, you can list them by adding + * METRIC_MATH to the AnomalyDetectorTypes array. This will + * return all metric math anomaly detectors in your account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -131,7 +130,8 @@ export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDe * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * * @throws {@link InternalServiceFault} (server fault) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidNextToken} (client fault) *

The next token specified is invalid.

diff --git a/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts index f3e11be8ee5e0..74d65e1bdc6b6 100644 --- a/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts @@ -29,8 +29,8 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO /** *

Returns a list of all the Contributor Insights rules in your account.

- *

For more information about Contributor Insights, see - * Using Contributor Insights to Analyze High-Cardinality Data.

+ *

For more information about Contributor Insights, see Using Contributor + * Insights to Analyze High-Cardinality Data.

* @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/DisableAlarmActionsCommand.ts b/clients/client-cloudwatch/src/commands/DisableAlarmActionsCommand.ts index cc3933498d0da..4f880b5bb17c0 100644 --- a/clients/client-cloudwatch/src/commands/DisableAlarmActionsCommand.ts +++ b/clients/client-cloudwatch/src/commands/DisableAlarmActionsCommand.ts @@ -28,8 +28,8 @@ export interface DisableAlarmActionsCommandInput extends DisableAlarmActionsInpu export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {} /** - *

Disables the actions for the specified alarms. When an alarm's actions are disabled, the - * alarm actions do not execute when the alarm state changes.

+ *

Disables the actions for the specified alarms. When an alarm's actions are + * disabled, the alarm actions do not execute when the alarm state changes.

* @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/DisableInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/DisableInsightRulesCommand.ts index 772721a76951a..111c8ef5081bf 100644 --- a/clients/client-cloudwatch/src/commands/DisableInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/DisableInsightRulesCommand.ts @@ -28,8 +28,8 @@ export interface DisableInsightRulesCommandInput extends DisableInsightRulesInpu export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOutput, __MetadataBearer {} /** - *

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do - * not incur costs.

+ *

Disables the specified Contributor Insights rules. When rules are disabled, they do + * not analyze log groups and do not incur costs.

* @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/EnableInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/EnableInsightRulesCommand.ts index 0a065ed98ba0c..fe8f28ef1107c 100644 --- a/clients/client-cloudwatch/src/commands/EnableInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/EnableInsightRulesCommand.ts @@ -28,7 +28,8 @@ export interface EnableInsightRulesCommandInput extends EnableInsightRulesInput export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutput, __MetadataBearer {} /** - *

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

+ *

Enables the specified Contributor Insights rules. When rules are enabled, they + * immediately begin analyzing log data.

* @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/GetDashboardCommand.ts b/clients/client-cloudwatch/src/commands/GetDashboardCommand.ts index 38839a749f05f..d1031210a745d 100644 --- a/clients/client-cloudwatch/src/commands/GetDashboardCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetDashboardCommand.ts @@ -29,9 +29,9 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat /** *

Displays the details of the dashboard that you specify.

- *

To copy an existing dashboard, use GetDashboard, and then use the data returned - * within DashboardBody as the template for the new dashboard when you call PutDashboard to create - * the copy.

+ *

To copy an existing dashboard, use GetDashboard, and then use the data + * returned within DashboardBody as the template for the new dashboard when + * you call PutDashboard to create the copy.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,7 +61,8 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat *

The specified dashboard does not exist.

* * @throws {@link InternalServiceFault} (server fault) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value of an input parameter is bad or out-of-range.

diff --git a/clients/client-cloudwatch/src/commands/GetInsightRuleReportCommand.ts b/clients/client-cloudwatch/src/commands/GetInsightRuleReportCommand.ts index 92897cf30cacc..847ed38a3284e 100644 --- a/clients/client-cloudwatch/src/commands/GetInsightRuleReportCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetInsightRuleReportCommand.ts @@ -28,41 +28,50 @@ export interface GetInsightRuleReportCommandInput extends GetInsightRuleReportIn export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportOutput, __MetadataBearer {} /** - *

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of - * contributors to the log group.

- *

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

+ *

This operation returns the time series data collected by a Contributor Insights rule. + * The data includes the identity and number of contributors to the log group.

+ *

You can also optionally return one or more statistics about each data point in the + * time series. These statistics can include the following:

* * @example diff --git a/clients/client-cloudwatch/src/commands/GetMetricDataCommand.ts b/clients/client-cloudwatch/src/commands/GetMetricDataCommand.ts index 3e48744185734..0ad83cf0301ed 100644 --- a/clients/client-cloudwatch/src/commands/GetMetricDataCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetMetricDataCommand.ts @@ -28,54 +28,70 @@ export interface GetMetricDataCommandInput extends GetMetricDataInput {} export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __MetadataBearer {} /** - *

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation - * can also include a CloudWatch Metrics Insights query, and one or more metric math functions.

- *

A GetMetricData operation that does not include a query can retrieve as many as 500 different - * metrics in a single request, with a total of as many as 100,800 data points. You can also - * optionally perform metric math expressions on the values of the returned statistics, to create - * new time series that represent new insights into your data. For example, using Lambda - * metrics, you could divide the Errors metric by the Invocations metric to get an error - * rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User - * Guide.

- *

If you include a Metrics Insights query, each GetMetricData operation can include only one - * query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries - * can query only the most recent three hours of metric data. For more information about Metrics Insights, - * see Query your metrics with CloudWatch Metrics Insights.

+ *

You can use the GetMetricData API to retrieve CloudWatch metric + * values. The operation can also include a CloudWatch Metrics Insights query, and + * one or more metric math functions.

+ *

A GetMetricData operation that does not include a query can retrieve + * as many as 500 different metrics in a single request, with a total of as many as 100,800 + * data points. You can also optionally perform metric math expressions on the values of + * the returned statistics, to create new time series that represent new insights into your + * data. For example, using Lambda metrics, you could divide the Errors metric by the + * Invocations metric to get an error rate time series. For more information about metric + * math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User + * Guide.

+ *

If you include a Metrics Insights query, each GetMetricData operation can + * include only one query. But the same GetMetricData operation can also + * retrieve other metrics. Metrics Insights queries can query only the most recent three + * hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.

*

Calls to the GetMetricData API have a different pricing structure than - * calls to GetMetricStatistics. For more information about pricing, see - * Amazon CloudWatch Pricing.

+ * calls to GetMetricStatistics. For more information about pricing, see + * Amazon CloudWatch + * Pricing.

*

Amazon CloudWatch retains metric data as follows:

* - *

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect - * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, - * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with - * a resolution of 1 hour.

- *

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified - * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. - * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

+ *

Data points that are initially published with a shorter period are aggregated + * together for long-term storage. For example, if you collect data using a period of 1 + * minute, the data remains available for 15 days with 1-minute resolution. After 15 days, + * this data is still available, but is aggregated and retrievable only with a resolution + * of 5 minutes. After 63 days, the data is further aggregated and is available with a + * resolution of 1 hour.

+ *

If you omit Unit in your request, all data that was collected with any + * unit is returned, along with the corresponding units that were specified when the data + * was reported to CloudWatch. If you specify a unit, the operation returns only data that + * was collected with that unit specified. If you specify a unit that does not match the + * data collected, the results of the operation are null. CloudWatch does not perform unit + * conversions.

*

- * Using Metrics Insights queries with metric math + * Using Metrics Insights queries with metric + * math *

- *

You can't mix a Metric Insights query and metric math syntax in the same expression, but - * you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights - * query without a GROUP BY clause returns a single time-series (TS), - * and can be used as input for a metric math expression that expects a single time series. A Metrics Insights - * query with a GROUP BY clause returns an array of time-series (TS[]), - * and can be used as input for a metric math expression that expects an array of time series.

+ *

You can't mix a Metric Insights query and metric math syntax in the same expression, + * but you can reference results from a Metrics Insights query within other Metric math + * expressions. A Metrics Insights query without a GROUP + * BY clause returns a single time-series (TS), and can be used as input for + * a metric math expression that expects a single time series. A Metrics Insights query + * with a GROUP BY clause returns an array of time-series + * (TS[]), and can be used as input for a metric math expression that expects an array of + * time series.

* @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/GetMetricStatisticsCommand.ts b/clients/client-cloudwatch/src/commands/GetMetricStatisticsCommand.ts index f7e0bcec575f6..559eb0d61213c 100644 --- a/clients/client-cloudwatch/src/commands/GetMetricStatisticsCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetMetricStatisticsCommand.ts @@ -29,19 +29,19 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut /** *

Gets statistics for the specified metric.

- *

The maximum number of data points returned from a single call is 1,440. If - * you request more than 1,440 data points, CloudWatch returns an error. - * To reduce the number of data points, you can narrow the specified time range and make - * multiple requests across adjacent time ranges, or you can increase the specified period. - * Data points are not returned in chronological order.

- *

CloudWatch aggregates data points based on the length of the period - * that you specify. For example, if you request statistics with a one-hour period, - * CloudWatch aggregates all data points with time stamps that fall within each - * one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than - * the number of data points returned.

+ *

The maximum number of data points returned from a single call is 1,440. If you + * request more than 1,440 data points, CloudWatch returns an error. To reduce the number + * of data points, you can narrow the specified time range and make multiple requests + * across adjacent time ranges, or you can increase the specified period. Data points are + * not returned in chronological order.

+ *

CloudWatch aggregates data points based on the length of the period that you + * specify. For example, if you request statistics with a one-hour period, CloudWatch + * aggregates all data points with time stamps that fall within each one-hour period. + * Therefore, the number of values aggregated by CloudWatch is larger than the number of + * data points returned.

*

CloudWatch needs raw data points to calculate percentile statistics. If you publish - * data using a statistic set instead, you can only retrieve - * percentile statistics for this data if one of the following conditions is true:

+ * data using a statistic set instead, you can only retrieve percentile statistics for this + * data if one of the following conditions is true:

* - *

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

+ *

Percentile statistics are not available for metrics when any of the metric values + * are negative numbers.

*

Amazon CloudWatch retains metric data as follows:

* - *

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect - * data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, - * but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with - * a resolution of 1 hour.

- *

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

- *

For information about metrics and dimensions supported by Amazon Web Services services, see the - * Amazon CloudWatch Metrics and Dimensions Reference in the - * Amazon CloudWatch User Guide.

+ *

Data points that are initially published with a shorter period are aggregated + * together for long-term storage. For example, if you collect data using a period of 1 + * minute, the data remains available for 15 days with 1-minute resolution. After 15 days, + * this data is still available, but is aggregated and retrievable only with a resolution + * of 5 minutes. After 63 days, the data is further aggregated and is available with a + * resolution of 1 hour.

+ *

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, + * 2016.

+ *

For information about metrics and dimensions supported by Amazon Web Services + * services, see the Amazon CloudWatch + * Metrics and Dimensions Reference in the Amazon CloudWatch User + * Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -130,7 +140,8 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * * @throws {@link InternalServiceFault} (server fault) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterCombinationException} (client fault) *

Parameters were used together that cannot be used together.

diff --git a/clients/client-cloudwatch/src/commands/GetMetricStreamCommand.ts b/clients/client-cloudwatch/src/commands/GetMetricStreamCommand.ts index b1b9c4ae47ac4..19a23ffb37770 100644 --- a/clients/client-cloudwatch/src/commands/GetMetricStreamCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetMetricStreamCommand.ts @@ -90,7 +90,8 @@ export interface GetMetricStreamCommandOutput extends GetMetricStreamOutput, __M * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * * @throws {@link InternalServiceFault} (server fault) - *

Request processing has failed due to some unknown error, exception, or failure.

+ *

Request processing has failed due to some unknown error, exception, or + * failure.

* * @throws {@link InvalidParameterCombinationException} (client fault) *

Parameters were used together that cannot be used together.

diff --git a/clients/client-cloudwatch/src/commands/GetMetricWidgetImageCommand.ts b/clients/client-cloudwatch/src/commands/GetMetricWidgetImageCommand.ts index e56815fdb7bb9..8b3c8619353e8 100644 --- a/clients/client-cloudwatch/src/commands/GetMetricWidgetImageCommand.ts +++ b/clients/client-cloudwatch/src/commands/GetMetricWidgetImageCommand.ts @@ -28,14 +28,15 @@ export interface GetMetricWidgetImageCommandInput extends GetMetricWidgetImageIn export interface GetMetricWidgetImageCommandOutput extends GetMetricWidgetImageOutput, __MetadataBearer {} /** - *

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of - * one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this - * image into your services and products, such as wiki pages, reports, and documents. - * You could also retrieve images regularly, such as every minute, and create your own - * custom live dashboard.

- *

The graph you retrieve can include all CloudWatch metric graph features, including metric math - * and horizontal and vertical annotations.

- *

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

+ *

You can use the GetMetricWidgetImage API to retrieve a snapshot graph + * of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this + * image into your services and products, such as wiki pages, reports, and documents. You + * could also retrieve images regularly, such as every minute, and create your own custom + * live dashboard.

+ *

The graph you retrieve can include all CloudWatch metric graph features, including + * metric math and horizontal and vertical annotations.

+ *

There is a limit of 20 transactions per second for this API. Each + * GetMetricWidgetImage action has the following limits:

*