UNPKG

133 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class CloudWatch extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: CloudWatch.Types.ClientConfiguration)
14 config: Config & CloudWatch.Types.ClientConfiguration;
15 /**
16 * 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. In the event of an error, no alarms are deleted. 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.
17 */
18 deleteAlarms(params: CloudWatch.Types.DeleteAlarmsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
19 /**
20 * 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. In the event of an error, no alarms are deleted. 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.
21 */
22 deleteAlarms(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
23 /**
24 * Deletes the specified anomaly detection model from your account.
25 */
26 deleteAnomalyDetector(params: CloudWatch.Types.DeleteAnomalyDetectorInput, callback?: (err: AWSError, data: CloudWatch.Types.DeleteAnomalyDetectorOutput) => void): Request<CloudWatch.Types.DeleteAnomalyDetectorOutput, AWSError>;
27 /**
28 * Deletes the specified anomaly detection model from your account.
29 */
30 deleteAnomalyDetector(callback?: (err: AWSError, data: CloudWatch.Types.DeleteAnomalyDetectorOutput) => void): Request<CloudWatch.Types.DeleteAnomalyDetectorOutput, AWSError>;
31 /**
32 * Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
33 */
34 deleteDashboards(params: CloudWatch.Types.DeleteDashboardsInput, callback?: (err: AWSError, data: CloudWatch.Types.DeleteDashboardsOutput) => void): Request<CloudWatch.Types.DeleteDashboardsOutput, AWSError>;
35 /**
36 * Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
37 */
38 deleteDashboards(callback?: (err: AWSError, data: CloudWatch.Types.DeleteDashboardsOutput) => void): Request<CloudWatch.Types.DeleteDashboardsOutput, AWSError>;
39 /**
40 * 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 may or may not be available.
41 */
42 deleteInsightRules(params: CloudWatch.Types.DeleteInsightRulesInput, callback?: (err: AWSError, data: CloudWatch.Types.DeleteInsightRulesOutput) => void): Request<CloudWatch.Types.DeleteInsightRulesOutput, AWSError>;
43 /**
44 * 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 may or may not be available.
45 */
46 deleteInsightRules(callback?: (err: AWSError, data: CloudWatch.Types.DeleteInsightRulesOutput) => void): Request<CloudWatch.Types.DeleteInsightRulesOutput, AWSError>;
47 /**
48 * 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.
49 */
50 describeAlarmHistory(params: CloudWatch.Types.DescribeAlarmHistoryInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request<CloudWatch.Types.DescribeAlarmHistoryOutput, AWSError>;
51 /**
52 * 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.
53 */
54 describeAlarmHistory(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmHistoryOutput) => void): Request<CloudWatch.Types.DescribeAlarmHistoryOutput, AWSError>;
55 /**
56 * Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.
57 */
58 describeAlarms(params: CloudWatch.Types.DescribeAlarmsInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
59 /**
60 * Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.
61 */
62 describeAlarms(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
63 /**
64 * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
65 */
66 describeAlarmsForMetric(params: CloudWatch.Types.DescribeAlarmsForMetricInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request<CloudWatch.Types.DescribeAlarmsForMetricOutput, AWSError>;
67 /**
68 * Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
69 */
70 describeAlarmsForMetric(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsForMetricOutput) => void): Request<CloudWatch.Types.DescribeAlarmsForMetricOutput, AWSError>;
71 /**
72 * Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.
73 */
74 describeAnomalyDetectors(params: CloudWatch.Types.DescribeAnomalyDetectorsInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAnomalyDetectorsOutput) => void): Request<CloudWatch.Types.DescribeAnomalyDetectorsOutput, AWSError>;
75 /**
76 * Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.
77 */
78 describeAnomalyDetectors(callback?: (err: AWSError, data: CloudWatch.Types.DescribeAnomalyDetectorsOutput) => void): Request<CloudWatch.Types.DescribeAnomalyDetectorsOutput, AWSError>;
79 /**
80 * Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation. For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
81 */
82 describeInsightRules(params: CloudWatch.Types.DescribeInsightRulesInput, callback?: (err: AWSError, data: CloudWatch.Types.DescribeInsightRulesOutput) => void): Request<CloudWatch.Types.DescribeInsightRulesOutput, AWSError>;
83 /**
84 * Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation. For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
85 */
86 describeInsightRules(callback?: (err: AWSError, data: CloudWatch.Types.DescribeInsightRulesOutput) => void): Request<CloudWatch.Types.DescribeInsightRulesOutput, AWSError>;
87 /**
88 * 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.
89 */
90 disableAlarmActions(params: CloudWatch.Types.DisableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
91 /**
92 * 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.
93 */
94 disableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
95 /**
96 * Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
97 */
98 disableInsightRules(params: CloudWatch.Types.DisableInsightRulesInput, callback?: (err: AWSError, data: CloudWatch.Types.DisableInsightRulesOutput) => void): Request<CloudWatch.Types.DisableInsightRulesOutput, AWSError>;
99 /**
100 * Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
101 */
102 disableInsightRules(callback?: (err: AWSError, data: CloudWatch.Types.DisableInsightRulesOutput) => void): Request<CloudWatch.Types.DisableInsightRulesOutput, AWSError>;
103 /**
104 * Enables the actions for the specified alarms.
105 */
106 enableAlarmActions(params: CloudWatch.Types.EnableAlarmActionsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
107 /**
108 * Enables the actions for the specified alarms.
109 */
110 enableAlarmActions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
111 /**
112 * Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
113 */
114 enableInsightRules(params: CloudWatch.Types.EnableInsightRulesInput, callback?: (err: AWSError, data: CloudWatch.Types.EnableInsightRulesOutput) => void): Request<CloudWatch.Types.EnableInsightRulesOutput, AWSError>;
115 /**
116 * Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
117 */
118 enableInsightRules(callback?: (err: AWSError, data: CloudWatch.Types.EnableInsightRulesOutput) => void): Request<CloudWatch.Types.EnableInsightRulesOutput, AWSError>;
119 /**
120 * 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.
121 */
122 getDashboard(params: CloudWatch.Types.GetDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request<CloudWatch.Types.GetDashboardOutput, AWSError>;
123 /**
124 * 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.
125 */
126 getDashboard(callback?: (err: AWSError, data: CloudWatch.Types.GetDashboardOutput) => void): Request<CloudWatch.Types.GetDashboardOutput, AWSError>;
127 /**
128 * 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. MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor may 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. 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. 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.
129 */
130 getInsightRuleReport(params: CloudWatch.Types.GetInsightRuleReportInput, callback?: (err: AWSError, data: CloudWatch.Types.GetInsightRuleReportOutput) => void): Request<CloudWatch.Types.GetInsightRuleReportOutput, AWSError>;
131 /**
132 * 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. MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor may 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. 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. 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.
133 */
134 getInsightRuleReport(callback?: (err: AWSError, data: CloudWatch.Types.GetInsightRuleReportOutput) => void): Request<CloudWatch.Types.GetInsightRuleReportOutput, AWSError>;
135 /**
136 * You can use the GetMetricData API to 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 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. Calls to the GetMetricData API have a different pricing structure than calls to 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 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 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 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.
137 */
138 getMetricData(params: CloudWatch.Types.GetMetricDataInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request<CloudWatch.Types.GetMetricDataOutput, AWSError>;
139 /**
140 * You can use the GetMetricData API to 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 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. Calls to the GetMetricData API have a different pricing structure than calls to 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 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 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 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.
141 */
142 getMetricData(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricDataOutput) => void): Request<CloudWatch.Types.GetMetricDataOutput, AWSError>;
143 /**
144 * 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. 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: The SampleCount value of the statistic set is 1. 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. 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 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 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 AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
145 */
146 getMetricStatistics(params: CloudWatch.Types.GetMetricStatisticsInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request<CloudWatch.Types.GetMetricStatisticsOutput, AWSError>;
147 /**
148 * 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. 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: The SampleCount value of the statistic set is 1. 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. 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 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 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 AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.
149 */
150 getMetricStatistics(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricStatisticsOutput) => void): Request<CloudWatch.Types.GetMetricStatisticsOutput, AWSError>;
151 /**
152 * 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. Up to 100 KB uncompressed payload.
153 */
154 getMetricWidgetImage(params: CloudWatch.Types.GetMetricWidgetImageInput, callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request<CloudWatch.Types.GetMetricWidgetImageOutput, AWSError>;
155 /**
156 * 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. Up to 100 KB uncompressed payload.
157 */
158 getMetricWidgetImage(callback?: (err: AWSError, data: CloudWatch.Types.GetMetricWidgetImageOutput) => void): Request<CloudWatch.Types.GetMetricWidgetImageOutput, AWSError>;
159 /**
160 * 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.
161 */
162 listDashboards(params: CloudWatch.Types.ListDashboardsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request<CloudWatch.Types.ListDashboardsOutput, AWSError>;
163 /**
164 * 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.
165 */
166 listDashboards(callback?: (err: AWSError, data: CloudWatch.Types.ListDashboardsOutput) => void): Request<CloudWatch.Types.ListDashboardsOutput, AWSError>;
167 /**
168 * List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain 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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
169 */
170 listMetrics(params: CloudWatch.Types.ListMetricsInput, callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request<CloudWatch.Types.ListMetricsOutput, AWSError>;
171 /**
172 * List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain 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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.
173 */
174 listMetrics(callback?: (err: AWSError, data: CloudWatch.Types.ListMetricsOutput) => void): Request<CloudWatch.Types.ListMetricsOutput, AWSError>;
175 /**
176 * Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
177 */
178 listTagsForResource(params: CloudWatch.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request<CloudWatch.Types.ListTagsForResourceOutput, AWSError>;
179 /**
180 * Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.
181 */
182 listTagsForResource(callback?: (err: AWSError, data: CloudWatch.Types.ListTagsForResourceOutput) => void): Request<CloudWatch.Types.ListTagsForResourceOutput, AWSError>;
183 /**
184 * 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. For more information, see CloudWatch Anomaly Detection.
185 */
186 putAnomalyDetector(params: CloudWatch.Types.PutAnomalyDetectorInput, callback?: (err: AWSError, data: CloudWatch.Types.PutAnomalyDetectorOutput) => void): Request<CloudWatch.Types.PutAnomalyDetectorOutput, AWSError>;
187 /**
188 * 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. For more information, see CloudWatch Anomaly Detection.
189 */
190 putAnomalyDetector(callback?: (err: AWSError, data: CloudWatch.Types.PutAnomalyDetectorOutput) => void): Request<CloudWatch.Types.PutAnomalyDetectorOutput, AWSError>;
191 /**
192 * 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. The alarms specified in a composite alarm's rule expression can include metric alarms and other 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. Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics. 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. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
193 */
194 putCompositeAlarm(params: CloudWatch.Types.PutCompositeAlarmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
195 /**
196 * 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. The alarms specified in a composite alarm's rule expression can include metric alarms and other 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. Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics. 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. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
197 */
198 putCompositeAlarm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
199 /**
200 * 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. 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.
201 */
202 putDashboard(params: CloudWatch.Types.PutDashboardInput, callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request<CloudWatch.Types.PutDashboardOutput, AWSError>;
203 /**
204 * 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. 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.
205 */
206 putDashboard(callback?: (err: AWSError, data: CloudWatch.Types.PutDashboardOutput) => void): Request<CloudWatch.Types.PutDashboardOutput, AWSError>;
207 /**
208 * 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 may or may not be available.
209 */
210 putInsightRule(params: CloudWatch.Types.PutInsightRuleInput, callback?: (err: AWSError, data: CloudWatch.Types.PutInsightRuleOutput) => void): Request<CloudWatch.Types.PutInsightRuleOutput, AWSError>;
211 /**
212 * 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 may or may not be available.
213 */
214 putInsightRule(callback?: (err: AWSError, data: CloudWatch.Types.PutInsightRuleOutput) => void): Request<CloudWatch.Types.PutInsightRuleOutput, AWSError>;
215 /**
216 * Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model. 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: iam:CreateServiceLinkedRole for all alarms with EC2 actions ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics ec2:StopInstances for alarms with stop actions ec2:TerminateInstances for alarms with terminate actions No specific permissions are needed for alarms with recover actions If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed. If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions. The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
217 */
218 putMetricAlarm(params: CloudWatch.Types.PutMetricAlarmInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
219 /**
220 * Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model. 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: iam:CreateServiceLinkedRole for all alarms with EC2 actions ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics ec2:StopInstances for alarms with stop actions ec2:TerminateInstances for alarms with terminate actions No specific permissions are needed for alarms with recover actions If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed. If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions. The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.
221 */
222 putMetricAlarm(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
223 /**
224 * 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 MetricDatum 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 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 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 10 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. 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. 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: 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.
225 */
226 putMetricData(params: CloudWatch.Types.PutMetricDataInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
227 /**
228 * 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 MetricDatum 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 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 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 10 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. 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. 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: 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.
229 */
230 putMetricData(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
231 /**
232 * 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 will return to its actual state only once any of its children alarms change state. It is also re-evaluated 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.
233 */
234 setAlarmState(params: CloudWatch.Types.SetAlarmStateInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
235 /**
236 * 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 will return to its actual state only once any of its children alarms change state. It is also re-evaluated 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.
237 */
238 setAlarmState(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
239 /**
240 * 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 AWS 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.
241 */
242 tagResource(params: CloudWatch.Types.TagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request<CloudWatch.Types.TagResourceOutput, AWSError>;
243 /**
244 * 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 AWS 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.
245 */
246 tagResource(callback?: (err: AWSError, data: CloudWatch.Types.TagResourceOutput) => void): Request<CloudWatch.Types.TagResourceOutput, AWSError>;
247 /**
248 * Removes one or more tags from the specified resource.
249 */
250 untagResource(params: CloudWatch.Types.UntagResourceInput, callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request<CloudWatch.Types.UntagResourceOutput, AWSError>;
251 /**
252 * Removes one or more tags from the specified resource.
253 */
254 untagResource(callback?: (err: AWSError, data: CloudWatch.Types.UntagResourceOutput) => void): Request<CloudWatch.Types.UntagResourceOutput, AWSError>;
255 /**
256 * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
257 */
258 waitFor(state: "alarmExists", params: CloudWatch.Types.DescribeAlarmsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
259 /**
260 * Waits for the alarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
261 */
262 waitFor(state: "alarmExists", callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
263 /**
264 * Waits for the compositeAlarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
265 */
266 waitFor(state: "compositeAlarmExists", params: CloudWatch.Types.DescribeAlarmsInput & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
267 /**
268 * Waits for the compositeAlarmExists state by periodically calling the underlying CloudWatch.describeAlarmsoperation every 5 seconds (at most 40 times).
269 */
270 waitFor(state: "compositeAlarmExists", callback?: (err: AWSError, data: CloudWatch.Types.DescribeAlarmsOutput) => void): Request<CloudWatch.Types.DescribeAlarmsOutput, AWSError>;
271}
272declare namespace CloudWatch {
273 export type ActionPrefix = string;
274 export type ActionsEnabled = boolean;
275 export type AlarmArn = string;
276 export type AlarmDescription = string;
277 export interface AlarmHistoryItem {
278 /**
279 * The descriptive name for the alarm.
280 */
281 AlarmName?: AlarmName;
282 /**
283 * The type of alarm, either metric alarm or composite alarm.
284 */
285 AlarmType?: AlarmType;
286 /**
287 * The time stamp for the alarm history item.
288 */
289 Timestamp?: Timestamp;
290 /**
291 * The type of alarm history item.
292 */
293 HistoryItemType?: HistoryItemType;
294 /**
295 * A summary of the alarm history, in text format.
296 */
297 HistorySummary?: HistorySummary;
298 /**
299 * Data about the alarm, in JSON format.
300 */
301 HistoryData?: HistoryData;
302 }
303 export type AlarmHistoryItems = AlarmHistoryItem[];
304 export type AlarmName = string;
305 export type AlarmNamePrefix = string;
306 export type AlarmNames = AlarmName[];
307 export type AlarmRule = string;
308 export type AlarmType = "CompositeAlarm"|"MetricAlarm"|string;
309 export type AlarmTypes = AlarmType[];
310 export type AmazonResourceName = string;
311 export interface AnomalyDetector {
312 /**
313 * The namespace of the metric associated with the anomaly detection model.
314 */
315 Namespace?: Namespace;
316 /**
317 * The name of the metric associated with the anomaly detection model.
318 */
319 MetricName?: MetricName;
320 /**
321 * The metric dimensions associated with the anomaly detection model.
322 */
323 Dimensions?: Dimensions;
324 /**
325 * The statistic associated with the anomaly detection model.
326 */
327 Stat?: AnomalyDetectorMetricStat;
328 /**
329 * 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.
330 */
331 Configuration?: AnomalyDetectorConfiguration;
332 /**
333 * The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
334 */
335 StateValue?: AnomalyDetectorStateValue;
336 }
337 export interface AnomalyDetectorConfiguration {
338 /**
339 * 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.
340 */
341 ExcludedTimeRanges?: AnomalyDetectorExcludedTimeRanges;
342 /**
343 * 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.
344 */
345 MetricTimezone?: AnomalyDetectorMetricTimezone;
346 }
347 export type AnomalyDetectorExcludedTimeRanges = Range[];
348 export type AnomalyDetectorMetricStat = string;
349 export type AnomalyDetectorMetricTimezone = string;
350 export type AnomalyDetectorStateValue = "PENDING_TRAINING"|"TRAINED_INSUFFICIENT_DATA"|"TRAINED"|string;
351 export type AnomalyDetectors = AnomalyDetector[];
352 export type BatchFailures = PartialFailure[];
353 export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|"LessThanLowerOrGreaterThanUpperThreshold"|"LessThanLowerThreshold"|"GreaterThanUpperThreshold"|string;
354 export interface CompositeAlarm {
355 /**
356 * Indicates whether actions should be executed during any changes to the alarm state.
357 */
358 ActionsEnabled?: ActionsEnabled;
359 /**
360 * 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).
361 */
362 AlarmActions?: ResourceList;
363 /**
364 * The Amazon Resource Name (ARN) of the alarm.
365 */
366 AlarmArn?: AlarmArn;
367 /**
368 * The time stamp of the last update to the alarm configuration.
369 */
370 AlarmConfigurationUpdatedTimestamp?: Timestamp;
371 /**
372 * The description of the alarm.
373 */
374 AlarmDescription?: AlarmDescription;
375 /**
376 * The name of the alarm.
377 */
378 AlarmName?: AlarmName;
379 /**
380 * The rule that this alarm uses to evaluate its alarm state.
381 */
382 AlarmRule?: AlarmRule;
383 /**
384 * 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).
385 */
386 InsufficientDataActions?: ResourceList;
387 /**
388 * 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).
389 */
390 OKActions?: ResourceList;
391 /**
392 * An explanation for the alarm state, in text format.
393 */
394 StateReason?: StateReason;
395 /**
396 * An explanation for the alarm state, in JSON format.
397 */
398 StateReasonData?: StateReasonData;
399 /**
400 * The time stamp of the last update to the alarm state.
401 */
402 StateUpdatedTimestamp?: Timestamp;
403 /**
404 * The state value for the alarm.
405 */
406 StateValue?: StateValue;
407 }
408 export type CompositeAlarms = CompositeAlarm[];
409 export type Counts = DatapointValue[];
410 export type DashboardArn = string;
411 export type DashboardBody = string;
412 export type DashboardEntries = DashboardEntry[];
413 export interface DashboardEntry {
414 /**
415 * The name of the dashboard.
416 */
417 DashboardName?: DashboardName;
418 /**
419 * The Amazon Resource Name (ARN) of the dashboard.
420 */
421 DashboardArn?: DashboardArn;
422 /**
423 * 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.
424 */
425 LastModified?: LastModified;
426 /**
427 * The size of the dashboard, in bytes.
428 */
429 Size?: Size;
430 }
431 export type DashboardName = string;
432 export type DashboardNamePrefix = string;
433 export type DashboardNames = DashboardName[];
434 export interface DashboardValidationMessage {
435 /**
436 * The data path related to the message.
437 */
438 DataPath?: DataPath;
439 /**
440 * A message describing the error or warning.
441 */
442 Message?: Message;
443 }
444 export type DashboardValidationMessages = DashboardValidationMessage[];
445 export type DataPath = string;
446 export interface Datapoint {
447 /**
448 * The time stamp used for the data point.
449 */
450 Timestamp?: Timestamp;
451 /**
452 * The number of metric values that contributed to the aggregate value of this data point.
453 */
454 SampleCount?: DatapointValue;
455 /**
456 * The average of the metric values that correspond to the data point.
457 */
458 Average?: DatapointValue;
459 /**
460 * The sum of the metric values for the data point.
461 */
462 Sum?: DatapointValue;
463 /**
464 * The minimum metric value for the data point.
465 */
466 Minimum?: DatapointValue;
467 /**
468 * The maximum metric value for the data point.
469 */
470 Maximum?: DatapointValue;
471 /**
472 * The standard unit for the data point.
473 */
474 Unit?: StandardUnit;
475 /**
476 * The percentile statistic for the data point.
477 */
478 ExtendedStatistics?: DatapointValueMap;
479 }
480 export type DatapointValue = number;
481 export type DatapointValueMap = {[key: string]: DatapointValue};
482 export type DatapointValues = DatapointValue[];
483 export type Datapoints = Datapoint[];
484 export type DatapointsToAlarm = number;
485 export interface DeleteAlarmsInput {
486 /**
487 * The alarms to be deleted.
488 */
489 AlarmNames: AlarmNames;
490 }
491 export interface DeleteAnomalyDetectorInput {
492 /**
493 * The namespace associated with the anomaly detection model to delete.
494 */
495 Namespace: Namespace;
496 /**
497 * The metric name associated with the anomaly detection model to delete.
498 */
499 MetricName: MetricName;
500 /**
501 * The metric dimensions associated with the anomaly detection model to delete.
502 */
503 Dimensions?: Dimensions;
504 /**
505 * The statistic associated with the anomaly detection model to delete.
506 */
507 Stat: AnomalyDetectorMetricStat;
508 }
509 export interface DeleteAnomalyDetectorOutput {
510 }
511 export interface DeleteDashboardsInput {
512 /**
513 * The dashboards to be deleted. This parameter is required.
514 */
515 DashboardNames: DashboardNames;
516 }
517 export interface DeleteDashboardsOutput {
518 }
519 export interface DeleteInsightRulesInput {
520 /**
521 * An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
522 */
523 RuleNames: InsightRuleNames;
524 }
525 export interface DeleteInsightRulesOutput {
526 /**
527 * An array listing the rules that could not be deleted. You cannot delete built-in rules.
528 */
529 Failures?: BatchFailures;
530 }
531 export interface DescribeAlarmHistoryInput {
532 /**
533 * The name of the alarm.
534 */
535 AlarmName?: AlarmName;
536 /**
537 * 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.
538 */
539 AlarmTypes?: AlarmTypes;
540 /**
541 * The type of alarm histories to retrieve.
542 */
543 HistoryItemType?: HistoryItemType;
544 /**
545 * The starting date to retrieve alarm history.
546 */
547 StartDate?: Timestamp;
548 /**
549 * The ending date to retrieve alarm history.
550 */
551 EndDate?: Timestamp;
552 /**
553 * The maximum number of alarm history records to retrieve.
554 */
555 MaxRecords?: MaxRecords;
556 /**
557 * The token returned by a previous call to indicate that there is more data available.
558 */
559 NextToken?: NextToken;
560 /**
561 * 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.
562 */
563 ScanBy?: ScanBy;
564 }
565 export interface DescribeAlarmHistoryOutput {
566 /**
567 * The alarm histories, in JSON format.
568 */
569 AlarmHistoryItems?: AlarmHistoryItems;
570 /**
571 * The token that marks the start of the next batch of returned results.
572 */
573 NextToken?: NextToken;
574 }
575 export interface DescribeAlarmsForMetricInput {
576 /**
577 * The name of the metric.
578 */
579 MetricName: MetricName;
580 /**
581 * The namespace of the metric.
582 */
583 Namespace: Namespace;
584 /**
585 * The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.
586 */
587 Statistic?: Statistic;
588 /**
589 * The percentile statistic for the metric. Specify a value between p0.0 and p100.
590 */
591 ExtendedStatistic?: ExtendedStatistic;
592 /**
593 * The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
594 */
595 Dimensions?: Dimensions;
596 /**
597 * The period, in seconds, over which the statistic is applied.
598 */
599 Period?: Period;
600 /**
601 * The unit for the metric.
602 */
603 Unit?: StandardUnit;
604 }
605 export interface DescribeAlarmsForMetricOutput {
606 /**
607 * The information for each alarm with the specified metric.
608 */
609 MetricAlarms?: MetricAlarms;
610 }
611 export interface DescribeAlarmsInput {
612 /**
613 * The names of the alarms to retrieve information about.
614 */
615 AlarmNames?: AlarmNames;
616 /**
617 * 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.
618 */
619 AlarmNamePrefix?: AlarmNamePrefix;
620 /**
621 * 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.
622 */
623 AlarmTypes?: AlarmTypes;
624 /**
625 * 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 will 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.
626 */
627 ChildrenOfAlarmName?: AlarmName;
628 /**
629 * 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 will 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.
630 */
631 ParentsOfAlarmName?: AlarmName;
632 /**
633 * Specify this parameter to receive information only about alarms that are currently in the state that you specify.
634 */
635 StateValue?: StateValue;
636 /**
637 * 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.
638 */
639 ActionPrefix?: ActionPrefix;
640 /**
641 * The maximum number of alarm descriptions to retrieve.
642 */
643 MaxRecords?: MaxRecords;
644 /**
645 * The token returned by a previous call to indicate that there is more data available.
646 */
647 NextToken?: NextToken;
648 }
649 export interface DescribeAlarmsOutput {
650 /**
651 * The information about any composite alarms returned by the operation.
652 */
653 CompositeAlarms?: CompositeAlarms;
654 /**
655 * The information about any metric alarms returned by the operation.
656 */
657 MetricAlarms?: MetricAlarms;
658 /**
659 * The token that marks the start of the next batch of returned results.
660 */
661 NextToken?: NextToken;
662 }
663 export interface DescribeAnomalyDetectorsInput {
664 /**
665 * Use the token returned by the previous operation to request the next page of results.
666 */
667 NextToken?: NextToken;
668 /**
669 * 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.
670 */
671 MaxResults?: MaxReturnedResultsCount;
672 /**
673 * Limits the results to only the anomaly detection models that are associated with the specified namespace.
674 */
675 Namespace?: Namespace;
676 /**
677 * 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.
678 */
679 MetricName?: MetricName;
680 /**
681 * 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.
682 */
683 Dimensions?: Dimensions;
684 }
685 export interface DescribeAnomalyDetectorsOutput {
686 /**
687 * The list of anomaly detection models returned by the operation.
688 */
689 AnomalyDetectors?: AnomalyDetectors;
690 /**
691 * A token that you can use in a subsequent operation to retrieve the next set of results.
692 */
693 NextToken?: NextToken;
694 }
695 export interface DescribeInsightRulesInput {
696 /**
697 * Reserved for future use.
698 */
699 NextToken?: NextToken;
700 /**
701 * This parameter is not currently used. Reserved for future use. If it is used in the future, the maximum value may be different.
702 */
703 MaxResults?: InsightRuleMaxResults;
704 }
705 export interface DescribeInsightRulesOutput {
706 /**
707 * Reserved for future use.
708 */
709 NextToken?: NextToken;
710 /**
711 * The rules returned by the operation.
712 */
713 InsightRules?: InsightRules;
714 }
715 export interface Dimension {
716 /**
717 * The name of the dimension.
718 */
719 Name: DimensionName;
720 /**
721 * The value representing the dimension measurement.
722 */
723 Value: DimensionValue;
724 }
725 export interface DimensionFilter {
726 /**
727 * The dimension name to be matched.
728 */
729 Name: DimensionName;
730 /**
731 * The value of the dimension to be matched.
732 */
733 Value?: DimensionValue;
734 }
735 export type DimensionFilters = DimensionFilter[];
736 export type DimensionName = string;
737 export type DimensionValue = string;
738 export type Dimensions = Dimension[];
739 export interface DisableAlarmActionsInput {
740 /**
741 * The names of the alarms.
742 */
743 AlarmNames: AlarmNames;
744 }
745 export interface DisableInsightRulesInput {
746 /**
747 * An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
748 */
749 RuleNames: InsightRuleNames;
750 }
751 export interface DisableInsightRulesOutput {
752 /**
753 * An array listing the rules that could not be disabled. You cannot disable built-in rules.
754 */
755 Failures?: BatchFailures;
756 }
757 export interface EnableAlarmActionsInput {
758 /**
759 * The names of the alarms.
760 */
761 AlarmNames: AlarmNames;
762 }
763 export interface EnableInsightRulesInput {
764 /**
765 * An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
766 */
767 RuleNames: InsightRuleNames;
768 }
769 export interface EnableInsightRulesOutput {
770 /**
771 * An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
772 */
773 Failures?: BatchFailures;
774 }
775 export type EvaluateLowSampleCountPercentile = string;
776 export type EvaluationPeriods = number;
777 export type ExceptionType = string;
778 export type ExtendedStatistic = string;
779 export type ExtendedStatistics = ExtendedStatistic[];
780 export type FailureCode = string;
781 export type FailureDescription = string;
782 export type FailureResource = string;
783 export interface GetDashboardInput {
784 /**
785 * The name of the dashboard to be described.
786 */
787 DashboardName: DashboardName;
788 }
789 export interface GetDashboardOutput {
790 /**
791 * The Amazon Resource Name (ARN) of the dashboard.
792 */
793 DashboardArn?: DashboardArn;
794 /**
795 * 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.
796 */
797 DashboardBody?: DashboardBody;
798 /**
799 * The name of the dashboard.
800 */
801 DashboardName?: DashboardName;
802 }
803 export interface GetInsightRuleReportInput {
804 /**
805 * The name of the rule that you want to see data from.
806 */
807 RuleName: InsightRuleName;
808 /**
809 * 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.
810 */
811 StartTime: Timestamp;
812 /**
813 * 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.
814 */
815 EndTime: Timestamp;
816 /**
817 * The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
818 */
819 Period: Period;
820 /**
821 * 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.
822 */
823 MaxContributorCount?: InsightRuleUnboundInteger;
824 /**
825 * 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. MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor may 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. 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. 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.
826 */
827 Metrics?: InsightRuleMetricList;
828 /**
829 * Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.
830 */
831 OrderBy?: InsightRuleOrderBy;
832 }
833 export interface GetInsightRuleReportOutput {
834 /**
835 * 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.
836 */
837 KeyLabels?: InsightRuleContributorKeyLabels;
838 /**
839 * Specifies whether this rule aggregates contributor data by COUNT or SUM.
840 */
841 AggregationStatistic?: InsightRuleAggregationStatistic;
842 /**
843 * The sum of the values from all individual contributors that match the rule.
844 */
845 AggregateValue?: InsightRuleUnboundDouble;
846 /**
847 * An approximate count of the unique contributors found by this rule in this time period.
848 */
849 ApproximateUniqueCount?: InsightRuleUnboundLong;
850 /**
851 * 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.
852 */
853 Contributors?: InsightRuleContributors;
854 /**
855 * A time series of metric data points that matches the time period in the rule request.
856 */
857 MetricDatapoints?: InsightRuleMetricDatapoints;
858 }
859 export interface GetMetricDataInput {
860 /**
861 * 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, or a math expression to perform on retrieved data.
862 */
863 MetricDataQueries: MetricDataQueries;
864 /**
865 * The time stamp indicating the earliest data to be returned. 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. 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. 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.
866 */
867 StartTime: Timestamp;
868 /**
869 * 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.
870 */
871 EndTime: Timestamp;
872 /**
873 * Include this value, if it was returned by the previous call, to get the next set of data points.
874 */
875 NextToken?: NextToken;
876 /**
877 * 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.
878 */
879 ScanBy?: ScanBy;
880 /**
881 * The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
882 */
883 MaxDatapoints?: GetMetricDataMaxDatapoints;
884 }
885 export type GetMetricDataMaxDatapoints = number;
886 export interface GetMetricDataOutput {
887 /**
888 * The metrics that are returned, including the metric name, namespace, and dimensions.
889 */
890 MetricDataResults?: MetricDataResults;
891 /**
892 * A token that marks the next batch of returned results.
893 */
894 NextToken?: NextToken;
895 /**
896 * Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that may 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.
897 */
898 Messages?: MetricDataResultMessages;
899 }
900 export interface GetMetricStatisticsInput {
901 /**
902 * The namespace of the metric, with or without spaces.
903 */
904 Namespace: Namespace;
905 /**
906 * The name of the metric, with or without spaces.
907 */
908 MetricName: MetricName;
909 /**
910 * 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.
911 */
912 Dimensions?: Dimensions;
913 /**
914 * 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). 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. 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. 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.
915 */
916 StartTime: Timestamp;
917 /**
918 * 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).
919 */
920 EndTime: Timestamp;
921 /**
922 * 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 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).
923 */
924 Period: Period;
925 /**
926 * The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.
927 */
928 Statistics?: Statistics;
929 /**
930 * 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.
931 */
932 ExtendedStatistics?: ExtendedStatistics;
933 /**
934 * 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 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.
935 */
936 Unit?: StandardUnit;
937 }
938 export interface GetMetricStatisticsOutput {
939 /**
940 * A label for the specified metric.
941 */
942 Label?: MetricLabel;
943 /**
944 * The data points for the specified metric.
945 */
946 Datapoints?: Datapoints;
947 }
948 export interface GetMetricWidgetImageInput {
949 /**
950 * 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.
951 */
952 MetricWidget: MetricWidget;
953 /**
954 * 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: &lt;GetMetricWidgetImageResponse xmlns=&lt;URLstring&gt;&gt; &lt;GetMetricWidgetImageResult&gt; &lt;MetricWidgetImage&gt; iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip... &lt;/MetricWidgetImage&gt; &lt;/GetMetricWidgetImageResult&gt; &lt;ResponseMetadata&gt; &lt;RequestId&gt;6f0d4192-4d42-11e8-82c1-f539a07e0e3b&lt;/RequestId&gt; &lt;/ResponseMetadata&gt; &lt;/GetMetricWidgetImageResponse&gt; The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS 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.
955 */
956 OutputFormat?: OutputFormat;
957 }
958 export interface GetMetricWidgetImageOutput {
959 /**
960 * The image of the graph, in the output format specified.
961 */
962 MetricWidgetImage?: MetricWidgetImage;
963 }
964 export type HistoryData = string;
965 export type HistoryItemType = "ConfigurationUpdate"|"StateUpdate"|"Action"|string;
966 export type HistorySummary = string;
967 export interface InsightRule {
968 /**
969 * The name of the rule.
970 */
971 Name: InsightRuleName;
972 /**
973 * Indicates whether the rule is enabled or disabled.
974 */
975 State: InsightRuleState;
976 /**
977 * For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For built-in rules, this is {"Name": "ServiceLogRule", "Version": 1}
978 */
979 Schema: InsightRuleSchema;
980 /**
981 * 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.
982 */
983 Definition: InsightRuleDefinition;
984 }
985 export type InsightRuleAggregationStatistic = string;
986 export interface InsightRuleContributor {
987 /**
988 * One of the log entry field keywords that is used to define contributors for this rule.
989 */
990 Keys: InsightRuleContributorKeys;
991 /**
992 * An approximation of the aggregate value that comes from this contributor.
993 */
994 ApproximateAggregateValue: InsightRuleUnboundDouble;
995 /**
996 * An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.
997 */
998 Datapoints: InsightRuleContributorDatapoints;
999 }
1000 export interface InsightRuleContributorDatapoint {
1001 /**
1002 * The timestamp of the data point.
1003 */
1004 Timestamp: Timestamp;
1005 /**
1006 * The approximate value that this contributor added during this timestamp.
1007 */
1008 ApproximateValue: InsightRuleUnboundDouble;
1009 }
1010 export type InsightRuleContributorDatapoints = InsightRuleContributorDatapoint[];
1011 export type InsightRuleContributorKey = string;
1012 export type InsightRuleContributorKeyLabel = string;
1013 export type InsightRuleContributorKeyLabels = InsightRuleContributorKeyLabel[];
1014 export type InsightRuleContributorKeys = InsightRuleContributorKey[];
1015 export type InsightRuleContributors = InsightRuleContributor[];
1016 export type InsightRuleDefinition = string;
1017 export type InsightRuleMaxResults = number;
1018 export interface InsightRuleMetricDatapoint {
1019 /**
1020 * The timestamp of the data point.
1021 */
1022 Timestamp: Timestamp;
1023 /**
1024 * 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.
1025 */
1026 UniqueContributors?: InsightRuleUnboundDouble;
1027 /**
1028 * 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.
1029 */
1030 MaxContributorValue?: InsightRuleUnboundDouble;
1031 /**
1032 * 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.
1033 */
1034 SampleCount?: InsightRuleUnboundDouble;
1035 /**
1036 * 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.
1037 */
1038 Average?: InsightRuleUnboundDouble;
1039 /**
1040 * 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.
1041 */
1042 Sum?: InsightRuleUnboundDouble;
1043 /**
1044 * 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.
1045 */
1046 Minimum?: InsightRuleUnboundDouble;
1047 /**
1048 * 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.
1049 */
1050 Maximum?: InsightRuleUnboundDouble;
1051 }
1052 export type InsightRuleMetricDatapoints = InsightRuleMetricDatapoint[];
1053 export type InsightRuleMetricList = InsightRuleMetricName[];
1054 export type InsightRuleMetricName = string;
1055 export type InsightRuleName = string;
1056 export type InsightRuleNames = InsightRuleName[];
1057 export type InsightRuleOrderBy = string;
1058 export type InsightRuleSchema = string;
1059 export type InsightRuleState = string;
1060 export type InsightRuleUnboundDouble = number;
1061 export type InsightRuleUnboundInteger = number;
1062 export type InsightRuleUnboundLong = number;
1063 export type InsightRules = InsightRule[];
1064 export type LastModified = Date;
1065 export interface ListDashboardsInput {
1066 /**
1067 * 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 "_".
1068 */
1069 DashboardNamePrefix?: DashboardNamePrefix;
1070 /**
1071 * The token returned by a previous call to indicate that there is more data available.
1072 */
1073 NextToken?: NextToken;
1074 }
1075 export interface ListDashboardsOutput {
1076 /**
1077 * The list of matching dashboards.
1078 */
1079 DashboardEntries?: DashboardEntries;
1080 /**
1081 * The token that marks the start of the next batch of returned results.
1082 */
1083 NextToken?: NextToken;
1084 }
1085 export interface ListMetricsInput {
1086 /**
1087 * The namespace to filter against.
1088 */
1089 Namespace?: Namespace;
1090 /**
1091 * The name of the metric to filter against.
1092 */
1093 MetricName?: MetricName;
1094 /**
1095 * The dimensions to filter against.
1096 */
1097 Dimensions?: DimensionFilters;
1098 /**
1099 * The token returned by a previous call to indicate that there is more data available.
1100 */
1101 NextToken?: NextToken;
1102 }
1103 export interface ListMetricsOutput {
1104 /**
1105 * The metrics.
1106 */
1107 Metrics?: Metrics;
1108 /**
1109 * The token that marks the start of the next batch of returned results.
1110 */
1111 NextToken?: NextToken;
1112 }
1113 export interface ListTagsForResourceInput {
1114 /**
1115 * 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 The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
1116 */
1117 ResourceARN: AmazonResourceName;
1118 }
1119 export interface ListTagsForResourceOutput {
1120 /**
1121 * The list of tag keys and values associated with the resource you specified.
1122 */
1123 Tags?: TagList;
1124 }
1125 export type MaxRecords = number;
1126 export type MaxReturnedResultsCount = number;
1127 export type Message = string;
1128 export interface MessageData {
1129 /**
1130 * The error code or status code associated with the message.
1131 */
1132 Code?: MessageDataCode;
1133 /**
1134 * The message text.
1135 */
1136 Value?: MessageDataValue;
1137 }
1138 export type MessageDataCode = string;
1139 export type MessageDataValue = string;
1140 export interface Metric {
1141 /**
1142 * The namespace of the metric.
1143 */
1144 Namespace?: Namespace;
1145 /**
1146 * The name of the metric. This is a required field.
1147 */
1148 MetricName?: MetricName;
1149 /**
1150 * The dimensions for the metric.
1151 */
1152 Dimensions?: Dimensions;
1153 }
1154 export interface MetricAlarm {
1155 /**
1156 * The name of the alarm.
1157 */
1158 AlarmName?: AlarmName;
1159 /**
1160 * The Amazon Resource Name (ARN) of the alarm.
1161 */
1162 AlarmArn?: AlarmArn;
1163 /**
1164 * The description of the alarm.
1165 */
1166 AlarmDescription?: AlarmDescription;
1167 /**
1168 * The time stamp of the last update to the alarm configuration.
1169 */
1170 AlarmConfigurationUpdatedTimestamp?: Timestamp;
1171 /**
1172 * Indicates whether actions should be executed during any changes to the alarm state.
1173 */
1174 ActionsEnabled?: ActionsEnabled;
1175 /**
1176 * 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).
1177 */
1178 OKActions?: ResourceList;
1179 /**
1180 * 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).
1181 */
1182 AlarmActions?: ResourceList;
1183 /**
1184 * 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).
1185 */
1186 InsufficientDataActions?: ResourceList;
1187 /**
1188 * The state value for the alarm.
1189 */
1190 StateValue?: StateValue;
1191 /**
1192 * An explanation for the alarm state, in text format.
1193 */
1194 StateReason?: StateReason;
1195 /**
1196 * An explanation for the alarm state, in JSON format.
1197 */
1198 StateReasonData?: StateReasonData;
1199 /**
1200 * The time stamp of the last update to the alarm state.
1201 */
1202 StateUpdatedTimestamp?: Timestamp;
1203 /**
1204 * The name of the metric associated with the alarm, if this is an alarm based on a single metric.
1205 */
1206 MetricName?: MetricName;
1207 /**
1208 * The namespace of the metric associated with the alarm.
1209 */
1210 Namespace?: Namespace;
1211 /**
1212 * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
1213 */
1214 Statistic?: Statistic;
1215 /**
1216 * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
1217 */
1218 ExtendedStatistic?: ExtendedStatistic;
1219 /**
1220 * The dimensions for the metric associated with the alarm.
1221 */
1222 Dimensions?: Dimensions;
1223 /**
1224 * The period, in seconds, over which the statistic is applied.
1225 */
1226 Period?: Period;
1227 /**
1228 * The unit of the metric associated with the alarm.
1229 */
1230 Unit?: StandardUnit;
1231 /**
1232 * The number of periods over which data is compared to the specified threshold.
1233 */
1234 EvaluationPeriods?: EvaluationPeriods;
1235 /**
1236 * The number of data points that must be breaching to trigger the alarm.
1237 */
1238 DatapointsToAlarm?: DatapointsToAlarm;
1239 /**
1240 * The value to compare with the specified statistic.
1241 */
1242 Threshold?: Threshold;
1243 /**
1244 * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
1245 */
1246 ComparisonOperator?: ComparisonOperator;
1247 /**
1248 * Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
1249 */
1250 TreatMissingData?: TreatMissingData;
1251 /**
1252 * 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.
1253 */
1254 EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile;
1255 /**
1256 * 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 ReturnValue set to true.
1257 */
1258 Metrics?: MetricDataQueries;
1259 /**
1260 * 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.
1261 */
1262 ThresholdMetricId?: MetricId;
1263 }
1264 export type MetricAlarms = MetricAlarm[];
1265 export type MetricData = MetricDatum[];
1266 export type MetricDataQueries = MetricDataQuery[];
1267 export interface MetricDataQuery {
1268 /**
1269 * 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.
1270 */
1271 Id: MetricId;
1272 /**
1273 * 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.
1274 */
1275 MetricStat?: MetricStat;
1276 /**
1277 * The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics 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.
1278 */
1279 Expression?: MetricExpression;
1280 /**
1281 * 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.
1282 */
1283 Label?: MetricLabel;
1284 /**
1285 * 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.
1286 */
1287 ReturnData?: ReturnData;
1288 /**
1289 * 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.
1290 */
1291 Period?: Period;
1292 }
1293 export interface MetricDataResult {
1294 /**
1295 * The short name you specified to represent this metric.
1296 */
1297 Id?: MetricId;
1298 /**
1299 * The human-readable label associated with the data.
1300 */
1301 Label?: MetricLabel;
1302 /**
1303 * 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].
1304 */
1305 Timestamps?: Timestamps;
1306 /**
1307 * 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].
1308 */
1309 Values?: DatapointValues;
1310 /**
1311 * 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.
1312 */
1313 StatusCode?: StatusCode;
1314 /**
1315 * A list of messages with additional information about the data returned.
1316 */
1317 Messages?: MetricDataResultMessages;
1318 }
1319 export type MetricDataResultMessages = MessageData[];
1320 export type MetricDataResults = MetricDataResult[];
1321 export interface MetricDatum {
1322 /**
1323 * The name of the metric.
1324 */
1325 MetricName: MetricName;
1326 /**
1327 * The dimensions associated with the metric.
1328 */
1329 Dimensions?: Dimensions;
1330 /**
1331 * The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
1332 */
1333 Timestamp?: Timestamp;
1334 /**
1335 * 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.
1336 */
1337 Value?: DatapointValue;
1338 /**
1339 * The statistical values for the metric.
1340 */
1341 StatisticValues?: StatisticSet;
1342 /**
1343 * 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.
1344 */
1345 Values?: Values;
1346 /**
1347 * 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.
1348 */
1349 Counts?: Counts;
1350 /**
1351 * 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.
1352 */
1353 Unit?: StandardUnit;
1354 /**
1355 * 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.
1356 */
1357 StorageResolution?: StorageResolution;
1358 }
1359 export type MetricExpression = string;
1360 export type MetricId = string;
1361 export type MetricLabel = string;
1362 export type MetricName = string;
1363 export interface MetricStat {
1364 /**
1365 * The metric to return, including the metric name, namespace, and dimensions.
1366 */
1367 Metric: Metric;
1368 /**
1369 * 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 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).
1370 */
1371 Period: Period;
1372 /**
1373 * The statistic to return. It can include any CloudWatch statistic or extended statistic.
1374 */
1375 Stat: Stat;
1376 /**
1377 * 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 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.
1378 */
1379 Unit?: StandardUnit;
1380 }
1381 export type MetricWidget = string;
1382 export type MetricWidgetImage = Buffer|Uint8Array|Blob|string;
1383 export type Metrics = Metric[];
1384 export type Namespace = string;
1385 export type NextToken = string;
1386 export type OutputFormat = string;
1387 export interface PartialFailure {
1388 /**
1389 * The specified rule that could not be deleted.
1390 */
1391 FailureResource?: FailureResource;
1392 /**
1393 * The type of error.
1394 */
1395 ExceptionType?: ExceptionType;
1396 /**
1397 * The code of the error.
1398 */
1399 FailureCode?: FailureCode;
1400 /**
1401 * A description of the error.
1402 */
1403 FailureDescription?: FailureDescription;
1404 }
1405 export type Period = number;
1406 export interface PutAnomalyDetectorInput {
1407 /**
1408 * The namespace of the metric to create the anomaly detection model for.
1409 */
1410 Namespace: Namespace;
1411 /**
1412 * The name of the metric to create the anomaly detection model for.
1413 */
1414 MetricName: MetricName;
1415 /**
1416 * The metric dimensions to create the anomaly detection model for.
1417 */
1418 Dimensions?: Dimensions;
1419 /**
1420 * The statistic to use for the metric and the anomaly detection model.
1421 */
1422 Stat: AnomalyDetectorMetricStat;
1423 /**
1424 * 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. You can in
1425 */
1426 Configuration?: AnomalyDetectorConfiguration;
1427 }
1428 export interface PutAnomalyDetectorOutput {
1429 }
1430 export interface PutCompositeAlarmInput {
1431 /**
1432 * Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
1433 */
1434 ActionsEnabled?: ActionsEnabled;
1435 /**
1436 * 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: arn:aws:sns:region:account-id:sns-topic-name
1437 */
1438 AlarmActions?: ResourceList;
1439 /**
1440 * The description for the composite alarm.
1441 */
1442 AlarmDescription?: AlarmDescription;
1443 /**
1444 * The name for the composite alarm. This name must be unique within your AWS account.
1445 */
1446 AlarmName: AlarmName;
1447 /**
1448 * 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. Functions can include the following: 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. INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state. TRUE always evaluates to TRUE. FALSE always evaluates to FALSE. 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(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. 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.
1449 */
1450 AlarmRule: AlarmRule;
1451 /**
1452 * 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: arn:aws:sns:region:account-id:sns-topic-name
1453 */
1454 InsufficientDataActions?: ResourceList;
1455 /**
1456 * 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: arn:aws:sns:region:account-id:sns-topic-name
1457 */
1458 OKActions?: ResourceList;
1459 /**
1460 * A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm. 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.
1461 */
1462 Tags?: TagList;
1463 }
1464 export interface PutDashboardInput {
1465 /**
1466 * 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.
1467 */
1468 DashboardName: DashboardName;
1469 /**
1470 * 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.
1471 */
1472 DashboardBody: DashboardBody;
1473 }
1474 export interface PutDashboardOutput {
1475 /**
1476 * 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 may not render. If this result includes error messages, the input was not valid and the operation failed.
1477 */
1478 DashboardValidationMessages?: DashboardValidationMessages;
1479 }
1480 export interface PutInsightRuleInput {
1481 /**
1482 * A unique name for the rule.
1483 */
1484 RuleName: InsightRuleName;
1485 /**
1486 * The state of the rule. Valid values are ENABLED and DISABLED.
1487 */
1488 RuleState?: InsightRuleState;
1489 /**
1490 * The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
1491 */
1492 RuleDefinition: InsightRuleDefinition;
1493 /**
1494 * 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.
1495 */
1496 Tags?: TagList;
1497 }
1498 export interface PutInsightRuleOutput {
1499 }
1500 export interface PutMetricAlarmInput {
1501 /**
1502 * The name for the alarm. This name must be unique within your AWS account.
1503 */
1504 AlarmName: AlarmName;
1505 /**
1506 * The description for the alarm.
1507 */
1508 AlarmDescription?: AlarmDescription;
1509 /**
1510 * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
1511 */
1512 ActionsEnabled?: ActionsEnabled;
1513 /**
1514 * 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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
1515 */
1516 OKActions?: ResourceList;
1517 /**
1518 * 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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
1519 */
1520 AlarmActions?: ResourceList;
1521 /**
1522 * 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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name Valid Values (for use with IAM roles): &gt;arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
1523 */
1524 InsufficientDataActions?: ResourceList;
1525 /**
1526 * 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 Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.
1527 */
1528 MetricName?: MetricName;
1529 /**
1530 * The namespace for the metric associated specified in MetricName.
1531 */
1532 Namespace?: Namespace;
1533 /**
1534 * 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.
1535 */
1536 Statistic?: Statistic;
1537 /**
1538 * The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.
1539 */
1540 ExtendedStatistic?: ExtendedStatistic;
1541 /**
1542 * The dimensions for the metric specified in MetricName.
1543 */
1544 Dimensions?: Dimensions;
1545 /**
1546 * 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 may 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.
1547 */
1548 Period?: Period;
1549 /**
1550 * 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 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 will work 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 will behave un-predictably. 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.
1551 */
1552 Unit?: StandardUnit;
1553 /**
1554 * 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.
1555 */
1556 EvaluationPeriods: EvaluationPeriods;
1557 /**
1558 * 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.
1559 */
1560 DatapointsToAlarm?: DatapointsToAlarm;
1561 /**
1562 * 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.
1563 */
1564 Threshold?: Threshold;
1565 /**
1566 * The arithmetic operation to use when comparing the specified statistic and 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.
1567 */
1568 ComparisonOperator: ComparisonOperator;
1569 /**
1570 * 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
1571 */
1572 TreatMissingData?: TreatMissingData;
1573 /**
1574 * 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
1575 */
1576 EvaluateLowSampleCountPercentile?: EvaluateLowSampleCountPercentile;
1577 /**
1578 * 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 ReturnValue to true for this object in the array. For more information, see MetricDataQuery. If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, 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.
1579 */
1580 Metrics?: MetricDataQueries;
1581 /**
1582 * A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. 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.
1583 */
1584 Tags?: TagList;
1585 /**
1586 * 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.
1587 */
1588 ThresholdMetricId?: MetricId;
1589 }
1590 export interface PutMetricDataInput {
1591 /**
1592 * The namespace for the metric data. To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with AWS/
1593 */
1594 Namespace: Namespace;
1595 /**
1596 * The data for the metric. The array can include no more than 20 metrics per call.
1597 */
1598 MetricData: MetricData;
1599 }
1600 export interface Range {
1601 /**
1602 * 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.
1603 */
1604 StartTime: Timestamp;
1605 /**
1606 * 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.
1607 */
1608 EndTime: Timestamp;
1609 }
1610 export type ResourceList = ResourceName[];
1611 export type ResourceName = string;
1612 export type ReturnData = boolean;
1613 export type ScanBy = "TimestampDescending"|"TimestampAscending"|string;
1614 export interface SetAlarmStateInput {
1615 /**
1616 * The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
1617 */
1618 AlarmName: AlarmName;
1619 /**
1620 * The value of the state.
1621 */
1622 StateValue: StateValue;
1623 /**
1624 * The reason that this alarm is set to this specific state, in text format.
1625 */
1626 StateReason: StateReason;
1627 /**
1628 * 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.
1629 */
1630 StateReasonData?: StateReasonData;
1631 }
1632 export type Size = number;
1633 export type StandardUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string;
1634 export type Stat = string;
1635 export type StateReason = string;
1636 export type StateReasonData = string;
1637 export type StateValue = "OK"|"ALARM"|"INSUFFICIENT_DATA"|string;
1638 export type Statistic = "SampleCount"|"Average"|"Sum"|"Minimum"|"Maximum"|string;
1639 export interface StatisticSet {
1640 /**
1641 * The number of samples used for the statistic set.
1642 */
1643 SampleCount: DatapointValue;
1644 /**
1645 * The sum of values for the sample set.
1646 */
1647 Sum: DatapointValue;
1648 /**
1649 * The minimum value of the sample set.
1650 */
1651 Minimum: DatapointValue;
1652 /**
1653 * The maximum value of the sample set.
1654 */
1655 Maximum: DatapointValue;
1656 }
1657 export type Statistics = Statistic[];
1658 export type StatusCode = "Complete"|"InternalError"|"PartialData"|string;
1659 export type StorageResolution = number;
1660 export interface Tag {
1661 /**
1662 * 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.
1663 */
1664 Key: TagKey;
1665 /**
1666 * The value for the specified tag key.
1667 */
1668 Value: TagValue;
1669 }
1670 export type TagKey = string;
1671 export type TagKeyList = TagKey[];
1672 export type TagList = Tag[];
1673 export interface TagResourceInput {
1674 /**
1675 * 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 The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
1676 */
1677 ResourceARN: AmazonResourceName;
1678 /**
1679 * The list of key-value pairs to associate with the alarm.
1680 */
1681 Tags: TagList;
1682 }
1683 export interface TagResourceOutput {
1684 }
1685 export type TagValue = string;
1686 export type Threshold = number;
1687 export type Timestamp = Date;
1688 export type Timestamps = Timestamp[];
1689 export type TreatMissingData = string;
1690 export interface UntagResourceInput {
1691 /**
1692 * 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 The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name For more information on ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
1693 */
1694 ResourceARN: AmazonResourceName;
1695 /**
1696 * The list of tag keys to remove from the resource.
1697 */
1698 TagKeys: TagKeyList;
1699 }
1700 export interface UntagResourceOutput {
1701 }
1702 export type Values = DatapointValue[];
1703 /**
1704 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1705 */
1706 export type apiVersion = "2010-08-01"|"latest"|string;
1707 export interface ClientApiVersions {
1708 /**
1709 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1710 */
1711 apiVersion?: apiVersion;
1712 }
1713 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1714 /**
1715 * Contains interfaces for use with the CloudWatch client.
1716 */
1717 export import Types = CloudWatch;
1718}
1719export = CloudWatch;