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 946d2811991d..182217815411 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 1fe3b6499f4e..24cee6713537 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 109fe7c263e9..06c78cda878d 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.
*- * 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 dbc129c10ec7..c78aa60b7983 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 8a8f726b8191..3cccd2e641e5 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 0ab0fc6939cb..90971bf08930 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 bf5deaee7d62..d797882a374e 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.
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.
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 547ed2227bd7..9e0606e0a95c 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.
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 f3e11be8ee5e..74d65e1bdc6b 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 cc3933498d0d..4f880b5bb17c 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 772721a76951..111c8ef5081b 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 0a065ed98ba0..fe8f28ef1107 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 38839a749f05..d1031210a745 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.
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 92897cf30cac..847ed38a3284 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:
*
- * UniqueContributors -- the number of unique contributors for each data point.
UniqueContributors -- the number of unique contributors for each
+ * data point.
*
- * MaxContributorValue -- the value of the top contributor for each data point. The identity of the
- * contributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
- * most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified
- * by the rule's Value, during that period.
MaxContributorValue -- the value of the top contributor for each
+ * data point. The identity of the contributor might change for each data point in
+ * the graph.
+ * If this rule aggregates by COUNT, the top contributor for each data point is
+ * the contributor with the most occurrences in that period. If the rule aggregates
+ * by SUM, the top contributor is the contributor with the highest sum in the log
+ * field specified by the rule's Value, during that period.
- * SampleCount -- the number of data points matched by the rule.
SampleCount -- the number of data points matched by the
+ * rule.
*
- * Sum -- the sum of the values from all contributors during the time period represented by that data point.
Sum -- the sum of the values from all contributors during the
+ * time period represented by that data point.
*
- * Minimum -- the minimum value from a single observation during the time period represented by that data point.
Minimum -- the minimum value from a single observation during the
+ * time period represented by that data point.
*
- * Maximum -- the maximum value from a single observation during the time period represented by that data point.
Maximum -- the maximum value from a single observation during the
+ * time period represented by that data point.
*
- * Average -- the average value from all contributors during the time period represented by that data point.
Average -- the average value from all contributors during the
+ * time period represented by that data point.
* 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.
GetMetricStatistics. For more information about pricing, see
+ * Amazon CloudWatch
+ * Pricing.
* Amazon CloudWatch retains metric data as follows:
*Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
- * metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of less than 60 seconds are available for 3
+ * hours. These data points are high-resolution metrics and are available only for
+ * custom metrics that have been defined with a StorageResolution of
+ * 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
+ *Data points with a period of 60 seconds (1-minute) are available for 15 + * days.
*Data points with a period of 300 seconds (5-minute) are available for 63 days.
+ *Data points with a period of 300 seconds (5-minute) are available for 63 + * days.
*Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
+ *Data points with a period of 3600 seconds (1 hour) are available for 455 + * days (15 months).
*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 f7e0bcec575f..559eb0d61213 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: *The SampleCount value of the statistic set is 1.
@@ -50,31 +50,41 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut *The Min and the Max values of the statistic set are equal.
*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 with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
- * metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of less than 60 seconds are available for 3
+ * hours. These data points are high-resolution metrics and are available only for
+ * custom metrics that have been defined with a StorageResolution of
+ * 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
+ *Data points with a period of 60 seconds (1-minute) are available for 15 + * days.
*Data points with a period of 300 seconds (5-minute) are available for 63 days.
+ *Data points with a period of 300 seconds (5-minute) are available for 63 + * days.
*Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
+ *Data points with a period of 3600 seconds (1 hour) are available for 455 + * days (15 months).
*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 b1b9c4ae47ac..19a23ffb3777 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 e56815fdb7bb..8b3c8619353e 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:
As many as 100 metrics in the graph.
diff --git a/clients/client-cloudwatch/src/commands/ListDashboardsCommand.ts b/clients/client-cloudwatch/src/commands/ListDashboardsCommand.ts index 3de7cd4a0079..52199acb6ff2 100644 --- a/clients/client-cloudwatch/src/commands/ListDashboardsCommand.ts +++ b/clients/client-cloudwatch/src/commands/ListDashboardsCommand.ts @@ -28,15 +28,14 @@ export interface ListDashboardsCommandInput extends ListDashboardsInput {} export interface ListDashboardsCommandOutput extends ListDashboardsOutput, __MetadataBearer {} /** - *Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only
- * those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are
- * listed.
- *
Returns a list of the dashboards for your account. If you include
+ * DashboardNamePrefix, only those dashboards with names starting with the
+ * prefix are listed. Otherwise, all dashboards in your account are listed.
- * ListDashboards returns up to 1000 results on one page. If there
- * are more than 1000 dashboards, you can call ListDashboards again and
- * include the value you received for NextToken in the first call, to receive
- * the next 1000 results.
ListDashboards returns up to 1000 results on one page. If there are
+ * more than 1000 dashboards, you can call ListDashboards again and include
+ * the value you received for NextToken in the first call, to receive the next
+ * 1000 results.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -70,7 +69,8 @@ export interface ListDashboardsCommandOutput extends ListDashboardsOutput, __Met
* @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/ListManagedInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/ListManagedInsightRulesCommand.ts index 72c63480b802..06c2643292d8 100644 --- a/clients/client-cloudwatch/src/commands/ListManagedInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/ListManagedInsightRulesCommand.ts @@ -28,13 +28,10 @@ export interface ListManagedInsightRulesCommandInput extends ListManagedInsightR export interface ListManagedInsightRulesCommandOutput extends ListManagedInsightRulesOutput, __MetadataBearer {} /** - *- * Returns a list - * that contains the number - * of managed Contributor Insights rules - * in your account. + *
Returns a list that contains the number of managed Contributor Insights rules in your + * account. * - *
+ * * @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/ListMetricStreamsCommand.ts b/clients/client-cloudwatch/src/commands/ListMetricStreamsCommand.ts index c57154c0ec57..4d7257118412 100644 --- a/clients/client-cloudwatch/src/commands/ListMetricStreamsCommand.ts +++ b/clients/client-cloudwatch/src/commands/ListMetricStreamsCommand.ts @@ -65,7 +65,8 @@ export interface ListMetricStreamsCommandOutput extends ListMetricStreamsOutput, * @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/ListMetricsCommand.ts b/clients/client-cloudwatch/src/commands/ListMetricsCommand.ts index b794a8a5fb15..5fca830e3557 100644 --- a/clients/client-cloudwatch/src/commands/ListMetricsCommand.ts +++ b/clients/client-cloudwatch/src/commands/ListMetricsCommand.ts @@ -30,17 +30,15 @@ export interface ListMetricsCommandOutput extends ListMetricsOutput, __MetadataB /** *List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
*Up to 500 results are returned for any one call. To retrieve additional results, - * use the returned token with subsequent calls.
- *After you create a metric, allow up to 15 minutes for the metric to appear. To see metric - * statistics sooner, use GetMetricData or GetMetricStatistics.
- *If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and - * view metrics from the linked source accounts. For more information, see - * CloudWatch cross-account observability.
+ * use the returned token with subsequent calls. + *After you create a metric, allow up to 15 minutes for the metric to appear. To see + * metric statistics sooner, use GetMetricData or GetMetricStatistics.
+ *If you are using CloudWatch cross-account observability, you can use this + * operation in a monitoring account and view metrics from the linked source accounts. For + * more information, see CloudWatch cross-account observability.
*
- * ListMetrics doesn't return information about metrics if those metrics haven't
- * reported data in the past two weeks. To retrieve those metrics, use
- * GetMetricData or
- * GetMetricStatistics.
ListMetrics doesn't return information about metrics if those metrics
+ * haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -91,7 +89,8 @@ export interface ListMetricsCommandOutput extends ListMetricsOutput, __MetadataB
* @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/ListTagsForResourceCommand.ts b/clients/client-cloudwatch/src/commands/ListTagsForResourceCommand.ts index d7578d06927d..2203b4b2dc86 100644 --- a/clients/client-cloudwatch/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloudwatch/src/commands/ListTagsForResourceCommand.ts @@ -28,8 +28,8 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceInpu export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {} /** - *Displays the tags associated with a CloudWatch resource. Currently, alarms - * and Contributor Insights rules support tagging.
+ *Displays the tags associated with a CloudWatch resource. Currently, alarms and + * Contributor Insights rules support tagging.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut * @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/PutAnomalyDetectorCommand.ts b/clients/client-cloudwatch/src/commands/PutAnomalyDetectorCommand.ts index 72e67eec3032..ec65953d497a 100644 --- a/clients/client-cloudwatch/src/commands/PutAnomalyDetectorCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutAnomalyDetectorCommand.ts @@ -28,11 +28,12 @@ export interface PutAnomalyDetectorCommandInput extends PutAnomalyDetectorInput export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorOutput, __MetadataBearer {} /** - *Creates an anomaly detection model for a CloudWatch metric. You can use the model - * to display a band of expected normal values when the metric is graphed.
- *If you have enabled unified cross-account observability, and this account is a monitoring
- * account, the metric can be in the same account or a source account. You can specify the account ID
- * in the object you specify in the SingleMetricAnomalyDetector parameter.
Creates an anomaly detection model for a CloudWatch metric. You can use the model to + * display a band of expected normal values when the metric is graphed.
+ *If you have enabled unified cross-account observability, and this account is a
+ * monitoring account, the metric can be in the same account or a source account. You can
+ * specify the account ID in the object you specify in the
+ * SingleMetricAnomalyDetector parameter.
For more information, see CloudWatch Anomaly Detection.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -110,7 +111,8 @@ export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorOutpu * @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/PutCompositeAlarmCommand.ts b/clients/client-cloudwatch/src/commands/PutCompositeAlarmCommand.ts index 19bcc4cc16e1..c451c548b63a 100644 --- a/clients/client-cloudwatch/src/commands/PutCompositeAlarmCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutCompositeAlarmCommand.ts @@ -29,19 +29,17 @@ export interface PutCompositeAlarmCommandOutput extends __MetadataBearer {} /** *Creates or updates a composite alarm. When you create a composite - * alarm, you specify a rule expression for the alarm that takes into account the alarm - * states of other alarms that you have created. The composite alarm goes into ALARM state - * only if all conditions of the rule are met.
+ * alarm, you specify a rule expression for the alarm that takes into account the alarm + * states of other alarms that you have created. The composite alarm goes into ALARM state + * only if all conditions of the rule are met. *The alarms specified in a composite alarm's rule expression can include metric alarms - * and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. - * Any single alarm can be included in the rule expressions of as many as 150 composite alarms.
- *Using composite alarms can reduce - * alarm noise. You can create multiple metric alarms, - * and also create a composite alarm and - * set up alerts only - * for the composite alarm. For example, you could create a composite - * alarm that goes into ALARM state only when more than one of the underlying metric alarms - * are in ALARM state.
+ * and other composite alarms. The rule expression of a composite alarm can include as many + * as 100 underlying alarms. Any single alarm can be included in the rule expressions of as + * many as 150 composite alarms. + *Using composite alarms can reduce alarm noise. You can create multiple metric alarms, + * and also create a composite alarm and set up alerts only for the composite alarm. For + * example, you could create a composite alarm that goes into ALARM state only when more + * than one of the underlying metric alarms are in ALARM state.
*Composite alarms can take the following actions:
*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.
*When this operation creates an alarm, the alarm state is immediately set to
- * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
- * appropriately. Any actions associated with the new state are then executed. For a
- * composite alarm, this initial time after creation is the only time that
- * the
- * alarm can be in INSUFFICIENT_DATA state.
INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
+ * appropriately. Any actions associated with the new state are then executed. For a
+ * composite alarm, this initial time after creation is the only time that the alarm can be
+ * in INSUFFICIENT_DATA state.
* When you update an existing alarm, its state is left unchanged, but the update - * completely overwrites the previous configuration of the alarm.
- *To use this operation, you must be signed on with
- * the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a
- * composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole to create
- * a composite alarm that has Systems Manager OpsItem actions.
To use this operation, you must be signed on with the
+ * cloudwatch:PutCompositeAlarm permission that is scoped to
+ * *. You can't create a composite alarms if your
+ * cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have
+ * iam:CreateServiceLinkedRole to create a composite alarm that has
+ * Systems Manager OpsItem actions.
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, - * the entire contents are replaced with what you specify here.
+ *Creates a dashboard if it does not already exist, or updates an existing dashboard. + * If you update a dashboard, the entire contents are replaced with what you specify + * here.
*All dashboards in your account are global, not region-specific.
*A simple way to create a dashboard using PutDashboard is to copy an
- * existing dashboard. To copy an existing dashboard using the console, you can load the dashboard
- * and then use the View/edit source command in the Actions menu to display the JSON block
- * for that dashboard. Another way to copy a dashboard is to
- * use GetDashboard, and then use the data returned
- * within DashboardBody as the template for the new dashboard when you call PutDashboard.
GetDashboard, and then use the data returned within
+ * DashboardBody as the template for the new dashboard when you call
+ * PutDashboard.
* When you create a dashboard with PutDashboard, a good practice is to
- * add a text widget at the top of the dashboard with a message that the dashboard was created by script and should
- * not be changed in the console. This message could also point console users to the location
- * of the DashboardBody script or the CloudFormation template used to create the
- * dashboard.
DashboardBody script or the
+ * CloudFormation template used to create the dashboard.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -75,7 +77,8 @@ export interface PutDashboardCommandOutput extends PutDashboardOutput, __Metadat
* Some part of the dashboard data is invalid.
* * @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 CloudWatchServiceException} *Base exception class for all service exceptions from CloudWatch service.
diff --git a/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts b/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts index 3b7bbd6a1347..e61496a062a9 100644 --- a/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts @@ -28,11 +28,12 @@ export interface PutInsightRuleCommandInput extends PutInsightRuleInput {} export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __MetadataBearer {} /** - *Creates a Contributor Insights rule. Rules evaluate log events in a - * CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, - * see Using Contributor Insights to Analyze High-Cardinality Data.
- *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.
+ *Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs + * log group, enabling you to find contributor data for the log events in that log group. + * For more information, see Using Contributor + * Insights to Analyze High-Cardinality Data.
+ *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/PutManagedInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/PutManagedInsightRulesCommand.ts index 0a1966c9df01..e1bfd32d5d45 100644 --- a/clients/client-cloudwatch/src/commands/PutManagedInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutManagedInsightRulesCommand.ts @@ -28,23 +28,16 @@ export interface PutManagedInsightRulesCommandInput extends PutManagedInsightRul export interface PutManagedInsightRulesCommandOutput extends PutManagedInsightRulesOutput, __MetadataBearer {} /** - *
- * Creates a managed Contributor Insights rule
- * for a specified Amazon Web Services resource.
- * When you enable a managed rule,
- * you create a Contributor Insights rule
- * that collects data
- * from Amazon Web Services services.
- * You cannot edit these rules
- * with PutInsightRule.
- * The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules.
- * If a previously created managed rule is currently disabled,
- * a subsequent call
- * to this API will re-enable it.
- * Use ListManagedInsightRules
- * to describe all available rules.
+ *
Creates a managed Contributor Insights rule for a specified Amazon Web Services
+ * resource. When you enable a managed rule, you create a Contributor Insights rule that
+ * collects data from Amazon Web Services services. You cannot edit these rules with
+ * PutInsightRule. The rules can be enabled, disabled, and deleted using
+ * EnableInsightRules, DisableInsightRules, and
+ * DeleteInsightRules. If a previously created managed rule is currently
+ * disabled, a subsequent call to this API will re-enable it. Use
+ * ListManagedInsightRules to describe all available rules.
*
- *
Creates or updates an alarm and associates it with the specified metric, metric math expression, - * anomaly detection model, or Metrics Insights query. For more information about using - * a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
+ *Creates or updates an alarm and associates it with the specified metric, metric + * math expression, anomaly detection model, or Metrics Insights query. For more + * information about using a Metrics Insights query for an alarm, see Create + * alarms on Metrics Insights queries.
*Alarms based on anomaly detection models cannot have Auto Scaling actions.
*When this operation creates an alarm, the alarm state is immediately set to
- * INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
- * appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the - * update completely overwrites the previous configuration of the alarm.
- *If you are an IAM user, you must have - * Amazon EC2 permissions for some alarm operations:
+ *INSUFFICIENT_DATA. The alarm is then evaluated and its state is set
+ * appropriately. Any actions associated with the new state are then executed.
+ * When you update an existing alarm, its state is left unchanged, but the update + * completely overwrites the previous configuration of the alarm.
+ *If you are an IAM user, you must have Amazon EC2 permissions for + * some alarm operations:
*The iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
The iam:CreateServiceLinkedRole permission for all alarms with
+ * EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm
- * with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the
- * Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
- * creates the necessary service-linked role for you. The service-linked roles
- * are called AWSServiceRoleForCloudWatchEvents and
- * AWSServiceRoleForCloudWatchAlarms_ActionSSM.
- * For more information, see Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary
+ * service-linked role for you. The service-linked roles are called
+ * AWSServiceRoleForCloudWatchEvents and
+ * AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see
+ * Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120
+ * KB.
* Cross-account alarms *
- *You can set an alarm on metrics in the current account, or in another - * account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following - * pre-requisites:
+ *You can set an alarm on metrics in the current account, or in another account. To + * create a cross-account alarm that watches a metric in a different account, you must have + * completed the following pre-requisites:
*The account where the metrics are located (the sharing account) must - * already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already - * have this role, you must create it using the instructions in Set up a - * sharing account in - * Cross-account cross-Region CloudWatch console. The policy for that - * role must grant access - * to the ID of the account where you are creating the alarm. - *
+ *The account where the metrics are located (the sharing + * account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not + * already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy + * for that role must grant access to the ID of the account where you are creating + * the alarm.
*The account where you are creating the alarm (the monitoring account) must - * already have a service-linked role named - * AWSServiceRoleForCloudWatchCrossAccount to allow - * CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a - * monitoring account in - * Cross-account cross-Region CloudWatch console.
+ *The account where you are creating the alarm (the monitoring + * account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow + * CloudWatch to assume the sharing role in the sharing account. If it + * does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
*Publishes metric data points to Amazon CloudWatch. CloudWatch associates - * the data points with the specified metric. If the specified metric does not exist, - * CloudWatch creates the metric. When CloudWatch creates a metric, it can - * take up to fifteen minutes for the metric to appear in calls to ListMetrics.
- *You can publish either individual data points in the Value field, or
- * arrays of values and the number of times each value occurred during the period by using the
- * Values and Counts fields in the MetricData structure. Using
- * the Values and Counts method enables you to publish up to 150 values per metric
- * with one PutMetricData request, and
- * supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can
- * send a payload compressed by gzip. Each request
- * is also limited to no more than 1000 different metrics.
Although the Value parameter accepts numbers of type
- * Double, CloudWatch rejects values that are either too small
- * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
- * -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension - * consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the - * Amazon CloudWatch User Guide.
- *You specify the time stamp to be associated with each data point. You can specify - * time stamps that are as much as two weeks before the current date, and as much as 2 hours after - * the current day and time.
- *Data points with time stamps from 24 hours ago or longer can take at least 48 - * hours to become available for GetMetricData or - * GetMetricStatistics from the time they - * are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available - * for for GetMetricData or - * GetMetricStatistics.
+ *Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the + * specified metric. If the specified metric does not exist, CloudWatch creates the metric. + * When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to + * appear in calls to ListMetrics.
+ *You can publish metrics with associated entity data (so that related telemetry can be
+ * found and viewed together), or publish metric data by itself. To send entity data with
+ * your metrics, use the EntityMetricData parameter. To send metrics without
+ * entity data, use the MetricData parameter. The
+ * EntityMetricData structure includes MetricData structures
+ * for the metric data.
You can publish either individual values in the Value field, or arrays of
+ * values and the number of times each value occurred during the period by using the
+ * Values and Counts fields in the MetricData
+ * structure. Using the Values and Counts method enables you to
+ * publish up to 150 values per metric with one PutMetricData request, and
+ * supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST
+ * requests. You can send a payload compressed by gzip. Each request is also limited to no
+ * more than 1000 different metrics (across both the MetricData and
+ * EntityMetricData properties).
Although the Value parameter accepts numbers of type Double,
+ * CloudWatch rejects values that are either too small or too large. Values must be in the
+ * range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
+ * -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric + * collects. Each dimension consists of a Name and Value pair. For more information about + * specifying dimensions, see Publishing + * Metrics in the Amazon CloudWatch User Guide.
+ *You specify the time stamp to be associated with each data point. You can specify time + * stamps that are as much as two weeks before the current date, and as much as 2 hours + * after the current day and time.
+ *Data points with time stamps from 24 hours ago or longer can take at least 48 hours to + * become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time + * stamps between 3 and 24 hours ago can take as much as 2 hours to become available for + * GetMetricData or GetMetricStatistics.
*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: *The SampleCount value of the statistic set is 1 and Min,
- * Max, and Sum are all equal.
The SampleCount value of the statistic set is 1 and
+ * Min, Max, and Sum are all
+ * equal.
The Min and
- * Max are equal, and Sum is equal to Min
- * multiplied by SampleCount.
The Min and Max are equal, and Sum
+ * is equal to Min multiplied by SampleCount.
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/PutMetricStreamCommand.ts b/clients/client-cloudwatch/src/commands/PutMetricStreamCommand.ts index d2121c57e17e..d5fce4c8764e 100644 --- a/clients/client-cloudwatch/src/commands/PutMetricStreamCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutMetricStreamCommand.ts @@ -29,39 +29,39 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M /** *Creates or updates a metric stream. Metric streams can automatically stream CloudWatch - * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party - * solutions.
- *For more information, see - * Using Metric Streams.
+ * metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party + * solutions. + *For more information, see Using + * Metric Streams.
*To create a metric stream, you must be signed in to an account that has the
- * iam:PassRole permission and either the
- * CloudWatchFullAccess policy or the
- * cloudwatch:PutMetricStream permission.
iam:PassRole permission and either the
+ * CloudWatchFullAccess policy or the
+ * cloudwatch:PutMetricStream permission.
* When you create or update a metric stream, you choose one of the following:
*Stream metrics from all metric namespaces in the account.
*Stream metrics from all metric namespaces in the account, except
- * for the namespaces that you list in ExcludeFilters.
Stream metrics from all metric namespaces in the account, except for the
+ * namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in
- * IncludeFilters.
IncludeFilters.
* By default, a metric stream always sends the MAX, MIN,
- * SUM, and SAMPLECOUNT statistics for each metric that is
- * streamed. You can use the StatisticsConfigurations parameter to have the
- * metric stream send additional statistics in the stream. Streaming additional statistics
- * incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream to create a new metric stream, the stream
- * is created in the running state. If you use it to update an existing stream,
- * the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account, - * you can choose whether to include metrics from source accounts in the stream. For more information, see - * CloudWatch cross-account observability.
+ *SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. You can use the StatisticsConfigurations parameter to have the
+ * metric stream send additional statistics in the stream. Streaming additional statistics
+ * incurs additional costs. For more information, see Amazon CloudWatch Pricing.
+ * When you use PutMetricStream to create a new metric stream, the stream is
+ * created in the running state. If you use it to update an existing stream,
+ * the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric + * stream in a monitoring account, you can choose whether to include metrics from source + * accounts in the stream. For more information, see CloudWatch cross-account observability.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -128,7 +128,8 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M *More than one process tried to modify a resource at the same time.
* * @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/SetAlarmStateCommand.ts b/clients/client-cloudwatch/src/commands/SetAlarmStateCommand.ts index bca453bfa76d..3d43a6c7785f 100644 --- a/clients/client-cloudwatch/src/commands/SetAlarmStateCommand.ts +++ b/clients/client-cloudwatch/src/commands/SetAlarmStateCommand.ts @@ -28,22 +28,22 @@ export interface SetAlarmStateCommandInput extends SetAlarmStateInput {} export interface SetAlarmStateCommandOutput extends __MetadataBearer {} /** - *Temporarily sets the state of an alarm for testing purposes. When the updated
- * state differs from the previous value, the action configured for
- * the appropriate state is invoked. For example, if your alarm is configured to send an
- * Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to
- * ALARM sends an SNS message.
Metric alarms - * returns to their actual state quickly, often within seconds. Because the metric alarm state change - * happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through - * DescribeAlarmHistory.
- *If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return
- * to its actual state. It
- * returns to its actual state only once any of its children alarms change state. It is also
- * reevaluated if you update its
- * configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include
- * information in the StateReasonData parameter to enable the policy to take the correct action.
Temporarily sets the state of an alarm for testing purposes. When the updated state
+ * differs from the previous value, the action configured for the appropriate state is
+ * invoked. For example, if your alarm is configured to send an Amazon SNS message when an
+ * alarm is triggered, temporarily changing the alarm state to ALARM sends an
+ * SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because + * the metric alarm state change happens quickly, it is typically only visible in the + * alarm's History tab in the Amazon CloudWatch console or + * through DescribeAlarmHistory.
+ *If you use SetAlarmState on a composite alarm, the composite alarm is
+ * not guaranteed to return to its actual state. It returns to its actual state only once
+ * any of its children alarms change state. It is also reevaluated if you update its
+ * configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling
+ * policies, you must include information in the StateReasonData parameter to
+ * enable the policy to take the correct action.
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/StopMetricStreamsCommand.ts b/clients/client-cloudwatch/src/commands/StopMetricStreamsCommand.ts index 47f305cac9da..c972039d2243 100644 --- a/clients/client-cloudwatch/src/commands/StopMetricStreamsCommand.ts +++ b/clients/client-cloudwatch/src/commands/StopMetricStreamsCommand.ts @@ -53,7 +53,8 @@ export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput, * @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/TagResourceCommand.ts b/clients/client-cloudwatch/src/commands/TagResourceCommand.ts index 32d982dd0be5..81933f90b5cc 100644 --- a/clients/client-cloudwatch/src/commands/TagResourceCommand.ts +++ b/clients/client-cloudwatch/src/commands/TagResourceCommand.ts @@ -28,16 +28,19 @@ export interface TagResourceCommandInput extends TagResourceInput {} export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {} /** - *Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that - * can be tagged are alarms and Contributor Insights rules.
- *Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.
- *Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
- *You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm,
- * this tag is appended to the list of tags associated
- * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
- * the previous value for that tag.
Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. + * Currently, the only CloudWatch resources that can be tagged are alarms and Contributor + * Insights rules.
+ *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *Tags don't have any semantic meaning to Amazon Web Services and are interpreted + * strictly as strings of characters.
+ *You can use the TagResource action with an alarm that already has tags.
+ * If you specify a new tag key for the alarm, this tag is appended to the list of tags
+ * associated with the alarm. If you specify a tag key that is already associated with the
+ * alarm, the new tag value that you specify replaces the previous value for that
+ * tag.
You can associate as many as 50 tags with a CloudWatch resource.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -70,7 +73,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB *More than one process tried to modify a resource at the same time.
* * @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/UntagResourceCommand.ts b/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts index 641fb9a53e1a..c4221ce57a89 100644 --- a/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts +++ b/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts @@ -57,7 +57,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad *More than one process tried to modify a resource at the same time.
* * @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/index.ts b/clients/client-cloudwatch/src/index.ts index f372975dfa71..3391ff27aca4 100644 --- a/clients/client-cloudwatch/src/index.ts +++ b/clients/client-cloudwatch/src/index.ts @@ -1,19 +1,19 @@ // smithy-typescript generated code /* eslint-disable */ /** - *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.
* * @packageDocumentation */ diff --git a/clients/client-cloudwatch/src/models/models_0.ts b/clients/client-cloudwatch/src/models/models_0.ts index 548ade54e355..afbc14643101 100644 --- a/clients/client-cloudwatch/src/models/models_0.ts +++ b/clients/client-cloudwatch/src/models/models_0.ts @@ -90,91 +90,93 @@ export interface AlarmHistoryItem { } /** - *Specifies one range of days or times to exclude from use for training an - * anomaly detection model.
+ *Specifies one range of days or times to exclude from use for training an anomaly + * detection model.
* @public */ export interface Range { /** - *The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example,
- * 2019-07-01T23:59:59.
The start time of the range to exclude. The format is
+ * yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example,
- * 2019-07-01T23:59:59.
The end time of the range to exclude. The format is
+ * yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The configuration specifies details about how the anomaly detection model is to be trained, - * including time ranges to exclude from use for training the model and the time zone to - * use for the metric.
+ *The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude from use for training the model and the time + * zone to use for the metric.
* @public */ export interface AnomalyDetectorConfiguration { /** - *An array of time ranges to exclude from use when the anomaly detection model is trained. Use - * this to make sure that events that could cause unusual values for the metric, such as - * deployments, aren't used when CloudWatch creates the model.
+ *An array of time ranges to exclude from use when the anomaly detection model is + * trained. Use this to make sure that events that could cause unusual values for the + * metric, such as deployments, aren't used when CloudWatch creates the model.
* @public */ ExcludedTimeRanges?: Range[] | undefined; /** - *The time zone to use for the metric. This is useful to enable the model to automatically - * account for daylight savings time changes if the metric is sensitive to such time - * changes.
- *To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, - * see tz database.
+ *The time zone to use for the metric. This is useful to enable the model to + * automatically account for daylight savings time changes if the metric is sensitive to + * such time changes.
+ *To specify a time zone, use the name of the time zone as specified in the standard + * tz database. For more information, see tz database.
* @public */ MetricTimezone?: string | undefined; } /** - *A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique
- * identifier for a metric, whenever you add a unique name/value pair to one of
- * your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish
- * InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You - * can assign up to 30 dimensions to a metric.
+ *A dimension is a name/value pair that is part of the identity of a metric. Because
+ * dimensions are part of the unique identifier for a metric, whenever you add a unique
+ * name/value pair to one of your metrics, you are creating a new variation of that metric.
+ * For example, many Amazon EC2 metrics publish InstanceId as a
+ * dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
* @public */ export interface Dimension { /** - *The name of the dimension. Dimension names must contain only ASCII characters, must include
- * at least one non-whitespace character, and cannot start with a colon (:).
- * ASCII
- * control characters are not supported as part of dimension names.
The name of the dimension. Dimension names must contain only ASCII characters, must
+ * include at least one non-whitespace character, and cannot start with a colon
+ * (:). ASCII control characters are not supported as part of dimension
+ * names.
The value of the dimension. Dimension values must contain only ASCII characters and must include - * at least one non-whitespace character. ASCII - * control characters are not supported as part of dimension values.
+ *The value of the dimension. Dimension values must contain only ASCII characters and + * must include at least one non-whitespace character. ASCII control characters are not + * supported as part of dimension values.
* @public */ Value: string | undefined; } /** - *This object includes parameters that you can use to provide information to - * CloudWatch to help it build more accurate anomaly detection models.
+ *This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
* @public */ export interface MetricCharacteristics { /** - *Set this parameter to true if values for this metric consistently include spikes
- * that should not be considered to be anomalies. With this set to true, CloudWatch will expect
- * to see spikes that occurred consistently during the model training period, and won't flag future similar spikes
- * as anomalies.
Set this parameter to true if values for this metric consistently include
+ * spikes that should not be considered to be anomalies. With this set to
+ * true, CloudWatch will expect to see spikes that occurred
+ * consistently during the model training period, and won't flag future similar spikes as
+ * anomalies.
This structure defines the metric to be returned, along with the statistics, period, and units.
+ *This structure defines the metric to be returned, along with the statistics, period, + * and units.
* @public */ export interface MetricStat { @@ -255,21 +258,27 @@ export interface MetricStat { Metric: Metric | undefined; /** - *The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
- * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
- * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
- * are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData call that includes a
+ * StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
- * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
+ *Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + * (1 minute).
*Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
+ *Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + * minutes).
*Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
+ *Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + * hour).
*The statistic to return. It can include any CloudWatch statistic or extended statistic.
+ *The statistic to return. It can include any CloudWatch statistic or extended + * statistic.
* @public */ Stat: string | undefined; /** - *When you are using a Put operation, this defines what unit you want to use when storing the metric.
In a Get operation, if you omit Unit then 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.
When you are using a Put operation, this defines what unit you want to
+ * use when storing the metric.
In a Get operation, if you omit Unit then 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.
This structure is used in both GetMetricData and PutMetricAlarm. The supported
- * use of this structure is different for those two operations.
When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving
- * a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A
- * single GetMetricData call can include up to 500 MetricDataQuery
- * structures.
This structure is used in both GetMetricData and
+ * PutMetricAlarm. The supported use of this structure is different for
+ * those two operations.
When used in GetMetricData, it indicates the metric data to return, and
+ * whether this call is just retrieving a batch set of data for one metric, or is
+ * performing a Metrics Insights query or a math expression. A single
+ * GetMetricData call can include up to 500 MetricDataQuery
+ * structures.
When used in PutMetricAlarm, it enables you to create an alarm based on a
- * metric math expression. Each MetricDataQuery in the array specifies either
- * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
- * single PutMetricAlarm call can include up to 20
- * MetricDataQuery structures in the array. The 20 structures can include
- * as many as 10 structures that contain a MetricStat parameter to retrieve a
- * metric, and as many as 10 structures that contain the Expression parameter
- * to perform a math expression. Of those Expression structures, one must have true
- * as the value for ReturnData. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm
- * operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User
- * Guide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData
- * operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.
MetricDataQuery in the array specifies either
+ * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
+ * single PutMetricAlarm call can include up to 20
+ * MetricDataQuery structures in the array. The 20 structures can include
+ * as many as 10 structures that contain a MetricStat parameter to retrieve a
+ * metric, and as many as 10 structures that contain the Expression parameter
+ * to perform a math expression. Of those Expression structures, one must have
+ * true as the value for ReturnData. The result of this
+ * expression is the value the alarm watches.
+ * Any expression used in a PutMetricAlarm operation must return a single
+ * time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User
+ * Guide.
Some of the parameters of this structure also have different uses whether you are
+ * using this structure in a GetMetricData operation or a
+ * PutMetricAlarm operation. These differences are explained in the
+ * following parameter list.
A short name used to tie this object to the results in the response. This name must be
- * unique within a single call to GetMetricData. If you are performing math
- * expressions on this set of data, this name represents that data and can serve as a
- * variable in the mathematical expression. The valid characters are letters, numbers, and
- * underscore. The first character must be a lowercase letter.
GetMetricData. If you are performing math
+ * expressions on this set of data, this name represents that data and can serve as a
+ * variable in the mathematical expression. The valid characters are letters, numbers, and
+ * underscore. The first character must be a lowercase letter.
* @public
*/
Id: string | undefined;
/**
- * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric - * and not performing a math expression on returned data.
- *Within one MetricDataQuery object, you must specify either
- * Expression or MetricStat but not both.
The metric to be returned, along with statistics, period, and units. Use this + * parameter only if this object is retrieving a metric and not performing a math + * expression on returned data.
+ *Within one MetricDataQuery object, you must specify either Expression or
+ * MetricStat but not both.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the - * returned data. For more information about Metrics Insights queries, see - * Metrics Insights query components and syntax in the - * Amazon CloudWatch User Guide.
- *A math expression
- * can use the Id of the other metrics or queries to refer to those metrics, and can also use
- * the Id of other
- * expressions to use the result of those expressions. For more information about metric math expressions, see
- * Metric Math Syntax and Functions in the
- * Amazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either
- * Expression or MetricStat but not both.
This field can contain either a Metrics Insights query, or a metric math expression to + * be performed on the returned data. For more information about Metrics Insights queries, + * see Metrics Insights query components and syntax in the Amazon + * CloudWatch User Guide.
+ *A math expression can use the Id of the other metrics or queries to refer
+ * to those metrics, and can also use the Id of other expressions to use the
+ * result of those expressions. For more information about metric math expressions, see
+ * Metric Math Syntax and Functions in the Amazon CloudWatch User
+ * Guide.
Within each MetricDataQuery object, you must specify either Expression or
+ * MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful - * if this is an expression, so that you know - * what the value represents. If the metric or expression is shown in a - * CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch - * generates a default.
- *You can put dynamic expressions into a label, so that it is more descriptive. - * For more information, see Using Dynamic Labels.
+ *A human-readable label for this metric or expression. This is especially useful if + * this is an expression, so that you know what the value represents. If the metric or + * expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is + * omitted, CloudWatch generates a default.
+ *You can put dynamic expressions into a label, so that it is more descriptive. For more + * information, see Using Dynamic + * Labels.
* @public */ Label?: string | undefined; /** *When used in GetMetricData, this option indicates whether to return the
- * timestamps and raw data values of this metric. If you are performing this call just to
- * do math expressions and do not also need the raw data returned, you can specify
- * false. If you omit this, the default of true is
- * used.
When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all
- * other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.
false. If you omit this, the default of true is
+ * used.
+ * When used in PutMetricAlarm, specify true for the one
+ * expression result to use as the alarm. For all other metrics and expressions in the same
+ * PutMetricAlarm operation, specify ReturnData as
+ * False.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
- * period can be as short as one minute (60 seconds) and must be a multiple of 60.
- * For high-resolution metrics that are collected at intervals of less than one minute,
- * the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics
- * stored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData operation that includes
+ * a StorageResolution of 1 second.
The ID of the account where the metrics are located.
- *If you are performing a GetMetricData operation in a monitoring account, use this to specify
- * which account to retrieve this metric from.
If you are performing a GetMetricData operation in a monitoring account,
+ * use this to specify which account to retrieve this metric from.
If you are performing a PutMetricAlarm operation, use this to specify
- * which account contains the metric that the alarm is watching.
Indicates the CloudWatch math expression that provides the time series the anomaly detector - * uses as input. - * The designated math expression must return a single time series.
+ *Indicates the CloudWatch math expression that provides the time series the anomaly + * detector uses as input. The designated math expression must return a single time + * series.
* @public */ export interface MetricMathAnomalyDetector { /** - *An array of metric data query structures
- * that enables you to create an anomaly detector
- * based on the result of a metric math expression.
- * Each item in MetricDataQueries gets a metric or performs a math expression.
- * One item in MetricDataQueries is the expression
- * that provides the time series
- * that the anomaly detector uses as input.
- * Designate the expression by setting ReturnData to true
- * for this object in the array.
- * For all other expressions and metrics, set ReturnData to false.
- * The designated expression must return
- * a single time series.
An array of metric data query structures that enables you to create an anomaly
+ * detector based on the result of a metric math expression. Each item in
+ * MetricDataQueries gets a metric or performs a math expression. One item
+ * in MetricDataQueries is the expression that provides the time series that
+ * the anomaly detector uses as input. Designate the expression by setting
+ * ReturnData to true for this object in the array. For all
+ * other expressions and metrics, set ReturnData to false. The
+ * designated expression must return a single time series.
Designates the CloudWatch metric and statistic that provides the time series the anomaly detector - * uses as input. If you have enabled unified cross-account observability, and this account is a monitoring - * account, the metric can be in the same account or a source account.
+ *Designates the CloudWatch metric and statistic that provides the time series the + * anomaly detector uses as input. If you have enabled unified cross-account observability, + * and this account is a monitoring account, the metric can be in the same account or a + * source account.
* @public */ export interface SingleMetricAnomalyDetector { /** - *If the CloudWatch metric that provides the time series that the anomaly detector - * uses as input is in another account, specify that account ID here. If you omit this parameter, - * the current account is used.
+ *If the CloudWatch metric that provides the time series that the anomaly + * detector uses as input is in another account, specify that account ID here. If you omit + * this parameter, the current account is used.
* @public */ AccountId?: string | undefined; @@ -478,11 +497,11 @@ export const AnomalyDetectorStateValue = { export type AnomalyDetectorStateValue = (typeof AnomalyDetectorStateValue)[keyof typeof AnomalyDetectorStateValue]; /** - *An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. - * You can use the model to display a band of expected, normal values - * when the metric is graphed.
- *If you have enabled unified cross-account observability, and this account is a monitoring - * account, the metric can be in the same account or a source account.
+ *An anomaly detection model associated with a particular CloudWatch metric, statistic, + * or metric math expression. You can use the model to display a band of expected, normal + * values when the metric is graphed.
+ *If you have enabled unified cross-account observability, and this account is a + * monitoring account, the metric can be in the same account or a source account.
* @public */ export interface AnomalyDetector { @@ -519,10 +538,9 @@ export interface AnomalyDetector { Stat?: string | undefined; /** - *The configuration specifies details about how the - * anomaly detection model is to be trained, including time ranges to - * exclude from use for training the model, and the time zone to use for - * the metric.
+ *The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude from use for training the model, and the time + * zone to use for the metric.
* @public */ Configuration?: AnomalyDetectorConfiguration | undefined; @@ -534,9 +552,9 @@ export interface AnomalyDetector { StateValue?: AnomalyDetectorStateValue | undefined; /** - *This object includes parameters that you can use to provide information about your metric to
- * CloudWatch to help it build more accurate anomaly detection models. Currently, it includes
- * the PeriodicSpikes parameter.
This object includes parameters that you can use to provide information about your
+ * metric to CloudWatch to help it build more accurate anomaly detection models.
+ * Currently, it includes the PeriodicSpikes parameter.
This array is empty if the API operation was successful for all the rules specified in the request. If the operation could - * not process one of the rules, the following data is returned for each of those rules.
+ *This array is empty if the API operation was successful for all the rules specified in + * the request. If the operation could not process one of the rules, the following data is + * returned for each of those rules.
* @public */ export interface PartialFailure { @@ -639,13 +658,15 @@ export type StateValue = (typeof StateValue)[keyof typeof StateValue]; */ export interface CompositeAlarm { /** - *Indicates whether actions should be executed during any changes to the alarm state.
+ *Indicates whether actions should be executed during any changes to the alarm + * state.
* @public */ ActionsEnabled?: boolean | undefined; /** - *The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
+ *The actions to execute when this alarm transitions to the ALARM state from any other + * state. Each action is specified as an Amazon Resource Name (ARN).
* @public */ AlarmActions?: string[] | undefined; @@ -681,13 +702,15 @@ export interface CompositeAlarm { AlarmRule?: string | undefined; /** - *The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
+ *The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from + * any other state. Each action is specified as an Amazon Resource Name (ARN).
* @public */ InsufficientDataActions?: string[] | undefined; /** - *The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
+ *The actions to execute when this alarm transitions to the OK state from any other + * state. Each action is specified as an Amazon Resource Name (ARN).
* @public */ OKActions?: string[] | undefined; @@ -705,7 +728,8 @@ export interface CompositeAlarm { StateReasonData?: string | undefined; /** - *Tracks the timestamp of any state update, even if StateValue doesn't change.
Tracks the timestamp of any state update, even if StateValue doesn't
+ * change.
- * The timestamp
- * of the last change
- * to the alarm's StateValue.
- *
The timestamp of the last change to the alarm's StateValue.
- * When the value is ALARM,
- * it means
- * that the actions are suppressed
- * because the suppressor alarm is
- * in ALARM
- * When the value is WaitPeriod,
- * it means that
- * the actions are suppressed
- * because the composite alarm is waiting
- * for the suppressor alarm
- * to go
- * into
- * into the ALARM state.
- * The maximum waiting time is as specified
- * in ActionsSuppressorWaitPeriod.
- * After this time,
- * the composite alarm performs its actions.
- * When the value is ExtensionPeriod,
- * it means
- * that the actions are suppressed
- * because the composite alarm is waiting
- * after the suppressor alarm went out
- * of the ALARM state.
- * The maximum waiting time is as specified
- * in ActionsSuppressorExtensionPeriod.
- * After this time,
- * the composite alarm performs its actions.
- *
When the value is ALARM, it means that the actions are suppressed
+ * because the suppressor alarm is in ALARM When the value is
+ * WaitPeriod, it means that the actions are suppressed because the
+ * composite alarm is waiting for the suppressor alarm to go into into the
+ * ALARM state. The maximum waiting time is as specified in
+ * ActionsSuppressorWaitPeriod. After this time, the composite alarm
+ * performs its actions. When the value is ExtensionPeriod, it means that the
+ * actions are suppressed because the composite alarm is waiting after the suppressor alarm
+ * went out of the ALARM state. The maximum waiting time is as specified in
+ * ActionsSuppressorExtensionPeriod. After this time, the composite alarm
+ * performs its actions.
- * Captures the reason for action suppression. - *
+ *Captures the reason for action suppression.
* @public */ ActionsSuppressedReason?: string | undefined; /** - *
- * Actions will be suppressed
- * if the suppressor alarm is
- * in the ALARM state.
- * ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN)
- * from an existing alarm.
- *
Actions will be suppressed if the suppressor alarm is in the ALARM
+ * state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name
+ * (ARN) from an existing alarm.
- * The maximum time
- * in seconds
- * that the composite alarm waits
- * for the suppressor alarm
- * to go
- * into the ALARM state.
- * After this time,
- * the composite alarm performs its actions.
- *
The maximum time in seconds that the composite alarm waits for the suppressor alarm
+ * to go into the ALARM state. After this time, the composite alarm performs
+ * its actions.
- * WaitPeriod
- * is required only
- * when ActionsSuppressor is specified.
- *
WaitPeriod is required only when ActionsSuppressor is
+ * specified.
*
- * The maximum time
- * in seconds
- * that the composite alarm waits
- * after suppressor alarm goes out
- * of the ALARM state.
- * After this time,
- * the composite alarm performs its actions.
- *
The maximum time in seconds that the composite alarm waits after suppressor alarm
+ * goes out of the ALARM state. After this time, the composite alarm performs
+ * its actions.
- * ExtensionPeriod
- * is required only
- * when ActionsSuppressor is specified.
- *
ExtensionPeriod is required only when ActionsSuppressor is
+ * specified.
* The time stamp of when the dashboard was last modified, either by an API call or - * through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
+ * through the console. This number is expressed as the number of milliseconds since Jan 1, + * 1970 00:00:00 UTC. * @public */ LastModified?: Date | undefined; @@ -938,7 +918,8 @@ export class DashboardNotFoundError extends __BaseException { } /** - *Encapsulates the statistical data that CloudWatch computes from metric data.
+ *Encapsulates the statistical data that CloudWatch computes from metric + * data.
* @public */ export interface Datapoint { @@ -949,8 +930,8 @@ export interface Datapoint { Timestamp?: Date | undefined; /** - *The number of metric values that contributed to the aggregate value of this - * data point.
+ *The number of metric values that contributed to the aggregate value of this data + * point.
* @public */ SampleCount?: number | undefined; @@ -1061,8 +1042,8 @@ export interface DeleteAnomalyDetectorInput { /** *A single metric anomaly detector to be deleted.
- *When using SingleMetricAnomalyDetector,
- * you cannot include the following parameters in the same operation:
When using SingleMetricAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
@@ -1084,19 +1065,21 @@ export interface DeleteAnomalyDetectorInput { *
*the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput
+ *
the MetricMathAnomalyDetector parameters of
+ * DeleteAnomalyDetectorInput
*
Instead, specify the single metric anomaly detector attributes
- * as part of the SingleMetricAnomalyDetector property.
Instead, specify the single metric anomaly detector attributes as part of the
+ * SingleMetricAnomalyDetector property.
The metric math anomaly detector to be deleted.
- *When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:
When using MetricMathAnomalyDetector, you cannot include following
+ * parameters in the same operation:
@@ -1118,12 +1101,13 @@ export interface DeleteAnomalyDetectorInput { *
*the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput
+ *
the SingleMetricAnomalyDetector parameters of
+ * DeleteAnomalyDetectorInput
*
Instead, specify the metric math anomaly detector attributes as part of the
- * MetricMathAnomalyDetector property.
MetricMathAnomalyDetector property.
* @public
*/
MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
@@ -1135,7 +1119,8 @@ export interface DeleteAnomalyDetectorInput {
export interface DeleteAnomalyDetectorOutput {}
/**
- * Request processing has failed due to some unknown error, exception, or failure.
+ *Request processing has failed due to some unknown error, exception, or + * failure.
* @public */ export class InternalServiceFault extends __BaseException { @@ -1267,7 +1252,8 @@ export interface DeleteDashboardsOutput {} */ export interface DeleteInsightRulesInput { /** - *An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
+ *An array of the rule names to delete. If you need to find out the names of your rules, + * use DescribeInsightRules.
* @public */ RuleNames: string[] | undefined; @@ -1278,7 +1264,8 @@ export interface DeleteInsightRulesInput { */ export interface DeleteInsightRulesOutput { /** - *An array listing the rules that could not be deleted. You cannot delete built-in rules.
+ *An array listing the rules that could not be deleted. You cannot delete built-in + * rules.
* @public */ Failures?: PartialFailure[] | undefined; @@ -1325,8 +1312,8 @@ export interface DescribeAlarmHistoryInput { AlarmName?: string | undefined; /** - *Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, - * only metric alarms are returned.
+ *Use this parameter to specify whether you want the operation to return metric alarms + * or composite alarms. If you omit this parameter, only metric alarms are returned.
* @public */ AlarmTypes?: AlarmType[] | undefined; @@ -1357,14 +1344,16 @@ export interface DescribeAlarmHistoryInput { /** *The token returned by a previous call to indicate that there is more data - * available.
+ * available. * @public */ NextToken?: string | undefined; /** - *Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest
- * event history returned first, and specify TimestampAscending to have the oldest history returned first.
Specified whether to return the newest or oldest alarm history first. Specify
+ * TimestampDescending to have the newest event history returned first,
+ * and specify TimestampAscending to have the oldest history returned
+ * first.
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names - * that start with this prefix.
- *If this parameter
- * is specified, you cannot specify AlarmNames.
An alarm name prefix. If you specify this parameter, you receive information about + * all alarms that have names that start with this prefix.
+ *If this parameter is specified, you cannot specify
+ * AlarmNames.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you - * omit this parameter, - * only metric alarms are returned, even if composite alarms exist in the account.
- *For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric
- * alarms. It does not return any composite alarms, even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of composite
- * alarms, and does not return any metric alarms.
Use this parameter to specify whether you want the operation to return metric alarms + * or composite alarms. If you omit this parameter, only metric alarms are returned, even + * if composite alarms exist in the account.
+ *For example, if you omit this parameter or specify MetricAlarms, the
+ * operation returns only a list of metric alarms. It does not return any composite alarms,
+ * even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of
+ * composite alarms, and does not return any metric alarms.
If you use this parameter and specify the name of a composite alarm, the operation returns
- * information about the "children" alarms
- * of the alarm you specify. These are the metric alarms and composite alarms referenced in the
- * AlarmRule field of the composite alarm that you specify in
- * ChildrenOfAlarmName. Information about the composite alarm that you name in
- * ChildrenOfAlarmName is not returned.
If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except
- * for MaxRecords and NextToken. If you do so, you
- * receive a validation
- * error.
If you use this parameter and specify the name of a composite alarm, the operation
+ * returns information about the "children" alarms of the alarm you specify. These are the
+ * metric alarms and composite alarms referenced in the AlarmRule field of the
+ * composite alarm that you specify in ChildrenOfAlarmName. Information about
+ * the composite alarm that you name in ChildrenOfAlarmName is not
+ * returned.
If you specify ChildrenOfAlarmName, you cannot specify any other
+ * parameters in the request except for MaxRecords and NextToken.
+ * If you do so, you receive a validation error.
Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
- * information are returned by this operation
- * when you use this parameter. To get complete information about
- * these alarms, perform another DescribeAlarms operation and specify
- * the parent alarm names in the AlarmNames parameter.
Only the Alarm Name, ARN, StateValue
+ * (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are
+ * returned by this operation when you use this parameter. To get complete information
+ * about these alarms, perform another DescribeAlarms operation and
+ * specify the parent alarm names in the AlarmNames parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns
- * information about the "parent" alarms
- * of the alarm you specify. These are the composite alarms that have AlarmRule
- * parameters that reference
- * the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in
- * ParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except
- * for MaxRecords and NextToken. If you do so, you receive a validation
- * error.
If you use this parameter and specify the name of a metric or composite alarm, the
+ * operation returns information about the "parent" alarms of the alarm you specify. These
+ * are the composite alarms that have AlarmRule parameters that reference the
+ * alarm named in ParentsOfAlarmName. Information about the alarm that you
+ * specify in ParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other
+ * parameters in the request except for MaxRecords and NextToken.
+ * If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about
- * these alarms, perform another DescribeAlarms operation and specify
- * the parent alarm names in the AlarmNames parameter.
Only the Alarm Name and ARN are returned by this operation when you use this
+ * parameter. To get complete information about these alarms, perform another
+ * DescribeAlarms operation and specify the parent alarm names in the
+ * AlarmNames parameter.
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
+ *Specify this parameter to receive information only about alarms that are currently + * in the state that you specify.
* @public */ StateValue?: StateValue | undefined; /** *Use this parameter to filter the results of the operation to only those alarms that - * use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all - * alarms that send notifications to that topic.
+ * use a certain alarm action. For example, you could specify the ARN of an SNS topic to + * find all alarms that send notifications to that topic. * @public */ ActionPrefix?: string | undefined; @@ -1501,7 +1491,7 @@ export interface DescribeAlarmsInput { /** *The token returned by a previous call to indicate that there is more data - * available.
+ * available. * @public */ NextToken?: string | undefined; @@ -1567,28 +1557,32 @@ export interface MetricAlarm { AlarmConfigurationUpdatedTimestamp?: Date | undefined; /** - *Indicates whether actions should be executed during any changes to the alarm state.
+ *Indicates whether actions should be executed during any changes to the alarm + * state.
* @public */ ActionsEnabled?: boolean | undefined; /** *The actions to execute when this alarm transitions to the OK state
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the ALARM state
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN).
The time stamp of the last update to the value of either the
- * StateValue or EvaluationState parameters.
StateValue or EvaluationState parameters.
* @public
*/
StateUpdatedTimestamp?: Date | undefined;
/**
- * The name of the metric associated with the alarm, if this is an alarm - * based on a single metric.
+ *The name of the metric associated with the alarm, if this is an alarm based on a + * single metric.
* @public */ MetricName?: string | undefined; @@ -1632,15 +1626,15 @@ export interface MetricAlarm { Namespace?: string | undefined; /** - *The statistic for the metric associated with the alarm, other than percentile.
- * For percentile statistics, use ExtendedStatistic.
The statistic for the metric associated with the alarm, other than percentile. For
+ * percentile statistics, use ExtendedStatistic.
The percentile statistic for the metric associated with the alarm. Specify a value between - * p0.0 and p100.
+ *The percentile statistic for the metric associated with the alarm. Specify a value + * between p0.0 and p100.
* @public */ ExtendedStatistic?: string | undefined; @@ -1664,7 +1658,8 @@ export interface MetricAlarm { Unit?: StandardUnit | undefined; /** - *The number of periods over which data is compared to the specified threshold.
+ *The number of periods over which data is compared to the specified + * threshold.
* @public */ EvaluationPeriods?: number | undefined; @@ -1682,64 +1677,60 @@ export interface MetricAlarm { Threshold?: number | undefined; /** - *The arithmetic operation to use when comparing the specified - * statistic and threshold. The specified statistic value is used as the first operand.
+ *The arithmetic operation to use when comparing the specified statistic and + * threshold. The specified statistic value is used as the first operand.
* @public */ ComparisonOperator?: ComparisonOperator | undefined; /** - *Sets how this alarm is to handle missing data points. The valid values
- * are breaching, notBreaching, ignore, and
- * missing. For more information, see
- * Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default
- * behavior of missing is used.
Sets how this alarm is to handle missing data points. The valid values are
+ * breaching, notBreaching, ignore, and
+ * missing. For more information, see Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default behavior of missing is
+ * used.
Used only for alarms based on percentiles. If ignore, the alarm state does not change
- * during periods with too few data points to be statistically significant. If evaluate or this
- * parameter is not used, the alarm is always evaluated and possibly changes state no matter
- * how many data points are available.
Used only for alarms based on percentiles. If ignore, the alarm state
+ * does not change during periods with too few data points to be statistically significant.
+ * If evaluate or this parameter is not used, the alarm is always evaluated
+ * and possibly changes state no matter how many data points are available.
An array of MetricDataQuery structures, used in an alarm based on a
- * metric math expression. Each structure either retrieves a
- * metric or performs a math expression.
- *
- * One item in the Metrics array is the math expression that the alarm watches.
- * This expression by designated by having ReturnData set to
- * true.
An array of MetricDataQuery structures, used in an alarm based on a metric math
+ * expression. Each structure either retrieves a metric or performs a math expression. One
+ * item in the Metrics array is the math expression that the alarm watches. This expression
+ * by designated by having ReturnData set to true.
In an alarm based on an anomaly detection model, this is the ID of the
- * ANOMALY_DETECTION_BAND function
- * used as the threshold for the alarm.
ANOMALY_DETECTION_BAND function used as the threshold for the
+ * alarm.
* @public
*/
ThresholdMetricId?: string | undefined;
/**
- * If the value of this field is
- * PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the
- * query used for the alarm returns more than 10,000 metrics. For
- * more information, see
- * Create alarms on Metrics Insights queries.
If the value of this field is PARTIAL_DATA, the alarm is being evaluated
+ * based on only partial data. This happens if the query used for the alarm returns more
+ * than 10,000 metrics. For more information, see Create
+ * alarms on Metrics Insights queries.
The date and time that the alarm's StateValue most recently changed.
The date and time that the alarm's StateValue most recently
+ * changed.
The statistic for the metric, other than percentiles.
- * For percentile statistics, use ExtendedStatistics.
The statistic for the metric, other than percentiles. For percentile statistics,
+ * use ExtendedStatistics.
The percentile statistic for the metric. Specify a value between - * p0.0 and p100.
+ *The percentile statistic for the metric. Specify a value between p0.0 and + * p100.
* @public */ ExtendedStatistic?: string | undefined; /** *The dimensions associated with the metric. If the metric has any associated - * dimensions, you must specify them in order for the call to succeed.
+ * dimensions, you must specify them in order for the call to succeed. * @public */ Dimensions?: Dimension[] | undefined; @@ -1834,46 +1825,48 @@ export interface DescribeAlarmsForMetricOutput { */ export interface DescribeAnomalyDetectorsInput { /** - *Use the token returned by the previous operation to request the next page of results.
+ *Use the token returned by the previous operation to request the next page of + * results.
* @public */ NextToken?: string | undefined; /** - *The maximum number of results to return in one operation. The maximum - * value that you can specify is 100.
+ *The maximum number of results to return in one operation. The maximum value that you + * can specify is 100.
*To retrieve the remaining results, make another call with the returned
- * NextToken value.
NextToken value.
* @public
*/
MaxResults?: number | undefined;
/**
- * Limits the results to only the anomaly detection models that - * are associated with the specified namespace.
+ *Limits the results to only the anomaly detection models that are associated with the + * specified namespace.
* @public */ Namespace?: string | undefined; /** *Limits the results to only the anomaly detection models that are associated with the - * specified metric name. If there are multiple metrics with this name in different - * namespaces that have anomaly detection models, they're all returned.
+ * specified metric name. If there are multiple metrics with this name in different + * namespaces that have anomaly detection models, they're all returned. * @public */ MetricName?: string | undefined; /** *Limits the results to only the anomaly detection models that are associated with the - * specified metric dimensions. If there are multiple metrics that have these dimensions - * and have anomaly detection models associated, they're all returned.
+ * specified metric dimensions. If there are multiple metrics that have these dimensions + * and have anomaly detection models associated, they're all returned. * @public */ Dimensions?: Dimension[] | undefined; /** - *The anomaly detector types to request when using DescribeAnomalyDetectorsInput.
- * If empty, defaults to SINGLE_METRIC.
The anomaly detector types to request when using
+ * DescribeAnomalyDetectorsInput. If empty, defaults to
+ * SINGLE_METRIC.
A token that you can use in a subsequent operation to - * retrieve the next set of results.
+ *A token that you can use in a subsequent operation to retrieve the next set of + * results.
* @public */ NextToken?: string | undefined; @@ -1902,26 +1895,24 @@ export interface DescribeAnomalyDetectorsOutput { */ export interface DescribeInsightRulesInput { /** - *Include this value, if it was returned by the previous operation, to get the next set of rules.
+ *Include this value, if it was returned by the previous operation, to get the next set + * of rules.
* @public */ NextToken?: string | undefined; /** - *The maximum number of results to return in one operation. If you omit this - * parameter, the default of 500 is used.
+ *The maximum number of results to return in one operation. If you omit this parameter, + * the default of 500 is used.
* @public */ MaxResults?: number | undefined; } /** - *This structure contains the definition - * for a Contributor Insights rule. - * For more information about this rule, - * see - * Using Constributor Insights to analyze high-cardinality data - * in the Amazon CloudWatch User Guide.
+ *This structure contains the definition for a Contributor Insights rule. For more + * information about this rule, see Using Constributor Insights to analyze high-cardinality data in the + * Amazon CloudWatch User Guide.
* @public */ export interface InsightRule { @@ -1938,26 +1929,24 @@ export interface InsightRule { State: string | undefined; /** - *For rules that you create, this is always \{"Name": "CloudWatchLogRule", "Version": 1\}. For managed rules,
- * this is \{"Name": "ServiceLogRule", "Version": 1\}
+ *
For rules that you create, this is always \{"Name": "CloudWatchLogRule",
+ * "Version": 1\}. For managed rules, this is \{"Name": "ServiceLogRule",
+ * "Version": 1\}
*
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, - * the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see - * Contributor Insights - * Rule Syntax.
+ *The definition of the rule, as a JSON object. The definition contains the keywords + * used to define contributors, the value to aggregate on if this rule returns a sum + * instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
* @public */ Definition: string | undefined; /** - *- * An optional built-in rule that Amazon Web Services manages. - *
+ *An optional built-in rule that Amazon Web Services manages.
* @public */ ManagedRule?: boolean | undefined; @@ -1968,7 +1957,8 @@ export interface InsightRule { */ export interface DescribeInsightRulesOutput { /** - *If this parameter is present, it is a token that marks the start of the next batch of returned results.
+ *If this parameter is present, it is a token that marks the start of the next batch of + * returned results.
* @public */ NextToken?: string | undefined; @@ -2014,7 +2004,8 @@ export interface DisableAlarmActionsInput { */ export interface DisableInsightRulesInput { /** - *An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
+ *An array of the rule names to disable. If you need to find out the names of your + * rules, use DescribeInsightRules.
* @public */ RuleNames: string[] | undefined; @@ -2025,7 +2016,8 @@ export interface DisableInsightRulesInput { */ export interface DisableInsightRulesOutput { /** - *An array listing the rules that could not be disabled. You cannot disable built-in rules.
+ *An array listing the rules that could not be disabled. You cannot disable built-in + * rules.
* @public */ Failures?: PartialFailure[] | undefined; @@ -2047,7 +2039,8 @@ export interface EnableAlarmActionsInput { */ export interface EnableInsightRulesInput { /** - *An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
+ *An array of the rule names to enable. If you need to find out the names of your rules, + * use DescribeInsightRules.
* @public */ RuleNames: string[] | undefined; @@ -2058,7 +2051,8 @@ export interface EnableInsightRulesInput { */ export interface EnableInsightRulesOutput { /** - *An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
+ *An array listing the rules that could not be enabled. You cannot disable or enable + * built-in rules.
* @public */ Failures?: PartialFailure[] | undefined; @@ -2086,6 +2080,179 @@ export class LimitExceededException extends __BaseException { } } +/** + *An entity associated with metrics, to allow for finding related telemetry. An entity + * is typically a resource or service within your system. For example, metrics from an + * Amazon EC2 instance could be associated with that instance as the entity. + * Similarly, metrics from a service that you own could be associated with that service as + * the entity.
+ * @public + */ +export interface Entity { + /** + *The attributes of the entity which identify the specific entity, as a list of
+ * key-value pairs. Entities with the same KeyAttributes are considered to be
+ * the same entity. For an entity to be valid, the KeyAttributes must exist
+ * and be formatted correctly.
There are five allowed attributes (key names): Type,
+ * ResourceType, Identifier, Name, and
+ * Environment.
For details about how to use the key attributes to specify an entity, see How to add related + * information to telemetry in the CloudWatch User + * Guide.
+ * @public + */ + KeyAttributes?: RecordAdditional attributes of the entity that are not used to specify the identity of the + * entity. A list of key-value pairs.
+ *For details about how to use the attributes, see How to add related information to + * telemetry in the CloudWatch User Guide.
+ * @public + */ + Attributes?: RecordRepresents a set of statistics that describes a specific metric.
+ * @public + */ +export interface StatisticSet { + /** + *The number of samples used for the statistic set.
+ * @public + */ + SampleCount: number | undefined; + + /** + *The sum of values for the sample set.
+ * @public + */ + Sum: number | undefined; + + /** + *The minimum value of the sample set.
+ * @public + */ + Minimum: number | undefined; + + /** + *The maximum value of the sample set.
+ * @public + */ + Maximum: number | undefined; +} + +/** + *Encapsulates the information sent to either create a metric or add new values to be + * aggregated into an existing metric.
+ * @public + */ +export interface MetricDatum { + /** + *The name of the metric.
+ * @public + */ + MetricName: string | undefined; + + /** + *The dimensions associated with the metric.
+ * @public + */ + Dimensions?: Dimension[] | undefined; + + /** + *The time the metric data was received, expressed as the number of milliseconds + * since Jan 1, 1970 00:00:00 UTC.
+ * @public + */ + Timestamp?: Date | undefined; + + /** + *The value for the metric.
+ *Although the parameter accepts numbers of type Double, CloudWatch rejects values + * that are either too small or too large. Values must be in the range of -2^360 to 2^360. + * In addition, special values (for example, NaN, +Infinity, -Infinity) are not + * supported.
+ * @public + */ + Value?: number | undefined; + + /** + *The statistical values for the metric.
+ * @public + */ + StatisticValues?: StatisticSet | undefined; + + /** + *Array of numbers representing the values for the metric during the period. Each unique
+ * value is listed just once in this array, and the corresponding number in the
+ * Counts array specifies the number of times that value occurred during
+ * the period. You can include up to 150 unique values in each PutMetricData
+ * action that specifies a Values array.
Although the Values array accepts numbers of type Double,
+ * CloudWatch rejects values that are either too small or too large. Values must be in the
+ * range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
+ * -Infinity) are not supported.
Array of numbers that is used along with the Values array. Each number in
+ * the Count array is the number of times the corresponding value in the
+ * Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for
+ * each count. If you include a Counts array, it must include the same amount
+ * of values as the Values array.
When you are using a Put operation, this defines what unit you want to
+ * use when storing the metric.
In a Get operation, this displays the unit that is used for the
+ * metric.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a + * high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution + * down to one second. Setting this to 60 specifies this metric as a regular-resolution + * metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is + * available only for custom metrics. For more information about high-resolution metrics, + * see High-Resolution Metrics in the Amazon CloudWatch User + * Guide.
+ *This field is optional, if you do not specify it the default of 60 is + * used.
+ * @public + */ + StorageResolution?: number | undefined; +} + +/** + *A set of metrics that are associated with an entity, such as a specific service + * or resource. Contains the entity and the list of metric data associated with it.
+ * @public + */ +export interface EntityMetricData { + /** + *The entity associated with the metrics.
+ * @public + */ + Entity?: Entity | undefined; + + /** + *The metric data.
+ * @public + */ + MetricData?: MetricDatum[] | undefined; +} + /** * @public */ @@ -2108,9 +2275,9 @@ export interface GetDashboardOutput { DashboardArn?: string | undefined; /** - *The detailed information about the dashboard, including what widgets are included and their location
- * on the dashboard. For more information about the DashboardBody syntax,
- * see Dashboard Body Structure and Syntax.
The detailed information about the dashboard, including what widgets are included
+ * and their location on the dashboard. For more information about the
+ * DashboardBody syntax, see Dashboard Body Structure and Syntax.
The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
- * yyyy-MM-dd'T'HH:mm:ss. For example,
- * 2019-07-01T23:59:59.
The start time of the data to use in the report. When used in a raw HTTP Query API, it
+ * is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
- * yyyy-MM-dd'T'HH:mm:ss. For example,
- * 2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it
+ * is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,
+ * 2019-07-01T23:59:59.
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
The period, in seconds, to use for the statistics in the
+ * InsightRuleMetricDatapoint results.
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
+ *The maximum number of contributors to include in the report. The range is 1 to 100. If + * you omit this, the default of 10 is used.
* @public */ MaxContributorCount?: number | undefined; /** - *Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more - * of the following metrics:
+ *Specifies which metrics to use for aggregation of contributor values for the report. + * You can specify one or more of the following metrics:
*
- * UniqueContributors -- the number of unique contributors for each data point.
UniqueContributors -- the number of unique contributors for each
+ * data point.
*
- * MaxContributorValue -- the value of the top contributor for each data point. The identity of the
- * contributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
- * most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified
- * by the rule's Value, during that period.
MaxContributorValue -- the value of the top contributor for each
+ * data point. The identity of the contributor might change for each data point in
+ * the graph.
+ * If this rule aggregates by COUNT, the top contributor for each data point is
+ * the contributor with the most occurrences in that period. If the rule aggregates
+ * by SUM, the top contributor is the contributor with the highest sum in the log
+ * field specified by the rule's Value, during that period.
- * SampleCount -- the number of data points matched by the rule.
SampleCount -- the number of data points matched by the
+ * rule.
*
- * Sum -- the sum of the values from all contributors during the time period represented by that data point.
Sum -- the sum of the values from all contributors during the
+ * time period represented by that data point.
*
- * Minimum -- the minimum value from a single observation during the time period represented by that data point.
Minimum -- the minimum value from a single observation during the
+ * time period represented by that data point.
*
- * Maximum -- the maximum value from a single observation during the time period represented by that data point.
Maximum -- the maximum value from a single observation during the
+ * time period represented by that data point.
*
- * Average -- the average value from all contributors during the time period represented by that data point.
Average -- the average value from all contributors during the
+ * time period represented by that data point.
* Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
Determines what statistic to use to rank the contributors. Valid values are
+ * Sum and Maximum.
One data point related to one contributor.
- *For more information, see GetInsightRuleReport and - * InsightRuleContributor.
+ *For more information, see GetInsightRuleReport and InsightRuleContributor.
* @public */ export interface InsightRuleContributorDatapoint { @@ -2229,15 +2406,18 @@ export interface InsightRuleContributorDatapoint { } /** - *One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then - * a unique contributor is a unique combination of values from all the keys in the rule.
- *If the rule contains a single key, then each unique contributor is each unique value for this key.
+ *One of the unique contributors found by a Contributor Insights rule. If the rule + * contains multiple keys, then a unique contributor is a unique combination of values from + * all the keys in the rule.
+ *If the rule contains a single key, then each unique contributor is each unique value + * for this key.
*For more information, see GetInsightRuleReport.
* @public */ export interface InsightRuleContributor { /** - *One of the log entry field keywords that is used to define contributors for this rule.
+ *One of the log entry field keywords that is used to define contributors for this + * rule.
* @public */ Keys: string[] | undefined; @@ -2249,14 +2429,16 @@ export interface InsightRuleContributor { ApproximateAggregateValue: number | undefined; /** - *An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
+ *An array of the data points where this contributor is present. Only the data points + * when this contributor appeared are included in the array.
* @public */ Datapoints: InsightRuleContributorDatapoint[] | undefined; } /** - *One data point from the metric time series returned in a Contributor Insights rule report.
+ *One data point from the metric time series returned in a Contributor Insights rule + * report.
*For more information, see GetInsightRuleReport.
* @public */ @@ -2269,51 +2451,62 @@ export interface InsightRuleMetricDatapoint { /** *The number of unique contributors who published data during this timestamp.
- *This statistic is returned only if you included it in the Metrics array in your request.
This statistic is returned only if you included it in the Metrics array
+ * in your request.
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, - * so the identity of the max contributor - * could be different for each timestamp.
- *This statistic is returned only if you included it in the Metrics array in your request.
The maximum value provided by one contributor during this timestamp. Each timestamp is + * evaluated separately, so the identity of the max contributor could be different for each + * timestamp.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The number of occurrences that matched the rule during this data point.
- *This statistic is returned only if you included it in the Metrics array in your request.
This statistic is returned only if you included it in the Metrics array
+ * in your request.
The average value from all contributors during the time period represented by that data point.
- *This statistic is returned only if you included it in the Metrics array in your request.
The average value from all contributors during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The sum of the values from all contributors during the time period represented by that data point.
- *This statistic is returned only if you included it in the Metrics array in your request.
The sum of the values from all contributors during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The minimum value from a single contributor during the time period represented by that data point.
- *This statistic is returned only if you included it in the Metrics array in your request.
The minimum value from a single contributor during the time period represented by that + * data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
The maximum value from a single occurence from a single contributor during the time period represented by that data point.
- *This statistic is returned only if you included it in the Metrics array in your request.
The maximum value from a single occurence from a single contributor during the time + * period represented by that data point.
+ *This statistic is returned only if you included it in the Metrics array
+ * in your request.
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. - * If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
+ *An array of the strings used as the keys for this rule. The keys are the dimensions + * used to classify contributors. If the rule contains more than one key, then each unique + * combination of values for the keys is counted as a unique contributor.
* @public */ KeyLabels?: string[] | undefined; @@ -2343,42 +2537,45 @@ export interface GetInsightRuleReportOutput { AggregateValue?: number | undefined; /** - *An approximate count of the unique contributors found by this rule in this time period.
+ *An approximate count of the unique contributors found by this rule in this time + * period.
* @public */ ApproximateUniqueCount?: number | undefined; /** - *An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values - * for the keys counts as a unique contributor.
+ *An array of the unique contributors found by this rule in this time period. If the + * rule contains multiple keys, each combination of values for the keys counts as a unique + * contributor.
* @public */ Contributors?: InsightRuleContributor[] | undefined; /** - *A time series of metric data points that matches the time period in the rule request.
+ *A time series of metric data points that matches the time period in the rule + * request.
* @public */ MetricDatapoints?: InsightRuleMetricDatapoint[] | undefined; } /** - *This structure includes the Timezone parameter, which you can use
- * to specify your time zone so that the labels that are associated with returned metrics display the
- * correct time
- * for your time zone.
The Timezone value affects a label only if you have a time-based
- * dynamic expression in the label. For more information about dynamic expressions in labels,
- * see Using Dynamic Labels.
This structure includes the Timezone parameter, which you can use to
+ * specify your time zone so that the labels that are associated with returned metrics
+ * display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based dynamic
+ * expression in the label. For more information about dynamic expressions in labels, see
+ * Using Dynamic
+ * Labels.
The time zone to use for metric data return in this operation.
- * The format is + or - followed by four digits.
- * The first two digits indicate the number of hours ahead or behind of UTC, and
- * the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour
- * and 30 minutes ahead of UTC. The default is +0000.
The time zone to use for metric data return in this operation. The format is
+ * + or - followed by four digits. The first two digits
+ * indicate the number of hours ahead or behind of UTC, and the final two digits are the
+ * number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
+ * minutes ahead of UTC. The default is +0000.
The metric queries to be returned. A single GetMetricData call can
- * include as many as 500 MetricDataQuery
- * structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,
- * or a math expression to perform on retrieved data.
MetricDataQuery structures. Each of these structures
+ * can specify either a metric to retrieve, a Metrics Insights query, or a math expression
+ * to perform on retrieved data.
* @public
*/
MetricDataQueries: MetricDataQuery[] | undefined;
/**
* The time stamp indicating the earliest data to be returned.
- *The value specified is inclusive; results include data points with the specified time stamp.
+ *The value specified is inclusive; results include data points with the specified + * time stamp.
*CloudWatch rounds the specified time stamp as follows:
*Start time less than 15 days ago - Round down to the nearest whole minute. - * For example, 12:32:34 is rounded down to 12:32:00.
+ * For example, 12:32:34 is rounded down to 12:32:00. *Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. - * For example, 12:32:34 is rounded down to 12:30:00.
+ *Start time between 15 and 63 days ago - Round down to the nearest 5-minute + * clock interval. For example, 12:32:34 is rounded down to 12:30:00.
*Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. - * For example, 12:32:34 is rounded down to 12:00:00.
+ *Start time greater than 63 days ago - Round down to the nearest 1-hour + * clock interval. For example, 12:32:34 is rounded down to 12:00:00.
*If you set Period to 5, 10, or 30, the start time of your request is
- * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
- * of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous
- * 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to
- * 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a
- * period of 5 seconds, you receive data
- * timestamped between 15:02:15 and 15:07:15.
- *
For better performance, specify StartTime and EndTime
- * values that align with the value of the metric's Period and sync up with
- * the beginning and end of an hour. For example, if the Period of a metric
- * is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response
- * from CloudWatch than setting 12:07 or 12:29 as the StartTime.
For better performance, specify StartTime and EndTime values
+ * that align with the value of the metric's Period and sync up with the
+ * beginning and end of an hour. For example, if the Period of a metric is 5
+ * minutes, specifying 12:05 or 12:30 as StartTime can get a faster response
+ * from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the latest data to be returned.
- *The value specified is exclusive; results include data points up to the specified time stamp.
- *For better performance, specify StartTime and EndTime
- * values that align with the value of the metric's Period and sync up with
- * the beginning and end of an hour. For example, if the Period of a metric
- * is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response
- * from CloudWatch than setting 12:07 or 12:29 as the EndTime.
The value specified is exclusive; results include data points up to the specified + * time stamp.
+ *For better performance, specify StartTime and EndTime values
+ * that align with the value of the metric's Period and sync up with the
+ * beginning and end of an hour. For example, if the Period of a metric is 5
+ * minutes, specifying 12:05 or 12:30 as EndTime can get a faster response
+ * from CloudWatch than setting 12:07 or 12:29 as the EndTime.
Include this value, if it was returned by the previous GetMetricData operation,
- * to get the next set of data points.
Include this value, if it was returned by the previous GetMetricData
+ * operation, to get the next set of data points.
The order in which data points should be returned. TimestampDescending returns the newest data first and paginates
- * when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates
- * when the MaxDatapoints limit is reached.
If you omit this parameter, the default of TimestampDescending is used.
The order in which data points should be returned. TimestampDescending
+ * returns the newest data first and paginates when the MaxDatapoints limit is
+ * reached. TimestampAscending returns the oldest data first and paginates
+ * when the MaxDatapoints limit is reached.
If you omit this parameter, the default of TimestampDescending is
+ * used.
The maximum number of data points the request should return before paginating. If you omit - * this, the default of 100,800 is used.
+ *The maximum number of data points the request should return before paginating. If you + * omit this, the default of 100,800 is used.
* @public */ MaxDatapoints?: number | undefined; /** - *This structure includes the Timezone parameter, which you can use
- * to specify your time zone so that the labels of returned data display the
- * correct time
- * for your time zone.
This structure includes the Timezone parameter, which you can use to
+ * specify your time zone so that the labels of returned data display the correct time for
+ * your time zone.
A message returned by the GetMetricDataAPI, including a code and a description.
If a cross-Region GetMetricData operation fails with a code of Forbidden and a
- * value of Authentication too complex to
- * retrieve cross region data, you can correct the problem by running the GetMetricData
- * operation in the same Region where the metric data is.
A message returned by the GetMetricDataAPI, including a code and a
+ * description.
If a cross-Region GetMetricData operation fails with a code of
+ * Forbidden and a value of Authentication too complex to retrieve
+ * cross region data, you can correct the problem by running the
+ * GetMetricData operation in the same Region where the metric data
+ * is.
A GetMetricData call returns an array of MetricDataResult
- * structures. Each of these structures includes the data points for that metric, along
- * with the timestamps of those data points and other identifying information.
The timestamps for the data points, formatted in Unix timestamp format. The number of - * timestamps always matches the number of values and the value for Timestamps[x] is - * Values[x].
+ * timestamps always matches the number of values and the value for Timestamps[x] is + * Values[x]. * @public */ Timestamps?: Date[] | undefined; /** *The data points for the metric corresponding to Timestamps. The number of
- * values always matches the number of timestamps and the timestamp for Values[x] is
- * Timestamps[x].
The status of the returned data. Complete indicates that all data points in the requested time range were returned.
- * PartialData means that an incomplete set of data points were returned.
- * You can use the NextToken value that was returned and repeat your request to get more data points.
- * NextToken is not returned if you are performing a math expression. InternalError
- * indicates that an error occurred. Retry your request using NextToken, if present.
The status of the returned data. Complete indicates that all data points
+ * in the requested time range were returned. PartialData means that an
+ * incomplete set of data points were returned. You can use the NextToken
+ * value that was returned and repeat your request to get more data points.
+ * NextToken is not returned if you are performing a math expression.
+ * InternalError indicates that an error occurred. Retry your request
+ * using NextToken, if present.
The metrics that are returned, including the metric name, namespace, and dimensions.
+ *The metrics that are returned, including the metric name, namespace, and + * dimensions.
* @public */ MetricDataResults?: MetricDataResult[] | undefined; @@ -2584,12 +2788,13 @@ export interface GetMetricDataOutput { NextToken?: string | undefined; /** - *Contains a message about this GetMetricData operation, if the operation results in such a message.
- * An example of a message that
- * might be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the
- * operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData operation. Any message
- * about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.
Contains a message about this GetMetricData operation, if the operation
+ * results in such a message. An example of a message that might be returned is
+ * Maximum number of allowed metrics exceeded. If there is a message, as
+ * much of the operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData
+ * operation. Any message about a specific metric returned by the operation appears in the
+ * MetricDataResult object returned for that metric.
The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. - * CloudWatch treats each unique combination of dimensions as a separate metric. - * If a specific combination of dimensions was not published, you can't retrieve statistics for it. - * You must specify the same dimensions that were used when the metrics were created. For an example, - * see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the - * Amazon CloudWatch User Guide.
+ *The dimensions. If the metric contains multiple dimensions, you must include a + * value for each dimension. CloudWatch treats each unique combination of dimensions as a + * separate metric. If a specific combination of dimensions was not published, you can't + * retrieve statistics for it. You must specify the same dimensions that were used when the + * metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User + * Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User + * Guide.
* @public */ Dimensions?: Dimension[] | undefined; /** *The time stamp that determines the first data point to return. Start times are - * evaluated relative to the time that CloudWatch receives the request.
- *The value specified is inclusive; results include data points with the specified time stamp. - * In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
+ * evaluated relative to the time that CloudWatch receives the request. + *The value specified is inclusive; results include data points with the specified + * time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for + * example, 2016-10-03T23:00:00Z).
*CloudWatch rounds the specified time stamp as follows:
*Start time less than 15 days ago - Round down to the nearest whole minute. - * For example, 12:32:34 is rounded down to 12:32:00.
+ * For example, 12:32:34 is rounded down to 12:32:00. *Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. - * For example, 12:32:34 is rounded down to 12:30:00.
+ *Start time between 15 and 63 days ago - Round down to the nearest 5-minute + * clock interval. For example, 12:32:34 is rounded down to 12:30:00.
*Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. - * For example, 12:32:34 is rounded down to 12:00:00.
+ *Start time greater than 63 days ago - Round down to the nearest 1-hour + * clock interval. For example, 12:32:34 is rounded down to 12:00:00.
*If you set Period to 5, 10, or 30, the start time of your request is
- * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
- * of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous
- * 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to
- * 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a
- * period of 5 seconds, you receive data
- * timestamped between 15:02:15 and 15:07:15.
- *
The time stamp that determines the last data point to return.
- *The value specified is exclusive; results include data points up to the specified time stamp. - * In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
+ *The value specified is exclusive; results include data points up to the specified + * time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for + * example, 2016-10-10T23:00:00Z).
* @public */ EndTime: Date | undefined; /** - *The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
- * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
- * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
- * are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular
+ * resolution, a period can be as short as one minute (60 seconds) and must be a multiple
+ * of 60. For high-resolution metrics that are collected at intervals of less than one
+ * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
+ * metrics are those metrics stored by a PutMetricData call that includes a
+ * StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than
- * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
+ *Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds + * (1 minute).
*Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
+ *Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 + * minutes).
*Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
+ *Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 + * hour).
*The metric statistics, other than percentile. For percentile statistics,
- * use ExtendedStatistics. When calling GetMetricStatistics, you must
- * specify either Statistics or ExtendedStatistics, but not both.
The metric statistics, other than percentile. For percentile statistics, use
+ * ExtendedStatistics. When calling GetMetricStatistics, you
+ * must specify either Statistics or ExtendedStatistics, but not
+ * both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must
- * specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not
- * available for metrics when any of the metric values are negative numbers.
The percentile statistics. Specify values between p0.0 and p100. When calling
+ * GetMetricStatistics, you must specify either Statistics or
+ * ExtendedStatistics, but not both. Percentile statistics are not
+ * available for metrics when any of the metric values are negative numbers.
The unit for a given metric.
- * If you omit Unit, 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.
The unit for a given metric. If you omit Unit, 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.
This structure contains a metric namespace and optionally, a list of metric names, - * to either include in a metric stream or exclude from - * a metric stream.
- *A metric stream's filters can include up to 1000 total names. This limit - * applies to the sum of namespace names and metric names in the filters. For example, - * this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters - * with 49 metrics specified in each filter.
+ *This structure contains a metric namespace and optionally, a list of metric names, to + * either include in a metric stream or exclude from a metric stream.
+ *A metric stream's filters can include up to 1000 total names. This limit applies to + * the sum of namespace names and metric names in the filters. For example, this could + * include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with + * 49 metrics specified in each filter.
* @public */ export interface MetricStreamFilter { /** *The name of the metric namespace for this filter.
- *The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must - * contain at least one non-whitespace character.
+ *The namespace can contain only ASCII printable characters (ASCII range 32 through + * 126). It must contain at least one non-whitespace character.
* @public */ Namespace?: string | undefined; @@ -2760,9 +2976,10 @@ export interface MetricStreamFilter { /** *The names of the metrics to either include or exclude from the metric stream.
*If you omit this parameter, all metrics in the namespace are included or excluded, - * depending on whether this filter is specified as an exclude filter or an include filter.
- *Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). - * Each metric name must contain at least one non-whitespace character.
+ * depending on whether this filter is specified as an exclude filter or an include + * filter. + *Each metric name can contain only ASCII printable characters (ASCII range 32 through + * 126). Each metric name must contain at least one non-whitespace character.
* @public */ MetricNames?: string[] | undefined; @@ -2785,7 +3002,7 @@ export type MetricStreamOutputFormat = (typeof MetricStreamOutputFormat)[keyof t /** *This object contains the information for one metric that is to be streamed with - * additional statistics.
+ * additional statistics. * @public */ export interface MetricStreamStatisticsMetric { @@ -2803,36 +3020,38 @@ export interface MetricStreamStatisticsMetric { } /** - *By default, a metric stream always sends the MAX, MIN, SUM,
- * and SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for
- * one metric that includes additional statistics in the stream. For more information about statistics,
- * see CloudWatch, listed in
- *
- * CloudWatch statistics definitions.
By default, a metric stream always sends the MAX, MIN,
+ * SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. This structure contains information for one metric that includes additional
+ * statistics in the stream. For more information about statistics, see CloudWatch,
+ * listed in
+ * CloudWatch statistics definitions.
An array of metric name and namespace pairs that stream the additional statistics listed
- * in the value of the AdditionalStatistics parameter. There can be as many as
- * 100 pairs in the array.
An array of metric name and namespace pairs that stream the additional statistics
+ * listed in the value of the AdditionalStatistics parameter. There can be as
+ * many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed - * with the additional statistics, no matter their dimensions.
+ * with the additional statistics, no matter their dimensions. * @public */ IncludeMetrics: MetricStreamStatisticsMetric[] | undefined; /** - *The list of additional statistics that are to be streamed for the metrics listed
- * in the IncludeMetrics array in this structure. This list can include as many as 20 statistics.
If the OutputFormat for the stream is opentelemetry1.0 or opentelemetry0.7, the only
- * valid values are p??
- * percentile statistics such as p90, p99 and so on.
If the OutputFormat for the stream is json,
- * the valid values include the abbreviations for all of the statistics listed in
- *
- * CloudWatch statistics definitions. For example, this includes
- * tm98,
+ *
The list of additional statistics that are to be streamed for the metrics listed in
+ * the IncludeMetrics array in this structure. This list can include as many
+ * as 20 statistics.
If the OutputFormat for the stream is opentelemetry1.0 or
+ * opentelemetry0.7, the only valid values are
+ * p??
+ * percentile statistics such as
+ * p90, p99 and so on.
If the OutputFormat for the stream is json, the valid values
+ * include the abbreviations for all of the statistics listed in
+ * CloudWatch statistics definitions. For example, this includes
+ * tm98,
* wm90, PR(:300), and so on.
If this array of metric namespaces is present, then these - * namespaces are the only - * metric namespaces that are streamed by this metric stream.
+ *If this array of metric namespaces is present, then these namespaces are the only + * metric namespaces that are streamed by this metric stream.
* @public */ IncludeFilters?: MetricStreamFilter[] | undefined; /** *If this array of metric namespaces is present, then these namespaces are the only - * metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in - * the account are streamed by this metric stream.
+ * metric namespaces that are not streamed by this metric stream. In this case, all other + * metric namespaces in the account are streamed by this metric stream. * @public */ ExcludeFilters?: MetricStreamFilter[] | undefined; /** - *The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric - * stream.
+ *The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this + * metric stream.
* @public */ FirehoseArn?: string | undefined; @@ -2885,8 +3103,8 @@ export interface GetMetricStreamOutput { RoleArn?: string | undefined; /** - *The state of the metric stream. The possible values are running
- * and stopped.
The state of the metric stream. The possible values are running and
+ * stopped.
The output format for the stream.
- * Valid values are json, opentelemetry1.0, and opentelemetry0.7.
- * For more information about metric stream output formats,
- * see Metric streams output formats.
The output format for the stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7. For more
+ * information about metric stream output formats, see Metric streams output formats.
Each entry in this array displays information about one or more metrics that include additional statistics - * in the metric stream. For more information about the additional statistics, see - * - * CloudWatch statistics definitions.
+ *Each entry in this array displays information about one or more metrics that include + * additional statistics in the metric stream. For more information about the additional + * statistics, see + * CloudWatch statistics definitions.
* @public */ StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined; /** - *If this is true and this metric stream is in a monitoring account, then the stream includes
- * metrics from source accounts that the monitoring account is linked to.
If this is true and this metric stream is in a monitoring account, then
+ * the stream includes metrics from source accounts that the monitoring account is linked
+ * to.
A JSON string that defines the bitmap graph to be retrieved. The string includes the
- * metrics to include in the graph, statistics, annotations, title, axis limits, and so on.
- * You can include only one MetricWidget parameter in each GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see
- * GetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation - * point appears next to the graph legend.
+ *A JSON string that defines the bitmap graph to be retrieved. The string includes
+ * the metrics to include in the graph, statistics, annotations, title, axis limits, and so
+ * on. You can include only one MetricWidget parameter in each
+ * GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange + * triangle with an exclamation point appears next to the graph legend.
* @public */ MetricWidget: string | undefined; /** *The format of the resulting image. Only PNG images are supported.
- *The default is png. If you specify png, the API returns an HTTP response with the
- * content-type set to text/xml. The image data is in a MetricWidgetImage
- * field. For example:
The default is png. If you specify png, the API returns
+ * an HTTP response with the content-type set to text/xml. The image data is
+ * in a MetricWidgetImage field. For example:
- *
- *
+ *
*
- *
+ *
*
- *
+ *
*
- * iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
+ * iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
*
- *
+ *
*
- *
+ *
*
- *
+ *
*
- *
+ *
+ *
*
- *
+ *
*
*
*
The image/png setting is intended only for custom HTTP requests. For most
- * use cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify
- * image/png, the HTTP response has a content-type set to image/png,
- * and the body of the response is a PNG image.
The image/png setting is intended only for custom HTTP requests. For
+ * most use cases, and all actions using an Amazon Web Services SDK, you should use
+ * png. If you specify image/png, the HTTP response has a
+ * content-type set to image/png, and the body of the response is a PNG
+ * image.
The image of the graph, in the output format specified. The output is base64-encoded.
+ *The image of the graph, in the output format specified. The output is + * base64-encoded.
* @public */ MetricWidgetImage?: Uint8Array | undefined; @@ -3006,17 +3226,16 @@ export interface GetMetricWidgetImageOutput { */ export interface ListDashboardsInput { /** - *If you specify this parameter, only - * the dashboards with names starting with the specified string are listed. The maximum length is 255, and - * valid characters are A-Z, a-z, 0-9, ".", "-", and "_". - * - *
+ *If you specify this parameter, only the dashboards with names starting with the + * specified string are listed. The maximum length is 255, and valid characters are A-Z, + * a-z, 0-9, ".", "-", and "_".
* @public */ DashboardNamePrefix?: string | undefined; /** - *The token returned by a previous call to indicate that there is more data available.
+ *The token returned by a previous call to indicate that there is more data + * available.
* @public */ NextToken?: string | undefined; @@ -3044,113 +3263,71 @@ export interface ListDashboardsOutput { */ export interface ListManagedInsightRulesInput { /** - *- * The ARN - * of an Amazon Web Services resource - * that has managed Contributor Insights rules. - *
+ *The ARN of an Amazon Web Services resource that has managed Contributor Insights + * rules.
* @public */ ResourceARN: string | undefined; /** - *- * Include this value - * to get - * the next set - * of rules - * if the value was returned - * by the previous operation. - *
+ *Include this value to get the next set of rules if the value was returned by the + * previous operation.
* @public */ NextToken?: string | undefined; /** - *
- * The maximum number
- * of results
- * to return
- * in one operation.
- * If you omit this parameter,
- * the default number is used.
- * The default number is 100.
- *
The maximum number of results to return in one operation. If you omit this parameter,
+ * the default number is used. The default number is 100.
- * The status - * of a managed Contributor Insights rule. - *
+ *The status of a managed Contributor Insights rule.
* @public */ export interface ManagedRuleState { /** - *- * The name - * of the Contributor Insights rule - * that contains data - * for the specified Amazon Web Services resource. - *
+ *The name of the Contributor Insights rule that contains data for the specified + * Amazon Web Services resource.
* @public */ RuleName: string | undefined; /** - *- * Indicates whether the rule is enabled or disabled. - *
+ *Indicates whether the rule is enabled or disabled.
* @public */ State: string | undefined; } /** - *
- * Contains information
- * about managed Contributor Insights rules,
- * as returned
- * by ListManagedInsightRules.
- *
- *
Contains information about managed Contributor Insights rules, as returned by
+ * ListManagedInsightRules.
+ *
- * The template name
- * for the managed rule.
- * Used
- * to enable managed rules using PutManagedInsightRules.
- *
The template name for the managed rule. Used to enable managed rules using
+ * PutManagedInsightRules.
- * If a managed rule is enabled, - * this is the ARN - * for the related Amazon Web Services resource. - *
+ *If a managed rule is enabled, this is the ARN for the related Amazon Web Services + * resource.
* @public */ ResourceARN?: string | undefined; /** - *- * Describes the state - * of a managed rule. - * If present, - * it contains information - * about the Contributor Insights rule - * that contains information - * about the related Amazon Web Services resource. - *
+ *Describes the state of a managed rule. If present, it contains information about the + * Contributor Insights rule that contains information about the related Amazon Web Services + * resource.
* @public */ RuleState?: ManagedRuleState | undefined; @@ -3161,24 +3338,15 @@ export interface ManagedRuleDescription { */ export interface ListManagedInsightRulesOutput { /** - *- * The managed rules - * that are available - * for the specified Amazon Web Services resource. - *
+ *The managed rules that are available for the specified Amazon Web Services resource. + *
* @public */ ManagedRules?: ManagedRuleDescription[] | undefined; /** - *- * Include this value - * to get - * the next set - * of rules - * if the value was returned - * by the previous operation. - *
+ *Include this value to get the next set of rules if the value was returned by the + * previous operation.
* @public */ NextToken?: string | undefined; @@ -3203,56 +3371,55 @@ export type RecentlyActive = (typeof RecentlyActive)[keyof typeof RecentlyActive export interface ListMetricsInput { /** *The metric namespace to filter against. Only the namespace that matches exactly - * will be returned.
+ * will be returned. * @public */ Namespace?: string | undefined; /** - *The name of the metric to filter against. Only the metrics with names that match exactly - * will be returned.
+ *The name of the metric to filter against. Only the metrics with names that match + * exactly will be returned.
* @public */ MetricName?: string | undefined; /** - *The dimensions to filter against. Only the dimensions that match exactly - * will be returned.
+ *The dimensions to filter against. Only the dimensions that match exactly will be + * returned.
* @public */ Dimensions?: DimensionFilter[] | undefined; /** *The token returned by a previous call to indicate that there is more data - * available.
+ * available. * @public */ NextToken?: string | undefined; /** - *To filter the results to show only metrics that have had data points published
- * in the past three hours, specify this parameter
- * with a value of PT3H. This is the only valid value
- * for this parameter.
The results that are returned are an approximation of the value you specify. There - * is a low probability that the returned results include metrics with last published - * data as much as 40 minutes more than the specified time interval.
+ *To filter the results to show only metrics that have had data points published in the
+ * past three hours, specify this parameter with a value of PT3H. This is the
+ * only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is + * a low probability that the returned results include metrics with last published data as + * much as 50 minutes more than the specified time interval.
* @public */ RecentlyActive?: RecentlyActive | undefined; /** - *If you are using this operation in a monitoring account,
- * specify true to include metrics from source accounts in the returned data.
If you are using this operation in a monitoring account, specify true to
+ * include metrics from source accounts in the returned data.
The default is false.
When you use this operation in a monitoring account, use this field to return metrics only from one source account.
- * To do so, specify that source account ID in this field, and also
- * specify true for IncludeLinkedAccounts.
When you use this operation in a monitoring account, use this field to return metrics
+ * only from one source account. To do so, specify that source account ID in this field,
+ * and also specify true for IncludeLinkedAccounts.
If you are using this operation in a monitoring account, this array contains the account IDs of the source - * accounts where the metrics in the returned data - * are from.
- *This field is a 1:1 mapping between each metric that is returned and the ID of the owning account.
+ *If you are using this operation in a monitoring account, this array contains the + * account IDs of the source accounts where the metrics in the returned data are + * from.
+ *This field is a 1:1 mapping between each metric that is returned and the ID of the + * owning account.
* @public */ OwningAccounts?: string[] | undefined; @@ -3289,7 +3457,8 @@ export interface ListMetricsOutput { */ export interface ListMetricStreamsInput { /** - *Include this value, if it was returned by the previous call, to get the next set of metric streams.
+ *Include this value, if it was returned by the previous call, to get the next set of + * metric streams.
* @public */ NextToken?: string | undefined; @@ -3319,7 +3488,8 @@ export interface MetricStreamEntry { CreationDate?: Date | undefined; /** - *The date that the configuration of this metric stream was most recently updated.
+ *The date that the configuration of this metric stream was most recently + * updated.
* @public */ LastUpdateDate?: Date | undefined; @@ -3331,21 +3501,22 @@ export interface MetricStreamEntry { Name?: string | undefined; /** - *The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
+ *The ARN of the Kinesis Firehose devlivery stream that is used for this metric + * stream.
* @public */ FirehoseArn?: string | undefined; /** - *The current state of this stream. Valid values are running and stopped.
The current state of this stream. Valid values are running and
+ * stopped.
The output format of this metric stream. Valid values are
- * json, opentelemetry1.0,
- * and opentelemetry0.7.
The output format of this metric stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7.
The token that marks the start of the next batch of returned results. You can use this - * token in a subsequent operation to get the next batch of results.
+ *The token that marks the start of the next batch of returned results. You can use + * this token in a subsequent operation to get the next batch of results.
* @public */ NextToken?: string | undefined; @@ -3376,16 +3547,15 @@ export interface ListTagsForResourceInput { /** *The ARN of the CloudWatch resource that you want to view tags for.
*The ARN format of an alarm is
- * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
*
*
The ARN format of a Contributor Insights rule is
- * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
*
*
For more information about ARN format, see Resource - * Types Defined by Amazon CloudWatch in the Amazon Web Services General - * Reference.
+ *For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
* @public */ ResourceARN: string | undefined; @@ -3397,8 +3567,8 @@ export interface ListTagsForResourceInput { */ export interface Tag { /** - *A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your - * resources.
+ *A string that you can use to assign a value. The combination of tag keys and values + * can help you organize and categorize your resources.
* @public */ Key: string | undefined; @@ -3458,28 +3628,26 @@ export interface PutAnomalyDetectorInput { Stat?: string | undefined; /** - *The configuration specifies details about how the - * anomaly detection model is to be trained, including - * time ranges to exclude when training and updating the model. - * You can specify as many as 10 time ranges.
- *The configuration can also include the time zone to use for - * the metric.
+ *The configuration specifies details about how the anomaly detection model is to be + * trained, including time ranges to exclude when training and updating the model. You can + * specify as many as 10 time ranges.
+ *The configuration can also include the time zone to use for the metric.
* @public */ Configuration?: AnomalyDetectorConfiguration | undefined; /** *Use this object to include parameters to provide information about your metric to
- * CloudWatch to help it build more accurate anomaly detection models. Currently, it includes
- * the PeriodicSpikes parameter.
PeriodicSpikes parameter.
* @public
*/
MetricCharacteristics?: MetricCharacteristics | undefined;
/**
* A single metric anomaly detector to be created.
- *When using SingleMetricAnomalyDetector,
- * you cannot include the following parameters in the same operation:
When using SingleMetricAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
@@ -3502,19 +3670,21 @@ export interface PutAnomalyDetectorInput { *
*the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput
+ *
the MetricMathAnomalyDetector parameters of
+ * PutAnomalyDetectorInput
*
Instead, specify the single metric anomaly detector attributes
- * as part of the property SingleMetricAnomalyDetector.
Instead, specify the single metric anomaly detector attributes as part of the property
+ * SingleMetricAnomalyDetector.
The metric math anomaly detector to be created.
- *When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:
When using MetricMathAnomalyDetector, you cannot include the following
+ * parameters in the same operation:
@@ -3537,12 +3707,13 @@ export interface PutAnomalyDetectorInput { *
*the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput
+ *
the SingleMetricAnomalyDetector parameters of
+ * PutAnomalyDetectorInput
*
Instead, specify the metric math anomaly detector attributes
- * as part of the property MetricMathAnomalyDetector.
Instead, specify the metric math anomaly detector attributes as part of the property
+ * MetricMathAnomalyDetector.
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is
- * TRUE.
Indicates whether actions should be executed during any changes to the alarm state of
+ * the composite alarm. The default is TRUE.
The actions to execute when this alarm transitions to the ALARM state from any other state.
- * Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the ALARM state
+ * from any other state. Each action is specified as an Amazon Resource Name
+ * (ARN).
Valid Values: ]
** Amazon SNS actions: @@ -3600,17 +3772,20 @@ export interface PutCompositeAlarmInput { *
*Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
The name for the composite alarm. This name must be unique within the Region.
+ *The name for the composite alarm. This name must be unique within the + * Region.
* @public */ AlarmName: string | undefined; /** *An expression that specifies which other alarms are to be evaluated to determine this - * composite alarm's state. For each alarm that you reference, you - * designate a function that - * specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You - * can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the - * functions in your expression.
- *You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
+ * composite alarm's state. For each alarm that you reference, you designate a function + * that specifies whether that alarm needs to be in ALARM state, OK state, or + * INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple + * functions in a single expression. You can use parenthesis to logically group the + * functions in your expression. + *You can use either alarm names or ARNs to reference the other alarms that are to be + * evaluated.
*Functions can include the following:
*
- * ALARM("alarm-name or alarm-ARN") is TRUE if the named
- * alarm is in ALARM state.
ALARM("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in
+ * ALARM state.
*
- * OK("alarm-name or alarm-ARN") is TRUE if the named
- * alarm is in OK state.
OK("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in OK
+ * state.
*
- * INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named
- * alarm is in INSUFFICIENT_DATA state.
INSUFFICIENT_DATA("alarm-name or
+ * alarm-ARN") is TRUE if the named alarm is in
+ * INSUFFICIENT_DATA state.
* @@ -3673,42 +3853,45 @@ export interface PutCompositeAlarmInput { *
TRUE and FALSE are useful for testing a complex AlarmRule structure, and
- * for testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes ("), but do not have to be.
The following
- * are some examples of AlarmRule:
Alarm names specified in AlarmRule can be surrounded with double-quotes
+ * ("), but do not have to be.
The following are some examples of AlarmRule:
- * ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes into ALARM state only
- * if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
+ * specifies that the composite alarm goes into ALARM state only if both
+ * CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
*
* ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
- * specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state
- * and DeploymentInProgress is not in ALARM state. This example reduces
- * alarm noise during a known deployment window.
- * (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into ALARM
- * state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state.
- * This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an
- * alarm action on high CPU or disk usage if a known network problem is also occurring.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
+ * OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh
+ * OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK
+ * state. This provides another example of using a composite alarm to prevent
+ * noise. This rule ensures that you are not notified with an alarm action on high
+ * CPU or disk usage if a known network problem is also occurring.
* The AlarmRule can specify as many as 100
- * "children" alarms. The AlarmRule expression can have as many as 500 elements. Elements
- * are child alarms, TRUE or FALSE statements, and
- * parentheses.
The AlarmRule can specify as many as 100 "children" alarms. The
+ * AlarmRule expression can have as many as 500 elements. Elements are
+ * child alarms, TRUE or FALSE statements, and parentheses.
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
- * Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN).
Valid Values: ]
** Amazon SNS actions: @@ -3722,17 +3905,20 @@ export interface PutCompositeAlarmInput { *
*Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
The actions to execute when this alarm transitions to an OK state
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to an OK state from
+ * any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
** Amazon SNS actions: @@ -3757,17 +3943,20 @@ export interface PutCompositeAlarmInput { *
*Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
- * To be able to associate tags with the alarm when you create the alarm, you must
- * have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.
- *If you are using this operation to update an existing alarm, any tags - * you specify in this parameter are ignored. To change the tags of an existing alarm, use - * TagResource - * or UntagResource.
+ *A list of key-value pairs to associate with the alarm. You can associate as many as
+ * 50 tags with an alarm. To be able to associate tags with the alarm when you create the
+ * alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *If you are using this operation to update an existing alarm, any tags you specify in + * this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
* @public */ Tags?: Tag[] | undefined; /** - *
- * Actions will be suppressed
- * if the suppressor alarm is
- * in the ALARM state.
- * ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN)
- * from an existing alarm.
- *
Actions will be suppressed if the suppressor alarm is in the ALARM
+ * state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name
+ * (ARN) from an existing alarm.
- * The maximum time
- * in seconds
- * that the composite alarm waits
- * for the suppressor alarm
- * to go
- * into the ALARM state.
- * After this time,
- * the composite alarm performs its actions.
- *
The maximum time in seconds that the composite alarm waits for the suppressor alarm
+ * to go into the ALARM state. After this time, the composite alarm performs
+ * its actions.
- * WaitPeriod
- * is required only
- * when ActionsSuppressor is specified.
- *
WaitPeriod is required only when ActionsSuppressor is
+ * specified.
*
- * The maximum time
- * in seconds
- * that the composite alarm waits
- * after suppressor alarm goes out
- * of the ALARM state.
- * After this time,
- * the composite alarm performs its actions.
- *
The maximum time in seconds that the composite alarm waits after suppressor alarm
+ * goes out of the ALARM state. After this time, the composite alarm performs
+ * its actions.
- * ExtensionPeriod
- * is required only
- * when ActionsSuppressor is specified.
- *
ExtensionPeriod is required only when ActionsSuppressor is
+ * specified.
* The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing - * its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are - * A-Z, a-z, 0-9, "-", and "_". This parameter is required.
+ *The name of the dashboard. If a dashboard with this name already exists, this call + * modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is + * created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and + * "_". This parameter is required.
* @public */ DashboardName: string | undefined; /** - *The detailed information about the dashboard in JSON format, including the widgets to include and their location - * on the dashboard. This parameter is required.
- *For more information about the syntax, - * see Dashboard Body Structure and Syntax.
+ *The detailed information about the dashboard in JSON format, including the widgets + * to include and their location on the dashboard. This parameter is required.
+ *For more information about the syntax, see Dashboard Body Structure and Syntax.
* @public */ DashboardBody: string | undefined; @@ -3874,11 +4040,13 @@ export interface PutDashboardInput { */ export interface PutDashboardOutput { /** - *If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be - * created or modified, but some elements of the dashboard - * might not render.
- *If this result includes error messages, the input was not valid and the operation failed.
+ *If the input for PutDashboard was correct and the dashboard was
+ * successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for + * the dashboard to be created or modified, but some elements of the dashboard might not + * render.
+ *If this result includes error messages, the input was not valid and the operation + * failed.
* @public */ DashboardValidationMessages?: DashboardValidationMessage[] | undefined; @@ -3902,24 +4070,23 @@ export interface PutInsightRuleInput { /** *The definition of the rule, as a JSON object. For details on the valid syntax, see - * Contributor Insights - * Rule Syntax.
+ * Contributor Insights Rule Syntax. * @public */ RuleDefinition: string | undefined; /** - *A list of key-value pairs to associate with the Contributor Insights rule. - * You can associate as many as 50 tags with a rule.
- *Tags can help you organize and categorize your - * resources. You can also use them to scope user permissions, by - * granting a user permission to access or change only the resources that have - * certain tag values.
- *To be able to associate tags with a rule, you must have the cloudwatch:TagResource
- * permission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags - * you specify in this parameter are ignored. To change the tags of an existing rule, use - * TagResource.
+ *A list of key-value pairs to associate with the Contributor Insights rule. You can + * associate as many as 50 tags with a rule.
+ *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions, by granting a user permission to access or change only the + * resources that have certain tag values.
+ *To be able to associate tags with a rule, you must have the
+ * cloudwatch:TagResource permission in addition to the
+ * cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any + * tags you specify in this parameter are ignored. To change the tags of an existing rule, + * use TagResource.
* @public */ Tags?: Tag[] | undefined; @@ -3931,65 +4098,37 @@ export interface PutInsightRuleInput { export interface PutInsightRuleOutput {} /** - *- * Contains the information - * that's required - * to enable a managed Contributor Insights rule - * for an Amazon Web Services resource. + *
Contains the information that's required to enable a managed Contributor Insights + * rule for an Amazon Web Services resource. * - *
+ * * @public */ export interface ManagedRule { /** - *
- * The template name
- * for the managed Contributor Insights rule,
- * as returned
- * by ListManagedInsightRules.
- *
The template name for the managed Contributor Insights rule, as returned by
+ * ListManagedInsightRules.
- * The ARN - * of an Amazon Web Services resource - * that has managed Contributor Insights rules. - *
+ *The ARN of an Amazon Web Services resource that has managed Contributor Insights + * rules.
* @public */ ResourceARN: string | undefined; /** - *
- * A list
- * of key-value pairs
- * that you can associate
- * with a managed Contributor Insights rule.
- * You can associate as many as 50 tags
- * with a rule.
- * Tags can help you organize and categorize your resources.
- * You also can use them
- * to scope user permissions
- * by granting a user permission
- * to access or change only the resources
- * that have certain tag values.
- * To associate tags
- * with a rule,
- * you must have the cloudwatch:TagResource permission
- * in addition
- * to the cloudwatch:PutInsightRule permission.
- * If you are using this operation
- * to update an existing Contributor Insights rule,
- * any tags
- * that you specify
- * in this parameter are ignored.
- * To change the tags
- * of an existing rule,
- * use TagResource.
- *
A list of key-value pairs that you can associate with a managed Contributor Insights
+ * rule. You can associate as many as 50 tags with a rule. Tags can help you organize and
+ * categorize your resources. You also can use them to scope user permissions by granting a
+ * user permission to access or change only the resources that have certain tag values. To
+ * associate tags with a rule, you must have the cloudwatch:TagResource
+ * permission in addition to the cloudwatch:PutInsightRule permission. If you
+ * are using this operation to update an existing Contributor Insights rule, any tags that
+ * you specify in this parameter are ignored. To change the tags of an existing rule, use
+ * TagResource.
- * A list
- * of ManagedRules
- * to enable.
- *
A list of ManagedRules to enable.
- * An array - * that lists the rules - * that could not be enabled. - *
+ *An array that lists the rules that could not be enabled.
* @public */ Failures?: PartialFailure[] | undefined; @@ -4031,8 +4162,8 @@ export interface PutManagedInsightRulesOutput { export interface PutMetricAlarmInput { /** *The name for the alarm. This name must be unique within the Region.
- *The name must contain only UTF-8 - * characters, and can't contain ASCII control characters
+ *The name must contain only UTF-8 characters, and can't contain ASCII control + * characters
* @public */ AlarmName: string | undefined; @@ -4044,15 +4175,16 @@ export interface PutMetricAlarmInput { AlarmDescription?: string | undefined; /** - *Indicates whether actions should be executed during any changes to the alarm state. The default is
- * TRUE.
Indicates whether actions should be executed during any changes to the alarm state.
+ * The default is TRUE.
The actions to execute when this alarm transitions to an OK state
- * from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
The actions to execute when this alarm transitions to an OK state from
+ * any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
+ * values:
* EC2 actions: *
@@ -4114,17 +4246,20 @@ export interface PutMetricAlarmInput { * *Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
The actions to execute when this alarm transitions to the ALARM state from any other state.
- * Each action is specified as an Amazon Resource Name (ARN). Valid values:
The actions to execute when this alarm transitions to the ALARM state
+ * from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid
+ * values:
* EC2 actions: *
@@ -4225,17 +4361,20 @@ export interface PutMetricAlarmInput { * *Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
- * Each action is specified as an Amazon Resource Name (ARN). Valid values:
The actions to execute when this alarm transitions to the
+ * INSUFFICIENT_DATA state from any other state. Each action is specified
+ * as an Amazon Resource Name (ARN). Valid values:
* EC2 actions: *
@@ -4336,17 +4476,20 @@ export interface PutMetricAlarmInput { * *Invoke the latest version of a Lambda function: Invoke the latest version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name
+ * arn:aws:lambda:region:account-id:function:function-name
*
*
Invoke a specific version of a Lambda function: Invoke a specific version of a Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
+ * arn:aws:lambda:region:account-id:function:function-name:version-number
*
*
Invoke a function by using an alias Lambda function: Invoke a function by using an alias Lambda function:
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
+ * arn:aws:lambda:region:account-id:function:function-name:alias-name
*
*
The name for the metric associated with the alarm. For each PutMetricAlarm
- * operation, you must specify either MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
- * Namespace, Dimensions, Period,
- * Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify
- * all this information in the Metrics array.
The name for the metric associated with the alarm. For each
+ * PutMetricAlarm operation, you must specify either
+ * MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this
+ * parameter, or any of the Namespace, Dimensions,
+ * Period, Unit, Statistic, or
+ * ExtendedStatistic parameters. Instead, you specify all this information
+ * in the Metrics array.
The namespace for the metric associated specified in MetricName.
The namespace for the metric associated specified in
+ * MetricName.
The statistic for the metric specified in MetricName, other than percentile.
- * For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify
- * a MetricName, you must
- * specify either Statistic or ExtendedStatistic, but not both.
The statistic for the metric specified in MetricName, other than
+ * percentile. For percentile statistics, use ExtendedStatistic. When you call
+ * PutMetricAlarm and specify a MetricName, you must specify
+ * either Statistic or ExtendedStatistic, but not both.
The extended statistic for the metric specified in MetricName. When you
- * call PutMetricAlarm and specify
- * a MetricName, you must
- * specify either Statistic or ExtendedStatistic but not both.
The extended statistic for the metric specified in MetricName. When
+ * you call PutMetricAlarm and specify a MetricName, you must
+ * specify either Statistic or ExtendedStatistic but not
+ * both.
If you specify ExtendedStatistic, the following are valid values:
- * PR(n:m) where n and m are values
- * of the metric
PR(n:m) where n and m
+ * are values of the metric
*
- * TC(X%:X%) where X is between
- * 10 and 90 inclusive.
TC(X%:X%) where X is
+ * between 10 and 90 inclusive.
*
- * TM(X%:X%) where X is between
- * 10 and 90 inclusive.
TM(X%:X%) where X is
+ * between 10 and 90 inclusive.
*
- * TS(X%:X%) where X is between
- * 10 and 90 inclusive.
TS(X%:X%) where X is
+ * between 10 and 90 inclusive.
*
- * WM(X%:X%) where X is between
- * 10 and 90 inclusive.
WM(X%:X%) where X is
+ * between 10 and 90 inclusive.
* For more information about these extended statistics, see - * CloudWatch statistics definitions.
+ *For more information about these extended statistics, see CloudWatch statistics definitions.
* @public */ ExtendedStatistic?: string | undefined; @@ -4485,104 +4630,110 @@ export interface PutMetricAlarmInput { Dimensions?: Dimension[] | undefined; /** - *The length, in seconds, used each time the metric specified in MetricName is
- * evaluated. Valid values are 10, 30, and any multiple of 60.
The length, in seconds, used each time the metric specified in
+ * MetricName is evaluated. Valid values are 10, 30, and any multiple of
+ * 60.
- * Period is required for alarms based on static thresholds. If
- * you are creating an alarm based on a metric math expression, you specify the
- * period for each metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
- * StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have
- * sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,
- * it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm
- * might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,
- * which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can
- * be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
Period is required for alarms based on static thresholds. If you are
+ * creating an alarm based on a metric math expression, you specify the period for each
+ * metric within the objects in the Metrics array.
+ * Be sure to specify 10 or 30 only for metrics that are stored by a
+ * PutMetricData call with a StorageResolution of 1. If you
+ * specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the
+ * alarm still attempts to gather data at the period rate that you specify. In this case,
+ * it does not receive data for the attempts that do not correspond to a one-minute data
+ * resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10
+ * or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than
+ * other alarms. For more information about pricing, see Amazon CloudWatch
+ * Pricing.
An alarm's total current evaluation period can be no longer than one day, so
+ * Period multiplied by EvaluationPeriods cannot be more than
+ * 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2
- * NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
- * receives on all network interfaces. You can also specify a unit when you create a custom
- * metric. Units help provide conceptual meaning to your data. Metric data points that
- * specify a unit of measure, such as Percent, are aggregated separately.
- * If you are creating an alarm based on a metric math expression, you can specify the unit for each
- * metric (if needed) within the objects in the Metrics array.
If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the
- * metric and attempts to evaluate the alarm.
- * Usually, metrics are
- * published with only one unit, so the alarm
- * works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's - * behavior is not defined and - * it behaves unpredictably.
- *We recommend omitting Unit so that you don't inadvertently
- * specify an incorrect unit that is not published for this metric. Doing so
- * causes the alarm to be stuck in the INSUFFICIENT DATA state.
Metrics array.
+ * If you don't specify Unit, CloudWatch retrieves all unit types that
+ * have been published for the metric and attempts to evaluate the alarm. Usually, metrics
+ * are published with only one unit, so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't + * specify a unit, the alarm's behavior is not defined and it behaves + * unpredictably.
+ *We recommend omitting Unit so that you don't inadvertently specify an
+ * incorrect unit that is not published for this metric. Doing so causes the alarm to be
+ * stuck in the INSUFFICIENT DATA state.
The number of periods over which data is compared to the specified threshold. If you are - * setting an alarm that requires that a number of consecutive data points be breaching to - * trigger the alarm, this value specifies that number. If you are setting an "M out of N" - * alarm, this value is the N.
- *An alarm's total current evaluation period can
- * be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
The number of periods over which data is compared to the specified threshold. If + * you are setting an alarm that requires that a number of consecutive data points be + * breaching to trigger the alarm, this value specifies that number. If you are setting an + * "M out of N" alarm, this value is the N.
+ *An alarm's total current evaluation period can be no longer than one day, so this
+ * number multiplied by Period cannot be more than 86,400 seconds.
The number of data points that must be breaching to trigger the alarm. This is used only if you are setting - * an "M out of N" alarm. In that case, this value is the M. For more information, see - * Evaluating an Alarm in the - * Amazon CloudWatch User Guide.
+ *The number of data points that must be breaching to trigger the alarm. This is used + * only if you are setting an "M out of N" alarm. In that case, this value is the M. For + * more information, see Evaluating an Alarm in the Amazon CloudWatch User + * Guide.
* @public */ DatapointsToAlarm?: number | undefined; /** *The value against which the specified statistic is compared.
- *This parameter is required for alarms based on static thresholds, but should - * not be used for alarms based on anomaly detection models.
+ *This parameter is required for alarms based on static thresholds, but should not be + * used for alarms based on anomaly detection models.
* @public */ Threshold?: number | undefined; /** *The arithmetic operation to use when comparing the specified statistic and - * threshold. The specified statistic value is used as the first operand.
+ * threshold. The specified statistic value is used as the first operand. *The values LessThanLowerOrGreaterThanUpperThreshold,
- * LessThanLowerThreshold, and GreaterThanUpperThreshold
- * are used only for alarms based on anomaly detection models.
LessThanLowerThreshold, and GreaterThanUpperThreshold are
+ * used only for alarms based on anomaly detection models.
* @public
*/
ComparisonOperator: ComparisonOperator | undefined;
/**
- * Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used.
- * For more information, see Configuring How CloudWatch
- * Alarms Treats Missing Data.
Sets how this alarm is to handle missing data points. If
+ * TreatMissingData is omitted, the default behavior of
+ * missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing
*
Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore
- * missing data even if you choose a different option for TreatMissingData. When an
- * AWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.
Alarms that evaluate metrics in the AWS/DynamoDB namespace always
+ * ignore missing data even if you choose a different option for
+ * TreatMissingData. When an AWS/DynamoDB metric has
+ * missing data, alarms that evaluate that metric remain in their current state.
Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be
- * statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state
- * no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Used only for alarms based on percentiles. If you specify ignore, the
+ * alarm state does not change during periods with too few data points to be statistically
+ * significant. If you specify evaluate or omit this parameter, the alarm is
+ * always evaluated and possibly changes state no matter how many data points are
+ * available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore
*
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a
- * metric math expression. For each PutMetricAlarm
- * operation, you must specify either MetricName or a Metrics array.
Each item in the Metrics array either retrieves a metric or performs a math expression.
One item in the Metrics array is the expression that the alarm watches. You designate this expression
- * by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.
An array of MetricDataQuery structures that enable you to create an alarm
+ * based on the result of a metric math expression. For each PutMetricAlarm
+ * operation, you must specify either MetricName or a Metrics
+ * array.
Each item in the Metrics array either retrieves a metric or performs a
+ * math expression.
One item in the Metrics array is the expression that the alarm watches.
+ * You designate this expression by setting ReturnData to true for this object
+ * in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the
- * Namespace, MetricName, Dimensions, Period,
- * Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation.
- * Instead, you retrieve
- * the metrics you are using in your math expression as part of the Metrics array.
Namespace, MetricName, Dimensions,
+ * Period, Unit, Statistic, or
+ * ExtendedStatistic parameters of PutMetricAlarm in the same
+ * operation. Instead, you retrieve the metrics you are using in your math expression as
+ * part of the Metrics array.
* @public
*/
Metrics?: MetricDataQuery[] | undefined;
/**
- * A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
- * To be able to associate tags with the alarm when you create the alarm, you must
- * have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.
- *If you are using this operation to update an existing alarm, any tags - * you specify in this parameter are ignored. To change the tags of an existing alarm, use - * TagResource - * or UntagResource.
+ *A list of key-value pairs to associate with the alarm. You can associate as many as
+ * 50 tags with an alarm. To be able to associate tags with the alarm when you create the
+ * alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *If you are using this operation to update an existing alarm, any tags you specify in + * this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
+ *To use this field to set tags for an alarm when you create it, you must be signed on
+ * with both the cloudwatch:PutMetricAlarm and
+ * cloudwatch:TagResource permissions.
If this is an alarm based on an anomaly detection model, make this value match
- * the ID of
- * the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the - * Anomaly Detection - * Model Alarm example on this page.
+ *If this is an alarm based on an anomaly detection model, make this value match the ID
+ * of the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the Anomaly + * Detection Model Alarm example on this page.
*If your alarm uses this parameter, it cannot have Auto Scaling actions.
* @public */ @@ -4634,136 +4788,99 @@ export interface PutMetricAlarmInput { } /** - *Represents a set of statistics that describes a specific metric.
- * @public - */ -export interface StatisticSet { - /** - *The number of samples used for the statistic set.
- * @public - */ - SampleCount: number | undefined; - - /** - *The sum of values for the sample set.
- * @public - */ - Sum: number | undefined; - - /** - *The minimum value of the sample set.
- * @public - */ - Minimum: number | undefined; - - /** - *The maximum value of the sample set.
- * @public - */ - Maximum: number | undefined; -} - -/** - *Encapsulates the information sent to either create a metric or add new values - * to be aggregated into an existing metric.
* @public */ -export interface MetricDatum { - /** - *The name of the metric.
- * @public - */ - MetricName: string | undefined; - - /** - *The dimensions associated with the metric.
- * @public - */ - Dimensions?: Dimension[] | undefined; - - /** - *The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
- * @public - */ - Timestamp?: Date | undefined; - - /** - *The value for the metric.
- *Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or - * too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) - * are not supported.
- * @public - */ - Value?: number | undefined; - - /** - *The statistical values for the metric.
- * @public - */ - StatisticValues?: StatisticSet | undefined; - - /** - *Array of numbers representing the values for the metric during the period. Each unique value is listed just once
- * in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.
- * You can include up to 150 unique values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type
- * Double, CloudWatch rejects values that are either too small
- * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
- * -Infinity) are not supported.
Array of numbers that is used along with the Values array. Each number in the Count array
- * is the number of times the corresponding value in the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for each count. If you
- * include a Counts array, it must include the same amount of values as the Values array.
The namespace for the metric data. You can use ASCII characters for the namespace, + * except for control characters which are not supported.
+ *To avoid conflicts with Amazon Web Services service namespaces, you should not
+ * specify a namespace that begins with AWS/
+ *
When you are using a Put operation, this defines what unit you want to use when storing the metric.
In
- * a Get operation, this displays the unit that is used for the metric.
The data for the metrics. Use this parameter if your metrics do not contain + * associated entities. The array can include no more than 1000 metrics per call.
+ *The limit of metrics allowed, 1000, is the sum of both EntityMetricData
+ * and MetricData metrics.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with - * sub-minute resolution down to one second. - * Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available - * only for custom metrics. For more information about high-resolution metrics, - * see High-Resolution Metrics in the - * Amazon CloudWatch User Guide. - *
- *This field is optional, if you do not specify it the default of 60 is used.
+ *Data for metrics that contain associated entity information. You can include up to
+ * two EntityMetricData objects, each of which can contain a single
+ * Entity and associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData
+ * and MetricData metrics.
The namespace for the metric data. You can use ASCII characters for the namespace, except for - * control characters which are not supported.
- *To avoid conflicts
- * with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/
- *
The data for the metric. The array can include no more than 1000 metrics per call.
+ *Whether to accept valid metric data when an invalid entity is sent.
+ *When set to true: Any validation error (for entity or metric
+ * data) will fail the entire request, and no data will be ingested. The failed
+ * operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not
+ * associate the metric with the entity, but the metric data will still be
+ * accepted and ingested. Validation errors in the metric data will fail the
+ * entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a
+ * 200 status, but an additional response header will contain
+ * information about the validation errors. The new header,
+ * X-Amzn-Failure-Message is an enumeration of the following
+ * values:
+ * InvalidEntity - The provided entity is invalid.
+ * InvalidKeyAttributes - The provided
+ * KeyAttributes of an entity is invalid.
+ * InvalidAttributes - The provided Attributes
+ * of an entity is invalid.
+ * InvalidTypeValue - The provided Type in the
+ * KeyAttributes of an entity is invalid.
+ * EntitySizeTooLarge - The number of
+ * EntityMetricData objects allowed is 2.
+ * MissingRequiredFields - There are missing required
+ * fields in the KeyAttributes for the provided
+ * Type.
For details of the requirements for specifying an entity, see + * How + * to add related information to telemetry in the + * CloudWatch User Guide.
+ *This parameter is required when EntityMetricData is
+ * included.
If you are creating a new metric stream, this is the name for the new stream. The name - * must be different than the names of other metric streams in this account and Region.
+ * must be different than the names of other metric streams in this account and + * Region. *If you are updating a metric stream, specify the name of that stream here.
*Valid characters are A-Z, a-z, 0-9, "-" and "_".
* @public @@ -4780,35 +4898,35 @@ export interface PutMetricStreamInput { Name: string | undefined; /** - *If you specify this parameter, the stream sends only the - * metrics from the metric namespaces that you specify here.
- *You cannot include IncludeFilters and ExcludeFilters
- * in the same operation.
If you specify this parameter, the stream sends only the metrics from the metric + * namespaces that you specify here.
+ *You cannot include IncludeFilters and ExcludeFilters in the
+ * same operation.
If you specify this parameter, the stream sends metrics from all - * metric namespaces except for the namespaces that you specify here.
- *You cannot include ExcludeFilters and IncludeFilters in
- * the same operation.
If you specify this parameter, the stream sends metrics from all metric namespaces + * except for the namespaces that you specify here.
+ *You cannot include ExcludeFilters and IncludeFilters in the
+ * same operation.
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. - * This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the - * same account as the metric stream.
+ *The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric + * stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be + * in the same account as the metric stream.
* @public */ FirehoseArn: string | undefined; /** *The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data - * Firehose resources. This IAM role must already exist and must be in the same account as - * the metric stream. This IAM role must include the following permissions:
+ * Firehose resources. This IAM role must already exist and must be in the same account as + * the metric stream. This IAM role must include the following permissions: *firehose:PutRecord
@@ -4822,49 +4940,47 @@ export interface PutMetricStreamInput { RoleArn: string | undefined; /** - *The output format for the stream. Valid values are json, opentelemetry1.0,
- * and opentelemetry0.7. For more information about metric stream
- * output formats, see
- *
- * Metric streams output formats.
The output format for the stream. Valid values are json,
+ * opentelemetry1.0, and opentelemetry0.7. For more
+ * information about metric stream output formats, see
+ * Metric streams output formats.
A list of key-value pairs to associate with the metric stream. You can associate as - * many as 50 tags with a metric stream.
- *Tags can help you organize and categorize your resources. You can also use them to scope user - * permissions by granting a user - * permission to access or change only resources with certain tag values.
- *You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags - * you specify in this parameter are ignored. To change the tags of an existing metric stream, use - * TagResource - * or UntagResource.
+ * many as 50 tags with a metric stream. + *Tags can help you organize and categorize your resources. You can also use them to + * scope user permissions by granting a user permission to access or change only resources + * with certain tag values.
+ *You can use this parameter only when you are creating a new metric stream. If you are + * using this operation to update an existing metric stream, any tags you specify in this + * parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
* @public */ Tags?: Tag[] | undefined; /** - *By default, a metric stream always sends the MAX, MIN, SUM,
- * and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have
- * the metric stream also send additional statistics in the stream. This
- * array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional
- * statistics to stream for those metrics. The additional statistics that you can stream
- * depend on the stream's OutputFormat. If the OutputFormat is
- * json, you can stream any additional statistic that is supported by
- * CloudWatch, listed in
- * CloudWatch statistics definitions. If the OutputFormat
- * is opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95,
- * p99.9, and so on.
By default, a metric stream always sends the MAX, MIN,
+ * SUM, and SAMPLECOUNT statistics for each metric that is
+ * streamed. You can use this parameter to have the metric stream also send additional
+ * statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of
+ * additional statistics to stream for those metrics. The additional statistics that you
+ * can stream depend on the stream's OutputFormat. If the
+ * OutputFormat is json, you can stream any additional
+ * statistic that is supported by CloudWatch, listed in
+ * CloudWatch statistics definitions. If the OutputFormat
+ * is opentelemetry1.0 or opentelemetry0.7, you can stream
+ * percentile statistics such as p95, p99.9, and so on.
If you are creating a metric stream in a monitoring account,
- * specify true to include metrics from source accounts in the metric stream.
If you are creating a metric stream in a monitoring account, specify true
+ * to include metrics from source accounts in the metric stream.
The reason that this alarm is set to this specific state, in JSON format.
- *For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling - * alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
+ *For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling + * or application Auto Scaling alarm actions, the Auto Scaling policy uses the information + * in this field to take the correct action.
* @public */ StateReasonData?: string | undefined; @@ -4938,9 +5055,9 @@ export interface SetAlarmStateInput { export interface StartMetricStreamsInput { /** *The array of the names of metric streams to start streaming.
- *This is an "all or nothing" operation. If you do not have - * permission to access all of the metric streams that you list here, then none of the streams that you list - * in the operation will start streaming.
+ *This is an "all or nothing" operation. If you do not have permission to access all of + * the metric streams that you list here, then none of the streams that you list in the + * operation will start streaming.
* @public */ Names: string[] | undefined; @@ -4957,9 +5074,9 @@ export interface StartMetricStreamsOutput {} export interface StopMetricStreamsInput { /** *The array of the names of metric streams to stop streaming.
- *This is an "all or nothing" operation. If you do not have - * permission to access all of the metric streams that you list here, then none of the streams that you list - * in the operation will stop streaming.
+ *This is an "all or nothing" operation. If you do not have permission to access all of + * the metric streams that you list here, then none of the streams that you list in the + * operation will stop streaming.
* @public */ Names: string[] | undefined; @@ -4977,16 +5094,15 @@ export interface TagResourceInput { /** *The ARN of the CloudWatch resource that you're adding tags to.
*The ARN format of an alarm is
- * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
*
*
The ARN format of a Contributor Insights rule is
- * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
*
*
For more information about ARN format, see Resource - * Types Defined by Amazon CloudWatch in the Amazon Web Services General - * Reference.
+ *For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
* @public */ ResourceARN: string | undefined; @@ -5010,16 +5126,15 @@ export interface UntagResourceInput { /** *The ARN of the CloudWatch resource that you're removing tags from.
*The ARN format of an alarm is
- * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
+ * arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
*
*
The ARN format of a Contributor Insights rule is
- * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
+ * arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name
*
*
For more information about ARN format, see Resource - * Types Defined by Amazon CloudWatch in the Amazon Web Services General - * Reference.
+ *For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web + * Services General Reference.
* @public */ ResourceARN: string | undefined; diff --git a/clients/client-cloudwatch/src/protocols/Aws_query.ts b/clients/client-cloudwatch/src/protocols/Aws_query.ts index bd82f6c612da..49a182835123 100644 --- a/clients/client-cloudwatch/src/protocols/Aws_query.ts +++ b/clients/client-cloudwatch/src/protocols/Aws_query.ts @@ -141,6 +141,8 @@ import { EnableAlarmActionsInput, EnableInsightRulesInput, EnableInsightRulesOutput, + Entity, + EntityMetricData, GetDashboardInput, GetDashboardOutput, GetInsightRuleReportInput, @@ -2387,6 +2389,104 @@ const se_EnableInsightRulesInput = (input: EnableInsightRulesInput, context: __S return entries; }; +/** + * serializeAws_queryEntity + */ +const se_Entity = (input: Entity, context: __SerdeContext): any => { + const entries: any = {}; + if (input[_KA] != null) { + const memberEntries = se_EntityKeyAttributesMap(input[_KA], context); + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `KeyAttributes.${key}`; + entries[loc] = value; + }); + } + if (input[_At] != null) { + const memberEntries = se_EntityAttributesMap(input[_At], context); + Object.entries(memberEntries).forEach(([key, value]) => { + const loc = `Attributes.${key}`; + entries[loc] = value; + }); + } + return entries; +}; + +/** + * serializeAws_queryEntityAttributesMap + */ +const se_EntityAttributesMap = (input: RecordThe configuration specifies details about how the \n\t\tanomaly detection model is to be trained, including time ranges to \n\t\texclude from use for training the model, and the time zone to use for \n\t\tthe metric.
" + "smithy.api#documentation": "The configuration specifies details about how the anomaly detection model is to be\n trained, including time ranges to exclude from use for training the model, and the time\n zone to use for the metric.
" } }, "StateValue": { @@ -275,7 +275,7 @@ "MetricCharacteristics": { "target": "com.amazonaws.cloudwatch#MetricCharacteristics", "traits": { - "smithy.api#documentation": "This object includes parameters that you can use to provide information about your metric to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models. Currently, it includes\n\t\t\tthe PeriodicSpikes parameter.
This object includes parameters that you can use to provide information about your\n metric to CloudWatch to help it build more accurate anomaly detection models.\n Currently, it includes the PeriodicSpikes parameter.
An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. \n\t\t\tYou can use the model to display a band of expected, normal values \n\t\t\twhen the metric is graphed.
\nIf you have enabled unified cross-account observability, and this account is a monitoring\n\t\t\taccount, the metric can be in the same account or a source account.
" + "smithy.api#documentation": "An anomaly detection model associated with a particular CloudWatch metric, statistic,\n or metric math expression. You can use the model to display a band of expected, normal\n values when the metric is graphed.
\nIf you have enabled unified cross-account observability, and this account is a\n monitoring account, the metric can be in the same account or a source account.
" } }, "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration": { @@ -301,18 +301,18 @@ "ExcludedTimeRanges": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorExcludedTimeRanges", "traits": { - "smithy.api#documentation": "An array of time ranges to exclude from use when the anomaly detection model is trained. Use\n\t\t\tthis to make sure that events that could cause unusual values for the metric, such as\n\t\t\tdeployments, aren't used when CloudWatch creates the model.
" + "smithy.api#documentation": "An array of time ranges to exclude from use when the anomaly detection model is\n trained. Use this to make sure that events that could cause unusual values for the\n metric, such as deployments, aren't used when CloudWatch creates the model.
" } }, "MetricTimezone": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone", "traits": { - "smithy.api#documentation": "The time zone to use for the metric. This is useful to enable the model to automatically\n\t\t\taccount for daylight savings time changes if the metric is sensitive to such time\n\t\t\tchanges.
\nTo specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, \n\t\t\tsee tz database.
" + "smithy.api#documentation": "The time zone to use for the metric. This is useful to enable the model to\n automatically account for daylight savings time changes if the metric is sensitive to\n such time changes.
\nTo specify a time zone, use the name of the time zone as specified in the standard\n tz database. For more information, see tz database.
" } } }, "traits": { - "smithy.api#documentation": "The configuration specifies details about how the anomaly detection model is to be trained,\n\t\t\tincluding time ranges to exclude from use for training the model and the time zone to\n\t\t\tuse for the metric.
" + "smithy.api#documentation": "The configuration specifies details about how the anomaly detection model is to be\n trained, including time ranges to exclude from use for training the model and the time\n zone to use for the metric.
" } }, "com.amazonaws.cloudwatch#AnomalyDetectorExcludedTimeRanges": { @@ -461,13 +461,13 @@ "ActionsEnabled": { "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { - "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state.
" + "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm\n state.
" } }, "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The actions to execute when this alarm transitions to the ALARM state from any other\n state. Each action is specified as an Amazon Resource Name (ARN).
" } }, "AlarmArn": { @@ -503,13 +503,13 @@ "InsufficientDataActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from\n any other state. Each action is specified as an Amazon Resource Name (ARN).
" } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The actions to execute when this alarm transitions to the OK state from any other\n state. Each action is specified as an Amazon Resource Name (ARN).
" } }, "StateReason": { @@ -527,7 +527,7 @@ "StateUpdatedTimestamp": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "Tracks the timestamp of any state update, even if StateValue doesn't change.
Tracks the timestamp of any state update, even if StateValue doesn't\n change.
\n\t\t\tThe timestamp \n\t\t\tof the last change \n\t\t\tto the alarm's StateValue.\n\t\t
The timestamp of the last change to the alarm's StateValue.
\n\t\t\tWhen the value is ALARM, \n\t\t\tit means \n\t\t\tthat the actions are suppressed\n\t\t\tbecause the suppressor alarm is \n\t\t\tin ALARM\n\t\t\tWhen the value is WaitPeriod, \n\t\t\tit means that \n\t\t\tthe actions are suppressed \n\t\t\tbecause the composite alarm is waiting\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto \n\t\t\tinto the ALARM state. \n\t\t\tThe maximum waiting time is as specified\n\t\t\tin ActionsSuppressorWaitPeriod. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t\tWhen the value is ExtensionPeriod,\n\t\t\tit means \n\t\t\tthat the actions are suppressed\n\t\t\tbecause the composite alarm is waiting \n\t\t\tafter the suppressor alarm went out\n\t\t\tof the ALARM state. \n\t\t\tThe maximum waiting time is as specified \n\t\t\tin ActionsSuppressorExtensionPeriod. \n\t\t\tAfter this time,\n\t\t\tthe composite alarm performs its actions.\n\t\t
When the value is ALARM, it means that the actions are suppressed\n because the suppressor alarm is in ALARM When the value is\n WaitPeriod, it means that the actions are suppressed because the\n composite alarm is waiting for the suppressor alarm to go into into the\n ALARM state. The maximum waiting time is as specified in\n ActionsSuppressorWaitPeriod. After this time, the composite alarm\n performs its actions. When the value is ExtensionPeriod, it means that the\n actions are suppressed because the composite alarm is waiting after the suppressor alarm\n went out of the ALARM state. The maximum waiting time is as specified in\n ActionsSuppressorExtensionPeriod. After this time, the composite alarm\n performs its actions.
\n\t\t\tCaptures the reason for action suppression.\n\t\t
" + "smithy.api#documentation": "Captures the reason for action suppression.
" } }, "ActionsSuppressor": { "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { - "smithy.api#documentation": "\n\t\t\tActions will be suppressed \n\t\t\tif the suppressor alarm is \n\t\t\tin the ALARM state. \n\t\t\tActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) \n\t\t\tfrom an existing alarm. \n\t\t
Actions will be suppressed if the suppressor alarm is in the ALARM\n state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name\n (ARN) from an existing alarm.
\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
The maximum time in seconds that the composite alarm waits for the suppressor alarm\n to go into the ALARM state. After this time, the composite alarm performs\n its actions.
\n WaitPeriod is required only when ActionsSuppressor is\n specified.
\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
The maximum time in seconds that the composite alarm waits after suppressor alarm\n goes out of the ALARM state. After this time, the composite alarm performs\n its actions.
\n ExtensionPeriod is required only when ActionsSuppressor is\n specified.
The time stamp of when the dashboard was last modified, either by an API call or\n\t\t\tthrough the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" + "smithy.api#documentation": "The time stamp of when the dashboard was last modified, either by an API call or\n through the console. This number is expressed as the number of milliseconds since Jan 1,\n 1970 00:00:00 UTC.
" } }, "Size": { @@ -743,7 +743,7 @@ "SampleCount": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "The number of metric values that contributed to the aggregate value of this\n\t\t\tdata point.
" + "smithy.api#documentation": "The number of metric values that contributed to the aggregate value of this data\n point.
" } }, "Average": { @@ -784,7 +784,7 @@ } }, "traits": { - "smithy.api#documentation": "Encapsulates the statistical data that CloudWatch computes from metric data.
" + "smithy.api#documentation": "Encapsulates the statistical data that CloudWatch computes from metric\n data.
" } }, "com.amazonaws.cloudwatch#DatapointValue": { @@ -833,7 +833,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more\n\t\t\tthan one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't\n\t\t\tdelete two composite alarms with one operation.
\n\n\t\t\tIf you specify an incorrect alarm name or make any other error in the operation, no alarms are\n\t\t\tdeleted. To confirm that alarms were deleted successfully, you can use \n\t\t\tthe DescribeAlarms operation after using\n\t\tDeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\nTo get out of such a situation, you must\n\t\t\t\tbreak 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\n\t\t\t\tchange 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.\n\t\t\t
\nDeletes the specified alarms. You can delete up to 100 alarms in one operation.\n However, this total can include no more than one composite alarm. For example, you could\n delete 99 metric alarms and one composite alarms with one operation, but you can't\n delete two composite alarms with one operation.
\n If you specify an incorrect alarm name or make any other error in the operation,\n no alarms are deleted. To confirm that alarms were deleted successfully, you can use the\n DescribeAlarms operation after using DeleteAlarms.
It is possible to create a loop or cycle of composite alarms, where composite\n alarm A depends on composite alarm B, and composite alarm B also depends on\n composite alarm A. In this scenario, you can't delete any composite alarm that is\n part of the cycle because there is always still a composite alarm that depends on\n that alarm that you want to delete.
\nTo get out of such a situation, you must break the cycle by changing the rule of\n one of the composite alarms in the cycle to remove a dependency that creates the\n cycle. The simplest change to make to break a cycle is to change the\n AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch\n detects a cycle in the evaluation path.
\n\n\t\t\tDeletes the specified anomaly detection model \n\t\t\tfrom your account.\n\t\t\tFor more information \n\t\t\tabout \n\t\t\thow to delete an anomaly detection model, \n\t\t\tsee Deleting an anomaly detection model \n\t\t\tin the CloudWatch User Guide. \n\t\t
" + "smithy.api#documentation": "Deletes the specified anomaly detection model from your account. For more information\n about how to delete an anomaly detection model, see Deleting an anomaly detection model in the CloudWatch User\n Guide.
" } }, "com.amazonaws.cloudwatch#DeleteAnomalyDetectorInput": { @@ -923,13 +923,13 @@ "SingleMetricAnomalyDetector": { "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", "traits": { - "smithy.api#documentation": "A single metric anomaly detector to be deleted.
\nWhen using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:
\n Dimensions,
\n MetricName\n
\n Namespace\n
\n Stat\n
the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput\n
Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.
A single metric anomaly detector to be deleted.
\nWhen using SingleMetricAnomalyDetector, you cannot include the following\n parameters in the same operation:
\n Dimensions,
\n MetricName\n
\n Namespace\n
\n Stat\n
the MetricMathAnomalyDetector parameters of\n DeleteAnomalyDetectorInput\n
Instead, specify the single metric anomaly detector attributes as part of the\n SingleMetricAnomalyDetector property.
The metric math anomaly detector to be deleted.
\nWhen using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:
\n Dimensions,
\n MetricName\n
\n Namespace\n
\n Stat\n
the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput\n
Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.
The metric math anomaly detector to be deleted.
\nWhen using MetricMathAnomalyDetector, you cannot include following\n parameters in the same operation:
\n Dimensions,
\n MetricName\n
\n Namespace\n
\n Stat\n
the SingleMetricAnomalyDetector parameters of\n DeleteAnomalyDetectorInput\n
Instead, specify the metric math anomaly detector attributes as part of the\n MetricMathAnomalyDetector property.
Deletes all dashboards that you specify. You\n\t\t\tcan specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are\n\t\t\tdeleted.
" + "smithy.api#documentation": "Deletes all dashboards that you specify. You can specify up to 100 dashboards to\n delete. If there is an error during this call, no dashboards are deleted.
" } }, "com.amazonaws.cloudwatch#DeleteDashboardsInput": { @@ -1007,7 +1007,7 @@ } ], "traits": { - "smithy.api#documentation": "Permanently deletes the specified Contributor Insights rules.
\nIf you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might\n\t\t\tnot be available.
" + "smithy.api#documentation": "Permanently deletes the specified Contributor Insights rules.
\nIf you create a rule, delete it, and then re-create it with the same name, historical\n data from the first time the rule was created might not be available.
" } }, "com.amazonaws.cloudwatch#DeleteInsightRulesInput": { @@ -1017,7 +1017,7 @@ "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
", + "smithy.api#documentation": "An array of the rule names to delete. If you need to find out the names of your rules,\n use DescribeInsightRules.
", "smithy.api#required": {} } } @@ -1032,7 +1032,7 @@ "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { - "smithy.api#documentation": "An array listing the rules that could not be deleted. You cannot delete built-in rules.
" + "smithy.api#documentation": "An array listing the rules that could not be deleted. You cannot delete built-in\n rules.
" } } }, @@ -1100,7 +1100,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.
\nCloudWatch retains the history of an alarm even if you delete the alarm.
\nTo use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.
Retrieves the history for the specified alarm. You can filter the results by date\n range or item type. If an alarm name is not specified, the histories for either all\n metric alarms or all composite alarms are returned.
\nCloudWatch retains the history of an alarm even if you delete the alarm.
\nTo use this operation and return information about a composite alarm, you must be\n signed on with the cloudwatch:DescribeAlarmHistory permission that is\n scoped to *. You can't return information about composite alarms if your\n cloudwatch:DescribeAlarmHistory permission has a narrower scope.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, \n\t\t\tonly metric alarms are returned.
" + "smithy.api#documentation": "Use this parameter to specify whether you want the operation to return metric alarms\n or composite alarms. If you omit this parameter, only metric alarms are returned.
" } }, "HistoryItemType": { @@ -1151,13 +1151,13 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" + "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n available.
" } }, "ScanBy": { "target": "com.amazonaws.cloudwatch#ScanBy", "traits": { - "smithy.api#documentation": "Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest\n\t\tevent history returned first, and specify TimestampAscending to have the oldest history returned first.
Specified whether to return the newest or oldest alarm history first. Specify\n TimestampDescending to have the newest event history returned first,\n and specify TimestampAscending to have the oldest history returned\n first.
Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.
\nTo use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.
Retrieves the specified alarms. You can filter the results by specifying a prefix\n for the alarm name, the alarm state, or a prefix for any action.
\nTo use this operation and return information about composite alarms, you must be\n signed on with the cloudwatch:DescribeAlarms permission that is scoped to\n *. You can't return information about composite alarms if your\n cloudwatch:DescribeAlarms permission has a narrower scope.
Retrieves the alarms for the specified metric. To\n\t\t\tfilter the results, specify a statistic, period, or unit.
\nThis operation retrieves only standard alarms that are based on\n\t\tthe specified metric. It does not return alarms based on math expressions that\n\t\tuse the specified metric, or composite alarms that use the specified metric.
" + "smithy.api#documentation": "Retrieves the alarms for the specified metric. To filter the results, specify a\n statistic, period, or unit.
\nThis operation retrieves only standard alarms that are based on the specified\n metric. It does not return alarms based on math expressions that use the specified\n metric, or composite alarms that use the specified metric.
" } }, "com.amazonaws.cloudwatch#DescribeAlarmsForMetricInput": { @@ -1273,19 +1273,19 @@ "Statistic": { "target": "com.amazonaws.cloudwatch#Statistic", "traits": { - "smithy.api#documentation": "The statistic for the metric, other than percentiles.\n\t\t For percentile statistics, use ExtendedStatistics.
The statistic for the metric, other than percentiles. For percentile statistics,\n use ExtendedStatistics.
The percentile statistic for the metric. Specify a value between\n\t\t p0.0 and p100.
" + "smithy.api#documentation": "The percentile statistic for the metric. Specify a value between p0.0 and\n p100.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "The dimensions associated with the metric. If the metric has any associated\n\t\t\tdimensions, you must specify them in order for the call to succeed.
" + "smithy.api#documentation": "The dimensions associated with the metric. If the metric has any associated\n dimensions, you must specify them in order for the call to succeed.
" } }, "Period": { @@ -1331,37 +1331,37 @@ "AlarmNamePrefix": { "target": "com.amazonaws.cloudwatch#AlarmNamePrefix", "traits": { - "smithy.api#documentation": "An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names\n\t\t\tthat start with this prefix.
\nIf this parameter\n\t\t\tis specified, you cannot specify AlarmNames.
An alarm name prefix. If you specify this parameter, you receive information about\n all alarms that have names that start with this prefix.
\nIf this parameter is specified, you cannot specify\n AlarmNames.
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you \n\t\t\tomit this parameter, \n\t\tonly metric alarms are returned, even if composite alarms exist in the account.
\nFor example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric\n\t\talarms. It does not return any composite alarms, even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of composite\n\t\t\talarms, and does not return any metric alarms.
Use this parameter to specify whether you want the operation to return metric alarms\n or composite alarms. If you omit this parameter, only metric alarms are returned, even\n if composite alarms exist in the account.
\nFor example, if you omit this parameter or specify MetricAlarms, the\n operation returns only a list of metric alarms. It does not return any composite alarms,\n even if composite alarms exist in the account.
If you specify CompositeAlarms, the operation returns only a list of\n composite alarms, and does not return any metric alarms.
If you use this parameter and specify the name of a composite alarm, the operation returns \n\t\t\tinformation about the \"children\" alarms\n\t\t\tof the alarm you specify. These are the metric alarms and composite alarms referenced in the \n\t\t\tAlarmRule field of the composite alarm that you specify in \n\t\t\tChildrenOfAlarmName. Information about the composite alarm that you name in \n\t\t\tChildrenOfAlarmName is not returned.
If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you\n\t\t\treceive a validation\n\t\t\terror.
Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp \n\t\t\tinformation are returned by this operation \n\t\t\twhen you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.
If you use this parameter and specify the name of a composite alarm, the operation\n returns information about the \"children\" alarms of the alarm you specify. These are the\n metric alarms and composite alarms referenced in the AlarmRule field of the\n composite alarm that you specify in ChildrenOfAlarmName. Information about\n the composite alarm that you name in ChildrenOfAlarmName is not\n returned.
If you specify ChildrenOfAlarmName, you cannot specify any other\n parameters in the request except for MaxRecords and NextToken.\n If you do so, you receive a validation error.
Only the Alarm Name, ARN, StateValue\n (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are\n returned by this operation when you use this parameter. To get complete information\n about these alarms, perform another DescribeAlarms operation and\n specify the parent alarm names in the AlarmNames parameter.
If you use this parameter and specify the name of a metric or composite alarm, the operation returns \n\t\t\tinformation about the \"parent\" alarms\n\t\t\tof the alarm you specify. These are the composite alarms that have AlarmRule\n\t\t\tparameters that reference \n\t\t\tthe alarm named in ParentsOfAlarmName. Information about the alarm that you specify in\n\t\t\tParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except\n\t\t\tfor MaxRecords and NextToken. If you do so, you receive a validation\n\t\t\terror.
Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about\n\t\t\tthese alarms, perform another DescribeAlarms operation and specify\n\t\t\tthe parent alarm names in the AlarmNames parameter.
If you use this parameter and specify the name of a metric or composite alarm, the\n operation returns information about the \"parent\" alarms of the alarm you specify. These\n are the composite alarms that have AlarmRule parameters that reference the\n alarm named in ParentsOfAlarmName. Information about the alarm that you\n specify in ParentsOfAlarmName is not returned.
If you specify ParentsOfAlarmName, you cannot specify any other\n parameters in the request except for MaxRecords and NextToken.\n If you do so, you receive a validation error.
Only the Alarm Name and ARN are returned by this operation when you use this\n parameter. To get complete information about these alarms, perform another\n DescribeAlarms operation and specify the parent alarm names in the\n AlarmNames parameter.
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
" + "smithy.api#documentation": "Specify this parameter to receive information only about alarms that are currently\n in the state that you specify.
" } }, "ActionPrefix": { "target": "com.amazonaws.cloudwatch#ActionPrefix", "traits": { - "smithy.api#documentation": "Use this parameter to filter the results of the operation to only those alarms that\n\t\tuse a certain alarm action. For example, you could specify the ARN of an SNS topic to find all\n\t\talarms that send notifications to that topic.
" + "smithy.api#documentation": "Use this parameter to filter the results of the operation to only those alarms that\n use a certain alarm action. For example, you could specify the ARN of an SNS topic to\n find all alarms that send notifications to that topic.
" } }, "MaxRecords": { @@ -1373,7 +1373,7 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" + "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n available.
" } } }, @@ -1430,7 +1430,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the anomaly detection models that you have created in your account.\n\t\t\tFor single metric anomaly detectors, \n\t\t\tyou can list all of the models in your account or filter the results \n\t\t\tto only the models that are related to a certain namespace, metric name, or metric dimension.\n\t\t\tFor metric math anomaly detectors, \n\t\t\tyou can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. \n\t\t\tThis will return all metric math anomaly detectors in your account.
Lists the anomaly detection models that you have created in your account. For single\n metric anomaly detectors, you can list all of the models in your account or filter the\n results to only the models that are related to a certain namespace, metric name, or\n metric dimension. For metric math anomaly detectors, you can list them by adding\n METRIC_MATH to the AnomalyDetectorTypes array. This will\n return all metric math anomaly detectors in your account.
Use the token returned by the previous operation to request the next page of results.
" + "smithy.api#documentation": "Use the token returned by the previous operation to request the next page of\n results.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#MaxReturnedResultsCount", "traits": { - "smithy.api#documentation": "The maximum number of results to return in one operation. The maximum\n\t\t\tvalue that you can specify is 100.
\nTo retrieve the remaining results, make another call with the returned \n\t\t\tNextToken value.
The maximum number of results to return in one operation. The maximum value that you\n can specify is 100.
\nTo retrieve the remaining results, make another call with the returned\n NextToken value.
Limits the results to only the anomaly detection models that\n\t\t\tare associated with the specified namespace.
" + "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n specified namespace.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric name. If there are multiple metrics with this name in different\n\t\t\tnamespaces that have anomaly detection models, they're all returned.
" + "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n specified metric name. If there are multiple metrics with this name in different\n namespaces that have anomaly detection models, they're all returned.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric dimensions. If there are multiple metrics that have these dimensions\n\t\t\tand have anomaly detection models associated, they're all returned.
" + "smithy.api#documentation": "Limits the results to only the anomaly detection models that are associated with the\n specified metric dimensions. If there are multiple metrics that have these dimensions\n and have anomaly detection models associated, they're all returned.
" } }, "AnomalyDetectorTypes": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorTypes", "traits": { - "smithy.api#documentation": "The anomaly detector types to request when using DescribeAnomalyDetectorsInput.\n\t\t\tIf empty, defaults to SINGLE_METRIC.
The anomaly detector types to request when using\n DescribeAnomalyDetectorsInput. If empty, defaults to\n SINGLE_METRIC.
A token that you can use in a subsequent operation to \n\t\tretrieve the next set of results.
" + "smithy.api#documentation": "A token that you can use in a subsequent operation to retrieve the next set of\n results.
" } } }, @@ -1517,7 +1517,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of all the Contributor Insights rules in your account.
\nFor more information about Contributor Insights, see \n\t\tUsing Contributor Insights to Analyze High-Cardinality Data.
", + "smithy.api#documentation": "Returns a list of all the Contributor Insights rules in your account.
\nFor more information about Contributor Insights, see Using Contributor\n Insights to Analyze High-Cardinality Data.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1531,13 +1531,13 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "Include this value, if it was returned by the previous operation, to get the next set of rules.
" + "smithy.api#documentation": "Include this value, if it was returned by the previous operation, to get the next set\n of rules.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#InsightRuleMaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results to return in one operation. If you omit this\n\t\tparameter, the default of 500 is used.
" + "smithy.api#documentation": "The maximum number of results to return in one operation. If you omit this parameter,\n the default of 500 is used.
" } } }, @@ -1551,7 +1551,7 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "If this parameter is present, it is a token that marks the start of the next batch of returned results.
" + "smithy.api#documentation": "If this parameter is present, it is a token that marks the start of the next batch of\n returned results.
" } }, "InsightRules": { @@ -1572,7 +1572,7 @@ "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the dimension. Dimension names must contain only ASCII characters, must include \n\t\t\tat least one non-whitespace character, and cannot start with a colon (:).\n\t\t\tASCII\n\t\t\tcontrol characters are not supported as part of dimension names.
The name of the dimension. Dimension names must contain only ASCII characters, must\n include at least one non-whitespace character, and cannot start with a colon\n (:). ASCII control characters are not supported as part of dimension\n names.
The value of the dimension. Dimension values must contain only ASCII characters and must include \n\t\t\tat least one non-whitespace character. ASCII\n\t\t\tcontrol characters are not supported as part of dimension values.
", + "smithy.api#documentation": "The value of the dimension. Dimension values must contain only ASCII characters and\n must include at least one non-whitespace character. ASCII control characters are not\n supported as part of dimension values.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You \n\t\tcan assign up to 30 dimensions to a metric.
" + "smithy.api#documentation": "A dimension is a name/value pair that is part of the identity of a metric. Because\n dimensions are part of the unique identifier for a metric, whenever you add a unique\n name/value pair to one of your metrics, you are creating a new variation of that metric.\n For example, many Amazon EC2 metrics publish InstanceId as a\n dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1662,7 +1662,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Disables the actions for the specified alarms. When an alarm's actions are disabled, the\n\t\t\talarm actions do not execute when the alarm state changes.
" + "smithy.api#documentation": "Disables the actions for the specified alarms. When an alarm's actions are\n disabled, the alarm actions do not execute when the alarm state changes.
" } }, "com.amazonaws.cloudwatch#DisableAlarmActionsInput": { @@ -1698,7 +1698,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do \n\t\tnot incur costs.
" + "smithy.api#documentation": "Disables the specified Contributor Insights rules. When rules are disabled, they do\n not analyze log groups and do not incur costs.
" } }, "com.amazonaws.cloudwatch#DisableInsightRulesInput": { @@ -1708,7 +1708,7 @@ "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
", + "smithy.api#documentation": "An array of the rule names to disable. If you need to find out the names of your\n rules, use DescribeInsightRules.
", "smithy.api#required": {} } } @@ -1723,7 +1723,7 @@ "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { - "smithy.api#documentation": "An array listing the rules that could not be disabled. You cannot disable built-in rules.
" + "smithy.api#documentation": "An array listing the rules that could not be disabled. You cannot disable built-in\n rules.
" } } }, @@ -1779,7 +1779,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
" + "smithy.api#documentation": "Enables the specified Contributor Insights rules. When rules are enabled, they\n immediately begin analyzing log data.
" } }, "com.amazonaws.cloudwatch#EnableInsightRulesInput": { @@ -1789,7 +1789,7 @@ "target": "com.amazonaws.cloudwatch#InsightRuleNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
", + "smithy.api#documentation": "An array of the rule names to enable. If you need to find out the names of your rules,\n use DescribeInsightRules.
", "smithy.api#required": {} } } @@ -1804,7 +1804,7 @@ "Failures": { "target": "com.amazonaws.cloudwatch#BatchFailures", "traits": { - "smithy.api#documentation": "An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
" + "smithy.api#documentation": "An array listing the rules that could not be enabled. You cannot disable or enable\n built-in rules.
" } } }, @@ -1812,6 +1812,118 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudwatch#Entity": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.cloudwatch#EntityKeyAttributesMap", + "traits": { + "smithy.api#documentation": "The attributes of the entity which identify the specific entity, as a list of \n key-value pairs. Entities with the same KeyAttributes are considered to be\n the same entity. For an entity to be valid, the KeyAttributes must exist\n and be formatted correctly.
There are five allowed attributes (key names): Type,\n ResourceType, Identifier, Name, and\n Environment.
For details about how to use the key attributes to specify an entity, see How to add related \n information to telemetry in the CloudWatch User \n Guide.
" + } + }, + "Attributes": { + "target": "com.amazonaws.cloudwatch#EntityAttributesMap", + "traits": { + "smithy.api#documentation": "Additional attributes of the entity that are not used to specify the identity of the\n entity. A list of key-value pairs.
\nFor details about how to use the attributes, see How to add related information to \n telemetry in the CloudWatch User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An entity associated with metrics, to allow for finding related telemetry. An entity\n is typically a resource or service within your system. For example, metrics from an\n Amazon EC2 instance could be associated with that instance as the entity. \n Similarly, metrics from a service that you own could be associated with that service as \n the entity.
" + } + }, + "com.amazonaws.cloudwatch#EntityAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatch#EntityAttributesMapKeyString" + }, + "value": { + "target": "com.amazonaws.cloudwatch#EntityAttributesMapValueString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.cloudwatch#EntityAttributesMapKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudwatch#EntityAttributesMapValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.cloudwatch#EntityKeyAttributesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudwatch#EntityKeyAttributesMapKeyString" + }, + "value": { + "target": "com.amazonaws.cloudwatch#EntityKeyAttributesMapValueString" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + } + } + }, + "com.amazonaws.cloudwatch#EntityKeyAttributesMapKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.cloudwatch#EntityKeyAttributesMapValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.cloudwatch#EntityMetricData": { + "type": "structure", + "members": { + "Entity": { + "target": "com.amazonaws.cloudwatch#Entity", + "traits": { + "smithy.api#documentation": "The entity associated with the metrics.
" + } + }, + "MetricData": { + "target": "com.amazonaws.cloudwatch#MetricData", + "traits": { + "smithy.api#documentation": "The metric data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of metrics that are associated with an entity, such as a specific service\n or resource. Contains the entity and the list of metric data associated with it.
" + } + }, + "com.amazonaws.cloudwatch#EntityMetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#EntityMetricData" + } + }, "com.amazonaws.cloudwatch#ErrorMessage": { "type": "string", "traits": { @@ -1899,7 +2011,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays the details of the dashboard that you specify.
\nTo copy an existing dashboard, use GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard to create\n\t\t\tthe copy.
Displays the details of the dashboard that you specify.
\nTo copy an existing dashboard, use GetDashboard, and then use the data\n returned within DashboardBody as the template for the new dashboard when\n you call PutDashboard to create the copy.
The detailed information about the dashboard, including what widgets are included and their location\n\t\t\ton the dashboard. For more information about the DashboardBody syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.
The detailed information about the dashboard, including what widgets are included\n and their location on the dashboard. For more information about the\n DashboardBody syntax, see Dashboard Body Structure and Syntax.
This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of \n\t\tcontributors to the log group.
\nYou can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:
\n\n UniqueContributors -- the number of unique contributors for each data point.
\n MaxContributorValue -- the value of the top contributor for each data point. The identity of the\n\t\t\t\t\tcontributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the \n\t\t\t\t\tmost occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified\n\t\t\t\t\tby the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the rule.
\n Sum -- the sum of the values from all contributors during the time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the time period represented by that data point.
\n Average -- the average value from all contributors during the time period represented by that data point.
This operation returns the time series data collected by a Contributor Insights rule.\n The data includes the identity and number of contributors to the log group.
\nYou can also optionally return one or more statistics about each data point in the\n time series. These statistics can include the following:
\n\n UniqueContributors -- the number of unique contributors for each\n data point.
\n MaxContributorValue -- the value of the top contributor for each\n data point. The identity of the contributor might change for each data point in\n the graph.
If this rule aggregates by COUNT, the top contributor for each data point is\n the contributor with the most occurrences in that period. If the rule aggregates\n by SUM, the top contributor is the contributor with the highest sum in the log\n field specified by the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the\n rule.
\n Sum -- the sum of the values from all contributors during the\n time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the\n time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the\n time period represented by that data point.
\n Average -- the average value from all contributors during the\n time period represented by that data point.
The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
The start time of the data to use in the report. When used in a raw HTTP Query API, it\n is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,\n 2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as \n\t\t\tyyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
The end time of the data to use in the report. When used in a raw HTTP Query API, it\n is formatted as yyyy-MM-dd'T'HH:mm:ss. For example,\n 2019-07-01T23:59:59.
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
The period, in seconds, to use for the statistics in the\n InsightRuleMetricDatapoint results.
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
" + "smithy.api#documentation": "The maximum number of contributors to include in the report. The range is 1 to 100. If\n you omit this, the default of 10 is used.
" } }, "Metrics": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricList", "traits": { - "smithy.api#documentation": "Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more\n\t\tof the following metrics:
\n\n UniqueContributors -- the number of unique contributors for each data point.
\n MaxContributorValue -- the value of the top contributor for each data point. The identity of the\n\t\t\t\t\tcontributor might change for each data point in the graph.
If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the \n\t\t\t\t\tmost occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified\n\t\t\t\t\tby the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the rule.
\n Sum -- the sum of the values from all contributors during the time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the time period represented by that data point.
\n Average -- the average value from all contributors during the time period represented by that data point.
Specifies which metrics to use for aggregation of contributor values for the report.\n You can specify one or more of the following metrics:
\n\n UniqueContributors -- the number of unique contributors for each\n data point.
\n MaxContributorValue -- the value of the top contributor for each\n data point. The identity of the contributor might change for each data point in\n the graph.
If this rule aggregates by COUNT, the top contributor for each data point is\n the contributor with the most occurrences in that period. If the rule aggregates\n by SUM, the top contributor is the contributor with the highest sum in the log\n field specified by the rule's Value, during that period.
\n SampleCount -- the number of data points matched by the\n rule.
\n Sum -- the sum of the values from all contributors during the\n time period represented by that data point.
\n Minimum -- the minimum value from a single observation during the\n time period represented by that data point.
\n Maximum -- the maximum value from a single observation during the\n time period represented by that data point.
\n Average -- the average value from all contributors during the\n time period represented by that data point.
Determines what statistic to use to rank the contributors. Valid values are Sum and Maximum.
Determines what statistic to use to rank the contributors. Valid values are\n Sum and Maximum.
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. \n\t\t\tIf the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
" + "smithy.api#documentation": "An array of the strings used as the keys for this rule. The keys are the dimensions\n used to classify contributors. If the rule contains more than one key, then each unique\n combination of values for the keys is counted as a unique contributor.
" } }, "AggregationStatistic": { @@ -2049,19 +2161,19 @@ "ApproximateUniqueCount": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundLong", "traits": { - "smithy.api#documentation": "An approximate count of the unique contributors found by this rule in this time period.
" + "smithy.api#documentation": "An approximate count of the unique contributors found by this rule in this time\n period.
" } }, "Contributors": { "target": "com.amazonaws.cloudwatch#InsightRuleContributors", "traits": { - "smithy.api#documentation": "An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values\n\t\tfor the keys counts as a unique contributor.
" + "smithy.api#documentation": "An array of the unique contributors found by this rule in this time period. If the\n rule contains multiple keys, each combination of values for the keys counts as a unique\n contributor.
" } }, "MetricDatapoints": { "target": "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints", "traits": { - "smithy.api#documentation": "A time series of metric data points that matches the time period in the rule request.
" + "smithy.api#documentation": "A time series of metric data points that matches the time period in the rule\n request.
" } } }, @@ -2083,7 +2195,7 @@ } ], "traits": { - "smithy.api#documentation": "You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan 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\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.
If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.
Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.
Amazon CloudWatch retains metric data as follows:
\nData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata 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, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.
\nIf you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
\n Using Metrics Insights queries with metric math\n
\nYou can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.
", + "smithy.api#documentation": "You can use the GetMetricData API to retrieve CloudWatch metric\n values. The operation can also include a CloudWatch Metrics Insights query, and\n one or more metric math functions.
A GetMetricData operation that does not include a query can retrieve\n as many as 500 different metrics in a single request, with a total of as many as 100,800\n data points. You can also optionally perform metric math expressions on the values of\n the returned statistics, to create new time series that represent new insights into your\n data. For example, using Lambda metrics, you could divide the Errors metric by the\n Invocations metric to get an error rate time series. For more information about metric\n math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n Guide.
If you include a Metrics Insights query, each GetMetricData operation can\n include only one query. But the same GetMetricData operation can also\n retrieve other metrics. Metrics Insights queries can query only the most recent three\n 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\n calls to GetMetricStatistics. For more information about pricing, see\n Amazon CloudWatch\n Pricing.
Amazon CloudWatch retains metric data as follows:
\nData points with a period of less than 60 seconds are available for 3\n hours. These data points are high-resolution metrics and are available only for\n custom metrics that have been defined with a StorageResolution of\n 1.
Data points with a period of 60 seconds (1-minute) are available for 15\n days.
\nData points with a period of 300 seconds (5-minute) are available for 63\n days.
\nData points with a period of 3600 seconds (1 hour) are available for 455\n days (15 months).
\nData points that are initially published with a shorter period are aggregated\n together for long-term storage. For example, if you collect data using a period of 1\n minute, the data remains available for 15 days with 1-minute resolution. After 15 days,\n this data is still available, but is aggregated and retrievable only with a resolution\n of 5 minutes. After 63 days, the data is further aggregated and is available with a\n resolution of 1 hour.
\nIf you omit Unit in your request, all data that was collected with any\n unit is returned, along with the corresponding units that were specified when the data\n was reported to CloudWatch. If you specify a unit, the operation returns only data that\n was collected with that unit specified. If you specify a unit that does not match the\n data collected, the results of the operation are null. CloudWatch does not perform unit\n conversions.
\n Using Metrics Insights queries with metric\n math\n
\nYou can't mix a Metric Insights query and metric math syntax in the same expression,\n but you can reference results from a Metrics Insights query within other Metric math\n expressions. A Metrics Insights query without a GROUP\n BY clause returns a single time-series (TS), and can be used as input for\n a metric math expression that expects a single time series. A Metrics Insights query\n with a GROUP BY clause returns an array of time-series\n (TS[]), and can be used as input for a metric math expression that expects an array of\n time series.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2098,7 +2210,7 @@ "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The metric queries to be returned. A single GetMetricData call can \n\t\t\tinclude as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.
The metric queries to be returned. A single GetMetricData call can\n include as many as 500 MetricDataQuery structures. Each of these structures\n can specify either a metric to retrieve, a Metrics Insights query, or a math expression\n to perform on retrieved data.
The time stamp indicating the earliest data to be returned.
\nThe value specified is inclusive; results include data points with the specified time stamp.
\nCloudWatch rounds the specified time stamp as follows:
\nStart time less than 15 days ago - Round down to the nearest whole minute.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour clock interval.\n\t\t\t\tFor example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t
For better performance, specify StartTime and EndTime\n\t\tvalues that align with the value of the metric's Period and sync up with\n\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\tis 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the earliest data to be returned.
\nThe value specified is inclusive; results include data points with the specified\n time stamp.
\nCloudWatch rounds the specified time stamp as follows:
\nStart time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values\n that align with the value of the metric's Period and sync up with the\n beginning and end of an hour. For example, if the Period of a metric is 5\n minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n from CloudWatch than setting 12:07 or 12:29 as the StartTime.
The time stamp indicating the latest data to be returned.
\nThe value specified is exclusive; results include data points up to the specified time stamp.
\nFor better performance, specify StartTime and EndTime\n\t\t\tvalues that align with the value of the metric's Period and sync up with\n\t\t\tthe beginning and end of an hour. For example, if the Period of a metric\n\t\t\tis 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n\t\t\tfrom CloudWatch than setting 12:07 or 12:29 as the EndTime.
The time stamp indicating the latest data to be returned.
\nThe value specified is exclusive; results include data points up to the specified\n time stamp.
\nFor better performance, specify StartTime and EndTime values\n that align with the value of the metric's Period and sync up with the\n beginning and end of an hour. For example, if the Period of a metric is 5\n minutes, specifying 12:05 or 12:30 as EndTime can get a faster response\n from CloudWatch than setting 12:07 or 12:29 as the EndTime.
Include this value, if it was returned by the previous GetMetricData operation, \n\t\t\tto get the next set of data points.
Include this value, if it was returned by the previous GetMetricData\n operation, to get the next set of data points.
The order in which data points should be returned. TimestampDescending returns the newest data first and paginates\n\t\t\twhen the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates\n\t\t\twhen the MaxDatapoints limit is reached.
If you omit this parameter, the default of TimestampDescending is used.
The order in which data points should be returned. TimestampDescending\n returns the newest data first and paginates when the MaxDatapoints limit is\n reached. TimestampAscending returns the oldest data first and paginates\n when the MaxDatapoints limit is reached.
If you omit this parameter, the default of TimestampDescending is\n used.
The maximum number of data points the request should return before paginating. If you omit\n\t\t\tthis, the default of 100,800 is used.
" + "smithy.api#documentation": "The maximum number of data points the request should return before paginating. If you\n omit this, the default of 100,800 is used.
" } }, "LabelOptions": { "target": "com.amazonaws.cloudwatch#LabelOptions", "traits": { - "smithy.api#documentation": "This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels of returned data display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.
This structure includes the Timezone parameter, which you can use to\n specify your time zone so that the labels of returned data display the correct time for\n your time zone.
The metrics that are returned, including the metric name, namespace, and dimensions.
" + "smithy.api#documentation": "The metrics that are returned, including the metric name, namespace, and\n dimensions.
" } }, "NextToken": { @@ -2171,7 +2283,7 @@ "Messages": { "target": "com.amazonaws.cloudwatch#MetricDataResultMessages", "traits": { - "smithy.api#documentation": "Contains a message about this GetMetricData operation, if the operation results in such a message.\n\t\t\tAn example of a message that\n\t\t\tmight be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the\n\t\t\toperation as possible is still executed.
A message appears here only if it is related to the global GetMetricData operation. Any message\n\t\t\tabout a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.
Contains a message about this GetMetricData operation, if the operation\n results in such a message. An example of a message that might be returned is\n Maximum number of allowed metrics exceeded. If there is a message, as\n much of the operation as possible is still executed.
A message appears here only if it is related to the global GetMetricData\n operation. Any message about a specific metric returned by the operation appears in the\n MetricDataResult object returned for that metric.
Gets statistics for the specified metric.
\nThe maximum number of data points returned from a single call is 1,440. If \n\t\t\tyou request more than 1,440 data points, CloudWatch returns an error. \n\t\t\tTo reduce the number of data points, you can narrow the specified time range and make \n\t\t\tmultiple requests across adjacent time ranges, or you can increase the specified period. \n\t\t\tData points are not returned in chronological order.
\nCloudWatch aggregates data points based on the length of the period\n\t\t\tthat you specify. For example, if you request statistics with a one-hour period, \n\t\t\tCloudWatch aggregates all data points with time stamps that fall within each \n\t\t\tone-hour period. Therefore, the number of values aggregated by CloudWatch is larger than\n\t\t\tthe number of data points returned.
\nCloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:
\nThe SampleCount value of the statistic set is 1.
\nThe Min and the Max values of the statistic set are equal.
\nPercentile statistics are not available for metrics when any of the metric values are negative numbers.
\nAmazon CloudWatch retains metric data as follows:
\nData points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
\nData points with a period of 300 seconds (5-minute) are available for 63 days.
\nData points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
\nData points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata 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, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\ta resolution of 1 hour.
\nCloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
\nFor information about metrics and dimensions supported by Amazon Web Services services, see the \n\t\t\tAmazon CloudWatch Metrics and Dimensions Reference in the\n\t\t\tAmazon CloudWatch User Guide.
" + "smithy.api#documentation": "Gets statistics for the specified metric.
\nThe maximum number of data points returned from a single call is 1,440. If you\n request more than 1,440 data points, CloudWatch returns an error. To reduce the number\n of data points, you can narrow the specified time range and make multiple requests\n across adjacent time ranges, or you can increase the specified period. Data points are\n not returned in chronological order.
\nCloudWatch aggregates data points based on the length of the period that you\n specify. For example, if you request statistics with a one-hour period, CloudWatch\n aggregates all data points with time stamps that fall within each one-hour period.\n Therefore, the number of values aggregated by CloudWatch is larger than the number of\n data points returned.
\nCloudWatch needs raw data points to calculate percentile statistics. If you publish\n data using a statistic set instead, you can only retrieve percentile statistics for this\n data if one of the following conditions is true:
\nThe SampleCount value of the statistic set is 1.
\nThe Min and the Max values of the statistic set are equal.
\nPercentile statistics are not available for metrics when any of the metric values\n are negative numbers.
\nAmazon CloudWatch retains metric data as follows:
\nData points with a period of less than 60 seconds are available for 3\n hours. These data points are high-resolution metrics and are available only for\n custom metrics that have been defined with a StorageResolution of\n 1.
Data points with a period of 60 seconds (1-minute) are available for 15\n days.
\nData points with a period of 300 seconds (5-minute) are available for 63\n days.
\nData points with a period of 3600 seconds (1 hour) are available for 455\n days (15 months).
\nData points that are initially published with a shorter period are aggregated\n together for long-term storage. For example, if you collect data using a period of 1\n minute, the data remains available for 15 days with 1-minute resolution. After 15 days,\n this data is still available, but is aggregated and retrievable only with a resolution\n of 5 minutes. After 63 days, the data is further aggregated and is available with a\n resolution of 1 hour.
\nCloudWatch started retaining 5-minute and 1-hour metric data as of July 9,\n 2016.
\nFor information about metrics and dimensions supported by Amazon Web Services\n services, see the Amazon CloudWatch\n Metrics and Dimensions Reference in the Amazon CloudWatch User\n Guide.
" } }, "com.amazonaws.cloudwatch#GetMetricStatisticsInput": { @@ -2227,14 +2339,14 @@ "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { - "smithy.api#documentation": "The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. \n\t\t\tCloudWatch treats each unique combination of dimensions as a separate metric.\n\t\t If a specific combination of dimensions was not published, you can't retrieve statistics for it.\n\t\t You must specify the same dimensions that were used when the metrics were created. For an example,\n\t\t see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.
" + "smithy.api#documentation": "The dimensions. If the metric contains multiple dimensions, you must include a\n value for each dimension. CloudWatch treats each unique combination of dimensions as a\n separate metric. If a specific combination of dimensions was not published, you can't\n retrieve statistics for it. You must specify the same dimensions that were used when the\n metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User\n Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User\n Guide.
" } }, "StartTime": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time stamp that determines the first data point to return. Start times are \n\t\t\tevaluated relative to the time that CloudWatch receives the request.
\nThe value specified is inclusive; results include data points with the specified time stamp. \n\t \tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
\nCloudWatch rounds the specified time stamp as follows:
\nStart time less than 15 days ago - Round down to the nearest whole minute.\n\t\t\t For example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.\n\t\t\t For example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour clock interval.\n\t\t\t For example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is \n\t\t\trounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions\n\t\t\tof a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous \n\t\t\t10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to \n\t\t\t01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a \n\t\t\tperiod of 5 seconds, you receive data \n\t\t\ttimestamped between 15:02:15 and 15:07:15.\n\t\t
The time stamp that determines the first data point to return. Start times are\n evaluated relative to the time that CloudWatch receives the request.
\nThe value specified is inclusive; results include data points with the specified\n time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for\n example, 2016-10-03T23:00:00Z).
\nCloudWatch rounds the specified time stamp as follows:
\nStart time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.
\nStart time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.
\nStart time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.
\nIf you set Period to 5, 10, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.
The time stamp that determines the last data point to return.
\nThe value specified is exclusive; results include data points up to the specified time stamp.\n\t\t\tIn a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
", + "smithy.api#documentation": "The time stamp that determines the last data point to return.
\nThe value specified is exclusive; results include data points up to the specified\n time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for\n example, 2016-10-10T23:00:00Z).
", "smithy.api#required": {} } }, @@ -2250,26 +2362,26 @@ "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than\n\t\t 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
\nThe granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).
\nThe metric statistics, other than percentile. For percentile statistics,\n\t\t use ExtendedStatistics. When calling GetMetricStatistics, you must \n\t\tspecify either Statistics or ExtendedStatistics, but not both.
The metric statistics, other than percentile. For percentile statistics, use\n ExtendedStatistics. When calling GetMetricStatistics, you\n must specify either Statistics or ExtendedStatistics, but not\n both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must \n\t\t\tspecify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not \n\t\t\tavailable for metrics when any of the metric values are negative numbers.
The percentile statistics. Specify values between p0.0 and p100. When calling\n GetMetricStatistics, you must specify either Statistics or\n ExtendedStatistics, but not both. Percentile statistics are not\n available for metrics when any of the metric values are negative numbers.
The unit for a given metric. \n\t\t\tIf you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
The unit for a given metric. If you omit Unit, all data that was\n collected with any unit is returned, along with the corresponding units that were\n specified when the data was reported to CloudWatch. If you specify a unit, the operation\n returns only data that was collected with that unit specified. If you specify a unit\n that does not match the data collected, the results of the operation are null.\n CloudWatch does not perform unit conversions.
If this array of metric namespaces is present, then these\n\t\t\tnamespaces are the only\n\t\tmetric namespaces that are streamed by this metric stream.
" + "smithy.api#documentation": "If this array of metric namespaces is present, then these namespaces are the only\n metric namespaces that are streamed by this metric stream.
" } }, "ExcludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "If this array of metric namespaces is present, then these namespaces are the only\n\t\t\tmetric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in\n\t\tthe account are streamed by this metric stream.
" + "smithy.api#documentation": "If this array of metric namespaces is present, then these namespaces are the only\n metric namespaces that are not streamed by this metric stream. In this case, all other\n metric namespaces in the account are streamed by this metric stream.
" } }, "FirehoseArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric\n\t\t\tstream.
" + "smithy.api#documentation": "The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this\n metric stream.
" } }, "RoleArn": { @@ -2384,7 +2496,7 @@ "State": { "target": "com.amazonaws.cloudwatch#MetricStreamState", "traits": { - "smithy.api#documentation": "The state of the metric stream. The possible values are running\n\t\tand stopped.
The state of the metric stream. The possible values are running and\n stopped.
The output format for the stream. \n\t\t\tValid values are json, opentelemetry1.0, and opentelemetry0.7. \n\t\t\tFor more information about metric stream output formats, \n\t\t\tsee Metric streams output formats.
The output format for the stream. Valid values are json,\n opentelemetry1.0, and opentelemetry0.7. For more\n information about metric stream output formats, see Metric streams output formats.
Each entry in this array displays information about one or more metrics that include additional statistics\n\t\t\tin the metric stream. For more information about the additional statistics, see \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.
" + "smithy.api#documentation": "Each entry in this array displays information about one or more metrics that include\n additional statistics in the metric stream. For more information about the additional\n statistics, see \n CloudWatch statistics definitions.
" } }, "IncludeLinkedAccountsMetrics": { "target": "com.amazonaws.cloudwatch#IncludeLinkedAccountsMetrics", "traits": { - "smithy.api#documentation": "If this is true and this metric stream is in a monitoring account, then the stream includes\n\t\t\tmetrics from source accounts that the monitoring account is linked to.
If this is true and this metric stream is in a monitoring account, then\n the stream includes metrics from source accounts that the monitoring account is linked\n to.
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of \n\t\t\tone or more Amazon CloudWatch metrics as a bitmap image. You can then embed this \n\t\t\timage into your services and products, such as wiki pages, reports, and documents. \n\t\t\tYou could also retrieve images regularly, such as every minute, and create your own \n\t\t\tcustom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math\n\t\tand horizontal and vertical annotations.
\nThere is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:
As many as 100 metrics in the graph.
\nUp to 100 KB uncompressed payload.
\nYou can use the GetMetricWidgetImage API to retrieve a snapshot graph\n of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this\n image into your services and products, such as wiki pages, reports, and documents. You\n could also retrieve images regularly, such as every minute, and create your own custom\n live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including\n metric math and horizontal and vertical annotations.
\nThere is a limit of 20 transactions per second for this API. Each\n GetMetricWidgetImage action has the following limits:
As many as 100 metrics in the graph.
\nUp to 100 KB uncompressed payload.
\nA JSON string that defines the bitmap graph to be retrieved. The string includes the \n\t\t\tmetrics to include in the graph, statistics, annotations, title, axis limits, and so on. \n\t\t\tYou can include only one MetricWidget parameter in each GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see \n\t\t\tGetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation\n\t\t\tpoint appears next to the graph legend.
", + "smithy.api#documentation": "A JSON string that defines the bitmap graph to be retrieved. The string includes\n the metrics to include in the graph, statistics, annotations, title, axis limits, and so\n on. You can include only one MetricWidget parameter in each\n GetMetricWidgetImage call.
For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax.
If any metric on the graph could not load all the requested data points, an orange\n triangle with an exclamation point appears next to the graph legend.
", "smithy.api#required": {} } }, "OutputFormat": { "target": "com.amazonaws.cloudwatch#OutputFormat", "traits": { - "smithy.api#documentation": "The format of the resulting image. Only PNG images are supported.
\nThe default is png. If you specify png, the API returns an HTTP response with the \n\t\t\tcontent-type set to text/xml. The image data is in a MetricWidgetImage \n\t\t\tfield. For example:
\n \n\t\t\t\n
\n \n
\n \n
\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n
\n \n
\n \n
\n \n
\n \n
\n \n
\n \n
The image/png setting is intended only for custom HTTP requests. For most\n\t\t\tuse cases, and all actions using an Amazon Web Services SDK, you should use png. If you specify \n\t\t\timage/png, the HTTP response has a content-type set to image/png, \n\t\t\tand the body of the response is a PNG image.
The format of the resulting image. Only PNG images are supported.
\nThe default is png. If you specify png, the API returns\n an HTTP response with the content-type set to text/xml. The image data is\n in a MetricWidgetImage field. For example:
\n \n
\n \n
\n \n
\n iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...\n
\n \n
\n \n
\n \n
\n \n \n
\n \n
\n \n
The image/png setting is intended only for custom HTTP requests. For\n most use cases, and all actions using an Amazon Web Services SDK, you should use\n png. If you specify image/png, the HTTP response has a\n content-type set to image/png, and the body of the response is a PNG \n image.
The image of the graph, in the output format specified. The output is base64-encoded.
" + "smithy.api#documentation": "The image of the graph, in the output format specified. The output is\n base64-encoded.
" } } }, @@ -2602,7 +2714,7 @@ "name": "monitoring" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.
\nCloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.
\nIn addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.
", + "smithy.api#documentation": "Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services)\n resources and the applications you run on Amazon Web Services in real time. You can use\n CloudWatch to collect and track metrics, which are the variables you want to\n measure for your resources and applications.
\nCloudWatch alarms send notifications or automatically change the resources you are\n monitoring based on rules that you define. For example, you can monitor the CPU usage\n and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine\n whether you should launch additional instances to handle increased load. You can also\n use this data to stop under-used instances to save money.
\nIn addition to monitoring the built-in metrics that come with Amazon Web Services,\n you can monitor your own custom metrics. With CloudWatch, you gain system-wide\n visibility into resource utilization, application performance, and operational\n health.
", "smithy.api#title": "Amazon CloudWatch", "smithy.api#xmlNamespace": { "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" @@ -3696,7 +3808,7 @@ "target": "com.amazonaws.cloudwatch#InsightRuleSchema", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For managed rules, \n\t\t\tthis is {\"Name\": \"ServiceLogRule\", \"Version\": 1}\n
For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\",\n \"Version\": 1}. For managed rules, this is {\"Name\": \"ServiceLogRule\",\n \"Version\": 1}\n
The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, \n\t\t\tthe value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\t\tRule Syntax.
", + "smithy.api#documentation": "The definition of the rule, as a JSON object. The definition contains the keywords\n used to define contributors, the value to aggregate on if this rule returns a sum\n instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
", "smithy.api#required": {} } }, "ManagedRule": { "target": "com.amazonaws.cloudwatch#InsightRuleIsManaged", "traits": { - "smithy.api#documentation": "\n\t\t\tAn optional built-in rule that Amazon Web Services manages.\n\t\t
" + "smithy.api#documentation": "An optional built-in rule that Amazon Web Services manages.
" } } }, "traits": { - "smithy.api#documentation": "This structure contains the definition \n\t\t\tfor a Contributor Insights rule.\n\t\t\tFor more information about this rule, \n\t\t\tsee\n\t\t\t\tUsing Constributor Insights to analyze high-cardinality data \n\t\t\tin the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "This structure contains the definition for a Contributor Insights rule. For more\n information about this rule, see Using Constributor Insights to analyze high-cardinality data in the\n Amazon CloudWatch User Guide.
" } }, "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic": { @@ -3729,7 +3841,7 @@ "target": "com.amazonaws.cloudwatch#InsightRuleContributorKeys", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "One of the log entry field keywords that is used to define contributors for this rule.
", + "smithy.api#documentation": "One of the log entry field keywords that is used to define contributors for this\n rule.
", "smithy.api#required": {} } }, @@ -3745,13 +3857,13 @@ "target": "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
", + "smithy.api#documentation": "An array of the data points where this contributor is present. Only the data points\n when this contributor appeared are included in the array.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then\n\t\t\ta unique contributor is a unique combination of values from all the keys in the rule.
\nIf the rule contains a single key, then each unique contributor is each unique value for this key.
\nFor more information, see GetInsightRuleReport.
" + "smithy.api#documentation": "One of the unique contributors found by a Contributor Insights rule. If the rule\n contains multiple keys, then a unique contributor is a unique combination of values from\n all the keys in the rule.
\nIf the rule contains a single key, then each unique contributor is each unique value\n for this key.
\nFor more information, see GetInsightRuleReport.
" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoint": { @@ -3775,7 +3887,7 @@ } }, "traits": { - "smithy.api#documentation": "One data point related to one contributor.
\nFor more information, see GetInsightRuleReport and \n\t\t\tInsightRuleContributor.
" + "smithy.api#documentation": "One data point related to one contributor.
\nFor more information, see GetInsightRuleReport and InsightRuleContributor.
" } }, "com.amazonaws.cloudwatch#InsightRuleContributorDatapoints": { @@ -3844,48 +3956,48 @@ "UniqueContributors": { "target": "com.amazonaws.cloudwatch#InsightRuleUnboundDouble", "traits": { - "smithy.api#documentation": "The number of unique contributors who published data during this timestamp.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The number of unique contributors who published data during this timestamp.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, \n\t\t\tso the identity of the max contributor\n\t\tcould be different for each timestamp.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The maximum value provided by one contributor during this timestamp. Each timestamp is\n evaluated separately, so the identity of the max contributor could be different for each\n timestamp.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The number of occurrences that matched the rule during this data point.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The number of occurrences that matched the rule during this data point.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The average value from all contributors during the time period represented by that data point.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The average value from all contributors during the time period represented by that\n data point.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The sum of the values from all contributors during the time period represented by that data point.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The sum of the values from all contributors during the time period represented by that\n data point.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The minimum value from a single contributor during the time period represented by that data point.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The minimum value from a single contributor during the time period represented by that\n data point.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
The maximum value from a single occurence from a single contributor during the time period represented by that data point.
\nThis statistic is returned only if you included it in the Metrics array in your request.
The maximum value from a single occurence from a single contributor during the time\n period represented by that data point.
\nThis statistic is returned only if you included it in the Metrics array\n in your request.
One data point from the metric time series returned in a Contributor Insights rule report.
\nFor more information, see GetInsightRuleReport.
" + "smithy.api#documentation": "One data point from the metric time series returned in a Contributor Insights rule\n report.
\nFor more information, see GetInsightRuleReport.
" } }, "com.amazonaws.cloudwatch#InsightRuleMetricDatapoints": { @@ -3979,7 +4091,7 @@ "code": "InternalServiceError", "httpResponseCode": 500 }, - "smithy.api#documentation": "Request processing has failed due to some unknown error, exception, or failure.
", + "smithy.api#documentation": "Request processing has failed due to some unknown error, exception, or\n failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -4070,12 +4182,12 @@ "Timezone": { "target": "com.amazonaws.cloudwatch#GetMetricDataLabelTimezone", "traits": { - "smithy.api#documentation": "The time zone to use for metric data return in this operation. \n\t\t\tThe format is + or - followed by four digits. \n\t\t\tThe first two digits indicate the number of hours ahead or behind of UTC, and \n\t\t\tthe final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour \n\t\t\tand 30 minutes ahead of UTC. The default is +0000.
The time zone to use for metric data return in this operation. The format is\n + or - followed by four digits. The first two digits\n indicate the number of hours ahead or behind of UTC, and the final two digits are the\n number of minutes. For example, +0130 indicates a time zone that is 1 hour and 30\n minutes ahead of UTC. The default is +0000.
This structure includes the Timezone parameter, which you can use\n\t\t\tto specify your time zone so that the labels that are associated with returned metrics display the \n\t\t\tcorrect time\n\t\t\tfor your time zone.
The Timezone value affects a label only if you have a time-based\n\t\tdynamic expression in the label. For more information about dynamic expressions in labels, \n\t\tsee Using Dynamic Labels.
This structure includes the Timezone parameter, which you can use to\n specify your time zone so that the labels that are associated with returned metrics\n display the correct time for your time zone.
The Timezone value affects a label only if you have a time-based dynamic\n expression in the label. For more information about dynamic expressions in labels, see\n Using Dynamic\n Labels.
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only\n\t\t\tthose dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are\n\t\t\tlisted.\n\t
\n ListDashboards returns up to 1000 results on one page. If there\n\t\t\tare more than 1000 dashboards, you can call ListDashboards again and\n\t\tinclude the value you received for NextToken in the first call, to receive\n\t\tthe next 1000 results.
Returns a list of the dashboards for your account. If you include\n DashboardNamePrefix, only those dashboards with names starting with the\n prefix are listed. Otherwise, all dashboards in your account are listed.
\n ListDashboards returns up to 1000 results on one page. If there are\n more than 1000 dashboards, you can call ListDashboards again and include\n the value you received for NextToken in the first call, to receive the next\n 1000 results.
If you specify this parameter, only\n\t\t\tthe dashboards with names starting with the specified string are listed. The maximum length is 255, and \n\t\t\tvalid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".\n\t\t\t \n\t\t
" + "smithy.api#documentation": "If you specify this parameter, only the dashboards with names starting with the\n specified string are listed. The maximum length is 255, and valid characters are A-Z,\n a-z, 0-9, \".\", \"-\", and \"_\".
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data available.
" + "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n available.
" } } }, @@ -4203,7 +4315,7 @@ } ], "traits": { - "smithy.api#documentation": "\n\t\t\tReturns a list \n\t\t\tthat contains the number\n\t\t\tof managed Contributor Insights rules \n\t\t\tin your account.\n\t\t\t\n\t\t
", + "smithy.api#documentation": "Returns a list that contains the number of managed Contributor Insights rules in your\n account.\n \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4218,20 +4330,20 @@ "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n\t\t\tThe ARN \n\t\t\tof an Amazon Web Services resource \n\t\t\tthat has managed Contributor Insights rules.\n\t\t
", + "smithy.api#documentation": "The ARN of an Amazon Web Services resource that has managed Contributor Insights\n rules.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "\n\t\t\tInclude this value \n\t\t\tto get \n\t\t\tthe next set \n\t\t\tof rules \n\t\t\tif the value was returned \n\t\t\tby the previous operation.\n\t\t
" + "smithy.api#documentation": "Include this value to get the next set of rules if the value was returned by the\n previous operation.
" } }, "MaxResults": { "target": "com.amazonaws.cloudwatch#InsightRuleMaxResults", "traits": { - "smithy.api#documentation": "\n\t\t\tThe maximum number \n\t\t\tof results \n\t\t\tto return \n\t\t\tin one operation. \n\t\t\tIf you omit this parameter, \n\t\t\tthe default number is used.\n\t\t\tThe default number is 100.\n\t\t
The maximum number of results to return in one operation. If you omit this parameter,\n the default number is used. The default number is 100.
\n\t\t\tThe managed rules\n\t\t\tthat are available \n\t\t\tfor the specified Amazon Web Services resource.\n\t\t
" + "smithy.api#documentation": "The managed rules that are available for the specified Amazon Web Services resource.\n
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "\n\t\t\tInclude this value \n\t\t\tto get \n\t\t\tthe next set \n\t\t\tof rules \n\t\t\tif the value was returned \n\t\t\tby the previous operation.\n\t\t
" + "smithy.api#documentation": "Include this value to get the next set of rules if the value was returned by the\n previous operation.
" } } }, @@ -4296,7 +4408,7 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "Include this value, if it was returned by the previous call, to get the next set of metric streams.
" + "smithy.api#documentation": "Include this value, if it was returned by the previous call, to get the next set of\n metric streams.
" } }, "MaxResults": { @@ -4325,7 +4437,7 @@ "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "The token that marks the start of the next batch of returned results. You can use this \n\t\ttoken in a subsequent operation to get the next batch of results.
" + "smithy.api#documentation": "The token that marks the start of the next batch of returned results. You can use\n this token in a subsequent operation to get the next batch of results.
" } }, "Entries": { @@ -4356,7 +4468,7 @@ } ], "traits": { - "smithy.api#documentation": "List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
\nUp to 500 results are returned for any one call. To retrieve additional results,\n\t\t\tuse the returned token with subsequent calls.
\nAfter you create a metric, allow up to 15 minutes for the metric to appear. To see metric\n\t\t\tstatistics sooner, use GetMetricData or GetMetricStatistics.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n\t\t\tview metrics from the linked source accounts. For more information, see \n\t\t\tCloudWatch cross-account observability.
\n\n ListMetrics doesn't return information about metrics if those metrics haven't \n\treported data in the past two weeks. To retrieve those metrics, use \n\t\tGetMetricData or \n\t\tGetMetricStatistics.
List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get statistical data.
\nUp to 500 results are returned for any one call. To retrieve additional results,\n use the returned token with subsequent calls.
\nAfter you create a metric, allow up to 15 minutes for the metric to appear. To see\n metric statistics sooner, use GetMetricData or GetMetricStatistics.
\nIf you are using CloudWatch cross-account observability, you can use this\n operation in a monitoring account and view metrics from the linked source accounts. For\n more information, see CloudWatch cross-account observability.
\n\n ListMetrics doesn't return information about metrics if those metrics\n haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.
The metric namespace to filter against. Only the namespace that matches exactly \n\t\twill be returned.
" + "smithy.api#documentation": "The metric namespace to filter against. Only the namespace that matches exactly\n will be returned.
" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "The name of the metric to filter against. Only the metrics with names that match exactly\n\t\t\twill be returned.
" + "smithy.api#documentation": "The name of the metric to filter against. Only the metrics with names that match\n exactly will be returned.
" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#DimensionFilters", "traits": { - "smithy.api#documentation": "The dimensions to filter against. Only the dimensions that match exactly \n\t\t\twill be returned.
" + "smithy.api#documentation": "The dimensions to filter against. Only the dimensions that match exactly will be\n returned.
" } }, "NextToken": { "target": "com.amazonaws.cloudwatch#NextToken", "traits": { - "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n\t\t\tavailable.
" + "smithy.api#documentation": "The token returned by a previous call to indicate that there is more data\n available.
" } }, "RecentlyActive": { "target": "com.amazonaws.cloudwatch#RecentlyActive", "traits": { - "smithy.api#documentation": "To filter the results to show only metrics that have had data points published\n\t\t\tin the past three hours, specify this parameter\n\t\t\twith a value of PT3H. This is the only valid value\n\t\t\tfor this parameter.
The results that are returned are an approximation of the value you specify. There\n\t\tis a low probability that the returned results include metrics with last published\n\t\tdata as much as 40 minutes more than the specified time interval.
" + "smithy.api#documentation": "To filter the results to show only metrics that have had data points published in the\n past three hours, specify this parameter with a value of PT3H. This is the\n only valid value for this parameter.
The results that are returned are an approximation of the value you specify. There is\n a low probability that the returned results include metrics with last published data as\n much as 50 minutes more than the specified time interval.
" } }, "IncludeLinkedAccounts": { "target": "com.amazonaws.cloudwatch#IncludeLinkedAccounts", "traits": { - "smithy.api#documentation": "If you are using this operation in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the returned data.
The default is false.
If you are using this operation in a monitoring account, specify true to\n include metrics from source accounts in the returned data.
The default is false.
When you use this operation in a monitoring account, use this field to return metrics only from one source account.\n\t\t\tTo do so, specify that source account ID in this field, and also\n\t\tspecify true for IncludeLinkedAccounts.
When you use this operation in a monitoring account, use this field to return metrics\n only from one source account. To do so, specify that source account ID in this field,\n and also specify true for IncludeLinkedAccounts.
If you are using this operation in a monitoring account, this array contains the account IDs of the source \n\t\t\taccounts where the metrics in the returned data\n\t\tare from.
\nThis field is a 1:1 mapping between each metric that is returned and the ID of the owning account.
" + "smithy.api#documentation": "If you are using this operation in a monitoring account, this array contains the\n account IDs of the source accounts where the metrics in the returned data are\n from.
\nThis field is a 1:1 mapping between each metric that is returned and the ID of the\n owning account.
" } } }, @@ -4474,7 +4586,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays the tags associated with a CloudWatch resource. Currently, alarms \n\t\t\tand Contributor Insights rules support tagging.
" + "smithy.api#documentation": "Displays the tags associated with a CloudWatch resource. Currently, alarms and\n Contributor Insights rules support tagging.
" } }, "com.amazonaws.cloudwatch#ListTagsForResourceInput": { @@ -4484,7 +4596,7 @@ "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the CloudWatch resource that you want to view tags for.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you want to view tags for.
\nThe ARN format of an alarm is\n arn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is\n arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web\n Services General Reference.
", "smithy.api#required": {} } } @@ -4514,7 +4626,7 @@ "target": "com.amazonaws.cloudwatch#TemplateName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n\t\t\tThe template name \n\t\t\tfor the managed Contributor Insights rule, \n\t\t\tas returned \n\t\t\tby ListManagedInsightRules.\n\t\t
The template name for the managed Contributor Insights rule, as returned by\n ListManagedInsightRules.
\n\t\t\tThe ARN\n\t\t\tof an Amazon Web Services resource\n\t\t\tthat has managed Contributor Insights rules.\n\t\t
", + "smithy.api#documentation": "The ARN of an Amazon Web Services resource that has managed Contributor Insights\n rules.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "\n\t\t\tA list \n\t\t\tof key-value pairs \n\t\t\tthat you can associate \n\t\t\twith a managed Contributor Insights rule.\n\t\t\tYou can associate as many as 50 tags \n\t\t\twith a rule.\n\t\t\tTags can help you organize and categorize your resources. \n\t\t\tYou also can use them \n\t\t\tto scope user permissions \n\t\t\tby granting a user permission \n\t\t\tto access or change only the resources\n\t\t\tthat have certain tag values.\n\t\t\tTo associate tags \n\t\t\twith a rule, \n\t\t\tyou must have the cloudwatch:TagResource permission\n\t\t\tin addition \n\t\t\tto the cloudwatch:PutInsightRule permission.\n\t\t\tIf you are using this operation \n\t\t\tto update an existing Contributor Insights rule, \n\t\t\tany tags \n\t\t\tthat you specify \n\t\t\tin this parameter are ignored. \n\t\t\tTo change the tags \n\t\t\tof an existing rule, \n\t\t\tuse TagResource.\n\t\t
A list of key-value pairs that you can associate with a managed Contributor Insights\n rule. You can associate as many as 50 tags with a rule. Tags can help you organize and\n categorize your resources. You also can use them to scope user permissions by granting a\n user permission to access or change only the resources that have certain tag values. To\n associate tags with a rule, you must have the cloudwatch:TagResource\n permission in addition to the cloudwatch:PutInsightRule permission. If you\n are using this operation to update an existing Contributor Insights rule, any tags that\n you specify in this parameter are ignored. To change the tags of an existing rule, use\n TagResource.
\n\t\t\tContains the information\n\t\t\tthat's required \n\t\t\tto enable a managed Contributor Insights rule \n\t\t\tfor an Amazon Web Services resource. \n\t\t\t\n\t\t
" + "smithy.api#documentation": "Contains the information that's required to enable a managed Contributor Insights\n rule for an Amazon Web Services resource.\n \n
" } }, "com.amazonaws.cloudwatch#ManagedRuleDescription": { @@ -4543,24 +4655,24 @@ "TemplateName": { "target": "com.amazonaws.cloudwatch#TemplateName", "traits": { - "smithy.api#documentation": "\n\t\t\tThe template name \n\t\t\tfor the managed rule. \n\t\t\tUsed \n\t\t\tto enable managed rules using PutManagedInsightRules.\n\t\t
The template name for the managed rule. Used to enable managed rules using\n PutManagedInsightRules.
\n\t\t\tIf a managed rule is enabled,\n\t\t\tthis is the ARN \n\t\t\tfor the related Amazon Web Services resource.\n\t\t
" + "smithy.api#documentation": "If a managed rule is enabled, this is the ARN for the related Amazon Web Services\n resource.
" } }, "RuleState": { "target": "com.amazonaws.cloudwatch#ManagedRuleState", "traits": { - "smithy.api#documentation": "\n\t\t\tDescribes the state \n\t\t\tof a managed rule. \n\t\t\tIf present, \n\t\t\tit contains information \n\t\t\tabout the Contributor Insights rule \n\t\t\tthat contains information \n\t\t\tabout the related Amazon Web Services resource.\n\t\t
" + "smithy.api#documentation": "Describes the state of a managed rule. If present, it contains information about the\n Contributor Insights rule that contains information about the related Amazon Web Services\n resource.
" } } }, "traits": { - "smithy.api#documentation": "\n\t\t\tContains information \n\t\t\tabout managed Contributor Insights rules,\n\t\t\tas returned\n\t\t\tby ListManagedInsightRules.\n\t\t\t\n\t\t
Contains information about managed Contributor Insights rules, as returned by\n ListManagedInsightRules. \n
\n\t\t\tThe name\n\t\t\tof the Contributor Insights rule \n\t\t\tthat contains data \n\t\t\tfor the specified Amazon Web Services resource.\n\t\t
", + "smithy.api#documentation": "The name of the Contributor Insights rule that contains data for the specified\n Amazon Web Services resource.
", "smithy.api#required": {} } }, @@ -4584,13 +4696,13 @@ "target": "com.amazonaws.cloudwatch#InsightRuleState", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n\t\t\tIndicates whether the rule is enabled or disabled.\n\t\t
", + "smithy.api#documentation": "Indicates whether the rule is enabled or disabled.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n\t\t\tThe status \n\t\t\tof a managed Contributor Insights rule.\n\t\t
" + "smithy.api#documentation": "The status of a managed Contributor Insights rule.
" } }, "com.amazonaws.cloudwatch#ManagedRules": { @@ -4636,7 +4748,7 @@ } }, "traits": { - "smithy.api#documentation": "A message returned by the GetMetricDataAPI, including a code and a description.
If a cross-Region GetMetricData operation fails with a code of Forbidden and a \n\t\t\tvalue of Authentication too complex to \n\t\t\tretrieve cross region data, you can correct the problem by running the GetMetricData\n\t\toperation in the same Region where the metric data is.
A message returned by the GetMetricDataAPI, including a code and a\n description.
If a cross-Region GetMetricData operation fails with a code of\n Forbidden and a value of Authentication too complex to retrieve\n cross region data, you can correct the problem by running the\n GetMetricData operation in the same Region where the metric data\n is.
Indicates whether actions should be executed during any changes to the alarm state.
" + "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm\n state.
" } }, "OKActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "The actions to execute when this alarm transitions to the OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the OK state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).
The actions to execute when this alarm transitions to the ALARM state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state \n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
The actions to execute when this alarm transitions to the\n INSUFFICIENT_DATA state from any other state. Each action is specified\n as an Amazon Resource Name (ARN).
The time stamp of the last update to the value of either the \n\t\t\tStateValue or EvaluationState parameters.
The time stamp of the last update to the value of either the\n StateValue or EvaluationState parameters.
The name of the metric associated with the alarm, if this is an alarm\n\t\tbased on a single metric.
" + "smithy.api#documentation": "The name of the metric associated with the alarm, if this is an alarm based on a\n single metric.
" } }, "Namespace": { @@ -4761,13 +4873,13 @@ "Statistic": { "target": "com.amazonaws.cloudwatch#Statistic", "traits": { - "smithy.api#documentation": "The statistic for the metric associated with the alarm, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic.
The statistic for the metric associated with the alarm, other than percentile. For\n percentile statistics, use ExtendedStatistic.
The percentile statistic for the metric associated with the alarm. Specify a value between\n\t\t\tp0.0 and p100.
" + "smithy.api#documentation": "The percentile statistic for the metric associated with the alarm. Specify a value\n between p0.0 and p100.
" } }, "Dimensions": { @@ -4791,7 +4903,7 @@ "EvaluationPeriods": { "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { - "smithy.api#documentation": "The number of periods over which data is compared to the specified threshold.
" + "smithy.api#documentation": "The number of periods over which data is compared to the specified\n threshold.
" } }, "DatapointsToAlarm": { @@ -4809,43 +4921,43 @@ "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { - "smithy.api#documentation": "The arithmetic operation to use when comparing the specified\n\t\t\tstatistic and threshold. The specified statistic value is used as the first operand.
" + "smithy.api#documentation": "The arithmetic operation to use when comparing the specified statistic and\n threshold. The specified statistic value is used as the first operand.
" } }, "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default \n \tbehavior of missing is used.
Sets how this alarm is to handle missing data points. The valid values are\n breaching, notBreaching, ignore, and\n missing. For more information, see Configuring how CloudWatch alarms treat missing data.
If this parameter is omitted, the default behavior of missing is\n used.
Used only for alarms based on percentiles. If ignore, the alarm state does not change \n\t\t\tduring periods with too few data points to be statistically significant. If evaluate or this \n\t\t\tparameter is not used, the alarm is always evaluated and possibly changes state no matter \n\t\t\thow many data points are available.
Used only for alarms based on percentiles. If ignore, the alarm state\n does not change during periods with too few data points to be statistically significant.\n If evaluate or this parameter is not used, the alarm is always evaluated\n and possibly changes state no matter how many data points are available.
An array of MetricDataQuery structures, used in an alarm based on a \n\t\t\tmetric math expression. Each structure either retrieves a \n\t\t\tmetric or performs a math expression.\n\t\t\t\n\t\t\tOne item in the Metrics array is the math expression that the alarm watches. \n\t\t\tThis expression by designated by having ReturnData set to\n\t\t\ttrue.
An array of MetricDataQuery structures, used in an alarm based on a metric math\n expression. Each structure either retrieves a metric or performs a math expression. One\n item in the Metrics array is the math expression that the alarm watches. This expression\n by designated by having ReturnData set to true.
In an alarm based on an anomaly detection model, this is the ID of the \n\t\t\tANOMALY_DETECTION_BAND function \n\t\t\tused as the threshold for the alarm.
In an alarm based on an anomaly detection model, this is the ID of the\n ANOMALY_DETECTION_BAND function used as the threshold for the\n alarm.
If the value of this field is\n\tPARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the\n\tquery used for the alarm returns more than 10,000 metrics. For \n\tmore information, see \n\t\tCreate alarms on Metrics Insights queries.
If the value of this field is PARTIAL_DATA, the alarm is being evaluated\n based on only partial data. This happens if the query used for the alarm returns more\n than 10,000 metrics. For more information, see Create\n alarms on Metrics Insights queries.
The date and time that the alarm's StateValue most recently changed.
The date and time that the alarm's StateValue most recently\n changed.
Set this parameter to true if values for this metric consistently include spikes\n\t\t\tthat should not be considered to be anomalies. With this set to true, CloudWatch will expect \n\t\t\tto see spikes that occurred consistently during the model training period, and won't flag future similar spikes\n\t\t\tas anomalies.
Set this parameter to true if values for this metric consistently include\n spikes that should not be considered to be anomalies. With this set to\n true, CloudWatch will expect to see spikes that occurred\n consistently during the model training period, and won't flag future similar spikes as\n anomalies.
This object includes parameters that you can use to provide information to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models.
" + "smithy.api#documentation": "This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
" } }, "com.amazonaws.cloudwatch#MetricData": { @@ -4892,49 +5004,49 @@ "target": "com.amazonaws.cloudwatch#MetricId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A short name used to tie this object to the results in the response. This name must be\n\t\t\tunique within a single call to GetMetricData. If you are performing math\n\t\t\texpressions on this set of data, this name represents that data and can serve as a\n\t\t\tvariable in the mathematical expression. The valid characters are letters, numbers, and\n\t\t\tunderscore. The first character must be a lowercase letter.
A short name used to tie this object to the results in the response. This name must be\n unique within a single call to GetMetricData. If you are performing math\n expressions on this set of data, this name represents that data and can serve as a\n variable in the mathematical expression. The valid characters are letters, numbers, and\n underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric \n\t\t\tand not performing a math expression on returned data.
\nWithin one MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.
The metric to be returned, along with statistics, period, and units. Use this\n parameter only if this object is retrieving a metric and not performing a math\n expression on returned data.
\nWithin one MetricDataQuery object, you must specify either Expression or\n MetricStat but not both.
This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.
\nA math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.
Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.
This field can contain either a Metrics Insights query, or a metric math expression to\n be performed on the returned data. For more information about Metrics Insights queries,\n see Metrics Insights query components and syntax in the Amazon\n CloudWatch User Guide.
\nA math expression can use the Id of the other metrics or queries to refer\n to those metrics, and can also use the Id of other expressions to use the\n result of those expressions. For more information about metric math expressions, see\n Metric Math Syntax and Functions in the Amazon CloudWatch User\n Guide.
Within each MetricDataQuery object, you must specify either Expression or\n MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful \n\t\t\tif this is an expression, so that you know\n\t\t\twhat the value represents. If the metric or expression is shown in a \n\t\t\tCloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n\t\t\tgenerates a default.
\nYou can put dynamic expressions into a label, so that it is more descriptive. \n\t\t\tFor more information, see Using Dynamic Labels.
" + "smithy.api#documentation": "A human-readable label for this metric or expression. This is especially useful if\n this is an expression, so that you know what the value represents. If the metric or\n expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is\n omitted, CloudWatch generates a default.
\nYou can put dynamic expressions into a label, so that it is more descriptive. For more\n information, see Using Dynamic\n Labels.
" } }, "ReturnData": { "target": "com.amazonaws.cloudwatch#ReturnData", "traits": { - "smithy.api#documentation": "When used in GetMetricData, this option indicates whether to return the\n\t\t\ttimestamps and raw data values of this metric. If you are performing this call just to\n\t\t\tdo math expressions and do not also need the raw data returned, you can specify\n\t\t\t\tfalse. If you omit this, the default of true is\n\t\t\tused.
When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all \n\t\tother metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.
When used in GetMetricData, this option indicates whether to return the\n timestamps and raw data values of this metric. If you are performing this call just to\n do math expressions and do not also need the raw data returned, you can specify\n false. If you omit this, the default of true is\n used.
When used in PutMetricAlarm, specify true for the one\n expression result to use as the alarm. For all other metrics and expressions in the same\n PutMetricAlarm operation, specify ReturnData as\n False.
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a \n\t\t\tperiod can be as short as one minute (60 seconds) and must be a multiple of 60. \n\t\t\tFor high-resolution metrics that are collected at intervals of less than one minute, \n\t\t\tthe period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics \n\t\t\tstored by a PutMetricData operation that includes a StorageResolution of 1 second.
The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData operation that includes\n a StorageResolution of 1 second.
The ID of the account where the metrics are located.
\nIf you are performing a GetMetricData operation in a monitoring account, use this to specify \n\t\t\twhich account to retrieve this metric from.
If you are performing a PutMetricAlarm operation, use this to specify \n\t\t\twhich account contains the metric that the alarm is watching.
The ID of the account where the metrics are located.
\nIf you are performing a GetMetricData operation in a monitoring account,\n use this to specify which account to retrieve this metric from.
If you are performing a PutMetricAlarm operation, use this to specify\n which account contains the metric that the alarm is watching.
This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.
When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.
When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have true\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.
Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.
Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.
This structure is used in both GetMetricData and\n PutMetricAlarm. The supported use of this structure is different for\n those two operations.
When used in GetMetricData, it indicates the metric data to return, and\n whether this call is just retrieving a batch set of data for one metric, or is\n performing a Metrics Insights query or a math expression. A single\n GetMetricData call can include up to 500 MetricDataQuery\n structures.
When used in PutMetricAlarm, it enables you to create an alarm based on a\n metric math expression. Each MetricDataQuery in the array specifies either\n a metric to retrieve, or a math expression to be performed on retrieved metrics. A\n single PutMetricAlarm call can include up to 20\n MetricDataQuery structures in the array. The 20 structures can include\n as many as 10 structures that contain a MetricStat parameter to retrieve a\n metric, and as many as 10 structures that contain the Expression parameter\n to perform a math expression. Of those Expression structures, one must have\n true as the value for ReturnData. The result of this\n expression is the value the alarm watches.
Any expression used in a PutMetricAlarm operation must return a single\n time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n Guide.
Some of the parameters of this structure also have different uses whether you are\n using this structure in a GetMetricData operation or a\n PutMetricAlarm operation. These differences are explained in the\n following parameter list.
The timestamps for the data points, formatted in Unix timestamp format. The number of\n\t\t\ttimestamps always matches the number of values and the value for Timestamps[x] is\n\t\t\tValues[x].
" + "smithy.api#documentation": "The timestamps for the data points, formatted in Unix timestamp format. The number of\n timestamps always matches the number of values and the value for Timestamps[x] is\n Values[x].
" } }, "Values": { "target": "com.amazonaws.cloudwatch#DatapointValues", "traits": { - "smithy.api#documentation": "The data points for the metric corresponding to Timestamps. The number of\n\t\t\tvalues always matches the number of timestamps and the timestamp for Values[x] is\n\t\t\tTimestamps[x].
The data points for the metric corresponding to Timestamps. The number of\n values always matches the number of timestamps and the timestamp for Values[x] is\n Timestamps[x].
The status of the returned data. Complete indicates that all data points in the requested time range were returned. \n\t\t\tPartialData means that an incomplete set of data points were returned. \n\t\t\t\t\tYou can use the NextToken value that was returned and repeat your request to get more data points. \n\t\t\tNextToken is not returned if you are performing a math expression. InternalError \n\t\t\tindicates that an error occurred. Retry your request using NextToken, if present.
The status of the returned data. Complete indicates that all data points\n in the requested time range were returned. PartialData means that an\n incomplete set of data points were returned. You can use the NextToken\n value that was returned and repeat your request to get more data points.\n NextToken is not returned if you are performing a math expression.\n InternalError indicates that an error occurred. Retry your request\n using NextToken, if present.
A GetMetricData call returns an array of MetricDataResult\n\t\t\tstructures. Each of these structures includes the data points for that metric, along\n\t\t\twith the timestamps of those data points and other identifying information.
A GetMetricData call returns an array of MetricDataResult\n structures. Each of these structures includes the data points for that metric, along\n with the timestamps of those data points and other identifying information.
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
" + "smithy.api#documentation": "The time the metric data was received, expressed as the number of milliseconds\n since Jan 1, 1970 00:00:00 UTC.
" } }, "Value": { "target": "com.amazonaws.cloudwatch#DatapointValue", "traits": { - "smithy.api#documentation": "The value for the metric.
\nAlthough the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or\n\t\t\ttoo large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)\n\t\t\tare not supported.
" + "smithy.api#documentation": "The value for the metric.
\nAlthough the parameter accepts numbers of type Double, CloudWatch rejects values\n that are either too small or too large. Values must be in the range of -2^360 to 2^360.\n In addition, special values (for example, NaN, +Infinity, -Infinity) are not\n supported.
" } }, "StatisticValues": { @@ -5031,30 +5143,30 @@ "Values": { "target": "com.amazonaws.cloudwatch#Values", "traits": { - "smithy.api#documentation": "Array of numbers representing the values for the metric during the period. Each unique value is listed just once\n\t\tin this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period.\n\t\tYou can include up to 150 unique values in each PutMetricData action that specifies a Values array.
Although the Values array accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.
Array of numbers representing the values for the metric during the period. Each unique\n value is listed just once in this array, and the corresponding number in the\n Counts array specifies the number of times that value occurred during\n the period. You can include up to 150 unique values in each PutMetricData\n action that specifies a Values array.
Although the Values array accepts numbers of type Double,\n CloudWatch rejects values that are either too small or too large. Values must be in the\n range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n -Infinity) are not supported.
Array of numbers that is used along with the Values array. Each number in the Count array \n\t\t\tis the number of times the corresponding value in the Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for each count. If you\n\t\tinclude a Counts array, it must include the same amount of values as the Values array.
Array of numbers that is used along with the Values array. Each number in\n the Count array is the number of times the corresponding value in the\n Values array occurred during the period.
If you omit the Counts array, the default of 1 is used as the value for\n each count. If you include a Counts array, it must include the same amount\n of values as the Values array.
When you are using a Put operation, this defines what unit you want to use when storing the metric.
In \n\t\ta Get operation, this displays the unit that is used for the metric.
When you are using a Put operation, this defines what unit you want to\n use when storing the metric.
In a Get operation, this displays the unit that is used for the\n metric.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with \n\t\t\tsub-minute resolution down to one second.\n\t\tSetting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available\n\t\tonly for custom metrics. For more information about high-resolution metrics, \n\t\t\tsee High-Resolution Metrics in the\n\t\t\tAmazon CloudWatch User Guide.\n\t\t
\nThis field is optional, if you do not specify it the default of 60 is used.
" + "smithy.api#documentation": "Valid values are 1 and 60. Setting this to 1 specifies this metric as a\n high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution\n down to one second. Setting this to 60 specifies this metric as a regular-resolution\n metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is\n available only for custom metrics. For more information about high-resolution metrics,\n see High-Resolution Metrics in the Amazon CloudWatch User\n Guide.
\nThis field is optional, if you do not specify it the default of 60 is\n used.
" } } }, "traits": { - "smithy.api#documentation": "Encapsulates the information sent to either create a metric or add new values\n\t\t\tto be aggregated into an existing metric.
" + "smithy.api#documentation": "Encapsulates the information sent to either create a metric or add new values to be\n aggregated into an existing metric.
" } }, "com.amazonaws.cloudwatch#MetricExpression": { @@ -5084,12 +5196,12 @@ "MetricDataQueries": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "An array of metric data query structures \n\t\t\tthat enables you to create an anomaly detector \n\t\t\tbased on the result of a metric math expression.\n\t\t\tEach item in MetricDataQueries gets a metric or performs a math expression.\n\t\t\tOne item in MetricDataQueries is the expression \n\t\t\tthat provides the time series \n\t\t\tthat the anomaly detector uses as input. \n\t\t\tDesignate the expression by setting ReturnData to true \n\t\t\tfor this object in the array.\n\t\t\tFor all other expressions and metrics, set ReturnData to false.\n\t\t\tThe designated expression must return \n\t\t\ta single time series.
An array of metric data query structures that enables you to create an anomaly\n detector based on the result of a metric math expression. Each item in\n MetricDataQueries gets a metric or performs a math expression. One item\n in MetricDataQueries is the expression that provides the time series that\n the anomaly detector uses as input. Designate the expression by setting\n ReturnData to true for this object in the array. For all\n other expressions and metrics, set ReturnData to false. The\n designated expression must return a single time series.
Indicates the CloudWatch math expression that provides the time series the anomaly detector\n\t\t\tuses as input.\n\t\t\tThe designated math expression must return a single time series.
" + "smithy.api#documentation": "Indicates the CloudWatch math expression that provides the time series the anomaly\n detector uses as input. The designated math expression must return a single time\n series.
" } }, "com.amazonaws.cloudwatch#MetricName": { @@ -5116,7 +5228,7 @@ "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can\n\t\t\tbe as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n\t\t\tat intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n\t\t\tare those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than\n\t\t\t\t3 hours ago, you must specify the period as follows or no data points in that time range is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
\nThe granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).
\nStart time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).
\nStart time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).
\nThe statistic to return. It can include any CloudWatch statistic or extended statistic.
", + "smithy.api#documentation": "The statistic to return. It can include any CloudWatch statistic or extended\n statistic.
", "smithy.api#required": {} } }, "Unit": { "target": "com.amazonaws.cloudwatch#StandardUnit", "traits": { - "smithy.api#documentation": "When you are using a Put operation, this defines what unit you want to use when storing the metric.
In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
When you are using a Put operation, this defines what unit you want to\n use when storing the metric.
In a Get operation, if you omit Unit then all data that\n was collected with any unit is returned, along with the corresponding units that were\n specified when the data was reported to CloudWatch. If you specify a unit, the operation\n returns only data that was collected with that unit specified. If you specify a unit\n that does not match the data collected, the results of the operation are null.\n CloudWatch does not perform unit conversions.
This structure defines the metric to be returned, along with the statistics, period, and units.
" + "smithy.api#documentation": "This structure defines the metric to be returned, along with the statistics, period,\n and units.
" } }, "com.amazonaws.cloudwatch#MetricStreamEntries": { @@ -5163,7 +5275,7 @@ "LastUpdateDate": { "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { - "smithy.api#documentation": "The date that the configuration of this metric stream was most recently updated.
" + "smithy.api#documentation": "The date that the configuration of this metric stream was most recently\n updated.
" } }, "Name": { @@ -5175,19 +5287,19 @@ "FirehoseArn": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.
" + "smithy.api#documentation": "The ARN of the Kinesis Firehose devlivery stream that is used for this metric\n stream.
" } }, "State": { "target": "com.amazonaws.cloudwatch#MetricStreamState", "traits": { - "smithy.api#documentation": "The current state of this stream. Valid values are running and stopped.
The current state of this stream. Valid values are running and\n stopped.
The output format of this metric stream. Valid values are \n\t\t\tjson, opentelemetry1.0, \n\t\t\tand opentelemetry0.7.
The output format of this metric stream. Valid values are json,\n opentelemetry1.0, and opentelemetry0.7.
The name of the metric namespace for this filter.
\nThe namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must\n\t\t\tcontain at least one non-whitespace character.
" + "smithy.api#documentation": "The name of the metric namespace for this filter.
\nThe namespace can contain only ASCII printable characters (ASCII range 32 through\n 126). It must contain at least one non-whitespace character.
" } }, "MetricNames": { "target": "com.amazonaws.cloudwatch#MetricStreamFilterMetricNames", "traits": { - "smithy.api#documentation": "The names of the metrics to either include or exclude from the metric stream.
\nIf you omit this parameter, all metrics in the namespace are included or excluded, \n\t\tdepending on whether this filter is specified as an exclude filter or an include filter.
\nEach metric name can contain only ASCII printable characters (ASCII range 32 through 126). \n\t\t\tEach metric name must contain at least one non-whitespace character.
" + "smithy.api#documentation": "The names of the metrics to either include or exclude from the metric stream.
\nIf you omit this parameter, all metrics in the namespace are included or excluded,\n depending on whether this filter is specified as an exclude filter or an include\n filter.
\nEach metric name can contain only ASCII printable characters (ASCII range 32 through\n 126). Each metric name must contain at least one non-whitespace character.
" } } }, "traits": { - "smithy.api#documentation": "This structure contains a metric namespace and optionally, a list of metric names, \n\t\t\tto either include in a metric stream or exclude from\n\t\t\ta metric stream.
\nA metric stream's filters can include up to 1000 total names. This limit\n\t\t\tapplies to the sum of namespace names and metric names in the filters. For example, \n\t\tthis could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters\n\t\twith 49 metrics specified in each filter.
" + "smithy.api#documentation": "This structure contains a metric namespace and optionally, a list of metric names, to\n either include in a metric stream or exclude from a metric stream.
\nA metric stream's filters can include up to 1000 total names. This limit applies to\n the sum of namespace names and metric names in the filters. For example, this could\n include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with\n 49 metrics specified in each filter.
" } }, "com.amazonaws.cloudwatch#MetricStreamFilterMetricNames": { @@ -5290,7 +5402,7 @@ "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An array of metric name and namespace pairs that stream the additional statistics listed\n\t\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t\t100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed\n\t\t\twith the additional statistics, no matter their dimensions.
", + "smithy.api#documentation": "An array of metric name and namespace pairs that stream the additional statistics\n listed in the value of the AdditionalStatistics parameter. There can be as\n many as 100 pairs in the array.
All metrics that match the combination of metric name and namespace will be streamed\n with the additional statistics, no matter their dimensions.
", "smithy.api#required": {} } }, @@ -5298,13 +5410,13 @@ "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of additional statistics that are to be streamed for the metrics listed\n\t\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.
If the OutputFormat for the stream is opentelemetry1.0 or opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.
If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\t\ttm98, \n wm90, PR(:300), and so on.
The list of additional statistics that are to be streamed for the metrics listed in\n the IncludeMetrics array in this structure. This list can include as many\n as 20 statistics.
If the OutputFormat for the stream is opentelemetry1.0 or\n opentelemetry0.7, the only valid values are\n p??\n percentile statistics such as\n p90, p99 and so on.
If the OutputFormat for the stream is json, the valid values\n include the abbreviations for all of the statistics listed in \n CloudWatch statistics definitions. For example, this includes\n tm98, \n wm90, PR(:300), and so on.
By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for\n\t\t\tone metric that includes additional statistics in the stream. For more information about statistics, \n\t\t\tsee CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.
By default, a metric stream always sends the MAX, MIN,\n SUM, and SAMPLECOUNT statistics for each metric that is\n streamed. This structure contains information for one metric that includes additional\n statistics in the stream. For more information about statistics, see CloudWatch,\n listed in \n CloudWatch statistics definitions.
This object contains the information for one metric that is to be streamed with \n\t\t\tadditional statistics.
" + "smithy.api#documentation": "This object contains the information for one metric that is to be streamed with\n additional statistics.
" } }, "com.amazonaws.cloudwatch#MetricWidget": { @@ -5426,7 +5538,7 @@ } }, "traits": { - "smithy.api#documentation": "This array is empty if the API operation was successful for all the rules specified in the request. If the operation could\n\t\tnot process one of the rules, the following data is returned for each of those rules.
" + "smithy.api#documentation": "This array is empty if the API operation was successful for all the rules specified in\n the request. If the operation could not process one of the rules, the following data is\n returned for each of those rules.
" } }, "com.amazonaws.cloudwatch#Period": { @@ -5466,7 +5578,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an anomaly detection model for a CloudWatch metric. You can use the model\n\t\t\tto display a band of expected normal values when the metric is graphed.
\nIf you have enabled unified cross-account observability, and this account is a monitoring\n\t\t\taccount, the metric can be in the same account or a source account. You can specify the account ID\n\t\t\tin the object you specify in the SingleMetricAnomalyDetector parameter.
For more information, see CloudWatch Anomaly Detection.
" + "smithy.api#documentation": "Creates an anomaly detection model for a CloudWatch metric. You can use the model to\n display a band of expected normal values when the metric is graphed.
\nIf you have enabled unified cross-account observability, and this account is a\n monitoring account, the metric can be in the same account or a source account. You can\n specify the account ID in the object you specify in the\n SingleMetricAnomalyDetector parameter.
For more information, see CloudWatch Anomaly Detection.
" } }, "com.amazonaws.cloudwatch#PutAnomalyDetectorInput": { @@ -5511,25 +5623,25 @@ "Configuration": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration", "traits": { - "smithy.api#documentation": "The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.
\nThe configuration can also include the time zone to use for \n\t\t\tthe metric.
" + "smithy.api#documentation": "The configuration specifies details about how the anomaly detection model is to be\n trained, including time ranges to exclude when training and updating the model. You can\n specify as many as 10 time ranges.
\nThe configuration can also include the time zone to use for the metric.
" } }, "MetricCharacteristics": { "target": "com.amazonaws.cloudwatch#MetricCharacteristics", "traits": { - "smithy.api#documentation": "Use this object to include parameters to provide information about your metric to \n\t\t\tCloudWatch to help it build more accurate anomaly detection models. Currently, it includes\n\t\t\tthe PeriodicSpikes parameter.
Use this object to include parameters to provide information about your metric to\n CloudWatch to help it build more accurate anomaly detection models.\n Currently, it includes the PeriodicSpikes parameter.
A single metric anomaly detector to be created.
\nWhen using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:
\n Dimensions\n
\n MetricName\n
\n Namespace\n
\n Stat\n
the MetricMathAnomalyDetector parameters of PutAnomalyDetectorInput\n
Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.
A single metric anomaly detector to be created.
\nWhen using SingleMetricAnomalyDetector, you cannot include the following\n parameters in the same operation:
\n Dimensions\n
\n MetricName\n
\n Namespace\n
\n Stat\n
the MetricMathAnomalyDetector parameters of\n PutAnomalyDetectorInput\n
Instead, specify the single metric anomaly detector attributes as part of the property\n SingleMetricAnomalyDetector.
The metric math anomaly detector to be created.
\nWhen using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:
\n Dimensions\n
\n MetricName\n
\n Namespace\n
\n Stat\n
the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput\n
Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.
The metric math anomaly detector to be created.
\nWhen using MetricMathAnomalyDetector, you cannot include the following\n parameters in the same operation:
\n Dimensions\n
\n MetricName\n
\n Namespace\n
\n Stat\n
the SingleMetricAnomalyDetector parameters of\n PutAnomalyDetectorInput\n
Instead, specify the metric math anomaly detector attributes as part of the property\n MetricMathAnomalyDetector.
Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.
\nThe alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.
\nUsing composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.
\nComposite alarms can take the following actions:
\nNotify Amazon SNS topics.
\nInvoke Lambda functions.
\nCreate OpsItems in Systems Manager Ops Center.
\nCreate incidents in Systems Manager Incident Manager.
\nIt is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.
\nTo get out of such a situation, you must\n\t\t\tbreak 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\n\t\t\tchange 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.\n\t\t
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.
\nTo use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.
Creates or updates a composite alarm. When you create a composite\n alarm, you specify a rule expression for the alarm that takes into account the alarm\n states of other alarms that you have created. The composite alarm goes into ALARM state\n only if all conditions of the rule are met.
\nThe alarms specified in a composite alarm's rule expression can include metric alarms\n and other composite alarms. The rule expression of a composite alarm can include as many\n as 100 underlying alarms. Any single alarm can be included in the rule expressions of as\n many as 150 composite alarms.
\nUsing composite alarms can reduce alarm noise. You can create multiple metric alarms,\n and also create a composite alarm and set up alerts only for the composite alarm. For\n example, you could create a composite alarm that goes into ALARM state only when more\n than one of the underlying metric alarms are in ALARM state.
\nComposite alarms can take the following actions:
\nNotify Amazon SNS topics.
\nInvoke Lambda functions.
\nCreate OpsItems in Systems Manager Ops Center.
\nCreate incidents in Systems Manager Incident Manager.
\nIt is possible to create a loop or cycle of composite alarms, where composite\n alarm A depends on composite alarm B, and composite alarm B also depends on\n composite alarm A. In this scenario, you can't delete any composite alarm that is\n part of the cycle because there is always still a composite alarm that depends on\n that alarm that you want to delete.
\nTo get out of such a situation, you must break the cycle by changing the rule of\n one of the composite alarms in the cycle to remove a dependency that creates the\n cycle. The simplest change to make to break a cycle is to change the\n AlarmRule of one of the alarms to false.
Additionally, the evaluation of composite alarms stops if CloudWatch detects a\n cycle in the evaluation path.
\nWhen this operation creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed. For a\n composite alarm, this initial time after creation is the only time that the alarm can be\n in INSUFFICIENT_DATA state.
When you update an existing alarm, its state is left unchanged, but the update\n completely overwrites the previous configuration of the alarm.
\nTo use this operation, you must be signed on with the\n cloudwatch:PutCompositeAlarm permission that is scoped to\n *. You can't create a composite alarms if your\n cloudwatch:PutCompositeAlarm permission has a narrower scope.
If you are an IAM user, you must have\n iam:CreateServiceLinkedRole to create a composite alarm that has\n Systems Manager OpsItem actions.
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is \n\t\t\tTRUE.
Indicates whether actions should be executed during any changes to the alarm state of\n the composite alarm. The default is TRUE.
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n Systems Manager actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity\n \n
The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n Systems Manager actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity\n \n
The name for the composite alarm. This name must be unique within the Region.
", + "smithy.api#documentation": "The name for the composite alarm. This name must be unique within the\n Region.
", "smithy.api#required": {} } }, @@ -5594,44 +5706,44 @@ "target": "com.amazonaws.cloudwatch#AlarmRule", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An expression that specifies which other alarms are to be evaluated to determine this\n\t\t\tcomposite alarm's state. For each alarm that you reference, you\n\t\t\tdesignate a function that\n\t\t\tspecifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You\n\t\t\tcan use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the \n\t\t\tfunctions in your expression.
\nYou can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
\nFunctions can include the following:
\n\n ALARM(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\talarm is in ALARM state.
\n OK(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\t\talarm is in OK state.
\n INSUFFICIENT_DATA(\"alarm-name or alarm-ARN\") is TRUE if the named\n\t\t\t\talarm is in INSUFFICIENT_DATA state.
\n TRUE always evaluates to TRUE.
\n FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and \n\t\tfor testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes (\"), but do not have to be.
The following\n\t\t\tare some examples of AlarmRule:
\n ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the composite alarm goes into ALARM state only\n\t\t\t\tif both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
\n ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)\n\t\t\t\t\tspecifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state\n\t\t\t\t\tand DeploymentInProgress is not in ALARM state. This example reduces\n\t\t\t\t\talarm noise during a known deployment window.
\n (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh) goes into ALARM \n\t\t\t\tstate if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. \n\t\t\t\tThis provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an \n\t\t\t\talarm action on high CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100\n\t\t\t\"children\" alarms. The AlarmRule expression can have as many as 500 elements. Elements\n\t\t\tare child alarms, TRUE or FALSE statements, and\n\t\t\tparentheses.
An expression that specifies which other alarms are to be evaluated to determine this\n composite alarm's state. For each alarm that you reference, you designate a function\n that specifies whether that alarm needs to be in ALARM state, OK state, or\n INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple\n functions in a single expression. You can use parenthesis to logically group the\n functions in your expression.
\nYou can use either alarm names or ARNs to reference the other alarms that are to be\n evaluated.
\nFunctions can include the following:
\n\n ALARM(\"alarm-name or\n alarm-ARN\") is TRUE if the named alarm is in\n ALARM state.
\n OK(\"alarm-name or\n alarm-ARN\") is TRUE if the named alarm is in OK\n state.
\n INSUFFICIENT_DATA(\"alarm-name or\n alarm-ARN\") is TRUE if the named alarm is in\n INSUFFICIENT_DATA state.
\n TRUE always evaluates to TRUE.
\n FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure, and\n for testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with double-quotes\n (\"), but do not have to be.
The following are some examples of AlarmRule:
\n ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)\n specifies that the composite alarm goes into ALARM state only if both\n CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.
\n ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)\n specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in\n ALARM state and DeploymentInProgress is not in ALARM state. This example reduces\n alarm noise during a known deployment window.
\n (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND\n OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh\n OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK\n state. This provides another example of using a composite alarm to prevent\n noise. This rule ensures that you are not notified with an alarm action on high\n CPU or disk usage if a known network problem is also occurring.
The AlarmRule can specify as many as 100 \"children\" alarms. The\n AlarmRule expression can have as many as 500 elements. Elements are\n child alarms, TRUE or FALSE statements, and parentheses.
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
The actions to execute when this alarm transitions to the\n INSUFFICIENT_DATA state from any other state. Each action is specified\n as an Amazon Resource Name (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
The actions to execute when this alarm transitions to an OK state from\n any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: ]
\n\n Amazon SNS actions:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.\n\t\t\tTo be able to associate tags with the alarm when you create the alarm, you must\n\t\t\thave the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\nIf you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.
" + "smithy.api#documentation": "A list of key-value pairs to associate with the alarm. You can associate as many as\n 50 tags with an alarm. To be able to associate tags with the alarm when you create the\n alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to\n scope user permissions by granting a user permission to access or change only resources\n with certain tag values.
\nIf you are using this operation to update an existing alarm, any tags you specify in\n this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
" } }, "ActionsSuppressor": { "target": "com.amazonaws.cloudwatch#AlarmArn", "traits": { - "smithy.api#documentation": "\n\t\t\tActions will be suppressed \n\t\t\tif the suppressor alarm is \n\t\t\tin the ALARM state.\n\t\t\tActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) \n\t\t\tfrom an existing alarm.\n\t\t
Actions will be suppressed if the suppressor alarm is in the ALARM\n state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name\n (ARN) from an existing alarm.
\n\t\t\tThe maximum time \n\t\t\tin seconds \n\t\t\tthat the composite alarm waits\n\t\t\tfor the suppressor alarm \n\t\t\tto go \n\t\t\tinto the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n WaitPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
The maximum time in seconds that the composite alarm waits for the suppressor alarm\n to go into the ALARM state. After this time, the composite alarm performs\n its actions.
\n WaitPeriod is required only when ActionsSuppressor is\n specified.
\n\t\t\tThe maximum time \n\t\t\tin seconds\n\t\t\tthat the composite alarm waits \n\t\t\tafter suppressor alarm goes out \n\t\t\tof the ALARM state. \n\t\t\tAfter this time, \n\t\t\tthe composite alarm performs its actions.\n\t\t
\n ExtensionPeriod \n\t\t\t\tis required only \n\t\t\t\twhen ActionsSuppressor is specified.\n\t\t\t
The maximum time in seconds that the composite alarm waits after suppressor alarm\n goes out of the ALARM state. After this time, the composite alarm performs\n its actions.
\n ExtensionPeriod is required only when ActionsSuppressor is\n specified.
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard,\n\t\tthe entire contents are replaced with what you specify here.
\nAll dashboards in your account are global, not region-specific.
\nA simple way to create a dashboard using PutDashboard is to copy an \n\t\t\texisting dashboard. To copy an existing dashboard using the console, you can load the dashboard\n\t\t\tand then use the View/edit source command in the Actions menu to display the JSON block\n\t\t\tfor that dashboard. Another way to copy a dashboard is to \n\t\t\tuse GetDashboard, and then use the data returned\n\t\t\twithin DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to \n\t\t\tadd a text widget at the top of the dashboard with a message that the dashboard was created by script and should\n\t\tnot be changed in the console. This message could also point console users to the location \n\t\tof the DashboardBody script or the CloudFormation template used to create the\n\t\tdashboard.
Creates a dashboard if it does not already exist, or updates an existing dashboard.\n If you update a dashboard, the entire contents are replaced with what you specify\n here.
\nAll dashboards in your account are global, not region-specific.
\nA simple way to create a dashboard using PutDashboard is to copy an\n existing dashboard. To copy an existing dashboard using the console, you can load the\n dashboard and then use the View/edit source command in the Actions menu to display the\n JSON block for that dashboard. Another way to copy a dashboard is to use\n GetDashboard, and then use the data returned within\n DashboardBody as the template for the new dashboard when you call\n PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to\n add a text widget at the top of the dashboard with a message that the dashboard was\n created by script and should not be changed in the console. This message could also\n point console users to the location of the DashboardBody script or the\n CloudFormation template used to create the dashboard.
The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing\n\t\t\tits current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are \n\t\t\tA-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.
", + "smithy.api#documentation": "The name of the dashboard. If a dashboard with this name already exists, this call\n modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is\n created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \"-\", and\n \"_\". This parameter is required.
", "smithy.api#required": {} } }, @@ -5674,7 +5786,7 @@ "target": "com.amazonaws.cloudwatch#DashboardBody", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The detailed information about the dashboard in JSON format, including the widgets to include and their location\n\t\t\ton the dashboard. This parameter is required.
\nFor more information about the syntax, \n\t\t\tsee Dashboard Body Structure and Syntax.
", + "smithy.api#documentation": "The detailed information about the dashboard in JSON format, including the widgets\n to include and their location on the dashboard. This parameter is required.
\nFor more information about the syntax, see Dashboard Body Structure and Syntax.
", "smithy.api#required": {} } } @@ -5689,7 +5801,7 @@ "DashboardValidationMessages": { "target": "com.amazonaws.cloudwatch#DashboardValidationMessages", "traits": { - "smithy.api#documentation": "If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be\n\t\t\tcreated or modified, but some elements of the dashboard\n\t\t\tmight not render.
\nIf this result includes error messages, the input was not valid and the operation failed.
" + "smithy.api#documentation": "If the input for PutDashboard was correct and the dashboard was\n successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for\n the dashboard to be created or modified, but some elements of the dashboard might not\n render.
\nIf this result includes error messages, the input was not valid and the operation\n failed.
" } } }, @@ -5717,7 +5829,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Contributor Insights rule. Rules evaluate log events in a\n\t\tCloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, \n\t\tsee Using Contributor Insights to Analyze High-Cardinality Data.
\nIf you create a rule, delete it, and then re-create it with the same name, historical data from the first time\n\t\t\tthe rule was created might not be available.
" + "smithy.api#documentation": "Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs\n log group, enabling you to find contributor data for the log events in that log group.\n For more information, see Using Contributor\n Insights to Analyze High-Cardinality Data.
\nIf you create a rule, delete it, and then re-create it with the same name, historical\n data from the first time the rule was created might not be available.
" } }, "com.amazonaws.cloudwatch#PutInsightRuleInput": { @@ -5741,14 +5853,14 @@ "target": "com.amazonaws.cloudwatch#InsightRuleDefinition", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The definition of the rule, as a JSON object. For details on the valid syntax, see \n\t\t\tContributor Insights\n\t\t\tRule Syntax.
", + "smithy.api#documentation": "The definition of the rule, as a JSON object. For details on the valid syntax, see\n Contributor Insights Rule Syntax.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cloudwatch#TagList", "traits": { - "smithy.api#documentation": "A list of key-value pairs to associate with the Contributor Insights rule. \n\t\t\tYou can associate as many as 50 tags with a rule.
\nTags can help you organize and categorize your\n\t\t\tresources. You can also use them to scope user permissions, by \n\t\t\tgranting a user permission to access or change only the resources that have\n\t\t\tcertain tag values.
\nTo be able to associate tags with a rule, you must have the cloudwatch:TagResource\n\t\tpermission in addition to the cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any tags\n\t\tyou specify in this parameter are ignored. To change the tags of an existing rule, use\n\t\t\tTagResource.
" + "smithy.api#documentation": "A list of key-value pairs to associate with the Contributor Insights rule. You can\n associate as many as 50 tags with a rule.
\nTags can help you organize and categorize your resources. You can also use them to\n scope user permissions, by granting a user permission to access or change only the\n resources that have certain tag values.
\nTo be able to associate tags with a rule, you must have the\n cloudwatch:TagResource permission in addition to the\n cloudwatch:PutInsightRule permission.
If you are using this operation to update an existing Contributor Insights rule, any\n tags you specify in this parameter are ignored. To change the tags of an existing rule,\n use TagResource.
" } } }, @@ -5780,7 +5892,7 @@ } ], "traits": { - "smithy.api#documentation": "\n\t\t\tCreates a managed Contributor Insights rule \n\t\t\tfor a specified Amazon Web Services resource.\n\t\t\tWhen you enable a managed rule, \n\t\t\tyou create a Contributor Insights rule \n\t\t\tthat collects data \n\t\t\tfrom Amazon Web Services services. \n\t\t\tYou cannot edit these rules \n\t\t\twith PutInsightRule.\n\t\t\tThe rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules.\n\t\t\tIf a previously created managed rule is currently disabled,\n\t\t\ta subsequent call\n\t\t\tto this API will re-enable it.\n\t\t\tUse ListManagedInsightRules \n\t\t\tto describe all available rules. \n\t\t\t\n\t\t
Creates a managed Contributor Insights rule for a specified Amazon Web Services\n resource. When you enable a managed rule, you create a Contributor Insights rule that\n collects data from Amazon Web Services services. You cannot edit these rules with\n PutInsightRule. The rules can be enabled, disabled, and deleted using\n EnableInsightRules, DisableInsightRules, and\n DeleteInsightRules. If a previously created managed rule is currently\n disabled, a subsequent call to this API will re-enable it. Use\n ListManagedInsightRules to describe all available rules.\n \n
\n\t\t\tA list\n\t\t\tof ManagedRules\n\t\t\tto enable.\n\t\t
A list of ManagedRules to enable.
\n\t\t\tAn array \n\t\t\tthat lists the rules \n\t\t\tthat could not be enabled.\n\t\t
" + "smithy.api#documentation": "An array that lists the rules that could not be enabled.
" } } }, @@ -5827,7 +5939,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tanomaly detection model, or Metrics Insights query. For more information about using \n\t\t\ta Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
\nAlarms based on anomaly detection models cannot have Auto Scaling actions.
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.
\nIf you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:
\nThe iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm\n\t\t\t\t\twith Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
\n Cross-account alarms\n
\nYou can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:
\nThe account where the metrics are located (the sharing account) must \n\t\t\t\talready have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already \n\t\t\t\thave this role, you must create it using the instructions in Set up a\n\t\t\t\t\tsharing account in \n\t\t\t\t\tCross-account cross-Region CloudWatch console. The policy for that\n\t\t\t\trole must grant access\n\t\t\t\tto the ID of the account where you are creating the alarm.\n\t\t\t
\nThe account where you are creating the alarm (the monitoring account) must \n\t\t\t\talready have a service-linked role named\n\t\t\t\tAWSServiceRoleForCloudWatchCrossAccount to allow \n\t\t\t\tCloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a\n\t\t\t\t\tmonitoring account in \n\t\t\t\t\t\tCross-account cross-Region CloudWatch console.
\nCreates or updates an alarm and associates it with the specified metric, metric\n math expression, anomaly detection model, or Metrics Insights query. For more\n information about using a Metrics Insights query for an alarm, see Create\n alarms on Metrics Insights queries.
\nAlarms based on anomaly detection models cannot have Auto Scaling actions.
\nWhen this operation creates an alarm, the alarm state is immediately set to\n INSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n appropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the update\n completely overwrites the previous configuration of the alarm.
\nIf you are an IAM user, you must have Amazon EC2 permissions for\n some alarm operations:
\nThe iam:CreateServiceLinkedRole permission for all alarms with\n EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm\n with Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary\n service-linked role for you. The service-linked roles are called\n AWSServiceRoleForCloudWatchEvents and\n AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see\n Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120\n KB.
\n Cross-account alarms\n
\nYou can set an alarm on metrics in the current account, or in another account. To\n create a cross-account alarm that watches a metric in a different account, you must have\n completed the following pre-requisites:
\nThe account where the metrics are located (the sharing\n account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not\n already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy\n for that role must grant access to the ID of the account where you are creating\n the alarm.
\nThe account where you are creating the alarm (the monitoring\n account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow\n CloudWatch to assume the sharing role in the sharing account. If it\n does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.
\nThe name for the alarm. This name must be unique within the Region.
\nThe name must contain only UTF-8\n\t\t\tcharacters, and can't contain ASCII control characters
", + "smithy.api#documentation": "The name for the alarm. This name must be unique within the Region.
\nThe name must contain only UTF-8 characters, and can't contain ASCII control\n characters
", "smithy.api#required": {} } }, @@ -5850,49 +5962,49 @@ "ActionsEnabled": { "target": "com.amazonaws.cloudwatch#ActionsEnabled", "traits": { - "smithy.api#documentation": "Indicates whether actions should be executed during any changes to the alarm state. The default is \n\t\t\tTRUE.
Indicates whether actions should be executed during any changes to the alarm state.\n The default is TRUE.
The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to an OK state from\n any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the\n INSUFFICIENT_DATA state from any other state. Each action is specified\n as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n Lambda actions:\n
\nInvoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n
Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n
Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The name for the metric associated with the alarm. For each PutMetricAlarm\n\t\toperation, you must specify either MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the \n\t\t\tNamespace, Dimensions, Period,\n\t\t\tUnit, Statistic, or ExtendedStatistic parameters. Instead, you specify \n\t\tall this information in the Metrics array.
The name for the metric associated with the alarm. For each\n PutMetricAlarm operation, you must specify either\n MetricName or a Metrics array.
If you are creating an alarm based on a math expression, you cannot specify this\n parameter, or any of the Namespace, Dimensions,\n Period, Unit, Statistic, or\n ExtendedStatistic parameters. Instead, you specify all this information\n in the Metrics array.
The namespace for the metric associated specified in MetricName.
The namespace for the metric associated specified in\n MetricName.
The statistic for the metric specified in MetricName, other than percentile.\n\t\t For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\tspecify either Statistic or ExtendedStatistic, but not both.
The statistic for the metric specified in MetricName, other than\n percentile. For percentile statistics, use ExtendedStatistic. When you call\n PutMetricAlarm and specify a MetricName, you must specify\n either Statistic or ExtendedStatistic, but not both.
The extended statistic for the metric specified in MetricName. When you \n\t\t\tcall PutMetricAlarm and specify \n\t\t\ta MetricName, you must \n\t\t\tspecify either Statistic or ExtendedStatistic but not both.
If you specify ExtendedStatistic, the following are valid values:
\n p90\n
\n tm90\n
\n tc90\n
\n ts90\n
\n wm90\n
\n IQM\n
\n PR(n:m) where n and m are values \n\t\t\tof the metric
\n TC(X%:X%) where X is between \n\t\t\t\t10 and 90 inclusive.
\n TM(X%:X%) where X is between \n\t\t\t\t10 and 90 inclusive.
\n TS(X%:X%) where X is between \n\t\t\t\t10 and 90 inclusive.
\n WM(X%:X%) where X is between \n\t\t\t\t10 and 90 inclusive.
For more information about these extended statistics, see \n\t\t\tCloudWatch statistics definitions.
" + "smithy.api#documentation": "The extended statistic for the metric specified in MetricName. When\n you call PutMetricAlarm and specify a MetricName, you must\n specify either Statistic or ExtendedStatistic but not\n both.
If you specify ExtendedStatistic, the following are valid values:
\n p90\n
\n tm90\n
\n tc90\n
\n ts90\n
\n wm90\n
\n IQM\n
\n PR(n:m) where n and m\n are values of the metric
\n TC(X%:X%) where X is\n between 10 and 90 inclusive.
\n TM(X%:X%) where X is\n between 10 and 90 inclusive.
\n TS(X%:X%) where X is\n between 10 and 90 inclusive.
\n WM(X%:X%) where X is\n between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
" } }, "Dimensions": { @@ -5904,71 +6016,71 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "The length, in seconds, used each time the metric specified in MetricName is\n\t\t\tevaluated. Valid values are 10, 30, and any multiple of 60.
\n Period is required for alarms based on static thresholds. If \n\t\tyou are creating an alarm based on a metric math expression, you specify the \n\t\tperiod for each metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a\n\t\t\t\tStorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have\n\t\t\tsub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,\n\t\t\tit does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm\n\t\t\tmight often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,\n\t\t\twhich has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
An alarm's total current evaluation period can\n\t\tbe no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
The length, in seconds, used each time the metric specified in\n MetricName is evaluated. Valid values are 10, 30, and any multiple of\n 60.
\n Period is required for alarms based on static thresholds. If you are\n creating an alarm based on a metric math expression, you specify the period for each\n metric within the objects in the Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a\n PutMetricData call with a StorageResolution of 1. If you\n specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the\n alarm still attempts to gather data at the period rate that you specify. In this case,\n it does not receive data for the attempts that do not correspond to a one-minute data\n resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10\n or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than\n other alarms. For more information about pricing, see Amazon CloudWatch\n Pricing.
An alarm's total current evaluation period can be no longer than one day, so\n Period multiplied by EvaluationPeriods cannot be more than\n 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2\n\t\t\tNetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n\t\t\treceives on all network interfaces. You can also specify a unit when you create a custom\n\t\t\tmetric. Units help provide conceptual meaning to your data. Metric data points that\n\t\t\tspecify a unit of measure, such as Percent, are aggregated separately.\n\t\t\tIf you are creating an alarm based on a metric math expression, you can specify the unit for each \n\t\t\tmetric (if needed) within the objects in the Metrics array.
If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the\n\t\t\tmetric and attempts to evaluate the alarm.\n\t\t\tUsually, metrics are\n\t\t\tpublished with only one unit, so the alarm\n\t\t\tworks as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's\n\t\t\tbehavior is not defined and\n\t\t\tit behaves unpredictably.
\nWe recommend omitting Unit so that you don't inadvertently\n\t\t\tspecify an incorrect unit that is not published for this metric. Doing so \n\t\t\tcauses the alarm to be stuck in the INSUFFICIENT DATA state.
The unit of measure for the statistic. For example, the units for the Amazon EC2\n NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance\n receives on all network interfaces. You can also specify a unit when you create a custom\n metric. Units help provide conceptual meaning to your data. Metric data points that\n specify a unit of measure, such as Percent, are aggregated separately. If you are\n creating an alarm based on a metric math expression, you can specify the unit for each\n metric (if needed) within the objects in the Metrics array.
If you don't specify Unit, CloudWatch retrieves all unit types that\n have been published for the metric and attempts to evaluate the alarm. Usually, metrics\n are published with only one unit, so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't\n specify a unit, the alarm's behavior is not defined and it behaves\n unpredictably.
\nWe recommend omitting Unit so that you don't inadvertently specify an\n incorrect unit that is not published for this metric. Doing so causes the alarm to be\n stuck in the INSUFFICIENT DATA state.
The number of periods over which data is compared to the specified threshold. If you are\n\t\t\tsetting an alarm that requires that a number of consecutive data points be breaching to\n\t\t\ttrigger the alarm, this value specifies that number. If you are setting an \"M out of N\"\n\t\t\talarm, this value is the N.
\nAn alarm's total current evaluation period can\n\t\t\tbe no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
The number of periods over which data is compared to the specified threshold. If\n you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies that number. If you are setting an\n \"M out of N\" alarm, this value is the N.
\nAn alarm's total current evaluation period can be no longer than one day, so this\n number multiplied by Period cannot be more than 86,400 seconds.
The number of data points that must be breaching to trigger the alarm. This is used only if you are setting \n\t\t\tan \"M out of N\" alarm. In that case, this value is the M. For more information, see \n\t\t\tEvaluating an Alarm in the\n\t\t\tAmazon CloudWatch User Guide.
" + "smithy.api#documentation": "The number of data points that must be breaching to trigger the alarm. This is used\n only if you are setting an \"M out of N\" alarm. In that case, this value is the M. For\n more information, see Evaluating an Alarm in the Amazon CloudWatch User\n Guide.
" } }, "Threshold": { "target": "com.amazonaws.cloudwatch#Threshold", "traits": { - "smithy.api#documentation": "The value against which the specified statistic is compared.
\nThis parameter is required for alarms based on static thresholds, but should\n\t\tnot be used for alarms based on anomaly detection models.
" + "smithy.api#documentation": "The value against which the specified statistic is compared.
\nThis parameter is required for alarms based on static thresholds, but should not be\n used for alarms based on anomaly detection models.
" } }, "ComparisonOperator": { "target": "com.amazonaws.cloudwatch#ComparisonOperator", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The arithmetic operation to use when comparing the specified statistic and\n\t\t\tthreshold. The specified statistic value is used as the first operand.
\nThe values LessThanLowerOrGreaterThanUpperThreshold, \n\t\t\tLessThanLowerThreshold, and GreaterThanUpperThreshold\n\t\tare used only for alarms based on anomaly detection models.
The arithmetic operation to use when comparing the specified statistic and\n threshold. The specified statistic value is used as the first operand.
\nThe values LessThanLowerOrGreaterThanUpperThreshold,\n LessThanLowerThreshold, and GreaterThanUpperThreshold are\n used only for alarms based on anomaly detection models.
Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing\n
Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.
Sets how this alarm is to handle missing data points. If\n TreatMissingData is omitted, the default behavior of\n missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing\n
Alarms that evaluate metrics in the AWS/DynamoDB namespace always\n ignore missing data even if you choose a different option for\n TreatMissingData. When an AWS/DynamoDB metric has\n missing data, alarms that evaluate that metric remain in their current state.
Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be \n\t\t\tstatistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state\n\t\t\tno matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore\n
Used only for alarms based on percentiles. If you specify ignore, the\n alarm state does not change during periods with too few data points to be statistically\n significant. If you specify evaluate or omit this parameter, the alarm is\n always evaluated and possibly changes state no matter how many data points are\n available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore\n
An array of MetricDataQuery structures that enable you to create an alarm based on the result of a \n\t\t\tmetric math expression. For each PutMetricAlarm\n\t\t\toperation, you must specify either MetricName or a Metrics array.
Each item in the Metrics array either retrieves a metric or performs a math expression.
One item in the Metrics array is the expression that the alarm watches. You designate this expression \n\t\t\tby setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the \n\t\t\tNamespace, MetricName, Dimensions, Period,\n\t\t\tUnit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. \n\t\t\tInstead, you retrieve\n\t\tthe metrics you are using in your math expression as part of the Metrics array.
An array of MetricDataQuery structures that enable you to create an alarm\n based on the result of a metric math expression. For each PutMetricAlarm\n operation, you must specify either MetricName or a Metrics\n array.
Each item in the Metrics array either retrieves a metric or performs a\n math expression.
One item in the Metrics array is the expression that the alarm watches.\n You designate this expression by setting ReturnData to true for this object\n in the array. For more information, see MetricDataQuery.
If you use the Metrics parameter, you cannot include the\n Namespace, MetricName, Dimensions,\n Period, Unit, Statistic, or\n ExtendedStatistic parameters of PutMetricAlarm in the same\n operation. Instead, you retrieve the metrics you are using in your math expression as\n part of the Metrics array.
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.\n\t\tTo be able to associate tags with the alarm when you create the alarm, you must\n\t\thave the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\nIf you are using this operation to update an existing alarm, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing alarm, use\n\t\t\tTagResource\n\t\t\tor UntagResource.
" + "smithy.api#documentation": "A list of key-value pairs to associate with the alarm. You can associate as many as\n 50 tags with an alarm. To be able to associate tags with the alarm when you create the\n alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to\n scope user permissions by granting a user permission to access or change only resources\n with certain tag values.
\nIf you are using this operation to update an existing alarm, any tags you specify in\n this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
\nTo use this field to set tags for an alarm when you create it, you must be signed on\n with both the cloudwatch:PutMetricAlarm and\n cloudwatch:TagResource permissions.
If this is an alarm based on an anomaly detection model, make this value match\n\t\t\tthe ID of\n\t\t\tthe ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the \n\t\t\tAnomaly Detection\n\t\tModel Alarm example on this page.
\nIf your alarm uses this parameter, it cannot have Auto Scaling actions.
" + "smithy.api#documentation": "If this is an alarm based on an anomaly detection model, make this value match the ID\n of the ANOMALY_DETECTION_BAND function.
For an example of how to use this parameter, see the Anomaly\n Detection Model Alarm example on this page.
\nIf your alarm uses this parameter, it cannot have Auto Scaling actions.
" } } }, @@ -5999,7 +6111,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.
\nYou can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricData structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.
Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.
\nYou specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.
\nData points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.
\nCloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:
\nThe SampleCount value of the statistic set is 1 and Min,\n\t\t\t\t\tMax, and Sum are all equal.
The Min and\n\t\t\t\t\tMax are equal, and Sum is equal to Min \n\t\t\t\t\tmultiplied by SampleCount.
Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the\n specified metric. If the specified metric does not exist, CloudWatch creates the metric.\n When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to\n appear in calls to ListMetrics.
\nYou can publish metrics with associated entity data (so that related telemetry can be\n found and viewed together), or publish metric data by itself. To send entity data with\n your metrics, use the EntityMetricData parameter. To send metrics without\n entity data, use the MetricData parameter. The\n EntityMetricData structure includes MetricData structures\n for the metric data.
You can publish either individual values in the Value field, or arrays of\n values and the number of times each value occurred during the period by using the\n Values and Counts fields in the MetricData\n structure. Using the Values and Counts method enables you to\n publish up to 150 values per metric with one PutMetricData request, and\n supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 1 MB in size for HTTP POST\n requests. You can send a payload compressed by gzip. Each request is also limited to no\n more than 1000 different metrics (across both the MetricData and \n EntityMetricData properties).
Although the Value parameter accepts numbers of type Double,\n CloudWatch rejects values that are either too small or too large. Values must be in the\n range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n -Infinity) are not supported.
You can use up to 30 dimensions per metric to further clarify what data the metric\n collects. Each dimension consists of a Name and Value pair. For more information about\n specifying dimensions, see Publishing\n Metrics in the Amazon CloudWatch User Guide.
\nYou specify the time stamp to be associated with each data point. You can specify time\n stamps that are as much as two weeks before the current date, and as much as 2 hours\n after the current day and time.
\nData points with time stamps from 24 hours ago or longer can take at least 48 hours to\n become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time\n stamps between 3 and 24 hours ago can take as much as 2 hours to become available for\n GetMetricData or GetMetricStatistics.
\nCloudWatch needs raw data points to calculate percentile statistics. If you publish\n data using a statistic set instead, you can only retrieve percentile statistics for this\n data if one of the following conditions is true:
\nThe SampleCount value of the statistic set is 1 and\n Min, Max, and Sum are all\n equal.
The Min and Max are equal, and Sum\n is equal to Min multiplied by SampleCount.
The namespace for the metric data. You can use ASCII characters for the namespace, except for\n\t\tcontrol characters which are not supported.
\nTo avoid conflicts\n\t\t\twith Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/\n
The namespace for the metric data. You can use ASCII characters for the namespace,\n except for control characters which are not supported.
\nTo avoid conflicts with Amazon Web Services service namespaces, you should not\n specify a namespace that begins with AWS/\n
The data for the metric. The array can include no more than 1000 metrics per call.
", - "smithy.api#required": {} + "smithy.api#documentation": "The data for the metrics. Use this parameter if your metrics do not contain\n associated entities. The array can include no more than 1000 metrics per call.
\nThe limit of metrics allowed, 1000, is the sum of both EntityMetricData \n and MetricData metrics.
Data for metrics that contain associated entity information. You can include up to \n two EntityMetricData objects, each of which can contain a single \n Entity and associated metrics.
The limit of metrics allowed, 1000, is the sum of both EntityMetricData \n and MetricData metrics.
Whether to accept valid metric data when an invalid entity is sent.
\nWhen set to true: Any validation error (for entity or metric \n data) will fail the entire request, and no data will be ingested. The failed \n operation will return a 400 result with the error.
When set to false: Validation errors in the entity will not \n associate the metric with the entity, but the metric data will still be \n accepted and ingested. Validation errors in the metric data will fail the \n entire request, and no data will be ingested.
In the case of an invalid entity, the operation will return a \n 200 status, but an additional response header will contain \n information about the validation errors. The new header, \n X-Amzn-Failure-Message is an enumeration of the following \n values:
\n InvalidEntity - The provided entity is invalid.
\n InvalidKeyAttributes - The provided\n KeyAttributes of an entity is invalid.
\n InvalidAttributes - The provided Attributes\n of an entity is invalid.
\n InvalidTypeValue - The provided Type in the\n KeyAttributes of an entity is invalid.
\n EntitySizeTooLarge - The number of \n EntityMetricData objects allowed is 2.
\n MissingRequiredFields - There are missing required \n fields in the KeyAttributes for the provided\n Type.
For details of the requirements for specifying an entity, see \n How \n to add related information to telemetry in the \n CloudWatch User Guide.
\nThis parameter is required when EntityMetricData is\n included.
Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n\t\t\tmetrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n\t\t\tsolutions.
\nFor more information, see \n\t\tUsing Metric Streams.
\nTo create a metric stream, you must be signed in to an account that has the\n\t\t\t\tiam:PassRole permission and either the\n\t\t\t\tCloudWatchFullAccess policy or the\n\t\t\t\tcloudwatch:PutMetricStream permission.
When you create or update a metric stream, you choose one of the following:
\nStream metrics from all metric namespaces in the account.
\nStream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in \n\t\t\t\tIncludeFilters.
By default, a metric stream always sends the MAX, MIN,\n\t\t\t\tSUM, and SAMPLECOUNT statistics for each metric that is\n\t\t\tstreamed. You can use the StatisticsConfigurations parameter to have the\n\t\t\tmetric stream send additional statistics in the stream. Streaming additional statistics\n\t\t\tincurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric stream in a monitoring account,\n\t\t\tyou can choose whether to include metrics from source accounts in the stream. For more information, see \n\t\t\tCloudWatch cross-account observability.
" + "smithy.api#documentation": "Creates or updates a metric stream. Metric streams can automatically stream CloudWatch\n metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party\n solutions.
\nFor more information, see Using\n Metric Streams.
\nTo create a metric stream, you must be signed in to an account that has the\n iam:PassRole permission and either the\n CloudWatchFullAccess policy or the\n cloudwatch:PutMetricStream permission.
When you create or update a metric stream, you choose one of the following:
\nStream metrics from all metric namespaces in the account.
\nStream metrics from all metric namespaces in the account, except for the\n namespaces that you list in ExcludeFilters.
Stream metrics from only the metric namespaces that you list in\n IncludeFilters.
By default, a metric stream always sends the MAX, MIN,\n SUM, and SAMPLECOUNT statistics for each metric that is\n streamed. You can use the StatisticsConfigurations parameter to have the\n metric stream send additional statistics in the stream. Streaming additional statistics\n incurs additional costs. For more information, see Amazon CloudWatch Pricing.
When you use PutMetricStream to create a new metric stream, the stream is\n created in the running state. If you use it to update an existing stream,\n the state of the stream is not changed.
If you are using CloudWatch cross-account observability and you create a metric\n stream in a monitoring account, you can choose whether to include metrics from source\n accounts in the stream. For more information, see CloudWatch cross-account observability.
" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -6065,27 +6187,27 @@ "target": "com.amazonaws.cloudwatch#MetricStreamName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "If you are creating a new metric stream, this is the name for the new stream. The name\n\t\tmust be different than the names of other metric streams in this account and Region.
\nIf you are updating a metric stream, specify the name of that stream here.
\nValid characters are A-Z, a-z, 0-9, \"-\" and \"_\".
", + "smithy.api#documentation": "If you are creating a new metric stream, this is the name for the new stream. The name\n must be different than the names of other metric streams in this account and\n Region.
\nIf you are updating a metric stream, specify the name of that stream here.
\nValid characters are A-Z, a-z, 0-9, \"-\" and \"_\".
", "smithy.api#required": {} } }, "IncludeFilters": { "target": "com.amazonaws.cloudwatch#MetricStreamFilters", "traits": { - "smithy.api#documentation": "If you specify this parameter, the stream sends only the \n\t\tmetrics from the metric namespaces that you specify here.
\nYou cannot include IncludeFilters and ExcludeFilters\n\t\tin the same operation.
If you specify this parameter, the stream sends only the metrics from the metric\n namespaces that you specify here.
\nYou cannot include IncludeFilters and ExcludeFilters in the\n same operation.
If you specify this parameter, the stream sends metrics from all\n\t\t\tmetric namespaces except for the namespaces that you specify here.
\nYou cannot include ExcludeFilters and IncludeFilters in \n\t\t\tthe same operation.
If you specify this parameter, the stream sends metrics from all metric namespaces\n except for the namespaces that you specify here.
\nYou cannot include ExcludeFilters and IncludeFilters in the\n same operation.
The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream.\n\t\t\tThis Amazon Kinesis Data Firehose delivery stream must already exist and must be in the\n\t\t\tsame account as the metric stream.
", + "smithy.api#documentation": "The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric\n stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be\n in the same account as the metric stream.
", "smithy.api#required": {} } }, @@ -6093,7 +6215,7 @@ "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n\t\t\tFirehose resources. This IAM role must already exist and must be in the same account as\n\t\t\tthe metric stream. This IAM role must include the following permissions:
\nfirehose:PutRecord
\nfirehose:PutRecordBatch
\nThe ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data\n Firehose resources. This IAM role must already exist and must be in the same account as\n the metric stream. This IAM role must include the following permissions:
\nfirehose:PutRecord
\nfirehose:PutRecordBatch
\nThe output format for the stream. Valid values are json, opentelemetry1.0, \n\t\t\tand opentelemetry0.7. For more information about metric stream\n\t\toutput formats, see \n\t\t\t\n\t\t\t\tMetric streams output formats.
The output format for the stream. Valid values are json,\n opentelemetry1.0, and opentelemetry0.7. For more\n information about metric stream output formats, see \n Metric streams output formats.
A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\nYou can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.
" + "smithy.api#documentation": "A list of key-value pairs to associate with the metric stream. You can associate as\n many as 50 tags with a metric stream.
\nTags can help you organize and categorize your resources. You can also use them to\n scope user permissions by granting a user permission to access or change only resources\n with certain tag values.
\nYou can use this parameter only when you are creating a new metric stream. If you are\n using this operation to update an existing metric stream, any tags you specify in this\n parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource.
" } }, "StatisticsConfigurations": { "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", "traits": { - "smithy.api#documentation": "By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional\n\t\t\tstatistics to stream for those metrics. The additional statistics that you can stream\n\t\t\tdepend on the stream's OutputFormat. If the OutputFormat is\n\t\t\t\tjson, you can stream any additional statistic that is supported by\n\t\t\t\tCloudWatch, listed in \n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat\n\t\t\tis opentelemetry1.0 or opentelemetry0.7, you can stream percentile statistics such as p95,\n\t\t\tp99.9, and so on.
By default, a metric stream always sends the MAX, MIN,\n SUM, and SAMPLECOUNT statistics for each metric that is\n streamed. You can use this parameter to have the metric stream also send additional\n statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of\n additional statistics to stream for those metrics. The additional statistics that you\n can stream depend on the stream's OutputFormat. If the\n OutputFormat is json, you can stream any additional\n statistic that is supported by CloudWatch, listed in \n CloudWatch statistics definitions. If the OutputFormat\n is opentelemetry1.0 or opentelemetry0.7, you can stream\n percentile statistics such as p95, p99.9, and so on.
If you are creating a metric stream in a monitoring account, \n\t\t\tspecify true to include metrics from source accounts in the metric stream.
If you are creating a metric stream in a monitoring account, specify true\n to include metrics from source accounts in the metric stream.
The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
The start time of the range to exclude. The format is\n yyyy-MM-dd'T'HH:mm:ss. For example,\n 2019-07-01T23:59:59.
The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, \n\t\t\t2019-07-01T23:59:59.
The end time of the range to exclude. The format is\n yyyy-MM-dd'T'HH:mm:ss. For example,\n 2019-07-01T23:59:59.
Specifies one range of days or times to exclude from use for training an\n\t\tanomaly detection model.
" + "smithy.api#documentation": "Specifies one range of days or times to exclude from use for training an anomaly\n detection model.
" } }, "com.amazonaws.cloudwatch#RecentlyActive": { @@ -6284,7 +6406,7 @@ } ], "traits": { - "smithy.api#documentation": "Temporarily sets the state of an alarm for testing purposes. When the updated\n\t\t\tstate differs from the previous value, the action configured for\n\t\t\tthe appropriate state is invoked. For example, if your alarm is configured to send an\n\t\t\tAmazon SNS message when an alarm is triggered, temporarily changing the alarm state to\n\t\t\tALARM sends an SNS message.
Metric alarms\n\t\t\treturns to their actual state quickly, often within seconds. Because the metric alarm state change\n\t\t\thappens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through\n\t\t\tDescribeAlarmHistory.
\nIf you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return\n\t\t\tto its actual state. It\n\t\t\treturns to its actual state only once any of its children alarms change state. It is also\n\t\t\treevaluated if you update its\n\t\t\tconfiguration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include\n\t\tinformation in the StateReasonData parameter to enable the policy to take the correct action.
Temporarily sets the state of an alarm for testing purposes. When the updated state\n differs from the previous value, the action configured for the appropriate state is\n invoked. For example, if your alarm is configured to send an Amazon SNS message when an\n alarm is triggered, temporarily changing the alarm state to ALARM sends an\n SNS message.
Metric alarms returns to their actual state quickly, often within seconds. Because\n the metric alarm state change happens quickly, it is typically only visible in the\n alarm's History tab in the Amazon CloudWatch console or\n through DescribeAlarmHistory.
\nIf you use SetAlarmState on a composite alarm, the composite alarm is\n not guaranteed to return to its actual state. It returns to its actual state only once\n any of its children alarms change state. It is also reevaluated if you update its\n configuration.
If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling\n policies, you must include information in the StateReasonData parameter to\n enable the policy to take the correct action.
The reason that this alarm is set to this specific state, in JSON format.
\nFor SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling\n\t\talarm actions, the Auto Scaling policy uses the information in this field to take the correct action.
" + "smithy.api#documentation": "The reason that this alarm is set to this specific state, in JSON format.
\nFor SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling\n or application Auto Scaling alarm actions, the Auto Scaling policy uses the information\n in this field to take the correct action.
" } } }, @@ -6331,7 +6453,7 @@ "AccountId": { "target": "com.amazonaws.cloudwatch#AccountId", "traits": { - "smithy.api#documentation": "If the CloudWatch metric that provides the time series that the anomaly detector\n\t\t\tuses as input is in another account, specify that account ID here. If you omit this parameter,\n\t\tthe current account is used.
" + "smithy.api#documentation": "If the CloudWatch metric that provides the time series that the anomaly\n detector uses as input is in another account, specify that account ID here. If you omit\n this parameter, the current account is used.
" } }, "Namespace": { @@ -6360,7 +6482,7 @@ } }, "traits": { - "smithy.api#documentation": "Designates the CloudWatch metric and statistic that provides the time series the anomaly detector\n\t\t\tuses as input. If you have enabled unified cross-account observability, and this account is a monitoring\n\t\taccount, the metric can be in the same account or a source account.
" + "smithy.api#documentation": "Designates the CloudWatch metric and statistic that provides the time series the\n anomaly detector uses as input. If you have enabled unified cross-account observability,\n and this account is a monitoring account, the metric can be in the same account or a\n source account.
" } }, "com.amazonaws.cloudwatch#Size": { @@ -6563,7 +6685,7 @@ "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The array of the names of metric streams to start streaming.
\nThis is an \"all or nothing\" operation. If you do not have \n\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\tin the operation will start streaming.
", + "smithy.api#documentation": "The array of the names of metric streams to start streaming.
\nThis is an \"all or nothing\" operation. If you do not have permission to access all of\n the metric streams that you list here, then none of the streams that you list in the\n operation will start streaming.
", "smithy.api#required": {} } } @@ -6769,7 +6891,7 @@ "target": "com.amazonaws.cloudwatch#MetricStreamNames", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The array of the names of metric streams to stop streaming.
\nThis is an \"all or nothing\" operation. If you do not have \n\t\t\tpermission to access all of the metric streams that you list here, then none of the streams that you list\n\t\t\tin the operation will stop streaming.
", + "smithy.api#documentation": "The array of the names of metric streams to stop streaming.
\nThis is an \"all or nothing\" operation. If you do not have permission to access all of\n the metric streams that you list here, then none of the streams that you list in the\n operation will stop streaming.
", "smithy.api#required": {} } } @@ -6793,6 +6915,9 @@ } } }, + "com.amazonaws.cloudwatch#StrictEntityValidation": { + "type": "boolean" + }, "com.amazonaws.cloudwatch#SuppressorPeriod": { "type": "integer" }, @@ -6803,7 +6928,7 @@ "target": "com.amazonaws.cloudwatch#TagKey", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your \n\t\tresources.
", + "smithy.api#documentation": "A string that you can use to assign a value. The combination of tag keys and values\n can help you organize and categorize your resources.
", "smithy.api#required": {} } }, @@ -6864,7 +6989,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that \n\t\t\tcan be tagged are alarms and Contributor Insights rules.
\nTags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
\nYou can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n\t\t\tthis tag is appended to the list of tags associated\n\t\t\twith the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n\t\t\tthe previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
" + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified CloudWatch resource.\n Currently, the only CloudWatch resources that can be tagged are alarms and Contributor\n Insights rules.
\nTags can help you organize and categorize your resources. You can also use them to\n scope user permissions by granting a user permission to access or change only resources\n with certain tag values.
\nTags don't have any semantic meaning to Amazon Web Services and are interpreted\n strictly as strings of characters.
\nYou can use the TagResource action with an alarm that already has tags.\n If you specify a new tag key for the alarm, this tag is appended to the list of tags\n associated with the alarm. If you specify a tag key that is already associated with the\n alarm, the new tag value that you specify replaces the previous value for that\n tag.
You can associate as many as 50 tags with a CloudWatch resource.
" } }, "com.amazonaws.cloudwatch#TagResourceInput": { @@ -6874,7 +6999,7 @@ "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the CloudWatch resource that you're adding tags to.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you're adding tags to.
\nThe ARN format of an alarm is\n arn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is\n arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web\n Services General Reference.
", "smithy.api#required": {} } }, @@ -6971,7 +7096,7 @@ "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the CloudWatch resource that you're removing tags from.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you're removing tags from.
\nThe ARN format of an alarm is\n arn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is\n arn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web\n Services General Reference.
", "smithy.api#required": {} } },